@pond-ts/process API Reference
    Preparing search index...

    Interface GraphSource<S>

    What fromLive needs from a pond live source: enough to materialize a snapshot, and a way to hear that one is due.

    Looser than core's LiveSource<S> in exactly one place — the 'event' listener's parameter is any, because this package never reads the event, it only needs the notification. It was introduced when LiveAggregation.on('event', …) handed back a widened event and so did not satisfy LiveSource<Out>; core has since narrowed that listener ([PND-LIVESRC]), so the aggregation operators now satisfy LiveSource<Out> too.

    LiveSeries, LiveView, LiveAggregation, LiveRollingAggregation, and LiveFusedRolling all match this.

    interface GraphSource<S extends SeriesSchema> {
        length: number;
        name: string;
        schema: S;
        at(index: number): EventForSchema<S> | undefined;
        on(type: "event", fn: (event: any) => void): () => void;
    }

    Type Parameters

    • S extends SeriesSchema

    Hierarchy (View Summary)

    Index

    Properties

    length name schema

    Methods

    at on

    Properties

    length: number
    name: string
    schema: S

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods