Interface: TransitionOptions

Defined in: migrate.ts:337

Options for MigrationStateManager.transition.

Properties

actor?

optional actor?: string

Defined in: migrate.ts:344

---

algorithm

algorithm: string

Defined in: migrate.ts:343

Key algorithm after the transition.

---

allowBackward?

optional allowBackward?: boolean

Defined in: migrate.ts:349

Must be true to permit a backward transition.

---

fromState

fromState: MigrationState

Defined in: migrate.ts:340

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

---

keyId

keyId: string

Defined in: migrate.ts:338

---

metadata?

optional metadata?: Record<string, unknown>

Defined in: migrate.ts:347

---

reason?

optional reason?: string

Defined in: migrate.ts:346

Required (non-empty) for backward transitions.

---

toState

toState: MigrationState

Defined in: migrate.ts:341