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 = {}

Index

Constructors

constructor

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

Accessors

definitions

get definitions(): C
Resulting definitions, suitable to be passed to Node's util.parseArgs, but also including description and short fields, if set.

Returns C
- Defined in index.ts:595

jackOptions

get jackOptions(): JackOptions
options passed to the Jack constructor

Returns JackOptions
- Defined in index.ts:607

shorts

get shorts(): Record<string, string>
map of { <short>: <long> } strings for each short name defined

Returns Record<string, string>
- Defined in index.ts:600

usageFields

get usageFields(): UsageField[]
the data used to generate Jack#usage and Jack#usageMarkdown content.

Returns UsageField[]
- Defined in index.ts:615

Methods

[custom]

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

addFields

addFields<F extends ConfigSet>(fields: F): 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 index.ts:999

applyDefaults

applyDefaults(p: Parsed<C>): void
Parameters
- p: Parsed<C>
Returns void
- Defined in index.ts:686

description

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

flag

flag<F extends ConfigMetaSet<"boolean", false>>(
    fields: F,
): Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"boolean", false, undefined>
    },
>
Add one or more flag fields.
Type Parameters
- F extends ConfigMetaSet<"boolean", false>
Parameters
- fields: F
Returns Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"boolean", false, undefined>
    },
>
- Defined in index.ts:979

flagList

flagList<F extends ConfigMetaSet<"boolean", true>>(
    fields: F,
): Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"boolean", true, undefined>
    },
>
Add one or more multiple flag fields.
Type Parameters
- F extends ConfigMetaSet<"boolean", true>
Parameters
- fields: F
Returns Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"boolean", true, undefined>
    },
>
- Defined in index.ts:988

heading

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

loadEnvDefaults

loadEnvDefaults(): void
Returns void
- Defined in index.ts:674

num

num<F extends ConfigMetaSet<"number", false>>(
    fields: F,
): Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"number", false, readonly number[] | undefined>
    },
>
Add one or more number fields.
Type Parameters
- F extends ConfigMetaSet<"number", false>
Parameters
- fields: F
Returns Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"number", false, readonly number[] | undefined>
    },
>
- Defined in index.ts:943

numList

numList<F extends ConfigMetaSet<"number", true>>(
    fields: F,
): Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"number", true, readonly number[] | undefined>
    },
>
Add one or more multiple number fields.
Type Parameters
- F extends ConfigMetaSet<"number", true>
Parameters
- fields: F
Returns Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"number", true, readonly number[] | undefined>
    },
>
- Defined in index.ts:952

opt

opt<F extends ConfigMetaSet<"string", false>>(
    fields: F,
): Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"string", false, readonly string[] | undefined>
    },
>
Add one or more string option fields.
Type Parameters
- F extends ConfigMetaSet<"string", false>
Parameters
- fields: F
Returns Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"string", false, readonly string[] | undefined>
    },
>
- Defined in index.ts:961

optList

optList<F extends ConfigMetaSet<"string", true>>(
    fields: F,
): Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"string", true, readonly string[] | undefined>
    },
>
Add one or more multiple string option fields.
Type Parameters
- F extends ConfigMetaSet<"string", true>
Parameters
- fields: F
Returns Jack<
    C & F & {
        [longOption in string
        | number
        | symbol]: ConfigOption<"string", true, readonly string[] | undefined>
    },
>
- Defined in index.ts:970

parse

parse(args?: string[]): 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 index.ts:666

parseRaw

parseRaw(args: string[]): Parsed<C>
Only parse the command line arguments passed in. Does not strip off the node script.js bits, so it must be just the arguments you wish to have parsed. Does not read from or write to the environment, or set defaults.
Parameters
- args: string[]
Returns Parsed<C>
- Defined in index.ts:701

setConfigValues

setConfigValues(values: Partial<OptionsResults<C>>, source?: string): 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: Partial<OptionsResults<C>>
- source: string = ''
Returns Jack<C>
- Defined in index.ts:625

toJSON

toJSON(): {
    [k: string]: {
        default?: ConfigValue;
        delim?: string;
        description?: string;
        hint?: string;
        multiple?: boolean;
        short?: string;
        type: ConfigType;
        validate?: ((v: unknown) => boolean)
        | ((v: unknown) => v is ConfigValue);
        validOptions?: readonly number[] | readonly string[];
    };
}
Return the configuration options as a plain object

Returns {
    [k: string]: {
        default?: ConfigValue;
        delim?: string;
        description?: string;
        hint?: string;
        multiple?: boolean;
        short?: string;
        type: ConfigType;
        validate?: ((v: unknown) => boolean) | ((v: unknown) => v is ConfigValue);
        validOptions?: readonly number[] | readonly string[];
    };
}
- Defined in index.ts:1304

usage

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

Returns string
- Defined in index.ts:1074

usageMarkdown

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

Returns string
- Defined in index.ts:1174

validate

validate(o: unknown): 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: unknown
Returns asserts o is OptionsResults<C>
- Defined in index.ts:858

writeEnv

writeEnv(p: Parsed<C>): void
Parameters
- p: Parsed<C>
Returns void
- Defined in index.ts:906

Class Jack<C>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Jack<C>

Accessors

definitions

Returns C

jackOptions

Returns JackOptions

shorts

Returns Record<string, string>

usageFields

Returns UsageField[]

Methods

[custom]

Parameters

Returns string

addFields

Type Parameters

Parameters

Returns Jack<C & F>

applyDefaults

Parameters

Returns void

description

Parameters

Returns Jack<C>

flag

Type Parameters

Parameters

Returns Jack< C & F & { [longOption in string | number | symbol]: ConfigOption<"boolean", false, undefined> },>

flagList

Type Parameters

Parameters

Returns Jack< C & F & { [longOption in string | number | symbol]: ConfigOption<"boolean", true, undefined> },>

heading

Parameters

Returns Jack<C>

loadEnvDefaults

Returns void

num

Type Parameters

Parameters

Returns Jack< C & F & { [longOption in string | number | symbol]: ConfigOption<"number", false, readonly number[] | undefined> },>

numList

Type Parameters

Parameters

Returns Jack< C & F & { [longOption in string | number | symbol]: ConfigOption<"number", true, readonly number[] | undefined> },>

opt

Type Parameters

Parameters

Returns Jack< C & F & { [longOption in string | number | symbol]: ConfigOption<"string", false, readonly string[] | undefined> },>

optList

Type Parameters

Parameters

Returns Jack< C & F & { [longOption in string | number | symbol]: ConfigOption<"string", true, readonly string[] | undefined> },>

parse

Parameters

Returns Parsed<C>

parseRaw

Parameters

Returns Parsed<C>

setConfigValues

Parameters

Returns Jack<C>

toJSON

Returns { [k: string]: { default?: ConfigValue; delim?: string; description?: string; hint?: string; multiple?: boolean; short?: string; type: ConfigType; validate?: ((v: unknown) => boolean) | ((v: unknown) => v is ConfigValue); validOptions?: readonly number[] | readonly string[]; };}

usage

Returns string

usageMarkdown

Returns string

validate

Parameters

Returns Jack<
C & F & {
[longOption in string
| number
| symbol]: ConfigOption<"boolean", false, undefined>
},
>

Returns Jack<
C & F & {
[longOption in string
| number
| symbol]: ConfigOption<"boolean", true, undefined>
},
>

Returns Jack<
C & F & {
[longOption in string
| number
| symbol]: ConfigOption<"number", false, readonly number[] | undefined>
},
>

Returns Jack<
C & F & {
[longOption in string
| number
| symbol]: ConfigOption<"number", true, readonly number[] | undefined>
},
>

Returns Jack<
C & F & {
[longOption in string
| number
| symbol]: ConfigOption<"string", false, readonly string[] | undefined>
},
>

Returns Jack<
C & F & {
[longOption in string
| number
| symbol]: ConfigOption<"string", true, readonly string[] | undefined>
},
>

Returns {
[k: string]: {
default?: ConfigValue;
delim?: string;
description?: string;
hint?: string;
multiple?: boolean;
short?: string;
type: ConfigType;
validate?: ((v: unknown) => boolean) | ((v: unknown) => v is ConfigValue);
validOptions?: readonly number[] | readonly string[];
};
}