Skip to main content
Version: Current

Append

@rotorsoft/act-root


@rotorsoft/act-root / act/src / Append

Type Alias: Append<E>

Append<E> = object

Defined in: libs/act/src/types/ports.ts:500

One append of a Store.commit: the events to append to one stream and, optionally, the version the stream must be at.

Type Parameters​

E​

E extends Schemas

Event schemas

Properties​

expectedVersion?​

readonly optional expectedVersion?: number

Defined in: libs/act/src/types/ports.ts:506

The version the stream must be at; -1 expects an empty stream, undefined skips the check.


msgs​

readonly msgs: readonly Message<E, keyof E>[]

Defined in: libs/act/src/types/ports.ts:504

The events to append, at least one.


stream​

readonly stream: string

Defined in: libs/act/src/types/ports.ts:502

The stream the events go to; named at most once per commit.