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

Removed module, tidied up docs

Browse Source
This commit is contained in:
Geoffrey Roberts
2019-03-06 11:52:19 +11:00
parent e4a7ccc4c4
commit 4bc460cbf9
10 changed files with 194 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/modules/_index_d_.md
View File

@@ -4,9 +4,37 @@
## Index
### Modules
### Interfaces
* [SearchQueryParser](_index_d_.searchqueryparser.md)
* [ISearchParserDictionary](../interfaces/_index_d_.isearchparserdictionary.md)
* [SearchParserOffset](../interfaces/_index_d_.searchparseroffset.md)
* [SearchParserOptions](../interfaces/_index_d_.searchparseroptions.md)
* [SearchParserResult](../interfaces/_index_d_.searchparserresult.md)
### Functions
* [parse](_index_d_.md#parse)
---
## Functions
<a id="parse"></a>
### parse
▸ **parse**(string: *`string`*, options?: *[SearchParserOptions](../interfaces/_index_d_.searchparseroptions.md)*): `string` \| [SearchParserResult](../interfaces/_index_d_.searchparserresult.md)
*Defined in [index.d.ts:32](https://github.com/rtrvrtg/search-query-parser/blob/e4a7ccc/index.d.ts#L32)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| string | `string` |
| `Optional` options | [SearchParserOptions](../interfaces/_index_d_.searchparseroptions.md) |
**Returns:** `string` \| [SearchParserResult](../interfaces/_index_d_.searchparserresult.md)
___