@sodazone/ocelloids-client - v2.5.2
    Preparing search index...

    Interface SubscribableApi<T, P>

    Subscribable Agent API.

    interface SubscribableApi<T = AnySubscriptionInputs, P = AnyJson> {
        allSubscriptions(options?: Options): Promise<Subscription<T>[]>;
        createSubscription(
            subscription: Omit<Subscription<T>, "agent">,
            options?: Options,
        ): Promise<unknown>;
        deleteSubscription(id: string, options?: Options): Promise<unknown>;
        getSubscription(id: string, options?: Options): Promise<Subscription<T>>;
        subscribe(
            subscription: string | T,
            handlers: WebSocketHandlers<P>,
            onDemandHandlers?: OnDemandSubscriptionHandlers<T>,
        ): Promise<WebSocket>;
    }

    Type Parameters

    Implemented by

    Index

    Methods

    • Parameters

      • subscription: Omit<Subscription<T>, "agent">
      • Optionaloptions: Options

      Returns Promise<unknown>

    • Parameters

      • id: string
      • Optionaloptions: Options

      Returns Promise<unknown>