Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Arguments

Arguments<T>: T & object

Type parameters

  • T

AsyncCompletionFunction

AsyncCompletionFunction: function

Type declaration

    • (current: string, argv: any, done: function): void
    • Parameters

      • current: string
      • argv: any
      • done: function
          • (completion: ReadonlyArray<string>): void
          • Parameters

            • completion: ReadonlyArray<string>

            Returns void

      Returns void

BuilderCallback

BuilderCallback<T, R>: function | function

Type parameters

  • T

  • R

Choices

Choices: ReadonlyArray<string | number | true | undefined>

CommandBuilder

CommandBuilder<T, U>: object | function

Type parameters

  • T

  • U

Defined

Defined<T, K>: Omit<T, K> & object

Remove undefined as a possible value for keys K in T

Type parameters

  • T

  • K: keyof T

InferredOptionType

InferredOptionType<O>: InferredOptionType<O>

Type parameters

InferredOptionTypes

InferredOptionTypes<O>: object

Type parameters

  • O: object

Type declaration

MiddlewareFunction

MiddlewareFunction<T>: function

Type parameters

  • T

Type declaration

Omit

Omit<T, K>: object

Remove keys K in T

Type parameters

  • T

  • K

Type declaration

ParseCallback

ParseCallback<T>: function

Type parameters

  • T

Type declaration

    • Parameters

      Returns void

PositionalOptionsType

PositionalOptionsType: "boolean" | "number" | "string"

PromiseCompletionFunction

PromiseCompletionFunction: function

Type declaration

    • (current: string, argv: any): Promise<string[]>
    • Parameters

      • current: string
      • argv: any

      Returns Promise<string[]>

RequiredOptionType

RequiredOptionType<O>: RequiredOptionType<O>

Type parameters

SyncCompletionFunction

SyncCompletionFunction: function

Type declaration

    • (current: string, argv: any): string[]
    • Parameters

      • current: string
      • argv: any

      Returns string[]

ToArray

ToArray<T>: Array<Exclude<T, undefined>> | Extract<T, undefined>

Convert T to T[] and T | undefined to T[] | undefined

Type parameters

  • T

ToNumber

ToNumber<T>: Exclude<T, undefined> extends any[] ? number[] : number | Extract<T, undefined>

Gives number[] if T is an array type, otherwise number. Preserves | undefined.

Type parameters

  • T

ToString

ToString<T>: Exclude<T, undefined> extends any[] ? string[] : string | Extract<T, undefined>

Gives string[] if T is an array type, otherwise string. Preserves | undefined.

Type parameters

  • T

Generated using TypeDoc