Interface: IPreconditionCondition
Defines the condition for PreconditionContainerArrays to run.
since 1.0.0
Methods​
chatInputParallel​
â–¸ chatInputParallel(interaction, command, entries, context): PreconditionContainerReturn
Runs all the containers using Promise.all, then checks the results once all tasks finished running.
seealso {@link PreconditionRunMode.parallel}
since 3.0.0
Parameters​
| Name | Type | Description |
|---|---|---|
interaction | CommandInteraction<CacheType> | The interaction that ran this precondition. |
command | ChatInputCommand | The command the interaction invoked. |
entries | readonly IPreconditionContainer[] | The containers to run. |
context | PreconditionContext | - |
Returns​
Defined in​
projects/framework/src/lib/utils/preconditions/conditions/IPreconditionCondition.ts:64
chatInputSequential​
â–¸ chatInputSequential(interaction, command, entries, context): PreconditionContainerReturn
Runs the containers one by one.
seealso {@link PreconditionRunMode.sequential}
since 3.0.0
Parameters​
| Name | Type | Description |
|---|---|---|
interaction | CommandInteraction<CacheType> | The interaction that ran this precondition. |
command | ChatInputCommand | The command the interaction invoked. |
entries | readonly IPreconditionContainer[] | The containers to run. |
context | PreconditionContext | - |
Returns​
Defined in​
projects/framework/src/lib/utils/preconditions/conditions/IPreconditionCondition.ts:49
contextMenuParallel​
â–¸ contextMenuParallel(interaction, command, entries, context): PreconditionContainerReturn
Runs all the containers using Promise.all, then checks the results once all tasks finished running.
seealso {@link PreconditionRunMode.parallel}
since 3.0.0
Parameters​
| Name | Type | Description |
|---|---|---|
interaction | ContextMenuInteraction<CacheType> | The interaction that ran this precondition. |
command | ContextMenuCommand | The command the interaction invoked. |
entries | readonly IPreconditionContainer[] | The containers to run. |
context | PreconditionContext | - |
Returns​
Defined in​
projects/framework/src/lib/utils/preconditions/conditions/IPreconditionCondition.ts:94
contextMenuSequential​
â–¸ contextMenuSequential(interaction, command, entries, context): PreconditionContainerReturn
Runs the containers one by one.
seealso {@link PreconditionRunMode.sequential}
since 3.0.0
Parameters​
| Name | Type | Description |
|---|---|---|
interaction | ContextMenuInteraction<CacheType> | The interaction that ran this precondition. |
command | ContextMenuCommand | The command the interaction invoked. |
entries | readonly IPreconditionContainer[] | The containers to run. |
context | PreconditionContext | - |
Returns​
Defined in​
projects/framework/src/lib/utils/preconditions/conditions/IPreconditionCondition.ts:79
messageParallel​
â–¸ messageParallel(message, command, entries, context): PreconditionContainerReturn
Runs all the containers using Promise.all, then checks the results once all tasks finished running.
seealso {@link PreconditionRunMode.parallel}
since 1.0.0
Parameters​
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message that ran this precondition. |
command | MessageCommand | The command the message invoked. |
entries | readonly IPreconditionContainer[] | The containers to run. |
context | PreconditionContext | - |
Returns​
Defined in​
projects/framework/src/lib/utils/preconditions/conditions/IPreconditionCondition.ts:34
messageSequential​
â–¸ messageSequential(message, command, entries, context): PreconditionContainerReturn
Runs the containers one by one.
seealso {@link PreconditionRunMode.sequential}
since 1.0.0
Parameters​
| Name | Type | Description |
|---|---|---|
message | Message<boolean> | The message that ran this precondition. |
command | MessageCommand | The command the message invoked. |
entries | readonly IPreconditionContainer[] | The containers to run. |
context | PreconditionContext | - |
Returns​
Defined in​
projects/framework/src/lib/utils/preconditions/conditions/IPreconditionCondition.ts:19