djs-commands

This page lists every public symbol the framework exports. Each link jumps to the concept page that explains it in context — start there for examples and trade-offs.

Concepts

The narrative documentation. Start here if you're new.

Components V2

Full JSX + function reference for the layout/form primitives.

Adapter Cookbook

Soup-to-nuts guides for each first-party adapter.

`@djs-commands/core`

Commands

Export	Kind	Page
`defineCommand`	function	Commands
`Command`	type	Commands
`AnyCommand`	type	Commands
`CommandRunContext`	type	Commands
`SlashRunContext`	type	Commands
`LegacyRunContext`	type	Commands
`CommandRun`	type	Commands
`CommandLegacyConfig`	type	Commands

Options

Export	Kind	Page
`CommandOption` / `CommandOptions`	type	Commands → Options
`StringOption`, `IntegerOption`, `NumberOption`, `BooleanOption`, `UserOption`, `ChannelOption`, `RoleOption`, `MentionableOption`, `AttachmentOption`	type	Commands → Options
`ResolveOption` / `ResolveOptions`	type	Commands → Options

Handler

Export	Kind	Page
`createCommandHandler`	function	Commands → Registering
`CommandHandler`	type	Commands
`CommandHandlerOptions`	type	Commands
`HandlerLegacyConfig`	type	Commands

Validators

Export	Kind	Page
`Validator`	type	Validators
`ValidatorContext`	type	Validators
`ValidationResult`	type	Validators
`ValidatorSource`	type	Validators
`CanRunCommand`	type	Validators

Cooldowns

Export	Kind	Page
`CooldownConfig`	type	Cooldowns
`CooldownType`	type	Cooldowns → Types
`CooldownActor`	type	Cooldowns
`CacheAdapter`	type	Cooldowns

Plugins

Export	Kind	Page
`PluginManifest`	type	Plugins
`PluginSetupContext`	type	Plugins

Storage

Export	Kind	Page
`Storage`	type	Storage
`StorageWhere` / `StorageFindOpts`	type	Storage
`runStorageConformance`	function	Storage → Custom adapter
`GuildPrefixModel` / `GuildPrefixRow`	const / type	Storage → Helpers
`getGuildPrefix` / `setGuildPrefix` / `clearGuildPrefix`	function	Storage → Helpers
`DisabledCommandsModel` / `DisabledCommandRow`	const / type	Storage → Helpers
`isCommandDisabled` / `disableCommand` / `enableCommand`	function	Storage → Helpers
`ChannelLocksModel` / `ChannelLockRow`	const / type	Storage → Helpers
`getChannelLocks` / `lockCommandToChannel` / `unlockCommandFromChannel`	function	Storage → Helpers

Filesystem loader

Export	Kind	Page
`loadCommandsFromDir`	function	Commands → Loading
`loadEventsFromDir`	function	Commands → Loading
`watchCommandsDir`	function	Commands → Loading

Events

Export	Kind	Description
`defineEvent`	function	Define a discord.js event handler with full type-safety.
`EventDefinition`	type	The shape `defineEvent` returns.

Components V2 (function API)

Export	Returns
`container`	`ContainerBuilder`
`section`	`SectionBuilder`
`textDisplay`	`TextDisplayBuilder`
`mediaGallery`	`MediaGalleryBuilder`
`separator`	`SeparatorBuilder`
`file`	`FileBuilder`
`thumbnail`	`ThumbnailBuilder`
`button`	`ButtonBuilder`
`actionRow`	`ActionRowBuilder`
`modal`	`ModalBuilder`
`textInput`	`TextInputBuilder`
`radioGroup` / `checkboxGroup`	`LabelBuilder`

Each takes an *Options object — see Components V2 for full signatures and examples.

Legacy parser

Export	Description
`parseLegacyArgs`	Parse a legacy message into a typed argument object using a command's `options` schema.
`LegacyParseResult`	Discriminated union of `{ ok: true; values }` / `{ ok: false; reason }`.

Context normalizers

Export	Description
`normalizeSlashContext`	Build a `SlashRunContext` from a discord.js interaction.
`normalizeLegacyContext`	Build a `LegacyRunContext` from a discord.js message.

`@djs-commands/jsx`

Export	Kind	Description
`render`	function	Compile a JSX tree into discord.js component builders.
`renderModal`	function	Compile a `<Modal>` JSX tree into a `ModalBuilder`.
`Container`, `Section`, `TextDisplay`, `MediaGallery`, `Separator`, `File`, `Thumbnail`	component	Display primitives.
`ActionRow`, `Button`, `TextInput`, `RadioGroup`, `CheckboxGroup`, `Modal`	component	Form primitives.
`Fragment`	component	Group children without nesting.
`*Props`, `ButtonStyleName`, `TextInputStyleName`, `DjsxNode`	type	TypeScript helpers.

JSX runtime entry points: @djs-commands/jsx/jsx-runtime and @djs-commands/jsx/jsx-dev-runtime — set jsxImportSource: "@djs-commands/jsx" in your tsconfig.

Adapters

Package	Factory	Notes
`@djs-commands/adapter-drizzle`	`drizzleStorage(db, options?)`	Postgres via Drizzle. Schema exported from `./schema`.
`@djs-commands/adapter-prisma`	`prismaStorage(prisma, options?)`	Generic Prisma client; ships schema fragments to copy in.
`@djs-commands/adapter-mongoose`	`mongooseStorage(connection, options?)`	Auto-creates Mongoose models if you don't pass your own.
`@djs-commands/adapter-redis`	`redisCacheAdapter(redis, options?)`	TTL-native `CacheAdapter` for distributed cooldowns.

See Adapter Cookbook for a walk-through per adapter.

API Reference