Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKawkahOptions

All Kawkah options passed by user for configuration.

Hierarchy

Index

Properties

Optional abort

abort: boolean

Optional about

about: string

Optional action

action: KawkahAction

Optional alias

alias: string | string[]

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 args

args: string[]

Optional charAbort

charAbort: string

Optional charNegate

charNegate: string

Optional charVariadic

charVariadic: string

Optional colorize

colorize: boolean

Optional commands

commands: IKawkahMap<string | IKawkahCommand>

Optional describe

describe: string

Optional examples

examples: IKawkahMap<string>

Optional external

external: string

Optional externalOptions

externalOptions: SpawnOptions

Optional footer

footer: string

Optional header

header: string

Optional help

help: string | boolean | KawkahHandler

Optional locale

locale: string

Optional logFormat

logFormat: string

Optional maxArgs

maxArgs: number

Optional maxFlags

maxFlags: number

Optional middleware

middleware: string[]

Optional minArgs

minArgs: number

Optional minFlags

minFlags: number

Optional name

name: string

Optional options

options: IKawkahMap<string | IKawkahOption>

Optional output

output: WritableStream

Optional parser

parser: KawkahParser

Optional scheme

scheme: KawkahHelpScheme | string

Optional skip

skip: boolean

Optional sortGroups

sortGroups: boolean

Optional spread

spread: boolean

Optional stacktrace

stacktrace: boolean

Optional strict

strict: boolean

Optional styles

Optional terminate

terminate: boolean

Optional theme

theme: KawkahThemeKeys | IKawkahTheme | string

Optional throw

throw: boolean

Optional timestampFormat

timestampFormat: string

Optional usage

usage: string

Optional width

width: number

Generated using TypeDoc