Skip to content
GitHub

Types

  • BuildableCommandType

    The command types registered with Discord, which take a builder: slash, context menu and entry point commands.

  • CallHandler

    Runs the rest of a call from inside an interceptor: the next interceptor, then the handler.

  • CatalogDefinition

    What defineCatalog takes: a catalog, checked as it is written.

  • CatalogShape

    A message catalog: messages, plurals, and nested groups of them, keyed by name.

  • CheckedParams

    The params a message handler declares, Declared, as @MessageHandler checks them against its pattern P.

  • CommandBuilderBase

    What a command builder implements: build, which describes the command to register.

  • CommandBuilderConstructor

    A command builder class, as @Command takes it.

  • CommandBuilderOptions

    Where a command @CommandBuilder describes is registered, in place of the configured scope.

  • CommandBuildResult

    What a builder's build() returns for its command type.

  • CommandInteractionType

    The interaction a @Command handler receives, from its builder or its CommandType.

  • CommandType

    The kind of interaction a @Command handles, such as a slash command or a button.

  • ControllerOptions

    How @Controller treats a class: whether the handlers it declares take the stages of the classes it extends.

  • CooldownBatchVerdict

    Whether a call may run against every cooldown it counts against, and if not, which refused it.

  • CooldownEntry

    One cooldown a call counts against: the key it counts under, and its limit.

  • CooldownLimit

    How many calls a cooldown allows, and in how long a window.

  • CooldownOptions

    What @Cooldown takes: the limit, whose calls count together, and how to exempt or tell calls apart.

  • CooldownScope

    The scope a cooldown counts calls in.

  • CooldownVerdict

    Whether a call may run, and if not, how long until one may.

  • DeepPartial

    T with every property optional, at every depth; arrays and tuples stay whole.

  • DeepReadonly

    T with every property readonly, at every depth; an array becomes a readonly one of readonly elements.

  • DeferOptions

    How @Defer acknowledges an interaction and locks a component's message.

  • DispatchObserver

    Observes every call MeoCord dispatches, as it starts and once it has settled, for metrics and audit logs.

  • DispatchOutcome

    How a dispatched call ended, as a DispatchObserver is told.

  • DispatchResult

    What a DispatchObserver is told about a call once it has settled.

  • EntityRef

    A member, user, role or channel a message command names, as its guards see it: not fetched yet.

  • ExceptionFilter

    What an exception filter implements: catch, which answers an error its @Catch names.

  • ExecutionContextType

    What an ExecutionContext is running a handler for: an interaction, an autocomplete, a message, a reaction or a gateway event.

  • GuardInterface

    What a guard implements: canActivate, which decides whether the handler runs.

  • GuardOptions

    What @Guard takes: the context types the guard runs for.

  • GuildThemeTarget

    What a per-server theme resolver is given: the server a call came from.

  • InferSchemaOutput

    The value a schema produces when validation succeeds: what a handler with @Validate(schema) receives.

  • Injected

    The values a factory receives for its inject list, in order, each what its token provides.

  • InstallContext

    Where an interaction happened, as getInstallContext reports it.

  • InterceptorInterface

    What an interceptor implements: intercept, which runs around the handler.

  • InterceptorOptions

    What @Interceptor takes: the context types the interceptor runs for.

  • Jsonified

    A value as it arrives after a trip through JSON: what toJSON returns, so a Date as a string; a Map or a Set as an empty object; a function, a symbol or undefined left out of an object, null in a list, and undefined on its own.

  • LocaleCatalog

    What a locale other than the default provides: any part of the default catalog, in its own wording.

  • LocalizationKey

    The keys Translator.localizations takes: a single string with no {params}, since Discord shows a command's name or description as written, with no plural forms.

  • MeoCordMessages

    MeoCord's own texts for users, in English, by key under meocord: usage replies, the built-in help, cooldown refusals, the fallback's answers and the default presenter's views.

  • MeoCordTheme

    A theme: design tokens by role, in three groups.

  • MessageHelp

    What the built-in help command found, for a presenter's messageHelp to write.

  • MessageHelpEntry

    One message command as the built-in help shows it: how to type it, what it does, and where it works.

  • MessageHelpParam

    One param or flag of a MessageHelpEntry, with what it takes in words.

  • MessageKey

    Every message key of a catalog: the dotted path to each message or plural.

  • MessageParams

    The params a catalog message takes: one per {name} placeholder, whose name is ASCII letters, digits or _, and count for a plural message.

  • MessageParamTypes

    What each param type in a message pattern gives the handler, by the name a pattern uses for it.

  • MessageScope

    Where a message command works: 'guild' in servers only, 'dm' in direct messages only, or 'any'.

  • MessageUsageIssue

    One thing wrong with a message command's input: a word that is not a value of its param's type, or a param missing.

  • MetadataDecorator

    A typed metadata decorator, made by createMetadata.

  • ObserverOptions

    What @Observer takes: the context types the observer is told about.

  • OnReady

    A controller, service or provided value that does work once the bot is online, such as starting timers.

  • OnShutdown

    A controller, service or provided value that cleans up before the bot stops, such as closing a connection.

  • ParamRefsOf

    The params of a message pattern as its guards see them: each member, user, role and channel as an EntityRef.

  • ParamsOf

    The params a message pattern gives its handler, read from the pattern itself.

  • Piped

    Marks a value of a handler's input that a separate @UsePipe produces, so the checks of what a call gives leave its type to that pipe.

  • PipeInterface

    What a pipe implements: transform, which turns one input value into what the handler receives.

  • PluralCategory

    The plural categories Intl.PluralRules selects between.

  • PluralMessage

    A message with a form per plural category, chosen by the count param through Intl.PluralRules.

  • PrimaryEntryPointCommandData

    The body an entry point command is registered with.

  • Provided

    What a token provides: a class's instance, or a createToken token's type; unknown for a string or a plain symbol.

  • ProviderToken

    What a provider is bound under and injected by: a class, a string, a symbol, or a typed Token.

  • ReactionEvent

    The second argument a @ReactionHandler method receives: who reacted, and whether they added or removed it.

  • ReactionHandlerAction

    Whether a @ReactionHandler call is for a reaction added to a message or removed from it.

  • ReactionHandlerOptions Deprecated

    The second argument a @ReactionHandler method receives: another name for ReactionEvent.

  • ReactionHandlerSettings

    The settings a @ReactionHandler takes for itself.

  • ReadyInfo

    What onReady learns about its process, beside the client: whether it should do one-off work.

  • RedisCooldownStoreOptions

    How a RedisCooldownStore names its keys and runs its script.

  • RedisEval

    Runs a Lua script on the server, as a client's EVAL does.

  • RedisEvalSha

    Runs a script the server already holds, by its SHA1, as a client's EVALSHA does.

  • ReservedThemeRole

    Names MeoCord keeps for roles it may add to any group.

  • Route

    A component's customId pattern with a typed build, as route makes it.

  • RouteParams

    The names of a customId pattern's params, as a union, such as 'id' | 'page' for 'list/{id}/{page:int}'.

  • RouteValue

    A value build takes for an untyped customId param: its text, or a number or snowflake written as its digits.

  • RouteValues

    The values a route's build takes, one for each of its params and no others.

  • ShardCallResult

    One process's answer to a ShardContext.call: the shards it runs, and the method's value or its error.

  • StageParams

    The params a guard, interceptor, filter or pipe declares, as { provide, params } must give them.

  • StandardSchemaV1

    The Standard Schema interface, version 1, which zod, valibot, arktype and other validation libraries implement.

  • StandardSchemaV1Issue

    One problem a schema found.

  • StandardSchemaV1Props

    What a Standard Schema exposes under ~standard.

  • StandardSchemaV1Result

    The outcome of validation: the output value, or the issues found.

  • StringMessageKey

    The keys whose message is a single string rather than plural forms, with or without {params}.

  • ThemeButtons

    The button style each role maps to, for the app's own buttons.

  • ThemeButtonStyle

    A button style a theme role maps to: one of Discord's four coloured styles.

  • ThemeColors

    The colours a theme names by role.

  • ThemeEmojis

    The emojis a theme names by role.

  • Token

    A symbol that names a value to provide and inject, typed with what it provides, as createToken makes it.

  • Translate

    Translates a key into one locale's message.

  • TranslatorOptions

    What createTranslator takes: the default locale, and a catalog per locale.

  • UserErrorOptions

    What a UserError carries besides its message.

  • UserThemeTarget

    What a per-user theme resolver is given: the user a call came from.

  • ValidateOptions

    What @Validate takes beside its schema: pipes for single values of the schema's output.

  • ValidatePipes

    The pipes @Validate takes for a schema: some of the schema's output keys, each with one pipe or several applied in order.

  • ValidationIssue

    One problem @Validate found in a handler's input.