Skip to main content

CloseTarget

@rotorsoft/act-root

@rotorsoft/act-root / act/src / CloseTarget

Type Alias: CloseTarget

CloseTarget = object

Defined in: libs/act/src/types/action.ts:452

Per-stream options for the archive-and-truncate (or restart-with- snapshot) operation.

See​

IAct.close for the close-the-books API

Properties​

archive?​

readonly optional archive?: () => Promise<void>

Defined in: libs/act/src/types/action.ts:461

Called before truncation while the stream is guarded (no concurrent writes). Use app.query() or app.query_array() inside for pagination. If it throws, the stream remains guarded but is not truncated.

Returns​

Promise<void>

restart?​

readonly optional restart?: boolean

Defined in: libs/act/src/types/action.ts:457

When true, restart with a __snapshot__ of the final state. When false/omitted, permanently close with a __tombstone__.

stream​

readonly stream: string

Defined in: libs/act/src/types/action.ts:454

Stream name to close