Class InvokeCommand

Hierarchy

BaseIPCClientCommand
- InvokeCommand

Index

Constructors

constructor

new InvokeCommand(argv: string[], config: Config): InvokeCommand
Parameters
- argv: string[]
- config: Config
Returns InvokeCommand
Inherited from BaseIPCClientCommand.constructor
- Defined in node_modules/@oclif/core/lib/command.d.ts:83

Properties

`Protected` _client

_client: undefined | APIClient

`Protected` _dataPath

_dataPath: string

`Protected` _metadata

_metadata: ModuleMetadataJSON[]

`Protected` _schema

_schema: RegisteredSchema

argv

argv: string[]

`Protected` baseIPCClientFlags

baseIPCClientFlags: BaseIPCClientFlags

config

config: Config

`Protected` debug

debug: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

id

id: undefined | string

`Static` _base

_base: string

`Static` _enableJsonFlag

_enableJsonFlag: boolean

`Protected` `Static` _flags

_flags: FlagInput<{
[flag: string]: any;
}>

A hash of flags for the command

`Protected` `Static` _globalFlags

_globalFlags: FlagInput<{
[flag: string]: any;
}>

`Static` aliases

aliases: string[]

An array of aliases for this command.

`Static` args

args: {
    description: string;
    name: string;
    required: boolean;
}[] = ...

An order-dependent array of arguments for the command

`Static` `Optional` deprecateAliases

deprecateAliases?: boolean

Emit deprecation warning when a command alias is used

`Static` `Optional` deprecationOptions

deprecationOptions?: Deprecation

`Static` description

description: string = 'Invokes the provided endpoint.'

A full description of how to use the command.

If no summary, the first line of the description will be used as the summary.

`Static` examples

examples: string[] = ...

An array of examples to show at the end of the command's help.

IF only a string is provided, it will try to look for a line that starts with the cmd.bin as the example command and the rest as the description. If found, the command will be formatted appropriately.

EXAMPLES:
  A description of a particular use case.

    $ <%= config.bin => command flags

`Static` flags

flags: {
    data-path: OptionFlag<undefined | string>;
    file: OptionFlag<undefined | string>;
    pretty: BooleanFlag<boolean>;
} = ...

Type declaration

data-path: OptionFlag<undefined | string>
file: OptionFlag<undefined | string>
pretty: BooleanFlag<boolean>

`Static` help

help: undefined | string

`Static` hidden

hidden: boolean

Hide the command from help

`Static` id

id: string

A command ID, used mostly in error or verbose reporting.

`Static` parse

parse: boolean

`Static` parserOptions

parserOptions: {}

Type declaration

`Static` plugin

plugin: undefined | Plugin

`Static` run

run: ((argv?: string[], config?: LoadOptions) => PromiseLike<any>)

Type declaration

- (argv?: string[], config?: LoadOptions): PromiseLike<any>
- instantiate and run the command
  Parameters
  - Optional argv: string[]
    
    argv
  - Optional config: LoadOptions
  Returns PromiseLike<any>

`Static` `Optional` state

state?: string

Mark the command as a given state (e.g. beta or deprecated) in help

`Static` strict

strict: boolean

When set to false, allows a variable amount of arguments

`Static` `Optional` summary

summary?: string

The tweet-sized description for your class, used in a parent-commands sub-command listing and as the header for the command help.

`Static` usage

usage: undefined | string | string[]

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

Accessors

ctor

get ctor(): typeof default
Returns typeof default
Inherited from BaseIPCClientCommand.ctor
- Defined in node_modules/@oclif/core/lib/command.d.ts:84

`Static` enableJsonFlag

get enableJsonFlag(): boolean
Returns boolean
Inherited from BaseIPCClientCommand.enableJsonFlag
- Defined in node_modules/@oclif/core/lib/command.d.ts:65
set enableJsonFlag(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BaseIPCClientCommand.enableJsonFlag
- Defined in node_modules/@oclif/core/lib/command.d.ts:66

`Static` globalFlags

get globalFlags(): FlagInput<{
[flag: string]: any;
}>
Returns FlagInput<{
[flag: string]: any;
}>
Inherited from BaseIPCClientCommand.globalFlags
- Defined in node_modules/@oclif/core/lib/command.d.ts:75
set globalFlags(flags: FlagInput<{
[flag: string]: any;
}>): void
Parameters
- flags: FlagInput<{
  [flag: string]: any;
  }>
Returns void
Inherited from BaseIPCClientCommand.globalFlags
- Defined in node_modules/@oclif/core/lib/command.d.ts:76

Methods

_run

_run<T>(): Promise<undefined | T>
Type Parameters
- T
Returns Promise<undefined | T>
Inherited from BaseIPCClientCommand._run
- Defined in node_modules/@oclif/core/lib/command.d.ts:85

`Protected` catch

catch(err: CommandError): Promise<any>
Parameters
- err: CommandError
Returns Promise<any>
Inherited from BaseIPCClientCommand.catch
- Defined in node_modules/@oclif/core/lib/command.d.ts:109

error

error(input: string | Error, options: {
code?: string;
exit: false;
} & PrettyPrintableError): void
Parameters
- input: string | Error
- options: {
  code?: string;
  exit: false;
  } & PrettyPrintableError
Returns void
Inherited from BaseIPCClientCommand.error
- Defined in node_modules/@oclif/core/lib/command.d.ts:88
error(input: string | Error, options?: {
code?: string;
exit?: number;
} & PrettyPrintableError): never
Parameters
- input: string | Error
- Optional options: {
  code?: string;
  exit?: number;
  } & PrettyPrintableError
Returns never
Inherited from BaseIPCClientCommand.error
- Defined in node_modules/@oclif/core/lib/command.d.ts:92

exit

exit(code?: number): void
Parameters
- Optional code: number
Returns void
Inherited from BaseIPCClientCommand.exit
- Defined in node_modules/@oclif/core/lib/command.d.ts:86

finally

finally(): Promise<void>
Returns Promise<void>
Inherited from BaseIPCClientCommand.finally
- Defined in commander/src/bootstrapping/commands/base_ipc_client.ts:41

init

init(): Promise<void>
Returns Promise<void>
Inherited from BaseIPCClientCommand.init
- Defined in commander/src/bootstrapping/commands/base_ipc_client.ts:47

jsonEnabled

jsonEnabled(): boolean
Returns boolean
Inherited from BaseIPCClientCommand.jsonEnabled
- Defined in node_modules/@oclif/core/lib/command.d.ts:98

log

log(message?: string, ...args: any[]): void
Parameters
- Optional message: string
- Rest ...args: any[]
Returns void
Inherited from BaseIPCClientCommand.log
- Defined in node_modules/@oclif/core/lib/command.d.ts:96

logToStderr

logToStderr(message?: string, ...args: any[]): void
Parameters
- Optional message: string
- Rest ...args: any[]
Returns void
Inherited from BaseIPCClientCommand.logToStderr
- Defined in node_modules/@oclif/core/lib/command.d.ts:97

`Protected` parse

parse<F, G, A>(options?: Input<F, G>, argv?: string[]): Promise<ParserOutput<F, G, A>>
Type Parameters
- F extends FlagOutput
- G extends FlagOutput
- A extends {
  [name: string]: any;
  }
Parameters
- Optional options: Input<F, G>
- Optional argv: string[]
Returns Promise<ParserOutput<F, G, A>>
Inherited from BaseIPCClientCommand.parse
- Defined in node_modules/@oclif/core/lib/command.d.ts:106

printJSON

printJSON(message?: Record<string, unknown>): void
Parameters
- Optional message: Record<string, unknown>
Returns void
Inherited from BaseIPCClientCommand.printJSON
- Defined in commander/src/bootstrapping/commands/base_ipc_client.ts:62

run

run(): Promise<void>
actual command run code goes here

Returns Promise<void>
Overrides BaseIPCClientCommand.run
- Defined in commander/src/bootstrapping/commands/endpoint/invoke.ts:37

`Protected` toErrorJson

toErrorJson(err: unknown): any
Parameters
- err: unknown
Returns any
Inherited from BaseIPCClientCommand.toErrorJson
- Defined in node_modules/@oclif/core/lib/command.d.ts:112

`Protected` toSuccessJson

toSuccessJson(result: unknown): any
Parameters
- result: unknown
Returns any
Inherited from BaseIPCClientCommand.toSuccessJson
- Defined in node_modules/@oclif/core/lib/command.d.ts:111

warn

warn(input: string | Error): string | Error
Parameters
- input: string | Error
Returns string | Error
Inherited from BaseIPCClientCommand.warn
- Defined in node_modules/@oclif/core/lib/command.d.ts:87

`Protected` warnIfCommandDeprecated

warnIfCommandDeprecated(): void
Returns void
Inherited from BaseIPCClientCommand.warnIfCommandDeprecated
- Defined in node_modules/@oclif/core/lib/command.d.ts:105

`Protected` warnIfFlagDeprecated

warnIfFlagDeprecated(flags: Record<string, unknown>): void
Parameters
- flags: Record<string, unknown>
Returns void
Inherited from BaseIPCClientCommand.warnIfFlagDeprecated
- Defined in node_modules/@oclif/core/lib/command.d.ts:104

Class InvokeCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

argv: string[]

config: Config

Returns InvokeCommand

Properties

Protected _client

Protected _dataPath

Protected _metadata

Protected _schema

argv

Protected baseIPCClientFlags

config

Protected debug

Type declaration

Parameters

Rest ...args: any[]

Returns void

id

Static _base

Static _enableJsonFlag

Protected Static _flags

Protected Static _globalFlags

Static aliases

Static args

Static Optional deprecateAliases

Static Optional deprecationOptions

Static description

Static examples

Static flags

Type declaration

data-path: OptionFlag<undefined | string>

file: OptionFlag<undefined | string>

pretty: BooleanFlag<boolean>

Static help

Static hidden

Static id

Static parse

Static parserOptions

Type declaration

Static plugin

Static run

Type declaration

Parameters

Optional argv: string[]

Optional config: LoadOptions

Returns PromiseLike<any>

Static Optional state

Static strict

Static Optional summary

Static usage

Accessors

ctor

Returns typeof default

Static enableJsonFlag

Returns boolean

Parameters

value: boolean

Returns void

Static globalFlags

Returns FlagInput<{ [flag: string]: any; }>

Parameters

flags: FlagInput<{ [flag: string]: any; }>

Returns void

Methods

_run

Type Parameters

T

Returns Promise<undefined | T>

Protected catch

Parameters

err: CommandError

`Protected` _client

`Protected` _dataPath

`Protected` _metadata

`Protected` _schema

`Protected` baseIPCClientFlags

`Protected` debug

`Rest` ...args: any[]

`Static` _base

`Static` _enableJsonFlag

`Protected` `Static` _flags

`Protected` `Static` _globalFlags

`Static` aliases

`Static` args

`Static` `Optional` deprecateAliases

`Static` `Optional` deprecationOptions

`Static` description

`Static` examples

`Static` flags

`Static` help

`Static` hidden

`Static` id

`Static` parse

`Static` parserOptions

`Static` plugin

`Static` run

`Optional` argv: string[]

`Optional` config: LoadOptions

`Static` `Optional` state

`Static` strict

`Static` `Optional` summary

`Static` usage

`Static` enableJsonFlag

`Static` globalFlags

Returns FlagInput<{
[flag: string]: any;
}>

flags: FlagInput<{
[flag: string]: any;
}>

`Protected` catch

options: {
code?: string;
exit: false;
} & PrettyPrintableError

`Optional` options: {
code?: string;
exit?: number;
} & PrettyPrintableError

`Optional` code: number

`Optional` message: string

`Rest` ...args: any[]

`Optional` message: string

`Rest` ...args: any[]

`Protected` parse

A extends {
[name: string]: any;
}

`Optional` options: Input<F, G>

`Optional` argv: string[]

`Optional` message: Record<string, unknown>

`Protected` toErrorJson

`Protected` toSuccessJson

`Protected` warnIfCommandDeprecated

`Protected` warnIfFlagDeprecated