BaseCommand

class

BaseCommand

source
export abstract class BaseCommand<T extends CommandType> implements BaseCommand.Data<T>
export abstract class BaseCommand<T extends CommandType> implements BaseCommand.Data<T>
constructor(data?: Partial<BaseCommand.Data<T>>)
constructor(data?: Partial<BaseCommand.Data<T>>)
ParamTypeRequired
data
data
Partial<BaseCommand.Data<T>>
Partial<BaseCommand.Data<T>>
No
public abstract source

.execute(...)

execute(data: AnyCommandExecuteData<T>): Promise<void>
execute(data: AnyCommandExecuteData<T>): Promise<void>
ParamTypeRequired
data
data
AnyCommandExecuteData<T>
AnyCommandExecuteData<T>
Yes

Returns:

Promise<void>
Promise<void>

public abstract source

.setCommand(...)

setCommand(data: AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>|(((builder: AnyCommandBuilder<T>)) => AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>)): this
setCommand(data: AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>|(((builder: AnyCommandBuilder<T>)) => AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>)): this
ParamTypeRequired
data
data
AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>|(((builder: AnyCommandBuilder<T>)) => AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>)
AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>|(((builder: AnyCommandBuilder<T>)) => AnyCommandBuilderData<T>|JSONEncodable<AnyCommandBuilderData<T>>)
Yes

Returns:

this
this

public source

.setCooldown(...)

setCooldown(cooldown: number): this
setCooldown(cooldown: number): this
ParamTypeRequired
cooldown
cooldown
number
number
Yes

Returns:

this
this

addPreconditions(...preconditions: RestOrArray<CommandPrecondition>): this
addPreconditions(...preconditions: RestOrArray<CommandPrecondition>): this
ParamTypeRequired
...preconditions
...preconditions
RestOrArray<CommandPrecondition>
RestOrArray<CommandPrecondition>
No

Returns:

this
this

setPreconditions(...preconditions: RestOrArray<CommandPrecondition>): this
setPreconditions(...preconditions: RestOrArray<CommandPrecondition>): this
ParamTypeRequired
...preconditions
...preconditions
RestOrArray<CommandPrecondition>
RestOrArray<CommandPrecondition>
No

Returns:

this
this

addPostconditions(...postconditions: RestOrArray<CommandPostcondition>): this
addPostconditions(...postconditions: RestOrArray<CommandPostcondition>): this
ParamTypeRequired
...postconditions
...postconditions
RestOrArray<CommandPostcondition>
RestOrArray<CommandPostcondition>
No

Returns:

this
this

setPostconditions(...postconditions: RestOrArray<CommandPostcondition>): this
setPostconditions(...postconditions: RestOrArray<CommandPostcondition>): this
ParamTypeRequired
...postconditions
...postconditions
RestOrArray<CommandPostcondition>
RestOrArray<CommandPostcondition>
No

Returns:

this
this

addDisabledPreconditions(...preconditions: RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>): this
addDisabledPreconditions(...preconditions: RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>): this
ParamTypeRequired
...preconditions
...preconditions
RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>
RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>
No

Returns:

this
this

setDisabledPreconditions(...preconditions: RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>): this
setDisabledPreconditions(...preconditions: RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>): this
ParamTypeRequired
...preconditions
...preconditions
RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>
RestOrArray<CommandPrecondition.Resolvable|CommandPrecondition.Resolvable["id"]>
No

Returns:

this
this

addDisabledPostconditions(...postconditions: RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>): this
addDisabledPostconditions(...postconditions: RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>): this
ParamTypeRequired
...postconditions
...postconditions
RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>
RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>
No

Returns:

this
this

setDisabledPostconditions(...postconditions: RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>): this
setDisabledPostconditions(...postconditions: RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>): this
ParamTypeRequired
...postconditions
...postconditions
RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>
RestOrArray<CommandPostcondition.Resolvable|CommandPostcondition.Resolvable["id"]>
No

Returns:

this
this

public source

.setExecute(...)

setExecute(execute: ((data: AnyCommandExecuteData<T>)) => Promise<void>): this
setExecute(execute: ((data: AnyCommandExecuteData<T>)) => Promise<void>): this
ParamTypeRequired
execute
execute
((data: AnyCommandExecuteData<T>)) => Promise<void>
((data: AnyCommandExecuteData<T>)) => Promise<void>
Yes

Returns:

this
this

public source

.toJSON()

toJSON(): BaseCommand.Data<T>
toJSON(): BaseCommand.Data<T>

Returns:

BaseCommand.Data<T>
BaseCommand.Data<T>

public source

.id

string
string
public abstract source

.type

T
T
public source

.data

AnyCommandBuilderData<T>
AnyCommandBuilderData<T>
number
number
CommandPrecondition<any>[]
CommandPrecondition<any>[]
CommandPostcondition<any>[]
CommandPostcondition<any>[]
string[]
string[]
string[]
string[]