mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
5e6bd4b3d7
* build: bump dependencies * fix: guide build * build: amend package.json.hbs * build: create-discord-bot * style: formatting * build: final change --------- Co-authored-by: almeidx <github@almeidx.dev>
88 lines
2.5 KiB
TypeScript
88 lines
2.5 KiB
TypeScript
import type { JSONEncodable } from '@discordjs/util';
|
|
import type {
|
|
ApplicationIntegrationType,
|
|
InteractionContextType,
|
|
Permissions,
|
|
RESTPostAPIApplicationCommandsJSONBody,
|
|
} from 'discord-api-types/v10';
|
|
import type { RestOrArray } from '../../util/normalizeArray.js';
|
|
import { normalizeArray } from '../../util/normalizeArray.js';
|
|
|
|
export interface CommandData extends Partial<
|
|
Pick<RESTPostAPIApplicationCommandsJSONBody, 'contexts' | 'default_member_permissions' | 'integration_types' | 'nsfw'>
|
|
> {}
|
|
|
|
/**
|
|
* The base class for all command builders.
|
|
*/
|
|
export abstract class CommandBuilder<
|
|
Command extends RESTPostAPIApplicationCommandsJSONBody,
|
|
> implements JSONEncodable<Command> {
|
|
/**
|
|
* The API data associated with this command.
|
|
*
|
|
* @internal
|
|
*/
|
|
declare protected readonly data: CommandData;
|
|
|
|
/**
|
|
* Sets the contexts of this command.
|
|
*
|
|
* @param contexts - The contexts
|
|
*/
|
|
public setContexts(...contexts: RestOrArray<InteractionContextType>) {
|
|
this.data.contexts = normalizeArray(contexts);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the integration types of this command.
|
|
*
|
|
* @param integrationTypes - The integration types
|
|
*/
|
|
public setIntegrationTypes(...integrationTypes: RestOrArray<ApplicationIntegrationType>) {
|
|
this.data.integration_types = normalizeArray(integrationTypes);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the default permissions a member should have in order to run the command.
|
|
*
|
|
* @remarks
|
|
* You can set this to `'0'` to disable the command by default.
|
|
* @param permissions - The permissions bit field to set
|
|
* @see {@link https://discord.com/developers/docs/interactions/application-commands#permissions}
|
|
*/
|
|
public setDefaultMemberPermissions(permissions: Permissions | bigint | number) {
|
|
this.data.default_member_permissions = typeof permissions === 'string' ? permissions : permissions.toString();
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Clears the default permissions a member should have in order to run the command.
|
|
*/
|
|
public clearDefaultMemberPermissions() {
|
|
this.data.default_member_permissions = undefined;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets whether this command is NSFW.
|
|
*
|
|
* @param nsfw - Whether this command is NSFW
|
|
*/
|
|
public setNSFW(nsfw = true) {
|
|
this.data.nsfw = nsfw;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Serializes this builder to API-compatible JSON data.
|
|
*
|
|
* Note that by disabling validation, there is no guarantee that the resulting object will be valid.
|
|
*
|
|
* @param validationOverride - Force validation to run/not run regardless of your global preference
|
|
*/
|
|
public abstract toJSON(validationOverride?: boolean): Command;
|
|
}
|