{"id":50819672,"url":"https://github.com/0nahid/mongoose-dynamic-querybuilder","last_synced_at":"2026-06-13T12:39:07.379Z","repository":{"id":213689159,"uuid":"734699028","full_name":"0nahid/mongoose-dynamic-querybuilder","owner":"0nahid","description":"This is Mongoose/Mongo QueryBuilder npm package that can fetch datas dynamically","archived":false,"fork":false,"pushed_at":"2024-06-11T16:03:15.000Z","size":17,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-06-13T12:39:06.283Z","etag":null,"topics":["builder","mongodb","mongoose","nodejs","query","query-builder","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/mongoose-dynamic-querybuilder","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0nahid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-22T11:18:41.000Z","updated_at":"2024-04-19T20:06:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"69709000-3760-4eb3-8cd1-6ee8462d3854","html_url":"https://github.com/0nahid/mongoose-dynamic-querybuilder","commit_stats":null,"previous_names":["0nahid/mongoose-dynamic-querybuilder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/0nahid/mongoose-dynamic-querybuilder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0nahid%2Fmongoose-dynamic-querybuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0nahid%2Fmongoose-dynamic-querybuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0nahid%2Fmongoose-dynamic-querybuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0nahid%2Fmongoose-dynamic-querybuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0nahid","download_url":"https://codeload.github.com/0nahid/mongoose-dynamic-querybuilder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0nahid%2Fmongoose-dynamic-querybuilder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34285191,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["builder","mongodb","mongoose","nodejs","query","query-builder","typescript"],"created_at":"2026-06-13T12:39:06.717Z","updated_at":"2026-06-13T12:39:07.368Z","avatar_url":"https://github.com/0nahid.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mongoose-dynamic-querybuilder\n\nA utility library for building dynamic queries with Mongoose, featuring enhanced capabilities such as dynamic searching, exclusion of fields, and additional filtering.\n\n## Installation\n\nInstall using npm:\n\n```bash\nnpm i mongoose-dynamic-querybuilder\n```\n\nOr using Yarn:\n\n```bash\nyarn add mongoose-dynamic-querybuilder\n```\n\n## Usage\n\nHere's how you can use the `QueryBuilder` with a Mongoose model:\n\n```jsx\nimport QueryBuilder from \"mongoose-dynamic-querybuilder\";\n\n// Initialize QueryBuilder with a Mongoose query and request query parameters\nconst userQuery = new QueryBuilder(User.find({}), req.query);\n\nconst [data, totalData] = await Promise.all([\n  userQuery\n    .filter()\n    .extraFilter({ role: { $ne: \"admin\" } })\n    .search([\"email\", \"username\", \"profile.fullname\"])\n    .sort()\n    .paginate()\n    .fields()\n    .exclude(\"password\")\n    .applyExclusions().modelQuery,\n  userQuery.countTotal(),\n]);\n```\n\n## API\n\n### Constructor\n\n- **`new QueryBuilder(query, queryParams)`**\n  - `query`: A Mongoose query instance.\n  - `queryParams`: An object containing query parameters.\n\n### Methods\n\n- **`.filter()`**: Apply filters based on `queryParams` for fields not directly involved in searching or sorting.\n- **`.search(fields)`**: Perform a dynamic search on specified fields.\n- **`.sort()`**: Apply sorting based on `queryParams`.\n- **`.paginate()`**: Paginate the results according to `queryParams`.\n- **`.fields()`**: Select which fields to return in the query results.\n- **`.exclude(fields)`**: Specify fields to exclude from the results.\n- **`.applyExclusions()`**: Apply exclusions set by `.exclude()`.\n- **`.extraFilter(...filters)`**: Apply additional custom filters.\n- **`.modelQuery`**: Get the final Mongoose query object.\n- **`.countTotal()`**: Count the total number of documents considering all applied filters, without pagination.\n\n## Examples\n\nHere are a few example API calls:\n\n- **Search by Term**:\n\n  ```\n  GET http://localhost:5000/api/v1/users?searchTerm=nahid\n  ```\n\n- **Pagination**:\n\n  ```\n  GET http://localhost:5000/api/v1/users?page=1\u0026limit=10\n  ```\n\n- **Select Specific Fields**:\n\n  ```\n  GET http://localhost:5000/api/v1/users?fields=password,email\n  ```\n\n- **Sort in Descending Order**:\n  ```\n  GET http://localhost:5000/api/v1/users?sort=-username\n  ```\n\n## Changelog\n\n- Added support for dynamic search on specific fields.\n- Added support for selecting specific fields to be returned in the query.\n- Added support for counting the total number of documents with all filters without pagination.\n- Added support for search with objectId\n- Added support for search with boolean\n\n## What's New?\n\n- **Dynamic Search**: Added support for dynamic search on specific fields including those containing ObjectId values and booleans.\n- **Field Selection and Exclusion**: Enhanced functionality to select specific fields and exclude others in the query results.\n- **Custom Filters**: Added capability to apply additional custom filters with the new `.extraFilter()` method.\n- **Accurate Document Counting**: Improved counting method that reflects all applied filters without including paginated results.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0nahid%2Fmongoose-dynamic-querybuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0nahid%2Fmongoose-dynamic-querybuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0nahid%2Fmongoose-dynamic-querybuilder/lists"}