chapterjs 0.1.2 → 0.1.4

package/dist/discord/types/user.d.ts

@@ -0,0 +1,273 @@
+import type { ImageData, Locale, Snowflake } from './common.js';
+import type { RawIntegration } from './guild.js';
+/**
+ * User Structure
+ * @see https://docs.discord.com/developers/resources/user#user-object-user-structure
+ */
+export interface RawUser {
+    /** the user's id */
+    id: Snowflake;
+    /** the user's username, not unique across the platform */
+    username: string;
+    /** the user's Discord-tag */
+    discriminator: string;
+    /** the user's display name, if it is set */
+    global_name: string | null;
+    /** the user's avatar hash */
+    avatar: string | null;
+    /** whether the user belongs to an OAuth2 application */
+    bot?: boolean;
+    /** whether the user is an Official Discord System user (part of the urgent message system) */
+    system?: boolean;
+    /** whether the user has two factor enabled on their account */
+    mfa_enabled?: boolean;
+    /** the user's banner hash */
+    banner?: string | null;
+    /** the user's banner color encoded as an integer representation of hexadecimal color code */
+    accent_color?: number | null;
+    /** the user's chosen language option */
+    locale?: Locale;
+    /** whether the email on this account has been verified */
+    verified?: boolean;
+    /** the user's email */
+    email?: string | null;
+    /** the flags on a user's account */
+    flags?: number;
+    /** the type of Nitro subscription on a user's account */
+    premium_type?: UserPremiumType;
+    /** the public flags on a user's account */
+    public_flags?: number;
+    /** data for the user's avatar decoration */
+    avatar_decoration_data?: RawAvatarDecorationData | null;
+    /** data for the user's collectibles */
+    collectibles?: RawCollectibles | null;
+    /** the user's primary guild */
+    primary_guild?: RawUserPrimaryGuild | null;
+}
+/**
+ * User Flags
+ * @see https://docs.discord.com/developers/resources/user#user-object-user-flags
+ */
+export declare const UserFlags: {
+    /** Discord Employee */
+    readonly Staff: number;
+    /** Partnered Server Owner */
+    readonly Partner: number;
+    /** HypeSquad Events Member */
+    readonly Hypesquad: number;
+    /** Bug Hunter Level 1 */
+    readonly BugHunterLevel1: number;
+    /** House Bravery Member */
+    readonly HypesquadOnlineHouse1: number;
+    /** House Brilliance Member */
+    readonly HypesquadOnlineHouse2: number;
+    /** House Balance Member */
+    readonly HypesquadOnlineHouse3: number;
+    /** Early Nitro Supporter */
+    readonly PremiumEarlySupporter: number;
+    /** User is a team */
+    readonly TeamPseudoUser: number;
+    /** Bug Hunter Level 2 */
+    readonly BugHunterLevel2: number;
+    /** Verified Bot */
+    readonly VerifiedBot: number;
+    /** Early Verified Bot Developer */
+    readonly VerifiedDeveloper: number;
+    /** Moderator Programs Alumni */
+    readonly CertifiedModerator: number;
+    /** Bot uses only HTTP interactions and is shown in the online member list */
+    readonly BotHttpInteractions: number;
+};
+export type UserFlags = (typeof UserFlags)[keyof typeof UserFlags];
+/**
+ * Premium Types
+ * @see https://docs.discord.com/developers/resources/user#user-object-premium-types
+ */
+export declare const UserPremiumType: {
+    readonly None: 0;
+    readonly NitroClassic: 1;
+    readonly Nitro: 2;
+    readonly NitroBasic: 3;
+};
+export type UserPremiumType = (typeof UserPremiumType)[keyof typeof UserPremiumType];
+/**
+ * User Primary Guild
+ * @see https://docs.discord.com/developers/resources/user#user-object-user-primary-guild
+ */
+export interface RawUserPrimaryGuild {
+    /** the id of the user's primary guild */
+    identity_guild_id: Snowflake | null;
+    /** whether the user is displaying the primary guild's server tag. This can be `null` if the system clears the identity, e.g. the server no longer supports tags. This will be `false` if the user manually removes their tag. */
+    identity_enabled: boolean | null;
+    /** the text of the user's server tag. Limited to 4 characters */
+    tag: string | null;
+    /** the server tag badge hash */
+    badge: string | null;
+}
+/**
+ * Avatar Decoration Data Structure
+ * @see https://docs.discord.com/developers/resources/user#avatar-decoration-data-object-avatar-decoration-data-structure
+ */
+export interface RawAvatarDecorationData {
+    /** the avatar decoration hash */
+    asset: string;
+    /** id of the avatar decoration's SKU */
+    sku_id: Snowflake;
+}
+/**
+ * Collectible Structure
+ * @see https://docs.discord.com/developers/resources/user#collectibles-collectible-structure
+ */
+export interface RawCollectibles {
+    /** object mapping of nameplate data */
+    nameplate?: RawNameplate;
+}
+/**
+ * Nameplate Structure
+ * @see https://docs.discord.com/developers/resources/user#nameplate-nameplate-structure
+ */
+export interface RawNameplate {
+    /** id of the nameplate SKU */
+    sku_id: Snowflake;
+    /** path to the nameplate asset */
+    asset: string;
+    /** the label of this nameplate. Currently unused */
+    label: string;
+    /** background color of the nameplate, one of: `crimson`, `berry`, `sky`, `teal`, `forest`, `bubble_gum`, `violet`, `cobalt`, `clover`, `lemon`, `white` */
+    palette: string;
+}
+/**
+ * Connection Structure
+ * @see https://docs.discord.com/developers/resources/user#connection-object-connection-structure
+ */
+export interface RawConnection {
+    /** id of the connection account */
+    id: string;
+    /** the username of the connection account */
+    name: string;
+    /** the service of this connection */
+    type: ConnectionService;
+    /** whether the connection is revoked */
+    revoked?: boolean;
+    /** an array of partial server integrations */
+    integrations?: Partial<RawIntegration>[];
+    /** whether the connection is verified */
+    verified: boolean;
+    /** whether friend sync is enabled for this connection */
+    friend_sync: boolean;
+    /** whether activities related to this connection will be shown in presence updates */
+    show_activity: boolean;
+    /** whether this connection has a corresponding third party OAuth2 token */
+    two_way_link: boolean;
+    /** visibility of this connection */
+    visibility: ConnectionVisibilityType;
+}
+/**
+ * Services
+ * @see https://docs.discord.com/developers/resources/user#connection-object-services
+ */
+export declare const ConnectionService: {
+    readonly AmazonMusic: 'amazon-music';
+    readonly BungieNet: 'bungie';
+    readonly Bluesky: 'bluesky';
+    readonly Crunchyroll: 'crunchyroll';
+    readonly Domain: 'domain';
+    readonly EBay: 'ebay';
+    readonly EpicGames: 'epicgames';
+    readonly Facebook: 'facebook';
+    readonly GitHub: 'github';
+    readonly Instagram: 'instagram';
+    readonly Mastodon: 'mastodon';
+    readonly PayPal: 'paypal';
+    readonly PlayStationNetwork: 'playstation';
+    readonly Reddit: 'reddit';
+    readonly Roblox: 'roblox';
+    readonly Spotify: 'spotify';
+    readonly Skype: 'skype';
+    readonly Steam: 'steam';
+    readonly TikTok: 'tiktok';
+    readonly Twitch: 'twitch';
+    readonly XTwitter: 'twitter';
+    readonly Xbox: 'xbox';
+    readonly YouTube: 'youtube';
+};
+export type ConnectionService = (typeof ConnectionService)[keyof typeof ConnectionService];
+/**
+ * Visibility Types
+ * @see https://docs.discord.com/developers/resources/user#connection-object-visibility-types
+ */
+export declare const ConnectionVisibilityType: {
+    /** invisible to everyone except the user themselves */
+    readonly None: 0;
+    /** visible to everyone */
+    readonly Everyone: 1;
+};
+export type ConnectionVisibilityType = (typeof ConnectionVisibilityType)[keyof typeof ConnectionVisibilityType];
+/**
+ * Application Role Connection Structure
+ * @see https://docs.discord.com/developers/resources/user#application-role-connection-object-application-role-connection-structure
+ */
+export interface RawApplicationRoleConnection {
+    /** the vanity name of the platform a bot has connected (max 50 characters) */
+    platform_name: string | null;
+    /** object mapping application role connection metadata keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected */
+    metadata: Record<string, string>;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/user#modify-current-user-json-params
+ */
+export interface ModifyCurrentUserJSONParams {
+    /** user's username, if changed may cause the user's discriminator to be randomized. */
+    username?: string;
+    /** if passed, modifies the user's avatar */
+    avatar?: ImageData | null;
+    /** if passed, modifies the user's banner */
+    banner?: ImageData | null;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/user#get-current-user-guilds-query-string-params
+ */
+export interface GetCurrentUserGuildsQuery {
+    /** get guilds before this guild ID */
+    before?: Snowflake;
+    /** get guilds after this guild ID */
+    after?: Snowflake;
+    /** max number of guilds to return (1-200) */
+    limit?: number;
+    /** only return guilds in this shard (`0` to `max_concurrency - 1`) */
+    shard?: number;
+    /** include approximate member and presence counts in response */
+    with_counts?: boolean;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/user#create-dm-json-params
+ */
+export interface CreateDmJSONParams {
+    /** the recipient to open a DM channel with */
+    recipient_id: Snowflake;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/user#create-group-dm-json-params
+ */
+export interface CreateGroupDmJSONParams {
+    /** access tokens of users that have granted your app the `gdm.join` scope */
+    access_tokens: string[];
+    /** a dictionary of user ids to their respective nicknames */
+    nicks: Record<Snowflake, string>;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/user#update-current-user-application-role-connection-json-params
+ */
+export interface UpdateCurrentUserApplicationRoleConnectionJSONParams {
+    /** the vanity name of the platform a bot has connected (max 50 characters) */
+    platform_name?: string;
+    /** the username on the platform a bot has connected (max 100 characters) */
+    platform_username?: string;
+    /** object mapping application role connection metadata keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected */
+    metadata?: Record<string, string>;
+}

package/dist/discord/types/user.js

@@ -0,0 +1,83 @@
+/**
+ * User Flags
+ * @see https://docs.discord.com/developers/resources/user#user-object-user-flags
+ */
+export const UserFlags = {
+    /** Discord Employee */
+    Staff: 1 << 0,
+    /** Partnered Server Owner */
+    Partner: 1 << 1,
+    /** HypeSquad Events Member */
+    Hypesquad: 1 << 2,
+    /** Bug Hunter Level 1 */
+    BugHunterLevel1: 1 << 3,
+    /** House Bravery Member */
+    HypesquadOnlineHouse1: 1 << 6,
+    /** House Brilliance Member */
+    HypesquadOnlineHouse2: 1 << 7,
+    /** House Balance Member */
+    HypesquadOnlineHouse3: 1 << 8,
+    /** Early Nitro Supporter */
+    PremiumEarlySupporter: 1 << 9,
+    /** User is a team */
+    TeamPseudoUser: 1 << 10,
+    /** Bug Hunter Level 2 */
+    BugHunterLevel2: 1 << 14,
+    /** Verified Bot */
+    VerifiedBot: 1 << 16,
+    /** Early Verified Bot Developer */
+    VerifiedDeveloper: 1 << 17,
+    /** Moderator Programs Alumni */
+    CertifiedModerator: 1 << 18,
+    /** Bot uses only HTTP interactions and is shown in the online member list */
+    BotHttpInteractions: 1 << 19,
+};
+/**
+ * Premium Types
+ * @see https://docs.discord.com/developers/resources/user#user-object-premium-types
+ */
+export const UserPremiumType = {
+    None: 0,
+    NitroClassic: 1,
+    Nitro: 2,
+    NitroBasic: 3,
+};
+/**
+ * Services
+ * @see https://docs.discord.com/developers/resources/user#connection-object-services
+ */
+export const ConnectionService = {
+    AmazonMusic: 'amazon-music',
+    BungieNet: 'bungie',
+    Bluesky: 'bluesky',
+    Crunchyroll: 'crunchyroll',
+    Domain: 'domain',
+    EBay: 'ebay',
+    EpicGames: 'epicgames',
+    Facebook: 'facebook',
+    GitHub: 'github',
+    Instagram: 'instagram',
+    Mastodon: 'mastodon',
+    PayPal: 'paypal',
+    PlayStationNetwork: 'playstation',
+    Reddit: 'reddit',
+    Roblox: 'roblox',
+    Spotify: 'spotify',
+    Skype: 'skype',
+    Steam: 'steam',
+    TikTok: 'tiktok',
+    Twitch: 'twitch',
+    XTwitter: 'twitter',
+    Xbox: 'xbox',
+    YouTube: 'youtube',
+};
+/**
+ * Visibility Types
+ * @see https://docs.discord.com/developers/resources/user#connection-object-visibility-types
+ */
+export const ConnectionVisibilityType = {
+    /** invisible to everyone except the user themselves */
+    None: 0,
+    /** visible to everyone */
+    Everyone: 1,
+};

package/dist/discord/types/voice.d.ts

@@ -0,0 +1,72 @@
+import type { ISO8601Timestamp, Snowflake } from './common.js';
+import type { RawGuildMember } from './guild.js';
+/**
+ * Voice State Structure
+ * @see https://docs.discord.com/developers/resources/voice#voice-state-object-voice-state-structure
+ */
+export interface RawVoiceState {
+    /** the guild id this voice state is for */
+    guild_id?: Snowflake;
+    /** the channel id this user is connected to */
+    channel_id: Snowflake | null;
+    /** the user id this voice state is for */
+    user_id: Snowflake;
+    /** the guild member this voice state is for */
+    member?: RawGuildMember;
+    /** the session id for this voice state */
+    session_id: string;
+    /** whether this user is deafened by the server */
+    deaf: boolean;
+    /** whether this user is muted by the server */
+    mute: boolean;
+    /** whether this user is locally deafened */
+    self_deaf: boolean;
+    /** whether this user is locally muted */
+    self_mute: boolean;
+    /** whether this user is streaming using "Go Live" */
+    self_stream?: boolean;
+    /** whether this user's camera is enabled */
+    self_video: boolean;
+    /** whether this user's permission to speak is denied */
+    suppress: boolean;
+    /** the time at which the user requested to speak */
+    request_to_speak_timestamp: ISO8601Timestamp | null;
+}
+/**
+ * Voice Region Structure
+ * @see https://docs.discord.com/developers/resources/voice#voice-region-object-voice-region-structure
+ */
+export interface RawVoiceRegion {
+    /** unique ID for the region */
+    id: string;
+    /** name of the region */
+    name: string;
+    /** true for a single server that is closest to the current user's client */
+    optimal: boolean;
+    /** whether this is a deprecated voice region (avoid switching to these) */
+    deprecated: boolean;
+    /** whether this is a custom voice region (used for events/etc) */
+    custom: boolean;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/voice#modify-current-user-voice-state-json-params
+ */
+export interface ModifyCurrentUserVoiceStateJSONParams {
+    /** the id of the channel the user is currently in */
+    channel_id?: Snowflake;
+    /** toggles the user's suppress state */
+    suppress?: boolean;
+    /** sets the user's request to speak */
+    request_to_speak_timestamp?: ISO8601Timestamp | null;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/voice#modify-user-voice-state-json-params
+ */
+export interface ModifyUserVoiceStateJSONParams {
+    /** the id of the channel the user is currently in */
+    channel_id?: Snowflake;
+    /** toggles the user's suppress state */
+    suppress?: boolean;
+}

package/dist/discord/types/voice.js

@@ -0,0 +1 @@
+export {};

package/dist/discord/types/webhook.d.ts

@@ -0,0 +1,184 @@
+import type { RawChannel } from './channel.js';
+import type { ImageData, Snowflake } from './common.js';
+import type { RawComponent } from './component.js';
+import type { RawGuild } from './guild.js';
+import type { RawAllowedMentions, RawAttachmentRequest, RawEmbed } from './message.js';
+import type { RawPollCreateRequest } from './poll.js';
+import type { RawUser } from './user.js';
+/**
+ * Webhook Structure
+ * @see https://docs.discord.com/developers/resources/webhook#webhook-object-webhook-structure
+ */
+export interface RawWebhook {
+    /** the id of the webhook */
+    id: Snowflake;
+    /** the type of the webhook */
+    type: WebhookType;
+    /** the guild id this webhook is for, if any */
+    guild_id?: Snowflake | null;
+    /** the channel id this webhook is for, if any */
+    channel_id: Snowflake | null;
+    /** the user this webhook was created by (not returned when getting a webhook with its token) */
+    user?: RawUser;
+    /** the default name of the webhook */
+    name: string | null;
+    /** the default user avatar hash of the webhook */
+    avatar: string | null;
+    /** the secure token of the webhook (returned for Incoming Webhooks) */
+    token?: string;
+    /** the bot/OAuth2 application that created this webhook */
+    application_id: Snowflake | null;
+    /** the guild of the channel that this webhook is following (returned for Channel Follower Webhooks) */
+    source_guild?: Partial<RawGuild>;
+    /** the channel that this webhook is following (returned for Channel Follower Webhooks) */
+    source_channel?: Partial<RawChannel>;
+    /** the url used for executing the webhook (returned by the webhooks OAuth2 flow) */
+    url?: string;
+}
+/**
+ * Webhook Types
+ * @see https://docs.discord.com/developers/resources/webhook#webhook-object-webhook-types
+ */
+export declare const WebhookType: {
+    /** Incoming Webhooks can post messages to channels with a generated token */
+    readonly Incoming: 1;
+    /** Channel Follower Webhooks are internal webhooks used with Channel Following to post new messages into channels */
+    readonly ChannelFollower: 2;
+    /** Application webhooks are webhooks used with Interactions */
+    readonly Application: 3;
+};
+export type WebhookType = (typeof WebhookType)[keyof typeof WebhookType];
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/webhook#create-webhook-json-params
+ */
+export interface CreateWebhookJSONParams {
+    /** name of the webhook (1-80 characters) */
+    name: string;
+    /** image for the default webhook avatar */
+    avatar?: ImageData | null;
+}
+/**
+ * JSON Params
+ * @see https://docs.discord.com/developers/resources/webhook#modify-webhook-json-params
+ */
+export interface ModifyWebhookJSONParams {
+    /** the default name of the webhook */
+    name?: string;
+    /** image for the default webhook avatar */
+    avatar?: ImageData | null;
+    /** the new channel id this webhook should be moved to */
+    channel_id?: Snowflake;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/webhook#execute-webhook-query-string-params
+ */
+export interface ExecuteWebhookQuery {
+    /** waits for server confirmation of message send before response, and returns the created message body (defaults to `false`; when `false` a message that is not saved does not return an error) */
+    wait?: boolean;
+    /** Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived. */
+    thread_id?: Snowflake;
+    /** whether to respect the `components` field of the request. When enabled, allows application-owned webhooks to use all components and non-owned webhooks to use non-interactive components. (defaults to `false`) */
+    with_components?: boolean;
+}
+/**
+ * JSON/Form Params
+ * @see https://docs.discord.com/developers/resources/webhook#execute-webhook-json/form-params
+ */
+export interface ExecuteWebhookJSONParams {
+    /** the message contents (up to 2000 characters) */
+    content?: string;
+    /** override the default username of the webhook */
+    username?: string;
+    /** override the default avatar of the webhook */
+    avatar_url?: string;
+    /** true if this is a TTS message */
+    tts?: boolean;
+    /** embedded `rich` content */
+    embeds?: RawEmbed[];
+    /** allowed mentions for the message */
+    allowed_mentions?: RawAllowedMentions;
+    /** the components to include with the message */
+    components?: RawComponent[];
+    /** JSON encoded body of non-file params */
+    payload_json?: string;
+    /** metadata for the attachments */
+    attachments?: Partial<RawAttachmentRequest>[];
+    /** message flags combined as a bitfield (only `SUPPRESS_EMBEDS`, `SUPPRESS_NOTIFICATIONS` and `IS_COMPONENTS_V2` can be set) */
+    flags?: number;
+    /** name of thread to create (requires the webhook channel to be a forum or media channel) */
+    thread_name?: string;
+    /** array of tag ids to apply to the thread (requires the webhook channel to be a forum or media channel) */
+    applied_tags?: Snowflake[];
+    /** A poll! */
+    poll?: RawPollCreateRequest;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/webhook#execute-slackcompatible-webhook-query-string-params
+ */
+export interface ExecuteSlackCompatibleWebhookQuery {
+    /** id of the thread to send the message in */
+    thread_id?: Snowflake;
+    /** waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) */
+    wait?: boolean;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/webhook#execute-githubcompatible-webhook-query-string-params
+ */
+export interface ExecuteGitHubCompatibleWebhookQuery {
+    /** id of the thread to send the message in */
+    thread_id?: Snowflake;
+    /** waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) */
+    wait?: boolean;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/webhook#get-webhook-message-query-string-params
+ */
+export interface GetWebhookMessageQuery {
+    /** id of the thread the message is in */
+    thread_id?: Snowflake;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/webhook#edit-webhook-message-query-string-params
+ */
+export interface EditWebhookMessageQuery {
+    /** id of the thread the message is in */
+    thread_id?: Snowflake;
+    /** whether to respect the `components` field of the request. When enabled, allows application-owned webhooks to use all components and non-owned webhooks to use non-interactive components. (defaults to `false`) */
+    with_components?: boolean;
+}
+/**
+ * JSON/Form Params
+ * @see https://docs.discord.com/developers/resources/webhook#edit-webhook-message-json/form-params
+ */
+export interface EditWebhookMessageJSONParams {
+    /** the message contents (up to 2000 characters) */
+    content?: string;
+    /** embedded `rich` content */
+    embeds?: RawEmbed[];
+    /** message flags combined as a bitfield (`SUPPRESS_EMBEDS` and `IS_COMPONENTS_V2` only) */
+    flags?: number;
+    /** allowed mentions for the message */
+    allowed_mentions?: RawAllowedMentions;
+    /** the components to include with the message */
+    components?: RawComponent[];
+    /** JSON encoded body of non-file params (multipart/form-data only) */
+    payload_json?: string;
+    /** attached files to keep and their metadata */
+    attachments?: Partial<RawAttachmentRequest>[];
+    /** A poll! */
+    poll?: RawPollCreateRequest;
+}
+/**
+ * Query String Params
+ * @see https://docs.discord.com/developers/resources/webhook#delete-webhook-message-query-string-params
+ */
+export interface DeleteWebhookMessageQuery {
+    /** id of the thread the message is in */
+    thread_id?: Snowflake;
+}

package/dist/discord/types/webhook.js

@@ -0,0 +1,12 @@
+/**
+ * Webhook Types
+ * @see https://docs.discord.com/developers/resources/webhook#webhook-object-webhook-types
+ */
+export const WebhookType = {
+    /** Incoming Webhooks can post messages to channels with a generated token */
+    Incoming: 1,
+    /** Channel Follower Webhooks are internal webhooks used with Channel Following to post new messages into channels */
+    ChannelFollower: 2,
+    /** Application webhooks are webhooks used with Interactions */
+    Application: 3,
+};

package/dist/events/convention.d.ts

@@ -0,0 +1,25 @@
+import type { Convention } from '../loader/loader.js';
+import { type EventContexts, type EventName } from './registry.js';
+/** One reaction to an event: a file of `src/events/<event>/`. */
+export interface EventHandler<Name extends EventName = EventName> {
+    /** The event, which is the name of the folder the file is in. */
+    readonly name: Name;
+    readonly handler: (context: EventContexts[Name]) => unknown;
+    /** The options the file gave to `event()`, checked. */
+    readonly options: Readonly<Record<string, unknown>>;
+}
+/**
+ * `src/events/`: one folder per event, named after it, and in it one file
+ * per reaction. The name of a file is free; it exports by default what
+ * `event()` returns:
+ *
+ * ```ts
+ * // src/events/memberJoin/welcome.ts
+ * import { event } from 'chapterjs';
+ *
+ * export default event(async ({ member, guild }) => {
+ *   await member.send(`Welcome to ${guild.name}!`);
+ * });
+ * ```
+ */
+export declare const eventsConvention: Convention<EventHandler>;