Class Jack<C>

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

Type Parameters

Constructors

constructor

Methods

[custom] addFields applyDefaults description flag flagList heading loadEnvDefaults num numList opt optList parse parseRaw setConfigValues toJSON usage usageMarkdown validate writeEnv

Constructors

constructor

Methods

[custom]

  • [custom](_, options): string

  • Custom printer for util.inspect

    Parameters

    • _: number
    • options: InspectOptions

    Returns string

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

    Parameters

    • fields: F

    Returns Jack<C & F>

applyDefaults

description

  • description(text, __namedParameters?): Jack<C>

  • Add a long-form description to the usage output at this position.

    Parameters

    • text: string
    • __namedParameters: {
          pre?: boolean;
      } = {}
      • Optionalpre?: boolean

    Returns Jack<C>

flag

  • flag<F>(fields): Jack<C & F & {
        [longOption in string | number | symbol]: ConfigOption<"boolean", false, undefined>
    }>

  • Add one or more flag fields.

    Type Parameters

    Parameters

    • fields: F

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

flagList

  • flagList<F>(fields): Jack<C & F & {
        [longOption in string | number | symbol]: ConfigOption<"boolean", true, undefined>
    }>

  • Add one or more multiple flag fields.

    Type Parameters

    Parameters

    • fields: F

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

heading

  • heading(text, level?, __namedParameters?): Jack<C>

  • Add a heading to the usage output banner

    Parameters

    • text: string
    • Optionallevel:
          | 2
          | 1
          | 3
          | 4
          | 5
          | 6
    • __namedParameters: {
          pre?: boolean;
      } = {}
      • Optionalpre?: boolean

    Returns Jack<C>

loadEnvDefaults

num

  • num<F>(fields): Jack<C & F & {
        [longOption in string | number | symbol]: ConfigOption<"number", false, undefined | readonly number[]>
    }>

  • Add one or more number fields.

    Type Parameters

    Parameters

    • fields: F

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

numList

  • numList<F>(fields): Jack<C & F & {
        [longOption in string | number | symbol]: ConfigOption<"number", true, undefined | readonly number[]>
    }>

  • Add one or more multiple number fields.

    Type Parameters

    Parameters

    • fields: F

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

opt

  • opt<F>(fields): Jack<C & F & {
        [longOption in string | number | symbol]: ConfigOption<"string", false, undefined | readonly string[]>
    }>

  • Add one or more string option fields.

    Type Parameters

    Parameters

    • fields: F

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

optList

  • optList<F>(fields): Jack<C & F & {
        [longOption in string | number | symbol]: ConfigOption<"string", true, undefined | readonly string[]>
    }>

  • Add one or more multiple string option fields.

    Type Parameters

    Parameters

    • fields: F

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

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>

parseRaw

  • parseRaw(args): 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>

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

    Returns Jack<C>

toJSON

  • toJSON(): {
        [k: string]: T;
    }

  • Return the configuration options as a plain object

    Returns {
        [k: string]: T;
    }

    • [k: string]: T

usage

  • usage(): string

  • Return the usage banner for the given configuration

    Returns string

usageMarkdown

  • usageMarkdown(): string

  • Return the usage banner markdown for the given configuration

    Returns string

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: unknown

    Returns asserts o is OptionsResults<C>

writeEnv

Settings

Member Visibility

On This Page

Constructors
Methods