Interface WebSocketProvider

interface WebSocketProvider {
    roomId: string;
    status: WebSocketStatus;
    whenSynced: Promise<void>;
    connect(): void;
    destroy(): void;
    disconnect(): void;
    onStatus(listener: (status: WebSocketStatus) => void): () => void;
}

Index

Properties

roomId status whenSynced

Methods

connect destroy disconnect onStatus

Properties

`Readonly`roomId

roomId: string

`Readonly`status

status: WebSocketStatus

whenSynced

whenSynced: Promise<void>

Resolves on the first successful sync.

Methods

connect

connect(): void

Returns void

destroy

destroy(): void

Returns void

disconnect

disconnect(): void

Returns void

onStatus

onStatus(listener: (status: WebSocketStatus) => void): () => void
Parameters
- listener: (status: WebSocketStatus) => void
Returns () => void