Interface UseLocalAwarenessProps

interface UseLocalAwarenessProps {
    handle: DocHandle<unknown>;
    heartbeatTime?: number;
    initialState: any;
    userId: string;
}

Index

Properties

handle heartbeatTime? initialState userId

Properties

handle

handle: DocHandle<unknown>

The document handle to send ephemeral state on

`Optional` heartbeatTime

heartbeatTime?: number

How frequently to send heartbeats

initialState

initialState: any

The initial state object/primitive we should advertise

userId

userId: string

Our user ID *