Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nakardo/hapi-mongoose2
mongoose plugin for hapi-based servers
https://github.com/nakardo/hapi-mongoose2
Last synced: about 1 month ago
JSON representation
mongoose plugin for hapi-based servers
- Host: GitHub
- URL: https://github.com/nakardo/hapi-mongoose2
- Owner: nakardo
- License: mit
- Created: 2018-08-23T21:48:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-19T11:38:16.000Z (over 4 years ago)
- Last Synced: 2024-10-29T07:09:58.437Z (2 months ago)
- Language: JavaScript
- Size: 180 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hapi-mongoose2
[](https://badge.fury.io/js/hapi-mongoose2)
[](https://greenkeeper.io/)
[](https://circleci.com/gh/nakardo/hapi-mongoose2)
Mongoose plugin for hapi-based servers. Supports connecting to one or multiple databases and look up and register models by connection. The plugin options are:
- `options` - a `connection` or an array of `connection`s where:
- `connection` - an object containing:
- `uri` - a mongo uri string
- `alias` - (optional) a database name alias used to namespace connections when multiple are created. otherwise ignored.
- `loadSchemasFrom` - (optional) one of:
- An array of [globs](https://github.com/isaacs/minimatch#usage) from where schemas will be loaded. matching files must export a `mongoose.Schema` object or a function with the signature `async function(server)` returning a schema.
- An object containing `Mongoose.Schema` elements.
- `options` - (optional) options passed to `mongoose` [createConnection](https://mongoosejs.com/docs/connections.html#options) method. unknown properties are allowed:
- `auth` - an object with auth credentials
- `user`
- `password`
- `autoIndex`
- `bufferCommands`
- `connections` - an array of `connection` objects as described above.
- `decorations` - (optional) an array of [interfaces](https://hapijs.com/api#-serverdecoratetype-property-method-options) to be decorated using `server.decorate` method. allowed values are `server`, `request`.
Connection and models are accessible under the `server.app.mongo` property. When multiple connections are created the database name or `alias` is used as namespace for accessing each database properties. Same applies for decorated interfaces.
Models are named as the filename matching the schema pattern. Model name first letter is capitalized by default. e.g. `Animal`.
## Example
```javascript
const plugin = {
plugin: require('hapi-mongoose2'),
options: {
connections: [
{
uri: 'mongodb://localhost:27017/myapp'
},
{
alias: 'safebox',
uri: 'mongodb://localhost:27017/secrets',
loadSchemasFrom: [
'src/schemas',
'!.{md,json}'
],
options: {
auth: {
user: 'admin',
password: 'pa55w0rd'
},
autoIndex: false,
bufferCommands: true
}
}
],
decorations: ['request', 'server']
}
};
const server = new Hapi.server();
await server.register(plugin);
// Using database `secrets` from:
// 1 - `server.app` object
// 2 - `request` decorated object
// 3 - `server` decorated object
const { Admin } = server.app.mongo.safebox.models;
await Admin.create({ name: 'Quentin', last: 'Tarantino' });
server.route({
method: 'GET',
path: '/',
handler: function (request) {
const { Admin } = request.mongo.safebox.models;
return Admin.findOne({ name: 'Quentin' }).exec();
}
});
await server.mongo.safebox.connection.close();
```
## Dependencies
`mongoose` needs to be installed alongside this plugin in order to work.