commandbot/dist/cjs/src/structures/CommandPermissions.d.ts

A framework that helps you create your own Discord bot easier.

import { Interaction, Permissions, Message, PermissionResolvable } from "discord.js";
import { PermissionCommand } from "../commands/base/PermissionCommand.js";
/**
 * Permission checking methods
 *
 * ALL - uses [*Permissions.prototype.has*](https://discord.js.org/#/docs/main/stable/class/Permissions?scrollTo=has) method
 *
 * ANY - uses [*Permissions.prototype.any*](https://discord.js.org/#/docs/main/stable/class/Permissions?scrollTo=any) method
 * @type
 */
export declare type PermissionCheckTypes = "ALL" | "ANY";
/**
 * Definition of permission function
 * @type
 */
export declare type PermissionFunction = (i: Interaction | Message) => boolean;
/**
 * Command permissions initialization object
 * @interface
 */
export interface CommandPermissionsInit {
    /**
     * Resolvable (Discord.js permission resolvables) or custom function that returns *boolean* value
     * @type {?PermissionResolvable | PermissionFunction}
     */
    resolvable?: PermissionResolvable | PermissionFunction;
    /**
     * Whether to check if the caller has all defined permissions or at least one of them (applies only if the command uses Discord.js permission system)
     * @type {?PermissionCheckTypes}
     */
    checkType?: PermissionCheckTypes;
}
/**
 * Object that stores permission resolvables and properties (bouund to a {@link PermissionCommand})
 * @class
 */
export declare class CommandPermissions {
    /**
     * Command bound to this object
     * @type {PermissionCommand}
     * @public
     * @readonly
     */
    readonly command: PermissionCommand;
    /**
     * If set to "ALL", the command can only be used when all specified conditions are met. (works only for Discord.js permissions object)
     * @type {PermissionCheckTypes}
     * @public
     * @readonly
     */
    readonly permissions: Permissions | PermissionFunction;
    /**
     * Command permissions
     * @type {Permissions | PermissionFunction}
     * @public
     * @readonly
     */
    readonly checkType: PermissionCheckTypes;
    /**
     * @constructor
     * @param {PermissionCommand} command - command attached to this permissions object
     * @param {?CommandPermissionsInit} [o] - initialization options
     */
    constructor(command: PermissionCommand, o?: CommandPermissionsInit);
    /**
     * Whether this object uses custom function to check permissions
     * @type {boolean}
     */
    get isCustom(): boolean;
    /**
     * Permission bitfield
     * @type {BigInt}
     */
    get bitfield(): BigInt;
    /**
     * Checks if the interaction sender is permitted to use the command attached to this object
     * @param {Interaction | Message} i - command interaction or Discord message
     * @returns {boolean} Whether a sender can use the command bound to this object
     * @public
     */
    check(i: Interaction | Message): boolean;
}