davejansen/search-query-parser
Archived
1
0
Fork 0
Code Activity

Updated README.md to reflect new functionality

Browse Source
This commit is contained in:
Tristan Jones
2018-04-11 10:24:27 -07:00
parent 02357ad02b
commit 972a46d2f5
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -53,27 +53,30 @@ var searchQueryObj = searchQuery.parse(query, options);
``` ```
You can configure what keywords and ranges the parser should accept with the options argument. You can configure what keywords and ranges the parser should accept with the options argument.
It accepts 2 values: It accepts 3 values:
* `keywords`, that can be separated by commas (,) * `keywords`, that can be separated by commas (,). Accepts an array of strings.
* `ranges`, that can be separated by a hyphen (-) * `ranges`, that can be separated by a hyphen (-). Accepts an array of strings.
* `tokenize`, that controls the behaviour of text search terms. If set to `true`, non-keyword text terms are returned as an array of strings where each term in the array is a whitespace-separated word, or a multi-word term surrounded by single- or double-quotes.
Both values take an array of strings, as in the example just above. If no keywords or ranges are specified, or if none are present in the given search query, then `searchQuery.parse` will return a string if `tokenize` is false, or an array of strings under the key `text` if `tokenize` is true.
If no keywords or ranges are specified, or if none are present in the given search query, then `searchQuery.parse` will return a string.
```javascript ```javascript
var searchQuery = require('search-query-parser'); var searchQuery = require('search-query-parser');
var query = 'a query with just text'; var query = 'a query with "just text"';
var parsedQuery = searchQuery.parse(query); var parsedQuery = searchQuery.parse(query);
// parsedQuery is now 'a query with just text' // parsedQuery is now 'a query with "just text"'
var options = {keywords: ['unused']}; var options = {keywords: ['unused']};
var parsedQueryWithOptions = searchQuery.parse(query, options); var parsedQueryWithOptions = searchQuery.parse(query, options);
// parsedQueryWithOptions is now 'a query with just text' // parsedQueryWithOptions is now 'a query with "just text"'
var options2 = {tokenize: true};
var parsedQueryWithTokens = searchQuery.parse(query, options2);
// parsedQueryWithTokens is now: ['a', 'query', 'with', 'just text']
``` ```
You can also use exclusion syntax, like `-from:sep@foobar.io name:hello,world` . And it will return : You can also use exclusion syntax, like `-from:sep@foobar.io name:hello,world`. This also works with non-keyword text terms when `tokenize` is set to `true`.
```javascript ```javascript
{ {
@@ -86,7 +89,7 @@ You can also use exclusion syntax, like `-from:sep@foobar.io name:hello,world` .
## Testing ## Testing
The 20 tests are written using the BDD testing framework should.js, and run with mocha. The 27 tests are written using the BDD testing framework should.js, and run with mocha.
Run `npm install should` and `npm install -g mocha` to install them both. Run `npm install should` and `npm install -g mocha` to install them both.