API ReferenceAdapters
adapter-mongoose
Mongoose Storage adapter with explicit model mappings.
mongooseStorage(options)
function mongooseStorage(options: MongooseStorageOptions): Storage;options.models is required. Each enabled framework model needs a Mongoose model and logical-field mapping.
import { mongooseStorage } from "@djs-commands/adapter-mongoose";
import { GuildPrefixModel } from "@djs-commands/core";
import mongoose from "mongoose";
mongooseStorage({
models: {
[GuildPrefixModel]: {
model: GuildPrefix as mongoose.Model<Record<string, unknown>>,
fields: { guild_id: "guildId", prefix: "prefix" },
},
},
});interface MongooseStorageOptions {
models: Partial<Record<FrameworkStorageModel, MongooseModelMapping>>;
}
interface MongooseModelMapping {
model: mongoose.Model<Record<string, unknown>>;
fields: Record<string, string>;
}Constructor validates required logical fields. It does not connect, register models, or query MongoDB.
Last updated on