syidaxchart
Home Pricing Settings

API REFERENCE

IcicleStreamSource

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

Markdown source Components

Type declaration

typescript
export interface IcicleStreamSource {
  readonly length: number;
  readonly capacity: number;
  readonly dropped: number;
  push(node: IcicleNodeInput): void;
  pushBatch(nodes: ReadonlyArray<IcicleNodeInput>): void;
  shift(count: number): void;
  replace(nodes: ReadonlyArray<IcicleNodeInput>): void;
  snapshot(): IcicleNodeInput[];
  subscribe(listener: (event: IcicleStreamEvent) => void): () => void;
}