Registry / database / mongoose-rest-helper

mongoose-rest-helper

library2.0.2jsnpmunverified

Mongoose REST Helper is a utility library (v2.0.2) that provides helper functions to simplify building REST APIs with Mongoose and Express. It includes pagination, query filtering, and response formatting, aiming for development speed but with limited maintenance since 2018. Released under MIT, the package has peer dependencies on Mongoose >=4.0.0 and Node >=0.8.0. No major updates or security patches have been noted.

database

npm install mongoose-rest-helper

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MONGOOSE-REST-HELP

mongoose-rest-helper

databasejavascriptv2.0.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

restHelper

✓ import restHelper from 'mongoose-rest-helper'

✗ const restHelper = require('mongoose-rest-helper')

Default export only; CommonJS require works in Node environments but the package does not provide ESM type declarations.

paginate

✓ import { paginate } from 'mongoose-rest-helper'

✗ const paginate = require('mongoose-rest-helper').paginate

Named export; use destructuring for clarity.

RestHelper

✓ import RestHelper from 'mongoose-rest-helper'

✗ import { RestHelper } from 'mongoose-rest-helper'

The default export is often confused as a named export; it is not.

Demonstrates basic CRUD endpoints using restHelper middleware with Express and Mongoose.

import restHelper from 'mongoose-rest-helper'; import mongoose from 'mongoose'; const Schema = mongoose.Schema; const UserSchema = new Schema({ name: String, age: Number }); const User = mongoose.model('User', UserSchema); app.get('/users', restHelper.paginate(User), (req, res) => { res.json(res.locals.pagination); }); app.get('/users/:id', restHelper.findOne(User), (req, res) => { res.json(res.locals.doc); }); app.post('/users', restHelper.create(User), (req, res) => { res.status(201).json(res.locals.doc); }); app.put('/users/:id', restHelper.update(User), (req, res) => { res.json(res.locals.doc); }); app.delete('/users/:id', restHelper.remove(User), (req, res) => { res.status(204).send(); });

Debug

Known issues

gotchaPackage has not been updated since 2018; compatibility with Mongoose 6+ is untested and may break.

fix

Consider migrating to a maintained alternative like 'express-mongoose-pagination' or implement custom helpers.

affects: >=2.0.2

deprecatedThe 'paginate' middleware modifies res.locals, which may conflict with other middleware or cause unexpected behavior if not used carefully.

fix

Check for existing res.locals properties before using; use in isolation if possible.

affects: all

gotchaNode >=0.8.0 required; Node 16+ may still work but no official support.

fix

Test with your Node version; if using modern Node, consider alternatives.

affects: all

Errors

Common errors & fixes

Cannot find module 'mongoose-rest-helper'

Package not installed or version mismatch.

fix

Run 'npm install mongoose-rest-helper' and verify package.json includes it.

TypeError: Cannot read property 'paginate' of undefined

Incorrect import: likely using the wrong import style (named vs default).

fix

Use 'import restHelper from 'mongoose-rest-helper'' then 'restHelper.paginate'.

MongooseError: Model not found

Passing a string instead of a Mongoose Model to helper functions.

fix

Ensure you pass a valid Mongoose Model instance, e.g., 'restHelper.paginate(User)' not 'restHelper.paginate('User')'.

Upgrade

Version history

2.0.2latest on npm

Audit

Dependencies

mongooserequiredCore peer dependency; required for all database operations and schema definitions.

Agent activity

4 hits · last 30 days

node

Resources

githubgit://github.com/codedoctor/mongoose-rest-helper ↗

packagemongoose-rest-helper ↗

homepagehttps://github.com/codedoctor/mongoose-rest-helper ↗