pond-ts API Reference (core)
    Preparing search index...

    Type Alias LivePartitionedOptions<K>

    Per-partition retention and grace settings for a partitioned live view. Each partition is its own bounded buffer with these limits; the source LiveSource's own retention does not propagate.

    type LivePartitionedOptions<K extends string> = {
        graceWindow?: DurationInput;
        groups?: ReadonlyArray<K>;
        ordering?: NonNullable<LiveSeriesOptions<SeriesSchema>["ordering"]>;
        retention?: NonNullable<LiveSeriesOptions<SeriesSchema>["retention"]>;
    }

    Type Parameters

    • K extends string
    Index

    Properties

    graceWindow? groups? ordering? retention?

    Properties

    graceWindow?: DurationInput

    Grace window applied per partition for late events. Defaults to inheriting the source's graceWindow when the effective ordering is 'reorder'; pass explicitly to override.

    groups?: ReadonlyArray<K>

    Declared partition values (mirrors batch partitionBy({ groups })).

    ordering?: NonNullable<LiveSeriesOptions<SeriesSchema>["ordering"]>

    Ordering mode for each partition. Defaults to inheriting the source's ordering; pass explicitly to override (e.g. force strict partitions on a reorder source).

    Pre-0.17.1 this defaulted to 'strict' regardless of source — a footgun that crashed the partition router on late events the source already accepted under reorder. Inheritance closes that gap; see the v0.17.1 CHANGELOG entry.

    retention?: NonNullable<LiveSeriesOptions<SeriesSchema>["retention"]>

    Retention applied to each partition's sub-buffer independently. Defaults to inheriting the source LiveSeries's retention; pass explicitly to override (e.g. shorter per-partition cap).

    Settings

    Member Visibility

    On This Page

    Properties