Skip to content
v9.1.1
Français

ObservationHubOptions

import type { ObservationHubOptions } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • sinksOptional
    readonly ObservationSink[] | undefined
    Receivers attached to this root and inherited by every child.
  • scopeOptional
    ObservationScope | undefined
    Initial correlation fields; child scopes override only explicitly supplied fields.
  • capacityOptional
    number | undefined
    Maximum events waiting per asynchronous sink, default 1024; on overflow the newest are dropped and counted. A value that is not a positive integer throws.
  • deliveryTimeoutMsOptional
    number | undefined
    Maximum wait for one asynchronous delivery or sink flush, default 5000; a sink that exceeds it is disabled for the hub’s lifetime. A value that is not a positive integer throws.
  • verboseOptional
    boolean | undefined
    Explicitly allow full model request/response events. Does not enable verbose journal retention by itself.

Signature

Section titled “Signature”
export interface ObservationHubOptions {
  readonly sinks?: readonly ObservationSink[];
  readonly scope?: ObservationScope;
  readonly capacity?: number;
  readonly deliveryTimeoutMs?: number;
  readonly verbose?: boolean;
}
Section titled “Related contracts”