Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rodydavis/query-utilities
Query utilities for javascript with zero dependencies.
https://github.com/rodydavis/query-utilities
query query-ast query-builder query-parser typescript
Last synced: 24 days ago
JSON representation
Query utilities for javascript with zero dependencies.
- Host: GitHub
- URL: https://github.com/rodydavis/query-utilities
- Owner: rodydavis
- License: apache-2.0
- Created: 2022-03-14T17:37:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-16T20:21:52.000Z (almost 3 years ago)
- Last Synced: 2024-12-24T00:10:48.759Z (30 days ago)
- Topics: query, query-ast, query-builder, query-parser, typescript
- Language: TypeScript
- Homepage: https://rodydavis.github.io/query-utilities/
- Size: 1.58 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Query Utilities
[](https://github.com/rodydavis/query-utilities/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/query-utilities)
Query utilities for javascript with zero dependencies.
[Demo](https://rodydavis.github.io/query-utilities/)
```
Search "Anything" AND (Get better >= results) OR build TO extend
```
- ✅ No Dependencies
- ✅ ES Modules
- ✅ Full Browser Support
- ✅ 100% Typescript
## Methods
### `parseQuery`
Returns a query from a given string.
```js
const result = parseQuery("this AND that");
console.log(result); // Returns AndQuery
```
### `highlight`
Highlight function that wraps the referenced text with a `` tag.
```js
const result = highlight("test highlight", "test");
console.log(result); // Returns "test highlight"
```
## Classes
### `SearchQuery`
```js
const query = new SearchQuery();
query.addSource("todos", todos, (item, search) => ({
type: "TODO",
item,
search,
}));
query.addSource("users", users, (item, search) => ({
type: "USER",
item,
search,
}));
const search = 'userId: 1';
const results = query.getResults(search);
console.log(results); // One result with user id === 1
```
This package also includes all the classes used in parsing and for building results:
### `Query`
Base class that all extend from and implement.
### `TextQuery` and `PhraseQuery`
Basic text query that can optionally be an exact match if the source starts and ends with a quote character. The returned string is trimmed.
```
"test" --> test
hello world --> hello world
test "inner" quotes --> test "inner" quotes
"trimmed " --> trimmed
```
### `AndQuery`
Joins two statements with the `AND` token and each side can extend `Query`.
```
this AND that
```
### `OrQuery`
Joins two statements with the `OR` token and each side can extend `Query`.
```
this OR that
```
### `NotQuery`
Negates the targeted query.
```
NOT this
```
### `SectionQuery`
Specifies a query on a given section or return the section if not specified.
```
@users userId:1 -> user with id = 1
@todos -> all todos
```
### `GroupQuery`
Group a query with `()`.
```
active todos AND NOT (completed:true OR stale)
```
### `FieldScope`
Target a query on a specified field.
```
active:true -> fields where active field === true
```
### `FieldCompareQuery`
Target a query on a specified field with a operator and text query.
```
id >= 2 -> ids where value is greater or equal to 2
```
### `RangeQuery`
Search a range (inclusive or exclusive) with a start and end query.
```
[200 TO 2000} -> range from inclusive 200 to exclusive 2000
```