You've already forked search-query-parser
Added type documentation
This commit is contained in:
@@ -0,0 +1,53 @@
|
||||
[search-query-parser](../README.md) > ["index.d"](../modules/_index_d_.md) > [SearchQueryParser](../modules/_index_d_.searchqueryparser.md) > [SearchParserResult](../interfaces/_index_d_.searchqueryparser.searchparserresult.md)
|
||||
|
||||
# Interface: SearchParserResult
|
||||
|
||||
## Hierarchy
|
||||
|
||||
[ISearchParserDictionary](_index_d_.searchqueryparser.isearchparserdictionary.md)
|
||||
|
||||
**↳ SearchParserResult**
|
||||
|
||||
## Indexable
|
||||
|
||||
\[key: `string`\]: `any`
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
* [exclude](_index_d_.searchqueryparser.searchparserresult.md#exclude)
|
||||
* [offsets](_index_d_.searchqueryparser.searchparserresult.md#offsets)
|
||||
* [text](_index_d_.searchqueryparser.searchparserresult.md#text)
|
||||
|
||||
---
|
||||
|
||||
## Properties
|
||||
|
||||
<a id="exclude"></a>
|
||||
|
||||
### `<Optional>` exclude
|
||||
|
||||
**● exclude**: *[ISearchParserDictionary](_index_d_.searchqueryparser.isearchparserdictionary.md)*
|
||||
|
||||
*Defined in [index.d.ts:30](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L30)*
|
||||
|
||||
___
|
||||
<a id="offsets"></a>
|
||||
|
||||
### `<Optional>` offsets
|
||||
|
||||
**● offsets**: *[SearchParserOffset](_index_d_.searchqueryparser.searchparseroffset.md)[]*
|
||||
|
||||
*Defined in [index.d.ts:29](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L29)*
|
||||
|
||||
___
|
||||
<a id="text"></a>
|
||||
|
||||
### `<Optional>` text
|
||||
|
||||
**● text**: *`string` \| `string`[]*
|
||||
|
||||
*Defined in [index.d.ts:28](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L28)*
|
||||
|
||||
___
|
||||
|
||||
Reference in New Issue
Block a user