35 lines
1.0 KiB
Markdown
35 lines
1.0 KiB
Markdown
[phantom-exo](../README.md) / [Modules](../modules.md) / marmiton/search
|
|
|
|
# Module: marmiton/search
|
|
|
|
## Table of contents
|
|
|
|
### Functions
|
|
|
|
- [search](marmiton_search.md#search)
|
|
|
|
## Functions
|
|
|
|
### search
|
|
|
|
▸ `Const` **search**(`search`, `opts?`): `Promise`<{ `commentCount`: `number` ; `name`: `string` ; `score`: `number` ; `url`: `string` }[]\>
|
|
|
|
function to scrap in the search response on marmiton website
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------- | :------------------------------------------------- | :----------------------------------- |
|
|
| `search` | `string` | words to search into marmiton search |
|
|
| `opts?` | [`SearchOptions`](marmiton_types.md#searchoptions) | option to filter results |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<{ `commentCount`: `number` ; `name`: `string` ; `score`: `number` ; `url`: `string` }[]\>
|
|
|
|
marmiton search result
|
|
|
|
#### Defined in
|
|
|
|
marmiton/search.ts:32
|