apifeatures-query-helper

Chainable Mongoose query and aggregate helper for backend APIs.

What this package gives you

• Filtering with whitelist support and operator parsing
• Sorting and projection helpers
• Safe pagination and metadata
• Regex/text search helpers
• Geo filtering helpers
• Aggregate pipeline helpers
• Parallel data + count execution

Install

npm install apifeatures-query-helper

Usage (ESM)

import APIFeatures from 'apifeatures-query-helper';

const { data, meta } = await APIFeatures
  .create(Product.find(), req.query)
  .filter(['name', 'price', 'category'])
  .search(['name', 'description'])
  .sortData('-price')
  .limitFields('name', 'price', 'slug')
  .paginate(50)
  .lean()
  .exec({ getCount: true });

Usage (CommonJS)

const APIFeatures = require('apifeatures-query-helper');

const { data, meta } = await APIFeatures
  .create(Product.find(), req.query)
  .filter(['name', 'price'])
  .paginate(100)
  .exec({ getCount: true });

Local build

npm install
npm run build

Publish to npm

1. Update the package name in package.json if needed.
2. Bump version in package.json.
3. Login to npm:

npm login

4. Publish:

npm publish

For scoped packages, publish as public:

npm publish --access public