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

Added type documentation

Browse Source
This commit is contained in:
Geoffrey Roberts
2019-03-06 11:31:03 +11:00
parent 5612d18669
commit b1f62a7397
12 changed files with 1356 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/modules/_index_d_.searchqueryparser.md Normal file
View File

@@ -0,0 +1,40 @@
[search-query-parser](../README.md) > ["index.d"](../modules/_index_d_.md) > [SearchQueryParser](../modules/_index_d_.searchqueryparser.md)
# Module: SearchQueryParser
## Index
### Interfaces
* [ISearchParserDictionary](../interfaces/_index_d_.searchqueryparser.isearchparserdictionary.md)
* [SearchParserOffset](../interfaces/_index_d_.searchqueryparser.searchparseroffset.md)
* [SearchParserOptions](../interfaces/_index_d_.searchqueryparser.searchparseroptions.md)
* [SearchParserResult](../interfaces/_index_d_.searchqueryparser.searchparserresult.md)
### Functions
* [parse](_index_d_.searchqueryparser.md#parse)
---
## Functions
<a id="parse"></a>
### parse
▸ **parse**(string: *`string`*, options?: *[SearchParserOptions](../interfaces/_index_d_.searchqueryparser.searchparseroptions.md)*): `string` \| [SearchParserResult](../interfaces/_index_d_.searchqueryparser.searchparserresult.md)
*Defined in [index.d.ts:33](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L33)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| string | `string` |
| `Optional` options | [SearchParserOptions](../interfaces/_index_d_.searchqueryparser.searchparseroptions.md) |
**Returns:** `string` \| [SearchParserResult](../interfaces/_index_d_.searchqueryparser.searchparserresult.md)
___