Class Jack<C>

Class returned by the jack function and all configuration definition methods. This is what gets chained together.

Type Parameters

C extends ConfigSet = {}

Hierarchy

Jack

Index

Constructors

constructor

new Jack<C>(options?): Jack<C>
Type Parameters
- C extends ConfigSet = {}
Parameters
- options: JackOptions = {}
Returns Jack<C>
- Defined in src/index.ts:579

Properties

`Private` #allowPositionals

#allowPositionals: boolean

`Private` #configSet

#configSet: C

`Private` #env

#env: {
[k: string]: string | undefined;
}

Type declaration

[k: string]: string | undefined

`Private` `Optional` #envPrefix

#envPrefix?: string

`Private` #fields

#fields: UsageField[] = []

`Private` #options

#options: JackOptions

`Private` #shorts

#shorts: {
[k: string]: string;
}

Type declaration

[k: string]: string

`Private` `Optional` #usage

#usage?: string

`Private` `Optional` #usageMarkdown

#usageMarkdown?: string

Methods

`Private` #addFields

#addFields<T, M, F>(fields, fn): Jack<C & ConfigSetFromMetaSet<T, M, F>>
Type Parameters
- T extends ConfigType
- M extends boolean
- F extends ConfigMetaSet<T, M>
Parameters
- fields: F
- fn: ((m) => ConfigOptionBase<T, M>)
  - - (m): ConfigOptionBase<T, M>
    - Parameters
      
      m: ConfigOptionMeta<T, M>
      
      Returns ConfigOptionBase<T, M>
Returns Jack<C & ConfigSetFromMetaSet<T, M, F>>
- Defined in src/index.ts:908

`Private` #noNoFields

#noNoFields(f, val, s?): void
do not set fields as 'no-foo' if 'foo' exists and both are bools just set foo.
Parameters
- f: string
- val: any
- s: string = f
Returns void
- Defined in src/index.ts:756

`Private` #usageRows

#usageRows(start): {
maxWidth: number;
rows: (Row | TextRow)[];
}
Parameters
- start: number
Returns {
maxWidth: number;
rows: (Row | TextRow)[];
}
- maxWidth: number
- rows: (Row | TextRow)[]
- Defined in src/index.ts:1143

`Private` #validateName

#validateName(name, field): void
Parameters
- name: string
- field: {
  short?: string;
  }
  - Optional short?: string
Returns void
- Defined in src/index.ts:936

`Private` #writeEnv

#writeEnv(p): void
Parameters
- p: Parsed<C>
Returns void
- Defined in src/index.ts:801

[custom]

[custom](_, options): string
Custom printer for util.inspect
Parameters
- _: number
- options: InspectOptions
Returns string
- Defined in src/index.ts:1221

addFields

addFields<F>(fields): Jack<C & F>
Generic field definition method. Similar to flag/flagList/number/etc, but you must specify the type (and optionally multiple and delim) fields on each one, or Jack won't know how to define them.
Type Parameters
- F extends ConfigSet
Parameters
- fields: F
Returns Jack<C & F>
- Defined in src/index.ts:894

description

description(text, __namedParameters?): Jack<C>
Add a long-form description to the usage output at this position.
Parameters
- text: string
- __namedParameters: {
  pre?: boolean;
  } = {}
  - Optional pre?: boolean
Returns Jack<C>
- Defined in src/index.ts:830

flag

flag<F>(fields): Jack<C & ConfigSetFromMetaSet<"boolean", false, F>>
Add one or more flag fields.
Type Parameters
- F extends ConfigMetaSet<"boolean", false>
Parameters
- fields: F
Returns Jack<C & ConfigSetFromMetaSet<"boolean", false, F>>
- Defined in src/index.ts:874

flagList

flagList<F>(fields): Jack<C & ConfigSetFromMetaSet<"boolean", true, F>>
Add one or more multiple flag fields.
Type Parameters
- F extends ConfigMetaSet<"boolean", true>
Parameters
- fields: F
Returns Jack<C & ConfigSetFromMetaSet<"boolean", true, F>>
- Defined in src/index.ts:883

heading

heading(text, level?, __namedParameters?): Jack<C>
Add a heading to the usage output banner
Parameters
- text: string
- Optional level: 1 | 2 | 3 | 4 | 5 | 6
- __namedParameters: {
  pre?: boolean;
  } = {}
  - Optional pre?: boolean
Returns Jack<C>
- Defined in src/index.ts:815

num

num<F>(fields): Jack<C & ConfigSetFromMetaSet<"number", false, F>>
Add one or more number fields.
Type Parameters
- F extends ConfigMetaSet<"number", false>
Parameters
- fields: F
Returns Jack<C & ConfigSetFromMetaSet<"number", false, F>>
- Defined in src/index.ts:838

numList

numList<F>(fields): Jack<C & ConfigSetFromMetaSet<"number", true, F>>
Add one or more multiple number fields.
Type Parameters
- F extends ConfigMetaSet<"number", true>
Parameters
- fields: F
Returns Jack<C & ConfigSetFromMetaSet<"number", true, F>>
- Defined in src/index.ts:847

opt

opt<F>(fields): Jack<C & ConfigSetFromMetaSet<"string", false, F>>
Add one or more string option fields.
Type Parameters
- F extends ConfigMetaSet<"string", false>
Parameters
- fields: F
Returns Jack<C & ConfigSetFromMetaSet<"string", false, F>>
- Defined in src/index.ts:856

optList

optList<F>(fields): Jack<C & ConfigSetFromMetaSet<"string", true, F>>
Add one or more multiple string option fields.
Type Parameters
- F extends ConfigMetaSet<"string", true>
Parameters
- fields: F
Returns Jack<C & ConfigSetFromMetaSet<"string", true, F>>
- Defined in src/index.ts:865

parse

parse(args?): Parsed<C>
Parse a string of arguments, and return the resulting { values, positionals } object.

If an JackOptions#envPrefix is set, then it will read default values from the environment, and write the resulting values back to the environment as well.

Environment values always take precedence over any other value, except an explicit CLI setting.
Parameters
- args: string[] = process.argv
Returns Parsed<C>
- Defined in src/index.ts:628

setConfigValues

setConfigValues(values, source?): Jack<C>
Set the default value (which will still be overridden by env or cli) as if from a parsed config file. The optional source param, if provided, will be included in error messages if a value is invalid or unknown.
Parameters
- values: OptionsResults<C>
- source: string = ''
Returns Jack<C>
- Defined in src/index.ts:598

toJSON

toJSON(): {
[k: string]: T;
}
Return the configuration options as a plain object

Returns {
[k: string]: T;
}
- [k: string]: T
- Defined in src/index.ts:1199

usage

usage(): string
Return the usage banner for the given configuration

Returns string
- Defined in src/index.ts:973

usageMarkdown

usageMarkdown(): string
Return the usage banner markdown for the given configuration

Returns string
- Defined in src/index.ts:1072

validate

validate(o): asserts o is OptionsResults<C>
Validate that any arbitrary object is a valid configuration values object. Useful when loading config files or other sources.
Parameters
- o: any
Returns asserts o is OptionsResults<C>
- Defined in src/index.ts:772

Class Jack<C>

Type Parameters

C extends ConfigSet = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

C extends ConfigSet = {}

Parameters

options: JackOptions = {}

Returns Jack<C>

Properties

Private #allowPositionals

Private #configSet

Private #env

Type declaration

[k: string]: string | undefined

Private Optional #envPrefix

Private #fields

Private #options

Private #shorts

Type declaration

[k: string]: string

Private Optional #usage

Private Optional #usageMarkdown

Methods

Private #addFields

Type Parameters

T extends ConfigType

M extends boolean

F extends ConfigMetaSet<T, M>

Parameters

fields: F

fn: ((m) => ConfigOptionBase<T, M>)

Parameters

m: ConfigOptionMeta<T, M>

Returns ConfigOptionBase<T, M>

Returns Jack<C & ConfigSetFromMetaSet<T, M, F>>

Private #noNoFields

Parameters

f: string

val: any

s: string = f

Returns void

Private #usageRows

Parameters

start: number

Returns { maxWidth: number; rows: (Row | TextRow)[]; }

maxWidth: number

rows: (Row | TextRow)[]

Private #validateName

Parameters

name: string

field: { short?: string; }

Optional short?: string

Returns void

Private #writeEnv

Parameters

p: Parsed<C>

Returns void

[custom]

Parameters

_: number

options: InspectOptions

Returns string

addFields

Type Parameters

F extends ConfigSet

Parameters

fields: F

Returns Jack<C & F>

description

Parameters

text: string

__namedParameters: { pre?: boolean; } = {}

Optional pre?: boolean

`Private` #allowPositionals

`Private` #configSet

`Private` #env

`Private` `Optional` #envPrefix

`Private` #fields

`Private` #options

`Private` #shorts

`Private` `Optional` #usage

`Private` `Optional` #usageMarkdown

`Private` #addFields

`Private` #noNoFields

`Private` #usageRows

Returns {
maxWidth: number;
rows: (Row | TextRow)[];
}

`Private` #validateName

field: {
short?: string;
}

`Optional` short?: string

`Private` #writeEnv

__namedParameters: {
pre?: boolean;
} = {}

`Optional` pre?: boolean

`Optional` level: 1 | 2 | 3 | 4 | 5 | 6

__namedParameters: {
pre?: boolean;
} = {}

`Optional` pre?: boolean

Returns {
[k: string]: T;
}