Interface ZHelpConfig<TOption>

Optional Readonly mode

Optional compare

• compare(key1, meta1, key2, meta2): number

• Compares two options meta.

  By default sorts options by their group first, and then - by their keys.

  Parameters

  • key1: string

    First option key.

  • meta1: Combined

    First option meta.

  • key2: string

    Second option key.

  • meta2: Combined

    Second option meta.

  Returns number

  Positive number if first option should be listed after the second one, negative number if first option should be listed before the second one, or zero to list them in original order.

Optional display

• display(options, option): void | PromiseLike<unknown>

• Displays help information.

  By default prints help information formatted by help formatter to console.

  Parameters

  • options: List

    A list of options meta to display.

  • option: TOption

    Help option representation.

  Returns void | PromiseLike<unknown>

  Either nothing if help displayed synchronously, or a promise-like instance resolved when help displayed asynchronously.