search-query-parser/docs/modules/_index_d_.md

Parser for advanced search query syntax

[search-query-parser](../README.md) > ["index.d"](../modules/_index_d_.md)

# External module: "index.d"

## Index

### Interfaces

* [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)

___