https://github.com/krasimir/q2m
A query object to MongoDB query
https://github.com/krasimir/q2m
Last synced: 6 months ago
JSON representation
A query object to MongoDB query
- Host: GitHub
- URL: https://github.com/krasimir/q2m
- Owner: krasimir
- License: mit
- Created: 2023-06-05T03:55:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-17T05:46:13.000Z (over 2 years ago)
- Last Synced: 2024-10-29T22:02:24.296Z (12 months ago)
- Language: JavaScript
- Size: 57.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# q2m
A URL query object to MongoDB query
- [$eq](#eq)
- [$ne](#ne)
- [$exists](#exists)
- [$exists](#exists)
- [$gt](#gt)
- [$gte](#gte)
- [$lt](#lt)
- [$lte](#lte)
- [$in](#in)
- [$nin](#nin)
- [$or (1)](#or-1)
- [$or (2)](#or-2)
- [$and](#and)
- [$nor](#nor)
- [$regex](#regex)
- [date](#date)
- [date](#date)
## Why
I needed to query MongoDB database from the URL. Basically transfrom the params passed via GET to a properly written MongoDB query object.
## Example
First, get the library via `npm install q2m` or `yarn install q2m`. Then:
```js
const { parse } = require('q2m');
parse({ foo: 'bar' });
// { foo: { $eq: 'bar' }}
```
## Mapping
_(The conversion from query string to object in the examples below is made with [qs](https://www.npmjs.com/package/qs) )_
### $eq
Query string: `foo=bar`
Object:
```json
{
"foo": "bar"
}
```
Output:
```json
{
"foo": {
"$eq": "bar"
}
}
```
### $ne
Query string: `foo=!bar`
Object:
```json
{
"foo": "!bar"
}
```
Output:
```json
{
"foo": {
"$ne": "bar"
}
}
```
### $exists
Query string: `foo==bar`
Object:
```json
{
"foo": "=bar"
}
```
Output:
```json
{
"foo": {
"$exists": true
}
}
```
### $exists
Query string: `foo=!=bar`
Object:
```json
{
"foo": "!=bar"
}
```
Output:
```json
{
"foo": {
"$exists": false
}
}
```
### $gt
Query string: `foo=>20`
Object:
```json
{
"foo": ">20"
}
```
Output:
```json
{
"foo": {
"$gt": 20
}
}
```
### $gte
Query string: `foo=>=20`
Object:
```json
{
"foo": ">=20"
}
```
Output:
```json
{
"foo": {
"$gte": 20
}
}
```
### $lt
Query string: `foo=<20`
Object:
```json
{
"foo": "<20"
}
```
Output:
```json
{
"foo": {
"$lt": 20
}
}
```
### $lte
Query string: `foo=<=20`
Object:
```json
{
"foo": "<=20"
}
```
Output:
```json
{
"foo": {
"$lte": 20
}
}
```
### $in
Query string: `foo[]=a&foo[]=b`
Object:
```json
{
"foo": [
"a",
"b"
]
}
```
Output:
```json
{
"foo": {
"$in": [
"a",
"b"
]
}
}
```
### $nin
Query string: `foo![]=a&foo![]=b`
Object:
```json
{
"foo!": [
"a",
"b"
]
}
```
Output:
```json
{
"foo": {
"$nin": [
"a",
"b"
]
}
}
```
### $or (1)
Query string: `or[0][a]=>20&or[1][b]=$bar`
Object:
```json
{
"or": [
{
"a": ">20"
},
{
"b": "$bar"
}
]
}
```
Output:
```json
{
"$or": [
{
"a": {
"$gt": 20
}
},
{
"b": {
"$regex": "bar",
"$options": "i"
}
}
]
}
```
### $or (2)
Object:
```json
{
"or": [
{
"a": "$foo"
},
{
"b": [
"n",
"m"
]
}
]
}
```
Output:
```json
{
"$or": [
{
"a": {
"$options": "i",
"$regex": "foo"
}
},
{
"b": {
"$in": [
"n",
"m"
]
}
}
]
}
```
### $and
Query string: `and[0][a]=>20&and[1][b]=$bar`
Object:
```json
{
"and": [
{
"a": ">20"
},
{
"b": "$bar"
}
]
}
```
Output:
```json
{
"$and": [
{
"a": {
"$gt": 20
}
},
{
"b": {
"$regex": "bar",
"$options": "i"
}
}
]
}
```
### $nor
Query string: `nor[0][a]=>20&nor[1][b]=$bar`
Object:
```json
{
"nor": [
{
"a": ">20"
},
{
"b": "$bar"
}
]
}
```
Output:
```json
{
"$nor": [
{
"a": {
"$gt": 20
}
},
{
"b": {
"$regex": "bar",
"$options": "i"
}
}
]
}
```
### $regex
Query string: `foo=$bar`
Object:
```json
{
"foo": "$bar"
}
```
Output:
```json
{
"foo": {
"$regex": "bar",
"$options": "i"
}
}
```
### date
Query string: `foo=2023-6-7`
Object:
```json
{
"foo": "2023-6-7"
}
```
Output:
```json
{
"foo": {
"$eq": ""
}
}
```
### date
Query string: `foo=<2023-6-7`
Object:
```json
{
"foo": "<2023-6-7"
}
```
Output:
```json
{
"foo": {
"$lt": ""
}
}
```