|
1 | 1 | # AQLqueryBuilder.js
|
2 | 2 | > a typescript query builder for [arangodb](https://www.arangodb.com)'s [ArangoSearch](https://www.arangodb.com/docs/stable/arangosearch.html)
|
| 3 | +See working demo at [hp4k1h5.github.io](https://hp4k1h5.github.io/#search-box). |
| 4 | + |
| 5 | +**!Note** AQLqueryBuilder.js does NOT contain any code for the search bar, only the |
| 6 | +query string parser and AQL builder. Unabstracted code for the searchbar is |
| 7 | +located |
| 8 | +[here](https://github.com/HP4k1h5/hp4k1h5.github.io/tree/main/demos/src/components/search). |
| 9 | + |
3 | 11 |
|
4 |
| -##### ! pre-alpha (v0.0.X) |
5 | 12 | - [ overview ](#overview)
|
6 | 13 | - [ setup](#setup)
|
7 | 14 | - [ installation](#installation)
|
|
85 | 92 | ## installation
|
86 | 93 | currently there is only support for server-side use.
|
87 | 94 |
|
88 |
| -1) run `yarn add @hp4klh5/AQLqueryBuilder.js` |
89 |
| - or `npm install --save @hp4klh5/AQLqueryBuilder.js` |
| 95 | +1) run `yarn add @hp4k1h5/AQLqueryBuilder.js` |
| 96 | + or `npm install --save @hp4k1h5/AQLqueryBuilder.js` |
90 | 97 | in a directory containing a `package.json` file.
|
91 | 98 | __or__
|
92 | 99 | clone this repository in your node compatible project.
|
93 | 100 |
|
94 | 101 | 2) import/require the exported functions
|
95 | 102 | ```js
|
96 | 103 | // use either
|
97 |
| -import {buildAQL} from '@hp4klh5/AQLqueryBuilder.js' |
| 104 | +import {buildAQL, parseQuery} from '@hp4k1h5/AQLqueryBuilder.js' |
98 | 105 | // or
|
99 |
| -const {buildAQL} = require('@hp4klh5/AQLqueryBuilder.js') |
| 106 | +const {buildAQL} = require('@hp4k1h5/AQLqueryBuilder.js') |
100 | 107 | ```
|
101 | 108 | This has been tested for
|
102 | 109 | - ✅ node v14.4.0
|
@@ -130,7 +137,7 @@ run against any number of language-specific collections simultaneously.
|
130 | 137 |
|
131 | 138 | __Example:__
|
132 | 139 | ```javascript
|
133 |
| -import {buildAQL} from '@hp4klh5/AQLqueryBuilder.js' |
| 140 | +import {buildAQL} from '@hp4k1h5/AQLqueryBuilder.js' |
134 | 141 |
|
135 | 142 | const queryObject = {
|
136 | 143 | "view": "the_arango-search_view-name",
|
|
0 commit comments