Interface UseRemoteAwarenessProps<T>

interface UseRemoteAwarenessProps<T> {
    getTime?: () => number;
    handle: DocHandle<T>;
    localUserId?: string;
    offlineTimeout?: number;
}

Type Parameters

T

Index

Properties

getTime? handle localUserId? offlineTimeout?

Properties

`Optional`getTime

getTime?: () => number

Function to provide current epoch time

handle

handle: DocHandle<T>

The handle to receive ephemeral state on

`Optional`localUserId

localUserId?: string

Our user ID

`Optional`offlineTimeout

offlineTimeout?: number

How long to wait (in ms) before marking a peer as offline