Interface: MigrationRecord

Defined in: migrate.ts:345

An immutable record of one migration transition.

Properties

actor

readonly actor: string

Defined in: migrate.ts:359

Who made the change (default system).

---

algorithm

readonly algorithm: string

Defined in: migrate.ts:355

The key algorithm after the transition.

---

fromState

readonly fromState: MigrationState

Defined in: migrate.ts:351

The state before the transition.

---

isForward

readonly isForward: boolean

Defined in: migrate.ts:365

True when toState is a forward step from fromState.

---

keyId

readonly keyId: string

Defined in: migrate.ts:349

The key this transition belongs to.

---

metadata

readonly metadata: Readonly<Record<string, unknown>>

Defined in: migrate.ts:363

Free-form JSON-serializable details supplied by the caller.

---

reason

readonly reason: string

Defined in: migrate.ts:361

Why the change was made; non-empty for a backward transition.

---

recordId

readonly recordId: string

Defined in: migrate.ts:347

A random UUID (version 4 layout) identifying this record.

---

timestamp

readonly timestamp: number

Defined in: migrate.ts:357

Unix seconds.

---

toState

readonly toState: MigrationState

Defined in: migrate.ts:353

The state after the transition.