Interface UseRemoteAwarenessProps<T>

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

Type Parameters

  • T

Properties

getTime? handle localUserId? offlineTimeout?

Properties

Optional getTime

getTime?: (() => number)

Function to provide current epoch time

Type declaration

    • (): number

    • Returns number

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

Settings

Member Visibility

Theme

On This Page

getTimehandlelocalUserIdofflineTimeout