Interface Migration

A single release-to-release cache migration. One per steps/vX.Y.Z-to-vA.B.C.ts file. from/to must match the filename's versions (the registry enforces this). description is shown to the user in the update prompt. up applies the change to the already-open cache; migrations are forward-only (no down).

interface Migration {
    from: string;
    to: string;
    description: string;
    up(ctx: MigrationContext): Promise<void>;
}

Index

Methods

up

Properties

from to description

Methods

up

up(ctx: MigrationContext): Promise<void>
Apply the migration against the open cache.
Parameters
- ctx: MigrationContext
  The migration context (untyped db handle + logger).
Returns Promise<void>
Resolves once the step's changes are committed.
- Defined in src/migrations/types.ts:33

Properties

from

from: string

Semver the cache is being migrated from, e.g. "1.0.0".

to

to: string

Semver the cache is being migrated to, e.g. "1.0.1".

description

description: string

Short, user-facing summary of what this step changes.

Interface Migration

Index

Methods

Properties

Methods

up

Parameters

Returns Promise<void>

Properties

from

to

description

Settings

On This Page