resourcejs

library2.6.1jsnpmunverified

Deprecated Express library that automatically generates RESTful API endpoints from Mongoose models. At version 2.6.1, it provided a one-liner to create CRUD routes for Express apps with Mongoose. No longer actively maintained; alternatives include nestjsx/crud or manual route definitions. Key differentiator: minimal setup for quick REST APIs, but lacks flexibility and modern features like validation or middleware composition.

database

npm install resourcejs

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · RESOURCEJS

resourcejs

databasejavascriptv2.6.1

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.

default

✓ import resource from 'resourcejs';

✗ const resource = require('resourcejs').default;

Default export; requires ESM or CJS with default import interop.

errorHandler

✓ import { errorHandler } from 'resourcejs';

Error handler middleware exported as named export.

Resource

✓ import { Resource } from 'resourcejs';

Class for programmatic route configuration.

Creates full REST API (GET, POST, PUT, DELETE) for a Mongoose User model with default routes.

import express from 'express'; import mongoose from 'mongoose'; import resource from 'resourcejs'; const app = express(); app.use(express.json()); await mongoose.connect(process.env.MONGO_URI || 'mongodb://localhost:27017/test'); const UserSchema = new mongoose.Schema({ name: String, email: { type: String, unique: true } }); const User = mongoose.model('User', UserSchema); resource(app, '', 'users', User).rest(); app.listen(3000, () => console.log('Server running on port 3000'));

Debug

Known issues

deprecatedresourcejs is not actively maintained; consider using nestjsx/crud or writing manual routes.

fix

Migrate to a maintained alternative like @nestjsx/crud or express-restify-mongoose.

affects: >=2.0.0

breakingIn v2.0.0, the API changed: resource(app, path, modelName, model, options) was restructured.

fix

Update to new signature: resource(app, basePath, resourceName, model, options).rest()

affects: <2.0.0

breakingMongoose 8.x dropped support for callbacks; resourcejs may not be compatible with legacy async patterns.

fix

Ensure Mongoose models use async/await and do not rely on callback-based queries.

affects: 2.x

gotchaThe module is ESM-only; using require() will fail. Must use import or dynamic import().

fix

Switch to ES modules or use dynamic import: const resource = await import('resourcejs');

affects: >=2.0.0

Errors

Common errors & fixes

TypeError: resource is not a function

Using require('resourcejs') returns an object with a default property instead of the function.

fix

Use import resource from 'resourcejs'; or const resource = require('resourcejs').default;

MongooseError: Model.prototype.save() no longer accepts a callback

resourcejs uses callbacks internally, incompatible with Mongoose 8+.

fix

Downgrade to Mongoose 7.x or migrate to a different library.

Upgrade

Version history

2.6.1latest on npm

Audit

Dependencies

expressrequiredPeer dependency for Express 4.x

mongooserequiredPeer dependency for Mongoose 8.x

Agent activity

14 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/travist/resourcejs ↗

packageresourcejs ↗

homepagehttps://github.com/travist/resourcejs ↗