Skip to main content

Type Alias: MigrationOption

MigrationOption = object

Defined in: migrations/types.ts:14

A flag a migration accepts beyond --dry-run. Declared so the runner can refuse a run that lacks a required one before any migration has started, and print it in --help.

Properties

description

description: string

Defined in: migrations/types.ts:17


flag

flag: string

Defined in: migrations/types.ts:16

The flag name, without dashes: owner-email is read as --owner-email.


required?

optional required?: boolean

Defined in: migrations/types.ts:19

Whether a run that includes this migration must supply the flag.