Testing

Inspection

• ComponentCommandType

  The command types routed by a customId pattern: buttons, select menus and modals.

• CooldownStoreSuiteFramework

  The test framework testCooldownStore registers its cases with: its describe, it and expect.

• createExecutionContext

  Builds the ExecutionContext a guard, interceptor or filter receives for one handler, to test it on its own.

• ExecutionContextOptions

  What createExecutionContext describes besides the handler.

• expectCompleteCatalog

  Checks that every locale translates every message, and throws listing each gap, locale by locale.

• findRouteConflicts

  Finds component patterns that rank equally and can match the same customId, which MeoCord otherwise only warns about at startup.

• getResponse

  Reports how an interaction was answered: where its answer stands, and every answer call it got, in order.

• HandlerInspection

  What runs for one handler, and the metadata declared on it, as inspectHandler reports it.

• InspectedCooldown

  One @Cooldown on a handler, with its defaults filled in, as inspectHandler reports it.

• InspectedFilter

  A filter as @UseFilter declares it: the class, or the class with its params.

• InspectedGuard

  A guard as @UseGuard declares it: the class, or the class with its params.

• InspectedInterceptor

  An interceptor as @UseInterceptor declares it: the class, or the class with its params.

• inspectHandler

  Reports what runs when a handler is dispatched, and the metadata declared on it, without running anything.

• InspectHandlerOptions

  What inspectHandler includes besides the handler's own stages.

• MessageToResolve

  A message, as resolveRoute takes it.

• ResolvedRoute

  The handler a component interaction or a message reaches, as resolveRoute reports it.

• resolveRoute

  Resolves which handler a component's customId or a message's content reaches, as dispatch routes it.

• ResponseReport

  How an interaction was answered, as getResponse reports it.

• RouteConflict

  Two patterns of one component type that rank equally and can both match a customId, as findRouteConflicts reports them.

• testCooldownStore

  Checks that a CooldownStore counts calls as MemoryCooldownStore does, as a suite of test cases.

Mocks

• ChatInputOptions

  The options of a mock slash command, as createChatInputOptions takes them: each value by its option's name.

• clearAllMocks

  Clears the calls every mock from meocord/testing has recorded, keeping what each was told to do.

• createChatInputOptions

  Builds a slash command's options from a plain record, found by name as the real options resolver finds them.

• createDiscordError

  Creates the error discord.js throws for a failed Discord API call, for a mock to reject with.

• createMock

  Creates a mock of any type, with no class needed, for service doubles and interfaces.

• createMockChannel

  Creates a mock channel of the given class, such as TextChannel, ThreadChannel or DMChannel.

• createMockClient

  Creates a mock Client, with users, channels, guilds and application.commands ready to stub.

• createMockFn

  Creates a mock function that jest's and Vitest's expect both read.

• createMockGuild

  Creates a mock Guild, with the members, channels, roles and bans managers ready to stub.

• createMockInteraction

  Creates a mock instance of a discord.js class, such as an interaction, keeping its prototype so instanceof holds.

• createMockMember

  Creates a mock GuildMember: a user in a server, with the roles given.

• createMockMessage

  Creates a mock Message that tracks whether it has been deleted.

• createMockRawMember

  Creates the member Discord sends with an interaction from a server the bot isn't in, as discord.js keeps it.

• createMockTheme

  Makes a whole theme for a test: MeoCord's defaults with overrides merged over them, frozen.

• createMockUser

  Creates a mock User: a person, not a bot, with an id of its own.

• createModalFields

  Builds the fields of a submitted form, as discord.js does when a user submits one.

• DeepMocked

  A mock of T: every method a mock function, and every nested object mocked in turn, five levels deep, including a discord.js structure that may be absent, such as a message's member, when it is present.

• isMockFunction

  Tells whether a value is a mock function: one from meocord/testing, jest.fn() or vi.fn().

• Mock

  A mock function, as jest's Mock and Vitest's Mock name it: the same type as MockedFunction.

• MockedFunction

  A mock function with the signature of T, and the mock API of MockInstance.

• MockFnFactory

  A test runner's mock function factory, such as vi.fn.

• MockGuildOverrides

  What createMockGuild puts in the guild's caches, as the gateway would have filled them.

• MockInstance

  The mock API of a mock function: what it has recorded, and the methods that change what it does.

• MockMemberOverrides

  What createMockMember builds a member with.

• MockMessageOverrides

  What createMockMessage builds a message with.

• MockProps

  Property values a mock factory sets as it builds the mock.

• MockRawMemberOverrides

  What createMockRawMember builds a member with: any field Discord sends, with permissions as a permission set and user as the fields of the user given.

• MockResult

  One call's outcome, as a mock function records it: the value it returned, or the error it threw.

• MockState

  What a mock function has recorded: each call's arguments, outcome and this, in order.

• resetAllMocks

  Clears every mock from meocord/testing, and puts each back to the implementation it was created with.

• RunnerMock

  A mock function a test runner makes, as useMockFn takes it.

• useMockFn

  Makes every mock meocord/testing creates with the test runner's own mock function, such as Vitest's vi.fn.

• useStrictMocks

  Has every mock from meocord/testing compute the values discord.js computes, where it reads a placeholder otherwise.

• withTheme

  Runs fn with theme as the theme of the call, as a handler's call runs.

Module

• DispatchedCall

  What TestingModule.dispatch did with an interaction, a message or a reaction.

• DispatchedHandler

  One handler TestingModule.dispatch ran, and how its call ended.

• EmitResult

  How an event sent with TestingModule.emit was handled.

• FromAppOptions

  What a test changes of the app MeoCordTestingModule.fromApp builds.

• HandlerName

  The names of a class's instance methods, as TestingModule.invoke takes them.

• InvocationResult

  How a call made with TestingModule.invoke ended.

• MeoCordTestingModule

  Builds testing modules: the classes a test needs, in a container of their own, with no Discord connection.

• reportAllStartupErrors

  Has decorators keep the startup errors they find, as a bot built with startupErrors: 'all' does, so a testing module reports every one at once.

• TestingModule

  A compiled testing module, which runs handlers as the bot does and resolves the classes it built.

• TestingModuleBuilder

  Builds a testing module, with stand-ins for the providers, stages and theme a test replaces.

• TestingModuleInitOptions

  How TestingModule.init prepares the module.

• TestingModuleOptions

  What a testing module is built from: the classes a test needs, and the app whose global stages apply.