Mongoose
@adminjs/mongoose
Before reading this article, make sure you have set up an AdminJS instance using one of the supported Plugins.
Additionally, you should have installed
@adminjs/mongoose
as described in Getting started section.There are small differences in how you connect Mongoose to Nest.js vs other plugins, so the guide will be split into two sections accordingly.
Example model:
category.entity.ts
import { model, Schema, Types } from 'mongoose'
export interface ICategory {
title: string;
}
export const CategorySchema = new Schema<ICategory>(
{
title: { type: 'String', required: true },
},
{ timestamps: true },
)
export const Category = model<ICategory>('Category', CategorySchema);
The configuration for non-Nest.js plugins is basically the same for each one of them:
- You must connect to Mongo before creating
AdminJS
instance - You must import
AdminJSMongoose
adapter and register it - You must import the entities you want to use and pass them to AdminJS
resources
options
app.ts
// ... other imports
import mongoose from 'mongoose'
import * as AdminJSMongoose from '@adminjs/mongoose'
import { Category } from './category.entity.js'
AdminJS.registerAdapter({
Resource: AdminJSMongoose.Resource,
Database: AdminJSMongoose.Database,
})
// ... other code
const start = async () => {
await mongoose.connect('<mongo db url>')
const adminOptions = {
// We pass Category to `resources`
resources: [Category],
}
// Please note that some plugins don't need you to create AdminJS instance manually,
// instead you would just pass `adminOptions` into the plugin directly,
// an example would be "@adminjs/hapi"
const admin = new AdminJS(adminOptions)
// ... other code
}
start()
Make sure you have set up your
app.module.ts
according to Nest.js documentation and you have followed Nest.js plugin tutorial as well.Your
app.module.ts
should have imports
option which contains:MongooseModule.forRoot('<mongo db url>')
to set up MongooseAdminModule.createAdminAsync({ ... }
In your
app.module.ts
add these imports at the top of the file:app.module.ts
import * as AdminJSMongoose from '@adminjs/mongoose'
import AdminJS from 'adminjs'
Following this, register
AdminJSMongoose
adapter somewhere after your imports:app.module.ts
AdminJS.registerAdapter({
Resource: AdminJSMongoose.Resource,
Database: AdminJSMongoose.Database,
})
This will allow you to pass Mongoose models for AdminJS to load. If we use the
Category
entity that we used as en example earlier, you should import it into app.module.ts
and pass it into resources
in your adminJsOptions
:app.module.ts
// ... other imports
import { Category } from './category.entity.js'
// ... other code
AdminModule.createAdminAsync({
useFactory: () => ({
adminJsOptions: {
rootPath: '/admin',
resources: [Category],
},
}),
}),
// ... other code
Last modified 5mo ago