Class Args

Hierarchy

Args

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Args(data: APIMessage, command: Command, parser: Args): Args

- Defined in src/lib/arguments/Args.ts:23
Parameters
- data: APIMessage
- command: Command
- parser: Args
Returns Args

Properties

Readonly command

command: Command

Readonly data

data: APIMessage

Private Readonly parser

parser: Args

Private states

states: ArgsState[] = []

Methods

getFlags

getFlags(...keys: readonly string[]): boolean

- Defined in src/lib/arguments/Args.ts:134
Parameters
- Rest ...keys: readonly string[]
Returns boolean

getOption

getOption(...keys: readonly string[]): null | string

- Defined in src/lib/arguments/Args.ts:138
Parameters
- Rest ...keys: readonly string[]
Returns null | string

getOptions

getOptions(...keys: readonly string[]): null | string[]

- Defined in src/lib/arguments/Args.ts:142
Parameters
- Rest ...keys: readonly string[]
Returns null | string[]

pick

pick<T>(type: IArgument<T>, options?: ArgOptions): Promise<T>
pick<K>(type: K, options?: ArgOptions): Promise<ArgumentType[K]>

- Defined in src/lib/arguments/Args.ts:58
Type parameters
- T
Parameters
- type: IArgument<T>
- Optional options: ArgOptions
Returns Promise<T>
- Defined in src/lib/arguments/Args.ts:59
Type parameters
- K: keyof ArgumentType
Parameters
- type: K
- Optional options: ArgOptions
Returns Promise<ArgumentType[K]>

pickResult

pickResult<T>(type: IArgument<T>, options?: ArgOptions): Promise<Result<T, UserError>>
pickResult<K>(type: K, options?: ArgOptions): Promise<Result<ArgumentType[K], UserError>>

- Defined in src/lib/arguments/Args.ts:40
Type parameters
- T
Parameters
- type: IArgument<T>
- Optional options: ArgOptions
Returns Promise<Result<T, UserError>>
- Defined in src/lib/arguments/Args.ts:41
Type parameters
- K: keyof ArgumentType
Parameters
- type: K
- Optional options: ArgOptions
Returns Promise<Result<ArgumentType[K], UserError>>

repeat

repeat<T>(type: IArgument<T>, options?: RepeatArgOptions): Promise<T[]>
repeat<K>(type: K, options?: RepeatArgOptions): Promise<ArgumentType[K][]>

- Defined in src/lib/arguments/Args.ts:125
Type parameters
- T
Parameters
- type: IArgument<T>
- Optional options: RepeatArgOptions
Returns Promise<T[]>
- Defined in src/lib/arguments/Args.ts:126
Type parameters
- K: keyof ArgumentType
Parameters
- type: K
- Optional options: RepeatArgOptions
Returns Promise<ArgumentType[K][]>

repeatResult

repeatResult<T>(type: IArgument<T>, options?: RepeatArgOptions): Promise<Result<T[], UserError>>
repeatResult<K>(type: K, options?: RepeatArgOptions): Promise<Result<ArgumentType[K][], UserError>>

- Defined in src/lib/arguments/Args.ts:96
Type parameters
- T
Parameters
- type: IArgument<T>
- Optional options: RepeatArgOptions
Returns Promise<Result<T[], UserError>>
- Defined in src/lib/arguments/Args.ts:97
Type parameters
- K: keyof ArgumentType
Parameters
- type: K
- Optional options: RepeatArgOptions
Returns Promise<Result<ArgumentType[K][], UserError>>

Private resolveArgument

resolveArgument<T>(arg: keyof ArgumentType | IArgument<T>): IArgument<T> | undefined

- Defined in src/lib/arguments/Args.ts:154
Type parameters
- T
Parameters
- arg: keyof ArgumentType | IArgument<T>
Returns IArgument<T> | undefined

rest

rest<T>(type: IArgument<T>, options?: ArgOptions): Promise<T>
rest<K>(type: K, options?: ArgOptions): Promise<ArgumentType[K]>

- Defined in src/lib/arguments/Args.ts:88
Type parameters
- T
Parameters
- type: IArgument<T>
- Optional options: ArgOptions
Returns Promise<T>
- Defined in src/lib/arguments/Args.ts:89
Type parameters
- K: keyof ArgumentType
Parameters
- type: K
- Optional options: ArgOptions
Returns Promise<ArgumentType[K]>

restResult

restResult<T>(type: IArgument<T>, options?: ArgOptions): Promise<Result<T, UserError>>
restResult<K>(type: K, options?: ArgOptions): Promise<Result<ArgumentType[K], UserError>>

- Defined in src/lib/arguments/Args.ts:67
Type parameters
- T
Parameters
- type: IArgument<T>
- Optional options: ArgOptions
Returns Promise<Result<T, UserError>>
- Defined in src/lib/arguments/Args.ts:68
Type parameters
- K: keyof ArgumentType
Parameters
- type: K
- Optional options: ArgOptions
Returns Promise<Result<ArgumentType[K], UserError>>

restore

restore(): void

- Defined in src/lib/arguments/Args.ts:150
Returns void

save

save(): void

- Defined in src/lib/arguments/Args.ts:146
Returns void

start

start(): Args

- Defined in src/lib/arguments/Args.ts:31
Returns Args

Static error

error<T>(argument: IArgument<T>, parameter: string, message: string): ArgumentError<T>
error<T>(argument: IArgument<T>, parameter: string, type: string, message: string): ArgumentError<T>

- Defined in src/lib/arguments/Args.ts:163
Type parameters
- T
Parameters
- argument: IArgument<T>
- parameter: string
- message: string
Returns ArgumentError<T>
- Defined in src/lib/arguments/Args.ts:165
Type parameters
- T
Parameters
- argument: IArgument<T>
- parameter: string
- type: string
- message: string
Returns ArgumentError<T>

Static make

make<T>(cb: IArgument<T>["run"], name?: string): IArgument<T>

- Defined in src/lib/arguments/Args.ts:159
Type parameters
- T
Parameters
- cb: IArgument<T>["run"]
- Default value name: string = ""
Returns IArgument<T>

Generated using TypeDoc