Interface SnapshotSource<S>

A live source that can snapshot itself to the batch layer in one call. LiveSeries and LiveView match; the incremental operators do not.

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

Type Parameters

S extends SeriesSchema

Hierarchy (View Summary)

GraphSource<S>
- SnapshotSource

Index

Properties

length name schema

Methods

at on toTimeSeries

Properties

`Readonly`length

length: number

`Readonly`name

name: string

`Readonly`schema

schema: S

Methods

at

at(index: number): EventForSchema<S> | undefined
Parameters
- index: number
Returns EventForSchema<S> | undefined
Inherited from GraphSource.at
- Defined in packages/process/src/source.ts:126

on

on(type: "event", fn: (event: any) => void): () => void
Parameters
- type: "event"
- fn: (event: any) => void
Returns () => void
Inherited from GraphSource.on
- Defined in packages/process/src/source.ts:127

toTimeSeries

toTimeSeries(name?: string): TimeSeries<S>
Parameters
- Optionalname: string
Returns TimeSeries<S>
- Defined in packages/process/src/source.ts:135