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

17
docs/interfaces/_index_d_.searchqueryparser.isearchparserdictionary.md Normal file
View File

@@ -0,0 +1,17 @@
[search-query-parser](../README.md) > ["index.d"](../modules/_index_d_.md) > [SearchQueryParser](../modules/_index_d_.searchqueryparser.md) > [ISearchParserDictionary](../interfaces/_index_d_.searchqueryparser.isearchparserdictionary.md)
# Interface: ISearchParserDictionary
## Hierarchy
**ISearchParserDictionary**
↳ [SearchParserResult](_index_d_.searchqueryparser.searchparserresult.md)
## Indexable
\[key: `string`\]: `any`
## Index
---

58
docs/interfaces/_index_d_.searchqueryparser.searchparseroffset.md Normal file
View File

@@ -0,0 +1,58 @@
[search-query-parser](../README.md) > ["index.d"](../modules/_index_d_.md) > [SearchQueryParser](../modules/_index_d_.searchqueryparser.md) > [SearchParserOffset](../interfaces/_index_d_.searchqueryparser.searchparseroffset.md)
# Interface: SearchParserOffset
## Hierarchy
**SearchParserOffset**
## Index
### Properties
* [keyword](_index_d_.searchqueryparser.searchparseroffset.md#keyword)
* [offsetEnd](_index_d_.searchqueryparser.searchparseroffset.md#offsetend)
* [offsetStart](_index_d_.searchqueryparser.searchparseroffset.md#offsetstart)
* [value](_index_d_.searchqueryparser.searchparseroffset.md#value)
---
## Properties
<a id="keyword"></a>
### keyword
**● keyword**: *`string`*
*Defined in [index.d.ts:21](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L21)*
___
<a id="offsetend"></a>
### offsetEnd
**● offsetEnd**: *`number`*
*Defined in [index.d.ts:24](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L24)*
___
<a id="offsetstart"></a>
### offsetStart
**● offsetStart**: *`number`*
*Defined in [index.d.ts:23](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L23)*
___
<a id="value"></a>
### `<Optional>` value
**● value**: *`string`*
*Defined in [index.d.ts:22](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L22)*
___

68
docs/interfaces/_index_d_.searchqueryparser.searchparseroptions.md Normal file
View File

@@ -0,0 +1,68 @@
[search-query-parser](../README.md) > ["index.d"](../modules/_index_d_.md) > [SearchQueryParser](../modules/_index_d_.searchqueryparser.md) > [SearchParserOptions](../interfaces/_index_d_.searchqueryparser.searchparseroptions.md)
# Interface: SearchParserOptions
## Hierarchy
**SearchParserOptions**
## Index
### Properties
* [alwaysArray](_index_d_.searchqueryparser.searchparseroptions.md#alwaysarray)
* [keywords](_index_d_.searchqueryparser.searchparseroptions.md#keywords)
* [offsets](_index_d_.searchqueryparser.searchparseroptions.md#offsets)
* [ranges](_index_d_.searchqueryparser.searchparseroptions.md#ranges)
* [tokenize](_index_d_.searchqueryparser.searchparseroptions.md#tokenize)
---
## Properties
<a id="alwaysarray"></a>
### `<Optional>` alwaysArray
**● alwaysArray**: *`boolean`*
*Defined in [index.d.ts:13](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L13)*
___
<a id="keywords"></a>
### `<Optional>` keywords
**● keywords**: *`string`[]*
*Defined in [index.d.ts:11](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L11)*
___
<a id="offsets"></a>
### `<Optional>` offsets
**● offsets**: *`boolean`*
*Defined in [index.d.ts:9](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L9)*
___
<a id="ranges"></a>
### `<Optional>` ranges
**● ranges**: *`string`[]*
*Defined in [index.d.ts:12](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L12)*
___
<a id="tokenize"></a>
### `<Optional>` tokenize
**● tokenize**: *`boolean`*
*Defined in [index.d.ts:10](https://github.com/rtrvrtg/search-query-parser/blob/5612d18/index.d.ts#L10)*
___

53
docs/interfaces/_index_d_.searchqueryparser.searchparserresult.md Normal file
View File

@@ -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`\]:&nbsp;`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)*
___