Type Alias StreamConfig

Type declaration

• allow_atomic: boolean

  Enables the ability to send atomic batches to the stream

• allow_msg_counter: boolean

  Enables a NATS stream implementation of CRDT operations

• allow_msg_schedules: boolean

  Enables the scheduling of messages in a stream.

• allow_msg_ttl: boolean

  Enables allows header initiated per-message TTLs. If disabled, then the NATS-TTL header will be ignored.

• 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.

• name: string

  A unique name for the Stream

• persist_mode: PersistMode

  Sets the persistence model for the stream - the default is PersistMode.Default. This is a 2.12 feature.

• 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.