Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for an event sourced entity.

Hierarchy

Index

Properties

snapshotEvery?: number

A snapshot will be persisted every time this many events are emitted.

remarks

It is strongly recommended to not disable snapshotting unless it is known that event sourced entities will never have more than 100 events (in which case the default will anyway not trigger any snapshots).

defaultvalue

100

serializeAllowPrimitives?: boolean

Whether serialization of primitives should be supported when serializing events and snapshots.

defaultvalue

false

serializeFallbackToJson?: boolean

Whether serialization should fallback to using JSON if an event or snapshot can't be serialized as a protobuf.

defaultvalue

false

entityType?: string

The entity type name for all entities of this type.

includeDirs?: string[]

The directories to include when looking up imported protobuf files.

defaultvalue

Defaults to the current directory ['.']

forwardHeaders?: string[]

Request headers to be forwarded as metadata to the component.

defaultvalue

Empty []

entityPassivationStrategy?: EntityPassivationStrategy

Entity passivation strategy to use.

Generated using TypeDoc