Interface TypedPresence<T>

interface TypedPresence<T> {
    inPendingSyncState(): boolean;
    list<V>(chooser?): V[];
    onJoin(callback): void;
    onLeave(callback): void;
    onSync(callback): void;
}

Type Parameters

  • T extends object

Hierarchy

  • Omit<Presence, "list">
    • TypedPresence

Methods

inPendingSyncState list onJoin onLeave onSync

Methods

inPendingSyncState

  • inPendingSyncState(): boolean

  • Returns boolean

list

  • list<V>(chooser?): V[]

  • Type Parameters

    Parameters

    • Optional chooser: ((key, presence) => V)

    Returns V[]

onJoin

  • onJoin(callback): void

  • Parameters

    • callback: PresenceOnJoinCallback

    Returns void

onLeave

  • onLeave(callback): void

  • Parameters

    • callback: PresenceOnLeaveCallback

    Returns void

onSync

  • onSync(callback): void

  • Parameters

    • callback: (() => void | Promise<void>)
        • (): void | Promise<void>

        • Returns void | Promise<void>

    Returns void

Settings

Member Visibility

Theme

On This Page

inPendingSyncStatelistonJoinonLeaveonSync

Generated using TypeDoc