Type Alias StreamConfig

StreamConfig: StreamUpdateConfig & {
    first_seq: number;
    max_consumers: number;
    mirror?: StreamSource;
    name: string;
    retention: RetentionPolicy;
    sealed: boolean;
    storage: StorageType;
}

Type declaration

  • first_seq: number

    Sets the first sequence number used by the stream. This property can only be specified when creating the stream, and likely is not valid on mirrors etc., as it may disrupt the synchronization logic.

  • max_consumers: number

    How many Consumers can be defined for a given Stream. -1 for unlimited.

  • Optionalmirror?: StreamSource

    Maintains a 1:1 mirror of another stream with name matching this property. When a mirror is configured subjects and sources must be empty.

  • name: string

    A unique name for the Stream

  • retention: RetentionPolicy

    How messages are retained in the Stream, once this is exceeded old messages are removed.

  • sealed: boolean

    Sealed streams do not allow messages to be deleted via limits or API, sealed streams can not be unsealed via configuration update. Can only be set on already created streams via the Update API

  • storage: StorageType

    The storage backend to use for the Stream.

Settings

Member Visibility