-
Command
↳ Up
- argv
- config
- debug
- id
- _base
- aliases
- args
- description
- examples
- help
- hidden
- id
- parse
- parserOptions
- plugin
- run
- strict
- title
- usage
+ 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
• argv: string[]
Defined in node_modules/@oclif/command/lib/command.d.ts:9
• config: IConfig
Defined in node_modules/@oclif/command/lib/command.d.ts:10
• debug: function
Defined in node_modules/@oclif/command/lib/command.d.ts:46
▸ (...args
: any[]): void
Parameters:
Name | Type |
---|---|
...args |
any[] |
• id: string | undefined
Defined in node_modules/@oclif/command/lib/command.d.ts:45
▪ _base: string
Defined in node_modules/@oclif/command/lib/command.d.ts:11
▪ aliases: string[]
Defined in node_modules/@oclif/command/lib/command.d.ts:26
An array of aliases for this command
▪ args: object[] = [{ name: 'count' }]
Defined in src/commands/up.ts:23
▪ description: string = "applies migrations"
Overrides void
Defined in src/commands/up.ts:7
▪ 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
▪ help: string | undefined
Defined in node_modules/@oclif/command/lib/command.d.ts:24
Static
hidden
▪ hidden: boolean
Defined in node_modules/@oclif/command/lib/command.d.ts:21
hide the command from help?
▪ id: string
Defined in node_modules/@oclif/command/lib/command.d.ts:13
A command ID, used mostly in error or verbose reporting
▪ parse: boolean
Defined in node_modules/@oclif/command/lib/command.d.ts:29
▪ parserOptions: object
Inherited from Create.parserOptions
Defined in node_modules/@oclif/command/lib/command.d.ts:37
▪ plugin: IPlugin | undefined
Defined in node_modules/@oclif/command/lib/command.d.ts:34
▪ run: Class["run"]
Defined in node_modules/@oclif/command/lib/command.d.ts:44
instantiate and run the command
param
Class
param
argv
param
options
▪ strict: boolean
Defined in node_modules/@oclif/command/lib/command.d.ts:28
When set to false, allows a variable amount of arguments
▪ title: string | undefined
Defined in node_modules/@oclif/command/lib/command.d.ts:14
▪ usage: string | string[] | undefined
Defined in node_modules/@oclif/command/lib/command.d.ts:23
An override string (or strings) for the default usage documentation
• get ctor(): typeof Command
Defined in node_modules/@oclif/command/lib/command.d.ts:48
Returns: typeof Command
▸ _help(): never
Defined in node_modules/@oclif/command/lib/command.d.ts:71
Returns: never
▸ _helpOverride(): boolean
Inherited from Create._helpOverride
Defined in node_modules/@oclif/command/lib/command.d.ts:72
Returns: boolean
▸ _run<T>(): Promise‹T | undefined›
Defined in node_modules/@oclif/command/lib/command.d.ts:49
Type parameters:
▪ T
Returns: Promise‹T | undefined›
▸ _version(): never
Inherited from Create._version
Defined in node_modules/@oclif/command/lib/command.d.ts:73
Returns: never
▸ catch(err
: any): Promise‹any›
Defined in node_modules/@oclif/command/lib/command.d.ts:69
Parameters:
Name | Type |
---|---|
err |
any |
Returns: Promise‹any›
▸ error(input
: string | Error, options
: object): void
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
Defined in node_modules/@oclif/command/lib/command.d.ts:56
Parameters:
Name | Type |
---|---|
input |
string | Error |
options? |
undefined | object |
Returns: never
▸ exit(code?
: undefined | number): never
Defined in node_modules/@oclif/command/lib/command.d.ts:50
Parameters:
Name | Type |
---|---|
code? |
undefined | number |
Returns: never
▸ finally(_
: Error | undefined): Promise‹any›
Defined in node_modules/@oclif/command/lib/command.d.ts:70
Parameters:
Name | Type |
---|---|
_ |
Error | undefined |
Returns: Promise‹any›
▸ init(): Promise‹any›
Defined in node_modules/@oclif/command/lib/command.d.ts:65
Returns: Promise‹any›
▸ log(message?
: undefined | string, ...args
: any[]): void
Defined in node_modules/@oclif/command/lib/command.d.ts:60
Parameters:
Name | Type |
---|---|
message? |
undefined | string |
...args |
any[] |
Returns: void
▸ parse<F, A>(options?
: Parser.Input‹F›, argv?
: string[]): Parser.Output‹F, A›
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(): Promise‹void›
Defined in src/commands/up.ts:25
Returns: Promise‹void›
▸ warn(input
: string | Error): void
Defined in node_modules/@oclif/command/lib/command.d.ts:51
Parameters:
Name | Type |
---|---|
input |
string | Error |
Returns: void
Overrides void
Defined in src/commands/up.ts:9
• changelog: object & object & object = flags.string({ description: 'migrations changelog collection', env: 'MIGRATIONS_CHANGELOG', })
Defined in src/commands/up.ts:13
• config: object & object & object = flags.string({ description: 'migrations custom config file', env: 'MIGRATIONS_CONFIG', })
Defined in src/commands/up.ts:17
• dir: object & object & object = flags.string({ description: 'migrations directory', char: 'd', env: 'MIGRATIONS_DIR' })
Defined in src/commands/up.ts:12
• help: object & object = flags.help({ char: 'h' })
Defined in src/commands/up.ts:10
• uri: object & object & object = flags.string({ description: 'mongo connection string', char: 'u', env: 'MONGO_URL' })
Defined in src/commands/up.ts:11