Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/south-paw/koa-mongoose
🍃 Mongoose middleware for Koa 2
https://github.com/south-paw/koa-mongoose
koa koa-middleware koa2 middleware mongo mongodb mongoose
Last synced: 3 months ago
JSON representation
🍃 Mongoose middleware for Koa 2
- Host: GitHub
- URL: https://github.com/south-paw/koa-mongoose
- Owner: South-Paw
- License: mit
- Archived: true
- Created: 2019-06-03T01:00:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-18T13:07:11.000Z (over 4 years ago)
- Last Synced: 2024-10-01T06:20:09.757Z (3 months ago)
- Topics: koa, koa-middleware, koa2, middleware, mongo, mongodb, mongoose
- Language: JavaScript
- Homepage:
- Size: 107 KB
- Stars: 5
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-mongoose
🍃 Mongoose middleware for Koa 2
[](https://www.npmjs.com/package/@south-paw/koa-mongoose)
[](https://travis-ci.org/South-Paw/koa-mongoose)
[](https://coveralls.io/github/South-Paw/koa-mongoose)
[](https://david-dm.org/South-Paw/koa-mongoose)
[](https://david-dm.org/South-Paw/koa-mongoose?type=dev)
---
## Features
- Adds `model()` and `document()` to the koa `ctx`
- Config for automatically loading schemas and events on the mongoose instance
## Basic Usage
The middleware config accepts a `user` and `pass` or you can use a `uri` or `url` as an escape hatch for other url schemes.
Unauthenticated connections will also work by omitting the `user` and `pass` and only providing a `host`, `port` and `db`.
Note: If you're using the `mongodb+srv` syntax to connect to [MongoDB Atlas](https://www.mongodb.com/cloud/atlas), you [should use the mongoose `dbName` option to specify the database](https://stackoverflow.com/questions/48917591/fail-to-connect-mongoose-to-atlas/48917626#48917626) because you currently cannot in the connection string. ([source](https://mongoosejs.com/docs/connections.html)) Be sure to change the default koa-mongoose `db` option to match as well.
```js
const Koa = require('koa');
const mongoose = require('@south-paw/koa-mongoose');
const app = new Koa();
// middleware config
const config = {
host: 'localhost',
port: '27017',
user: '',
pass: '',
db: 'test',
mongoOptions: {
// these are the default middleware options, see https://mongoosejs.com/docs/connections.html#options
useNewUrlParser: true,
useCreateIndex: true,
useUnifiedTopology: true,
reconnectTries: Number.MAX_SAFE_INTEGER, // Never stop trying to reconnect
reconnectInterval: 500, // Reconnect every 500ms
poolSize: 10, // Maintain up to 10 socket connections
bufferMaxEntries: 0, // If not connected, return errors immediately rather than waiting for reconnect
connectTimeoutMS: 10000, // Give up initial connection after 10 seconds
socketTimeoutMS: 45000, // Close sockets after 45 seconds of inactivity
},
schemas: {
// schemas recieve the middleware's mongoose instance, see https://mongoosejs.com/docs/schematypes.html
users: ({ Schema }) =>
new Schema(
{
name: { type: String },
pets: [Schema.Types.ObjectId],
},
{ collection: 'users' },
),
pets: ({ Schema }) =>
new Schema(
{
type: { type: String },
name: { type: String },
},
{ collection: 'pets' },
),
},
events: {
// see https://mongoosejs.com/docs/api.html#connection_Connection-readyState
error: () => console.error('mongoose: error'),
connected: () => console.log('mongoose: connected'),
connecting: () => console.log('mongoose: connecting'),
disconnecting: () => console.log('mongoose: disconnecting'),
disconnected: () => console.log('mongoose: disconnected'),
},
useDefaultErrorHandler: false, // enable or disable the default error handler
};
// apply the middleware
app.use(mongoose(config));
// and you can now use the middleware via the ctx with
// `ctx.model(modelName)` and `ctx.document(modelName, document)`
```
## Issues and Bugs
If you manage to find any, please report them [here](https://github.com/South-Paw/koa-mongoose/issues) so they can be squashed.
## Development and Contributing
Pull the repo and install dependencies with `yarn`
```bash
# run tests
yarn test
# lint source
yarn lint
# format source with prettier
yarn format
```
## License
MIT, see the [LICENSE](./LICENSE) file.