Interface: TransitionOptions

Defined in: migrate.ts:418

Options for MigrationStateManager.transition.

Properties

actor?

optional actor?: string

Defined in: migrate.ts:428

Who made the change. Default system.

---

algorithm

algorithm: string

Defined in: migrate.ts:426

Key algorithm after the transition.

---

allowBackward?

optional allowBackward?: boolean

Defined in: migrate.ts:434

Must be true to permit a backward transition.

---

fromState

fromState: MigrationState

Defined in: migrate.ts:422

Expected current state: an optimistic-concurrency check against stale callers.

---

keyId

keyId: string

Defined in: migrate.ts:420

The key to move; a non-empty string.

---

metadata?

optional metadata?: Record<string, unknown>

Defined in: migrate.ts:432

Free-form JSON-serializable details stored in the record. Default empty.

---

reason?

optional reason?: string

Defined in: migrate.ts:430

Required (non-empty) for backward transitions.

---

toState

toState: MigrationState

Defined in: migrate.ts:424

The state to move to.