API REFERENCE

WaterfallStreamSource

The WaterfallStreamSource type declaration and related types. Optional fields are marked with ?.

Type declaration

typescript
export interface WaterfallStreamSource {
  readonly length: number;
  readonly capacity: number;
  readonly dropped: number;
  push(datum: WaterfallDatumInput): void;
  pushBatch(data: ReadonlyArray<WaterfallDatumInput>): void;
  shift(count: number): void;
  replace(data: ReadonlyArray<WaterfallDatumInput>): void;
  snapshot(): WaterfallDatumInput[];
  subscribe(listener: (event: WaterfallStreamEvent) => void): () => void;
}