# simple-query-ln

> A simple query language

Latest version **2.0.2** (published 2022-10-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install simple-query-ln
pnpm add simple-query-ln
yarn add simple-query-ln
bun add simple-query-ln
```

## 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 | 2.0.2 |
| Published | 2022-10-18 |
| First published | 2022-07-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 110 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ashwaniarya |

## Links

- npm: https://www.npmjs.com/package/simple-query-ln
- npm.io page: https://npm.io/package/simple-query-ln

## Recent versions

- 2.0.2 (latest) — 2022-10-18
- 2.0.1 — 2022-07-26
- 2.0.0 — 2022-07-26
- 1.0.1 — 2022-07-19
- 1.0.0 — 2022-07-18

## README

# Query Builder

A simple query language

Node | React | JavaScript

Note: This is just a builder and parser. When used in query param, use encodeURIComponent() to encode the query string.

## Install

```js
npm install simple-query-ln
```
### Where can be used
- Can be used to generate string based query language
- Can be used to create filter query

## API
There are primarily two apis
- Query Builder - To build the query language
- Query Parser - To parse the query language and get object

### Query Builder

```js
import { QueryBuilder } from 'simple-query-ln'

const queryBuilder = new QueryBuilder();
queryBuilder.addFilter('name','Arya');
queryBuilder.addFilter('age',25,QueryBuilder.operator.greater_or_equal);
queryBuilder.addFilter('age',30,'less_or_equal');

console.log(queryBuilder.stringify());
// name:Arya,age[greater_or_equal]:25,age[less_or_equal]:30
```

### Query Parser

```js
import { QueryParser } from 'simple-query-ln'

const queryParser = new QueryParser();
const parsedObject = queryParser.parse('name:Arya,age[greater_or_equal]:25,age[less_or_equal]:30');

console.log(parsedObject);
/* 
[
  { 
    field: "name", 
    operators: [ 
      {  
        value: "Arya" 
      } 
    ]
  },
  { 
    field: "age",
    operators: [
      {
        value: 25,
        operator: "greater_or_equal"
      },
      {
        value: 30,
        operator: "less_or_equal"
      }
    ]
  }
]

*/
```

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