You've already forked search-query-parser
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
[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)
|
|
|
|
___
|
|
|