@dxos/client
    Preparing search index...

    Interface ClientServicesProvider

    Provide access to client services definitions and service handler.

    interface ClientServicesProvider {
        closed: Event<undefined | Error>;
        onReconnect?: (callback: () => Promise<void>) => void;
        reconnected?: Event<void>;
        rpc: ClientServicesRpc;
        services: Partial<ClientServices>;
        close(): Promise<unknown>;
        open(): Promise<unknown>;
    }

    Implemented by

    Index

    Properties

    closed onReconnect? reconnected? rpc services

    Methods

    close open

    Properties

    closed: Event<undefined | Error>

    The connection to the services provider was terminated. This should fire if the services disconnect unexpectedly or during a client reset.

    onReconnect?: (callback: () => Promise<void>) => void

    Register a callback to be invoked when services reconnect. The callback should re-establish any RPC streams. Reconnection waits for all callbacks to complete before emitting reconnected.

    reconnected?: Event<void>

    The underlying service connection was re-established. Fires after all reconnection callbacks have completed.

    rpc: ClientServicesRpc

    Effect-native client for all client services, inferred from the effect-rpc definitions. Preferred surface for new consumers; must be re-read after reconnect rather than cached. Effects it produces require only the default runtime and can be run with any Runtime<never>.

    services: Partial<ClientServices>

    Prefer rpc. Promise/Stream shaped services derived from rpc.

    Methods

    • Returns Promise<unknown>

    • Returns Promise<unknown>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods