Class: Args
Constructors
constructor
• new Args(message
, command
, parser
, context
)
Parameters
Name | Type |
---|---|
message | Message <boolean > |
command | MessageCommand |
parser | ArgumentStream |
context | MessageCommandContext |
Defined in
projects/framework/src/lib/parsers/Args.ts:58
Properties
command
• Readonly
command: MessageCommand
Defined in
projects/framework/src/lib/parsers/Args.ts:39
commandContext
• Readonly
commandContext: MessageCommandContext
Defined in
projects/framework/src/lib/parsers/Args.ts:44
message
• Readonly
message: Message
<boolean
>
Defined in
projects/framework/src/lib/parsers/Args.ts:34
parser
• Protected
Readonly
parser: ArgumentStream
Defined in
projects/framework/src/lib/parsers/Args.ts:49
states
• Private
Readonly
states: State
[] = []
Defined in
projects/framework/src/lib/parsers/Args.ts:56
Accessors
finished
• get
finished(): boolean
Returns
boolean
Defined in
projects/framework/src/lib/parsers/Args.ts:708
Methods
getFlags
▸ getFlags(...keys
): boolean
Parameters
Name | Type | Description |
---|---|---|
...keys | readonly string [] |
Returns
boolean
Defined in
projects/framework/src/lib/parsers/Args.ts:598
getOption
▸ getOption(...keys
): null
| string
Parameters
Name | Type | Description |
---|---|---|
...keys | readonly string [] |
Returns
null
| string
Defined in
projects/framework/src/lib/parsers/Args.ts:641
getOptionResult
▸ getOptionResult(...keys
): Option
<string
>
Parameters
Name | Type | Description |
---|---|---|
...keys | readonly string [] |
Returns
Option
<string
>
Defined in
projects/framework/src/lib/parsers/Args.ts:620
getOptions
▸ getOptions(...keys
): null
| readonly string
[]
Parameters
Name | Type | Description |
---|---|---|
...keys | readonly string [] |
Returns
null
| readonly string
[]
Defined in
projects/framework/src/lib/parsers/Args.ts:685
getOptionsResult
▸ getOptionsResult(...keys
): Option
<readonly string
[]>
Parameters
Name | Type | Description |
---|---|---|
...keys | readonly string [] |
Returns
Option
<readonly string
[]>
Defined in
projects/framework/src/lib/parsers/Args.ts:664
missingArguments
▸ Protected
missingArguments(): Err
<UserError
>
Returns
Err
<UserError
>
Defined in
projects/framework/src/lib/parsers/Args.ts:730
next
▸ next(): string
Returns
string
Defined in
projects/framework/src/lib/parsers/Args.ts:559
▸ next<T
>(cb
): T
Type parameters
Name | Description |
---|---|
T | - |
Parameters
Name | Type | Description |
---|---|---|
cb | ArgsNextCallback <T > |
Returns
T
Defined in
projects/framework/src/lib/parsers/Args.ts:576
nextMaybe
▸ nextMaybe(): Option
<string
>
Returns
Option
<string
>
Defined in
projects/framework/src/lib/parsers/Args.ts:526
▸ nextMaybe<T
>(cb
): Option
<T
>
Type parameters
Name | Description |
---|---|
T | - |
Parameters
Name | Type | Description |
---|---|---|
cb | ArgsNextCallback <T > |
Returns
Option
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:544
peek
▸ peek<T
>(type
): Promise
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | () => Result <T > |
Returns
Promise
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:464
▸ peek<T
>(type
, options?
): Promise
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | ArgOptions |
Returns
Promise
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:493
▸ peek<K
>(type
, options?
): Promise
<ArgType
[K
]>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | () => Result <ArgType [K ]> | |
options? | ArgOptions |
Returns
Promise
<ArgType
[K
]>
Defined in
projects/framework/src/lib/parsers/Args.ts:510
peekResult
▸ peekResult<T
>(type
): Promise
<ResultType
<T
>>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | () => Result <T > |
Returns
Promise
<ResultType
<T
>>
Defined in
projects/framework/src/lib/parsers/Args.ts:386
▸ peekResult<T
>(type
, options?
): Promise
<ResultType
<T
>>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | ArgOptions |
Returns
Promise
<ResultType
<T
>>
Defined in
projects/framework/src/lib/parsers/Args.ts:406
▸ peekResult<K
>(type
, options?
): Promise
<ResultType
<ArgType
[K
]>>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | () => Awaitable <Result <ArgType [K ]>> | |
options? | ArgOptions |
Returns
Promise
<ResultType
<ArgType
[K
]>>
Defined in
projects/framework/src/lib/parsers/Args.ts:428
pick
▸ pick<T
>(type
, options?
): Promise
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | ArgOptions |
Returns
Promise
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:158
▸ pick<K
>(type
, options?
): Promise
<ArgType
[K
]>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | |
options? | ArgOptions |
Returns
Promise
<ArgType
[K
]>
Defined in
projects/framework/src/lib/parsers/Args.ts:172
pickResult
▸ pickResult<T
>(type
, options?
): Promise
<ResultType
<T
>>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | ArgOptions |
Returns
Promise
<ResultType
<T
>>
Defined in
projects/framework/src/lib/parsers/Args.ts:96
▸ pickResult<K
>(type
, options?
): Promise
<ResultType
<ArgType
[K
]>>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | |
options? | ArgOptions |
Returns
Promise
<ResultType
<ArgType
[K
]>>
Defined in
projects/framework/src/lib/parsers/Args.ts:114
repeat
▸ repeat<T
>(type
, options?
): Promise
<T
[]>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | RepeatArgOptions |
Returns
Promise
<T
[]>
Defined in
projects/framework/src/lib/parsers/Args.ts:345
▸ repeat<K
>(type
, options?
): Promise
<ArgType
[K
][]>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | |
options? | RepeatArgOptions |
Returns
Promise
<ArgType
[K
][]>
Defined in
projects/framework/src/lib/parsers/Args.ts:358
repeatResult
▸ repeatResult<T
>(type
, options?
): Promise
<ArrayResultType
<T
>>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | RepeatArgOptions |
Returns
Promise
<ArrayResultType
<T
>>
Defined in
projects/framework/src/lib/parsers/Args.ts:280
▸ repeatResult<K
>(type
, options?
): Promise
<ArrayResultType
<ArgType
[K
]>>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | |
options? | RepeatArgOptions |
Returns
Promise
<ArrayResultType
<ArgType
[K
]>>
Defined in
projects/framework/src/lib/parsers/Args.ts:295
resolveArgument
▸ Private
resolveArgument<T
>(arg
): undefined
| IArgument
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
arg | keyof ArgType | IArgument <T > |
Returns
undefined
| IArgument
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:738
rest
▸ rest<T
>(type
, options?
): Promise
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | ArgOptions |
Returns
Promise
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:245
▸ rest<K
>(type
, options?
): Promise
<ArgType
[K
]>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | |
options? | ArgOptions |
Returns
Promise
<ArgType
[K
]>
Defined in
projects/framework/src/lib/parsers/Args.ts:259
restResult
▸ restResult<T
>(type
, options?
): Promise
<ResultType
<T
>>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
type | IArgument <T > | |
options? | ArgOptions |
Returns
Promise
<ResultType
<T
>>
Defined in
projects/framework/src/lib/parsers/Args.ts:194
▸ restResult<K
>(type
, options?
): Promise
<ResultType
<ArgType
[K
]>>
Type parameters
Name | Type |
---|---|
K | extends keyof ArgType |
Parameters
Name | Type | Description |
---|---|---|
type | K | |
options? | ArgOptions |
Returns
Promise
<ResultType
<ArgType
[K
]>>
Defined in
projects/framework/src/lib/parsers/Args.ts:212
restore
▸ restore(): void
Returns
void
Defined in
projects/framework/src/lib/parsers/Args.ts:701
save
▸ save(): void
Returns
void
Defined in
projects/framework/src/lib/parsers/Args.ts:693
start
▸ start(): Args
Returns
Defined in
projects/framework/src/lib/parsers/Args.ts:68
toJSON
▸ toJSON(): ArgsJson
Returns
Defined in
projects/framework/src/lib/parsers/Args.ts:715
unavailableArgument
▸ Protected
unavailableArgument<T
>(type
): Err
<UserError
>
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
type | string | IArgument <T > |
Returns
Err
<UserError
>
Defined in
projects/framework/src/lib/parsers/Args.ts:719
error
▸ Static
error<T
>(options
): Err
<ArgumentError
<T
>>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
options | Options <T > |
Returns
Err
<ArgumentError
<T
>>
Defined in
projects/framework/src/lib/parsers/Args.ts:764
make
▸ Static
make<T
>(cb
, name?
): IArgument
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
cb | (parameter : string , context : Context <T >) => AwaitableResult <T > | undefined | |
name | string | '' |
Returns
IArgument
<T
>
Defined in
projects/framework/src/lib/parsers/Args.ts:748
ok
▸ Static
ok<T
>(value
): Ok
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
value | T |
Returns
Ok
<T
>