Fastify MongoDB Plugin using Mongoose ODM
Installation
npm i fastify-mongoose-driver -s
Usage
// ...Other Pluginsfastify; fastify; ; // Returns the decorator pointer, useful for using mongoose in seperate files
Options
Option | Description |
---|---|
uri |
Required, the Unique Resource Identifier to use when connecting to the Database. |
settings |
Optional, the settings to be passed on to the MongoDB Driver as well as the Mongoose-specific options. Refer here for further info. |
models |
Optional, any models to be declared and injected under fastify.mongoose |
useNameAndAlias |
Optional, declares models using mongoose.model(alias, schema, name) instead of mongoose.model(name, schema) |
Any models declared should follow the following format:
name: "profiles" // Required, should match name of model in database alias: "Profile" // Optional, an alias to inject the model as schema: schemaDefinition // Required, should match schema of model in database, class: classDefinition // Optional, should be an ES6 class wrapper for the model
The schemaDefinition
variable should be created according to the Mongoose Model Specification.
The classDefinition
variable should be created according to the Mongoose Class Specification.
Author
License
Licensed under GPLv3.