@photostructure/fs-metadata
    Preparing search index...

    Interface PollingSubscription<TSnapshot, TChange>

    Public lifecycle and events shared by polling subscriptions.

    interface PollingSubscription<TSnapshot, TChange> {
        closed: boolean;
        lastError: Error | undefined;
        ready: Promise<TSnapshot>;
        close(): void;
        hasRef(): boolean;
        off(event: "change", listener: (change: TChange) => void): this;
        off(event: "error", listener: (error: Error) => void): this;
        on(event: "change", listener: (change: TChange) => void): this;
        on(event: "error", listener: (error: Error) => void): this;
        once(event: "change", listener: (change: TChange) => void): this;
        once(event: "error", listener: (error: Error) => void): this;
        ref(): this;
        unref(): this;
    }

    Type Parameters

    • TSnapshot
    • TChange
    Index
    closed lastError ready
    close hasRef off on once ref unref
    closed: boolean
    lastError: Error | undefined
    ready: Promise<TSnapshot>

    • Parameters

      • event: "change"
      • listener: (change: TChange) => void

      Returns this

    • Parameters

      • event: "error"
      • listener: (error: Error) => void

      Returns this

    • Parameters

      • event: "change"
      • listener: (change: TChange) => void

      Returns this

    • Parameters

      • event: "error"
      • listener: (error: Error) => void

      Returns this

    • Parameters

      • event: "change"
      • listener: (change: TChange) => void

      Returns this

    • Parameters

      • event: "error"
      • listener: (error: Error) => void

      Returns this

    Settings
    Member Visibility

    On This Page
    Properties
    Methods