Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sungwoncho/qparse
A simple top-down parser for advanced search queries
https://github.com/sungwoncho/qparse
advanced-search parser query-parser search typescript
Last synced: 7 days ago
JSON representation
A simple top-down parser for advanced search queries
- Host: GitHub
- URL: https://github.com/sungwoncho/qparse
- Owner: sungwoncho
- License: apache-2.0
- Created: 2020-02-12T00:23:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T23:22:58.000Z (over 1 year ago)
- Last Synced: 2024-03-10T22:36:59.748Z (4 months ago)
- Topics: advanced-search, parser, query-parser, search, typescript
- Language: TypeScript
- Homepage:
- Size: 110 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-stars - qparse - A simple top-down parser for advanced search queries (TypeScript)
README
# qparse
[](https://travis-ci.org/sungwoncho/qparse)
A top-down parser to turn advanced search query strings into JavaScript objects.
It has *no dependency* and provides *a simple interface* with *readable implementation*.
## Installation
```bash
# Using npm
npm install --save qparse
# Using yarn
yarn add qparse
```
## Usage
### parse(str, keywords)
Parse the given `str` while matching the `keywords`.
```js
const q = require('qparse');
q.parse('tag:foo tag:bar sort:baz quz qux', ['tag', 'sort']);
// => { text: 'quz qux', filters: { tag: [ 'foo', 'bar' ], sort: 'baz' } }
q.parse('tag:foo tag:bar sort:baz quz qux', ['tag']);
// => { text: 'sort:baz quz qux', filters: { tag: [ 'foo', 'bar' ] } }
q.parse('tag:foo sort:baz quz qux', ['tag']);
// => { text: 'sort:baz quz qux', filters: { tag: 'foo' } }
q.parse('tag:foo sort:baz quz qux', []);
// => { text: 'tag:foo sort:baz quz qux', filters: {} }
```
## Real World Example
Used by [Dnote](https://github.com/dnote/dnote).
## LICENSE
Apache 2.0