https://github.com/anandchowdhary/text-filter-parser

🌪️ Parse query filter rules given in plain text
https://github.com/anandchowdhary/text-filter-parser

mysql nodejs query query-language typescript

Last synced: about 1 month ago
JSON representation

🌪️ Parse query filter rules given in plain text

• Host: GitHub
• URL: https://github.com/anandchowdhary/text-filter-parser
• Owner: AnandChowdhary
• License: mit
• Created: 2019-08-22T07:41:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T02:25:15.000Z (7 months ago)
• Last Synced: 2024-12-20T12:13:25.895Z (about 1 month ago)
• Topics: mysql, nodejs, query, query-language, typescript
• Language: TypeScript
• Homepage: https://anandchowdhary.github.io/text-filter-parser/
• Size: 264 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌪️ Text Filter Parser

[![NPM](https://img.shields.io/npm/v/text-filter-parser.svg)](https://www.npmjs.com/package/text-filter-parser)

[![Build](https://img.shields.io/travis/AnandChowdhary/text-filter-parser.svg)](https://travis-ci.org/AnandChowdhary/text-filter-parser)

[![Coveralls](https://img.shields.io/coveralls/github/AnandChowdhary/text-filter-parser.svg)](https://coveralls.io/github/AnandChowdhary/text-filter-parser)

![Type definitions](https://img.shields.io/npm/types/text-filter-parser.svg?color=brightgreen)

[![GitHub](https://img.shields.io/github/license/anandchowdhary/text-filter-parser.svg)](https://github.com/AnandChowdhary/text-filter-parser/blob/master/LICENSE)

![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/AnandChowdhary/text-filter-parser.svg)

A utility to parse query filter rules given in plain text and get a structured array.

## ⭐ How it works

If you have a database view in your app, you might want to give users the option to filter based on a text input. For example, `hello=world` becomes:

```json

[

  {

    "key": "hello",

    "condition": "is",

    "value": "world"

  }

]

```

You can then translate this into a query or use one of built-in functions like `toSQL()`.

## 💻 Usage

Add fraud to your project with NPM:

```bash

npm install text-filter-parser

```

Add it to your project:

```js

const Parser = require("text-filter-parser");

```

Create an object and use a method to get your desired output.

```js

const result = new Parser("id > 2, name ew nand")

const json = result.toJSON();

console.log(json);

/*

[

  {

    key": "id",

    condition": "is greater than",

    value: 2

  },

  {

    key": "name",

    condition": "ends with",

    value: "nand"

  }

]

*/

```

You can also generate the `WHERE` clause of an SQL query:

```js

const result = new Parser("id > 2, name ew nand")

const sql = result.toSQL();

console.log("SELECT * FROM users WHERE " + sql);

/*

SELECT * FROM users WHERE `id` > 2 AND `name` = "%nand"

*/

```

### Operators

| Operator | Condition |

| -------- | --------- |

| = | `"is"` |

| != | `"is not"` |

| > | `"is greater than"` |

| < | `"is less than"` |

| >= | `"is greater than or equal to"` |

| <= | `"is less than or equal to"` |

| sw | `"starts with"` |

| ew | `"ends with"` |

| * | `"includes"` |

## 📝 License

MIT