# mongodb-querystring

> Pass MongoDB query through URL query string.

Latest version **1.0.3** (published 2016-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install mongodb-querystring
pnpm add mongodb-querystring
yarn add mongodb-querystring
bun add mongodb-querystring
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2016-03-10 |
| First published | 2016-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Nicolas Thouvenin |
| Maintainers | touv |
| Keywords | mongo, mongodb, url, querystring |

## Links

- npm: https://www.npmjs.com/package/mongodb-querystring
- Repository: https://github.com/touv/node-mongodb-querystring
- Homepage: http://github.com/touv/node-mongodb-querystring
- Issues: https://github.com/touv/node-mongodb-querystring/issues
- npm.io page: https://npm.io/package/mongodb-querystring

## Dependencies (2)

- [qs](https://npm.io/package/qs.md) ^6.1.0
- [traverse](https://npm.io/package/traverse.md) ^0.6.6

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2016-03-10
- 1.0.2 — 2016-03-08
- 1.0.1 — 2016-03-04
- 1.0.0 — 2016-03-04

## README

# MongoDB query through URL

Pass MongoDB query through URL query string.

## Contributors

  * [Nicolas Thouvenin](https://github.com/touv)

# Installation

With [npm](http://npmjs.org) do:

    $ npm install mongodb-querystring


# Tests

Use [mocha](https://github.com/visionmedia/mocha) to run the tests.

    $ npm install mocha
    $ mocha test

# API Documentation

## stringify(input : Object, [separator : String]) : String

Converts `query` to a URL query string.

```javascript
	var mqs = require('mongodb-querystring');
	var qry = {
     "$query" : {
       "age" : {
         "$gte" : new Date(1976, 11, 14)
       },
       "$or": [
         { "cuisine": "Italian" },
         { "address.zipcode": "10075" }
       ]
     },
     "$limit" : 20,
     "$orderby" : {
       "age" : -1,
       "posts": 1
     }
   };
   console.log(mqs.stringify(qry);

```
Output:

	'$query[age][$gte]=219366000000^D&$query[$or][0][cuisine]=Italian&$query[$or][1][address.zipcode]=10075&$limit=20^N&$orderby[age]=-1^N&$orderby[posts]=1^N'

## parse(input : String) : Object
## parse(input : Object) : Object

Parse `input` to convert to an query.
```javascript
	var mqs = require('mongodb-querystring');
	var qry = '$query[type][$in][0]=food&$query[type][$in][1]=snacks';
	console.dir(mqs.parse(qry));

```
Output:

	{ '$query': { type: { '$in': [ 'food', 'snacks' ] } } }

## create(input : String) : Object
## create(input : Object) : Object

Parse `input` to convert to an Object query.
```javascript
	var mqs = require('mongodb-querystring');
	var qry = mqs.create(req.query);
	console.log(qry.$query());
	console.log(qry.$limit(10));

```
# Also

* https://www.npmjs.com/package/query-to-mongo
* https://www.npmjs.com/package/mongo-querystring

---
_Source: https://npm.io/package/mongodb-querystring · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._