MessageCommandFlagValueManager

class

MessageCommandFlagValueManager

source
export class MessageCommandFlagValueManager
export class MessageCommandFlagValueManager
constructor(client: Client, options: MessageCommandFlagValueManager.Options)
constructor(client: Client, options: MessageCommandFlagValueManager.Options)
ParamTypeRequired
client
client
Client
Client
Yes
options
options
MessageCommandFlagValueManager.Options
MessageCommandFlagValueManager.Options
Yes
public source

.getFlag(...)

getFlag<T>(name: string): MessageCommandFlag<T>|null
getFlag<T>(name: string): MessageCommandFlag<T>|null
ParamTypeRequired
name
name
string
string
Yes

Returns:

MessageCommandFlag<T>|null
MessageCommandFlag<T>|null

getFlagValues<ReturnType extends "string"|"boolean", Returns>(name: string, options?: { type: ReturnType; required: boolean; }): Returns|null
getFlagValues<ReturnType extends "string"|"boolean", Returns>(name: string, options?: { type: ReturnType; required: boolean; }): Returns|null
ParamTypeRequired
name
name
string
string
Yes
options
options
{ type: ReturnType; required: boolean; }
{ type: ReturnType; required: boolean; }
No

Returns:

Returns|null
Returns|null

public async source

.getFlagResolvedValues(...)

getFlagResolvedValues<T>(name: string, required?: boolean): Promise<T[]|null>
getFlagResolvedValues<T>(name: string, required?: boolean): Promise<T[]|null>
ParamTypeRequired
name
name
string
string
Yes
required
required
boolean
boolean
No

Returns:

Promise<T[]|null>
Promise<T[]|null>

public async source

.getInvalidFlags()

getInvalidFlags(): Promise<MessageCommandFlagValueManager.ValidateData[]>
getInvalidFlags(): Promise<MessageCommandFlagValueManager.ValidateData[]>

Returns:

Promise<MessageCommandFlagValueManager.ValidateData[]>
Promise<MessageCommandFlagValueManager.ValidateData[]>

public async source

.validateFlag(...)

validateFlag<T>(flag: MessageCommandFlag<T>, values: string[]|boolean[]|null): Promise<MessageCommandFlagValueManager.ValidateData<T>>
validateFlag<T>(flag: MessageCommandFlag<T>, values: string[]|boolean[]|null): Promise<MessageCommandFlagValueManager.ValidateData<T>>
ParamTypeRequired
flag
flag
MessageCommandFlag<T>
MessageCommandFlag<T>
Yes
values
values
string[]|boolean[]|null
string[]|boolean[]|null
Yes

Returns:

Promise<MessageCommandFlagValueManager.ValidateData<T>>
Promise<MessageCommandFlagValueManager.ValidateData<T>>

public source

.flags

Collection<string, MessageCommandFlag<any>>
Collection<string, MessageCommandFlag<any>>
MessageCommand
MessageCommand
Message
Message
MessageCommandParser
MessageCommandParser