Skip to content

Latest commit

 

History

History
590 lines (326 loc) · 10.7 KB

up.md

File metadata and controls

590 lines (326 loc) · 10.7 KB
Raw

yammy › Up

Class: Up

Hierarchy

  • Command

    ↳ Up

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

+ new Up(argv: string[], config: IConfig): Up

Inherited from Create.constructor

Defined in node_modules/@oclif/command/lib/command.d.ts:46

Parameters:

Name Type
argv string[]
config IConfig

Returns: Up

Properties

argv

• argv: string[]

Inherited from Create.argv

Defined in node_modules/@oclif/command/lib/command.d.ts:9

config

• config: IConfig

Inherited from Create.config

Defined in node_modules/@oclif/command/lib/command.d.ts:10

Protected debug

• debug: function

Inherited from Create.debug

Defined in node_modules/@oclif/command/lib/command.d.ts:46

Type declaration:

▸ (...args: any[]): void

Parameters:

Name Type
...args any[]

id

• id: string | undefined

Inherited from Create.id

Defined in node_modules/@oclif/command/lib/command.d.ts:45

Static _base

▪ _base: string

Inherited from Create._base

Defined in node_modules/@oclif/command/lib/command.d.ts:11

Static aliases

▪ aliases: string[]

Inherited from Create.aliases

Defined in node_modules/@oclif/command/lib/command.d.ts:26

An array of aliases for this command

Static args

▪ args: object[] = [{ name: 'count' }]

Overrides Status.args

Defined in src/commands/up.ts:23

Static description

▪ description: string = "applies migrations"

Overrides void

Defined in src/commands/up.ts:7

Static examples

▪ examples: string[] | undefined

Inherited from Create.examples

Defined in node_modules/@oclif/command/lib/command.d.ts:36

An array of example strings to show at the end of the command's help

Static help

▪ help: string | undefined

Inherited from Create.help

Defined in node_modules/@oclif/command/lib/command.d.ts:24

Static hidden

▪ hidden: boolean

Inherited from Create.hidden

Defined in node_modules/@oclif/command/lib/command.d.ts:21

hide the command from help?

Static id

▪ id: string

Inherited from Create.id

Defined in node_modules/@oclif/command/lib/command.d.ts:13

A command ID, used mostly in error or verbose reporting

Static parse

▪ parse: boolean

Inherited from Create.parse

Defined in node_modules/@oclif/command/lib/command.d.ts:29

Static parserOptions

▪ parserOptions: object

Inherited from Create.parserOptions

Defined in node_modules/@oclif/command/lib/command.d.ts:37

Type declaration:

Static plugin

▪ plugin: IPlugin | undefined

Inherited from Create.plugin

Defined in node_modules/@oclif/command/lib/command.d.ts:34

Static run

▪ run: Class["run"]

Inherited from Create.run

Defined in node_modules/@oclif/command/lib/command.d.ts:44

instantiate and run the command

param Class

param argv

param options

Static strict

▪ strict: boolean

Inherited from Create.strict

Defined in node_modules/@oclif/command/lib/command.d.ts:28

When set to false, allows a variable amount of arguments

Static title

▪ title: string | undefined

Inherited from Create.title

Defined in node_modules/@oclif/command/lib/command.d.ts:14

Static usage

▪ usage: string | string[] | undefined

Inherited from Create.usage

Defined in node_modules/@oclif/command/lib/command.d.ts:23

An override string (or strings) for the default usage documentation

Accessors

ctor

• get ctor(): typeof Command

Inherited from Create.ctor

Defined in node_modules/@oclif/command/lib/command.d.ts:48

Returns: typeof Command

Methods

Protected _help

▸ _help(): never

Inherited from Create._help

Defined in node_modules/@oclif/command/lib/command.d.ts:71

Returns: never

Protected _helpOverride

▸ _helpOverride(): boolean

Inherited from Create._helpOverride

Defined in node_modules/@oclif/command/lib/command.d.ts:72

Returns: boolean

_run

▸ _run<T>(): Promise‹T | undefined›

Inherited from Create._run

Defined in node_modules/@oclif/command/lib/command.d.ts:49

Type parameters:

▪ T

Returns: Promise‹T | undefined›

Protected _version

▸ _version(): never

Inherited from Create._version

Defined in node_modules/@oclif/command/lib/command.d.ts:73

Returns: never

Protected catch

▸ catch(err: any): Promise‹any›

Inherited from Create.catch

Defined in node_modules/@oclif/command/lib/command.d.ts:69

Parameters:

Name Type
err any

Returns: Promise‹any›

error

▸ error(input: string | Error, options: object): void

Inherited from Create.error

Defined in node_modules/@oclif/command/lib/command.d.ts:52

Parameters:

▪ input: string | Error

▪ options: object

Name Type
code? undefined | string
exit false

Returns: void

▸ error(input: string | Error, options?: undefined | object): never

Inherited from Create.error

Defined in node_modules/@oclif/command/lib/command.d.ts:56

Parameters:

Name Type
input string | Error
options? undefined | object

Returns: never

exit

▸ exit(code?: undefined | number): never

Inherited from Create.exit

Defined in node_modules/@oclif/command/lib/command.d.ts:50

Parameters:

Name Type
code? undefined | number

Returns: never

Protected finally

▸ finally(_: Error | undefined): Promise‹any›

Inherited from Create.finally

Defined in node_modules/@oclif/command/lib/command.d.ts:70

Parameters:

Name Type
_ Error | undefined

Returns: Promise‹any›

Protected init

▸ init(): Promise‹any›

Inherited from Create.init

Defined in node_modules/@oclif/command/lib/command.d.ts:65

Returns: Promise‹any›

log

▸ log(message?: undefined | string, ...args: any[]): void

Inherited from Create.log

Defined in node_modules/@oclif/command/lib/command.d.ts:60

Parameters:

Name Type
message? undefined | string
...args any[]

Returns: void

Protected parse

▸ parse<F, A>(options?: Parser.Input‹F›, argv?: string[]): Parser.Output‹F, A›

Inherited from Create.parse

Defined in node_modules/@oclif/command/lib/command.d.ts:66

Type parameters:

▪ F

▪ A: object

Parameters:

Name Type
options? Parser.Input‹F›
argv? string[]

Returns: Parser.Output‹F, A›

run

▸ run(): Promise‹void›

Overrides Create.run

Defined in src/commands/up.ts:25

Returns: Promise‹void›

warn

▸ warn(input: string | Error): void

Inherited from Create.warn

Defined in node_modules/@oclif/command/lib/command.d.ts:51

Parameters:

Name Type
input string | Error

Returns: void

Object literals

Static flags

▪ flags: object

Overrides void

Defined in src/commands/up.ts:9

changelog

• changelog: object & object & object = flags.string({ description: 'migrations changelog collection', env: 'MIGRATIONS_CHANGELOG', })

Defined in src/commands/up.ts:13

config

• config: object & object & object = flags.string({ description: 'migrations custom config file', env: 'MIGRATIONS_CONFIG', })

Defined in src/commands/up.ts:17

dir

• dir: object & object & object = flags.string({ description: 'migrations directory', char: 'd', env: 'MIGRATIONS_DIR' })

Defined in src/commands/up.ts:12

help

• help: object & object = flags.help({ char: 'h' })

Defined in src/commands/up.ts:10

uri

• uri: object & object & object = flags.string({ description: 'mongo connection string', char: 'u', env: 'MONGO_URL' })

Defined in src/commands/up.ts:11