forgescript/dist/structures/NativeFunction.d.ts

ForgeScript is a comprehensive package that empowers you to effortlessly interact with Discord's API. It ensures scripting remains easy to learn and consistently effective.

import { AttachmentBuilder, BaseChannel, Guild, GuildEmoji, GuildForumTag, GuildMember, Invite, Message, MessageReaction, PermissionsString, Role, Sticker, User, Webhook } from "discord.js";
import { CompiledFunction } from "./CompiledFunction";
import { Context } from "./Context";
import { Return } from "./Return";
export type EnumLike<T = any> = {
    [id: string]: T | string;
    [nu: number]: string;
};
export type GetEnum<T> = T extends EnumLike<infer P> ? P : never;
export declare enum ArgType {
    URL = 0,
    String = 1,
    BigInt = 2,
    Number = 3,
    User = 4,
    Date = 5,
    Guild = 6,
    Invite = 7,
    Permission = 8,
    Json = 9,
    Color = 10,
    Enum = 11,
    ForumTag = 12,
    GuildEmoji = 13,
    Boolean = 14,
    Attachment = 15,
    Reaction = 16,
    Message = 17,
    Channel = 18,
    Role = 19,
    Webhook = 20,
    GuildSticker = 21,
    Time = 22,
    Member = 23
}
export interface IArg<Type extends ArgType = ArgType, Required extends boolean = boolean, Rest extends boolean = boolean, Enum extends EnumLike = EnumLike> {
    name: string;
    description: string;
    type: Type;
    enum?: Enum;
    /**
     * Arg index to look at when a type requires a previously guild arg or depends on something.
     */
    pointer?: number;
    condition?: boolean;
    delimiter?: string;
    check?: (i: GetArgType<Type, Enum>) => boolean;
    /**
     * Defaults to false
     */
    required?: Required;
    /**
     * Whether this argument is an array of values
     */
    rest: Rest;
}
export type NativeFunctionExecutor<T extends [...IArg[]], Unwrap extends boolean = boolean> = Unwrap extends true ? (this: CompiledFunction<T, Unwrap>, ctx: Context, args: UnwrapArgs<T>) => Promise<Return> | Return : (this: CompiledFunction<T, Unwrap>, ctx: Context) => Promise<Return> | Return;
export interface INativeFunction<T extends [...IArg[]], Unwrap extends boolean = boolean> {
    name: string;
    description: string;
    examples?: string[];
    experimental?: boolean;
    /**
     * Resolves all arguments and are passed through execute params.
     */
    unwrap: Unwrap;
    args?: [...T];
    /**
     * Do not provide this.
     */
    version?: string;
    /**
     * If undefined, function has no brackets
     *
     * If false, function can have brackets.
     *
     * If true, function must have brackets.
     */
    brackets?: boolean;
    execute: NativeFunctionExecutor<T, Unwrap>;
}
export type MarkRest<T, B extends boolean> = B extends true ? T[] : T;
export type GetArgType<T extends ArgType, Enum extends EnumLike> = T extends ArgType.Number ? number : T extends ArgType.String ? string : T extends ArgType.User ? User : T extends ArgType.URL ? string : T extends ArgType.Json ? Record<string, unknown> : T extends ArgType.Guild ? Guild : T extends ArgType.Color ? number : T extends ArgType.Role ? Role : T extends ArgType.Attachment ? AttachmentBuilder : T extends ArgType.BigInt ? bigint : T extends ArgType.Boolean ? boolean : T extends ArgType.Date ? Date : T extends ArgType.Enum ? GetEnum<Enum> : T extends ArgType.Channel ? BaseChannel : T extends ArgType.Message ? Message<true> : T extends ArgType.Member ? GuildMember : T extends ArgType.GuildEmoji ? GuildEmoji : T extends ArgType.GuildSticker ? Sticker : T extends ArgType.Reaction ? MessageReaction : T extends ArgType.Webhook ? Webhook : T extends ArgType.Invite ? Invite : T extends ArgType.ForumTag ? GuildForumTag : T extends ArgType.Time ? number : T extends ArgType.Permission ? PermissionsString : null;
export type MarkNullable<T, Req extends boolean, Rest extends boolean = boolean> = Rest extends true ? T : Req extends true ? T : T | null;
export type UnwrapArg<T> = T extends IArg<infer Type, infer Required, infer Rest, infer Enum> ? MarkRest<MarkNullable<GetArgType<Type, Enum>, Required, Rest>, Rest> : never;
export type UnwrapArgs<T> = T extends [infer L, ...infer R] ? [UnwrapArg<L>, ...UnwrapArgs<R>] : [];
export declare class NativeFunction<T extends [...IArg[]] = IArg[], Unwrap extends boolean = boolean> {
    readonly data: INativeFunction<T, Unwrap>;
    readonly async: boolean;
    constructor(data: INativeFunction<T, Unwrap>);
    get name(): string;
}
//# sourceMappingURL=NativeFunction.d.ts.map