Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKawkahOptionsInternal

Internal options interface stripping out default command options.

Hierarchy

Index

Properties

Optional allowAliases

allowAliases: boolean

Optional allowAnonymous

allowAnonymous: boolean

Optional allowBoolNegation

allowBoolNegation: boolean

Optional allowCamelcase

allowCamelcase: boolean

Optional allowCountOptions

allowCountOptions: boolean

Optional allowDotNotation

allowDotNotation: boolean

Optional allowDuplicateOptions

allowDuplicateOptions: boolean

Optional allowExtendArgs

allowExtendArgs: boolean

Optional allowParseBooleans

allowParseBooleans: boolean

Optional allowParseNumbers

allowParseNumbers: boolean

Optional allowPlaceholderArgs

allowPlaceholderArgs: boolean

Optional allowPlaceholderOptions

allowPlaceholderOptions: boolean

Optional allowShortExpand

allowShortExpand: boolean

Optional allowShortValues

allowShortValues: boolean

Optional allowVariadics

allowVariadics: boolean

Optional charAbort

charAbort: string

Optional charNegate

charNegate: string

Optional charVariadic

charVariadic: string

Optional colorize

colorize: boolean

Optional commands

commands: IKawkahMap<string | IKawkahCommand>

Optional examples

examples: IKawkahMap<string>

Optional footer

footer: string

Optional header

header: string

Optional locale

locale: string

Optional logFormat

logFormat: string

Optional middleware

middleware: string[]

Optional name

name: string

Optional onParserError

onParserError: function

Type declaration

    • (err: Error, template?: string, args?: any[]): void
    • Parameters

      • err: Error
      • Optional template: string
      • Optional args: any[]

      Returns void

Optional options

options: IKawkahParserConfigs

Optional output

output: WritableStream

Optional parser

parser: KawkahParser

Optional scheme

scheme: KawkahHelpScheme | string

Optional sortGroups

sortGroups: boolean

Optional spread

spread: boolean

Optional stacktrace

stacktrace: boolean

Optional strict

strict: boolean

Optional styles

styles: object

Type declaration

Optional terminate

terminate: boolean

Optional theme

Optional throw

throw: boolean

Optional timestampFormat

timestampFormat: string

Optional width

width: number

Generated using TypeDoc