Registry / database / mongodb-query-util

mongodb-query-util

JSON →
library2.6.5jsnpmunverified

Utility functions for MongoDB query operations, current stable version 2.6.5. A dependency of MongoDB Compass, it provides helpers for building and manipulating MongoDB query objects (e.g., filtering, projections, sort). Released as needed with Compass updates, it is primarily used internally by MongoDB GUI tools. Differentiators: focused on query utility rather than full driver, with TypeScript types included.

database
npm install mongodb-query-util
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · MONGODB-QUERY-UTIL
M
mongodb-query-util
databasejavascriptv2.6.5
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.

filterQuery
✓ import { filterQuery } from 'mongodb-query-util'
✗ const filterQuery = require('mongodb-query-util').filterQuery
ESM-only since v2, uses named export.
projectQuery
✓ import { projectQuery } from 'mongodb-query-util'
✗ import projectQuery from 'mongodb-query-util'
Named export, not default export.
sortQuery
✓ import { sortQuery } from 'mongodb-query-util'
✗ const sortQuery = require('mongodb-query-util').sortQuery
CommonJS require works but ESM is preferred.

Shows how to import and use the three main utility functions to clean/filter MongoDB query objects.

import { filterQuery, projectQuery, sortQuery } from 'mongodb-query-util'; const filter = { status: 'active', age: { $gte: 18 } }; const projection = { name: 1, email: 1 }; const sort = { createdAt: -1 }; const cleanedFilter = filterQuery(filter); const cleanedProjection = projectQuery(projection); const cleanedSort = sortQuery(sort); console.log(cleanedFilter); console.log(cleanedProjection); console.log(cleanedSort);
Debug
Known issues
breakingv2 dropped support for Node.js < 10, altering export patterns from CommonJS to ESM.
fix
Use import syntax instead of require; upgrade Node to >=10.
affects: >=2.0.0
gotchafilterQuery mutates the input object in older versions (pre-1.2.0). Ensure you pass a copy if immutability is needed.
fix
Upgrade to >=1.3.0 or clone the input before calling filterQuery.
affects: <1.3.0
deprecatedThe function 'validateQuery' was deprecated in v2.0.0 and removed in v2.2.0.
fix
Use filterQuery instead; it performs validation and filtering.
affects: >=2.0.0
Errors
Common errors & fixes
Cannot find module 'mongodb-query-util'
Package not installed or not in node_modules.
fix
Run 'npm install mongodb-query-util' or 'yarn add mongodb-query-util'.
filterQuery is not a function
Incorrect import style (default import instead of named import).
fix
Use 'import { filterQuery } from 'mongodb-query-util'' instead of default import.
TypeError: Cannot read property 'status' of undefined
Passing undefined or null as an argument to any of the query functions.
fix
Ensure the argument is an object (even empty) before passing to the utility functions.
Upgrade
Version history
2.6.5latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
7 hits · last 30 days
node
6
Resources
githubhttps://github.com/mongodb-js/compass ↗
packagemongodb-query-util ↗
homepagehttps://github.com/mongodb-js/compass ↗
mongodb-query-util — npm install mongodb-query-util · libregistry