tsbase
    Preparing search index...

    Interface IAsyncObservable<T>

    Coordinates async subscriber actions with publish events

    interface IAsyncObservable<T> {
        Cancel(subscriptionId: string): void;
        Discontinue(): void;
        Order(
            func: (content?: T) => Promise<void>,
            useCurrentIssue?: boolean,
        ): Promise<void>;
        Publish(content?: T): void;
        Reinstate(): void;
        Subscribe(
            func: (content?: T) => Promise<void>,
            useCurrentIssue?: boolean,
        ): Promise<string>;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    Cancel Discontinue Order Publish Reinstate Subscribe

    Methods

    • A single issue subscription. Once the function for an order fires, it is automatically canceled

      Parameters

      • func: (content?: T) => Promise<void>
      • OptionaluseCurrentIssue: boolean

        Determines if the order can be filled by the current issue

      Returns Promise<void>

    • Specify an async function to fire on future publish events | id returned allows caller to cancel subscription

      Parameters

      • func: (content?: T) => Promise<void>
      • OptionaluseCurrentIssue: boolean

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Methods