Class YargsBuilder<T>

Type Parameters

T

Index

Constructors

Methods

add build empty withDefaults

Constructors

constructor

new YargsBuilder<T>(): YargsBuilder<T>
Type Parameters
- T
Returns YargsBuilder<T>

Methods

add

add<R>(mutator: YargsMutator<T, R>): YargsBuilder<T & R>
Type Parameters
- R
Parameters
- mutator: YargsMutator<T, R>
Returns YargsBuilder<T & R>
- Defined in yargs/yargs-builder.class.ts:28

build

build(args?: string | readonly string[] | undefined, cwd?: string): Argv<T>
usage: pass
Parameters
- args: string | readonly string[] | undefined = ...
- Optionalcwd: string
Returns Argv<T>
- Defined in yargs/yargs-builder.class.ts:39

`Static`empty

empty(): YargsBuilder<object>
Returns YargsBuilder<object>
- Defined in yargs/yargs-builder.class.ts:11

`Static`withDefaults

withDefaults<
    T extends
        Replace<JSONSchemaForNPMPackageJsonFiles, SimplifiedPackageJsonFields>,
>(
    packageJson?: T,
): YargsBuilder<object>
Creates a YargsBuilder with some default options:
- enables help
- adds metadata found in packageJson for
  - version
  - epilogue showing the repository url
It does not add any options
Type Parameters
- T extends Replace<JSONSchemaForNPMPackageJsonFiles, SimplifiedPackageJsonFields>
Parameters
- OptionalpackageJson: T
Returns YargsBuilder<object>
- Defined in yargs/yargs-builder.class.ts:24