Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseRelaySubProtocolResult<TPayload>

    interface UseRelaySubProtocolResult<TPayload> {
        isConnected: boolean;
        publish: (payload: TPayload, opts?: PublishOptions) => void;
    }

    Type Parameters

    • TPayload
    Index

    Properties

    isConnected publish

    Properties

    isConnected: boolean

    Convenience: relay's connection state.

    publish: (payload: TPayload, opts?: PublishOptions) => void

    Send a payload on the topic. No-op until the relay is connected. By default acked + retried up to 3 times; pass { requireAck: false } for fire-and-forget.

    Settings

    Member Visibility

    On This Page

    Properties