Class default`Abstract`

Hierarchy

Command
- default

Index

Constructors

Properties

Methods

catch environmentsFilename exitWithTimestampWhenEnvVariablePresent failMissingNonTTYFlags init parse resultWithEnvironment showNpmFlagWarning analyticsNameOverride analyticsStopCommand descriptionWithoutMarkdown

Constructors

constructor

new default(argv, config): default
Parameters
- argv: string[]
- config: Config
Returns default
Inherited from Command.constructor
- Defined in node_modules/.pnpm/@oclif+core@3.26.5/node_modules/@oclif/core/lib/command.d.ts:76

Properties

`Static` baseFlags

baseFlags: FlagInput<{}> = {}

Type declaration

Methods

catch

catch(error): Promise<void>
Parameters
- error: Error & {
  skipOclifErrorHandling: boolean;
  }
Returns Promise<void>
Overrides Command.catch
- Defined in packages/cli-kit/src/public/node/base-command.ts:39

`Protected` environmentsFilename

environmentsFilename(): undefined | string
Returns undefined | string
- Defined in packages/cli-kit/src/public/node/base-command.ts:102

`Protected` exitWithTimestampWhenEnvVariablePresent

exitWithTimestampWhenEnvVariablePresent(): void
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:77

`Protected` failMissingNonTTYFlags

failMissingNonTTYFlags(flags, requiredFlags): void
Parameters
- flags: FlagOutput
- requiredFlags: string[]
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:107

`Protected` init

init(): Promise<any>
Returns Promise<any>
Overrides Command.init
- Defined in packages/cli-kit/src/public/node/base-command.ts:46

`Protected` parse

parse<TFlags, TGlobalFlags, TArgs>(options?, argv?): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
argv: string[];
}>
Type Parameters
- TFlags extends FlagOutput & {
  path?: string;
  verbose?: boolean;
  }
- TGlobalFlags extends FlagOutput
- TArgs extends ArgOutput
Parameters
- Optional options: Input<TFlags, TGlobalFlags, TArgs>
- Optional argv: string[]
Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
argv: string[];
}>
Overrides Command.parse
- Defined in packages/cli-kit/src/public/node/base-command.ts:88

`Private` resultWithEnvironment

resultWithEnvironment<TFlags, TGlobalFlags, TArgs>(originalResult, options?, argv?): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs>>
Type Parameters
- TFlags extends FlagOutput & {
  path?: string;
  verbose?: boolean;
  }
- TGlobalFlags extends FlagOutput
- TArgs extends ArgOutput
Parameters
- originalResult: ParserOutput<TFlags, TGlobalFlags, TArgs>
- Optional options: Input<TFlags, TGlobalFlags, TArgs>
- Optional argv: string[]
Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs>>
- Defined in packages/cli-kit/src/public/node/base-command.ts:124

`Protected` showNpmFlagWarning

showNpmFlagWarning(): void
Returns void
- Defined in packages/cli-kit/src/public/node/base-command.ts:59

`Static` analyticsNameOverride

analyticsNameOverride(): undefined | string
Returns undefined | string
- Defined in packages/cli-kit/src/public/node/base-command.ts:31

`Static` analyticsStopCommand

analyticsStopCommand(): undefined | string
Returns undefined | string
- Defined in packages/cli-kit/src/public/node/base-command.ts:35

`Static` descriptionWithoutMarkdown

descriptionWithoutMarkdown(): undefined | string
Returns undefined | string
- Defined in packages/cli-kit/src/public/node/base-command.ts:26

Class defaultAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Static baseFlags

Type declaration

Methods

catch

Parameters

Returns Promise<void>

Protected environmentsFilename

Returns undefined | string

Protected exitWithTimestampWhenEnvVariablePresent

Returns void

Protected failMissingNonTTYFlags

Parameters

Returns void

Protected init

Returns Promise<any>

Protected parse

Type Parameters

Parameters

Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & { argv: string[]; }>

Private resultWithEnvironment

Type Parameters

Parameters

Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs>>

Protected showNpmFlagWarning

Returns void

Static analyticsNameOverride

Returns undefined | string

Static analyticsStopCommand

Returns undefined | string

Static descriptionWithoutMarkdown

Returns undefined | string

Settings

Member Visibility

Theme

On This Page

Class default`Abstract`

`Static` baseFlags

`Protected` environmentsFilename

`Protected` exitWithTimestampWhenEnvVariablePresent

`Protected` failMissingNonTTYFlags

`Protected` init

`Protected` parse

Returns Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
argv: string[];
}>

`Private` resultWithEnvironment

`Protected` showNpmFlagWarning

`Static` analyticsNameOverride

`Static` analyticsStopCommand

`Static` descriptionWithoutMarkdown