docs: TSDoc + reference of fulfillment service (#5761)
This commit is contained in:
@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SearchService
|
||||
|
||||
## Constructors
|
||||
|
||||
#### constructor
|
||||
## constructor
|
||||
|
||||
`**new SearchService**(«destructured», options)`
|
||||
|
||||
##### Parameters
|
||||
### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -35,6 +33,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -67,21 +67,41 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Accessors
|
||||
|
||||
#### options
|
||||
### options
|
||||
|
||||
**options**: [object Object]
|
||||
`get**options**(): Record<string, unknown>`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Record<string, unknown>`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Record",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
#### addDocuments
|
||||
### addDocuments
|
||||
|
||||
`**addDocuments**(indexName, documents, type): Promise<void>`
|
||||
|
||||
Used to index documents by the search engine provider
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -113,7 +133,7 @@ Used to index documents by the search engine provider
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -131,13 +151,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### createIndex
|
||||
### createIndex
|
||||
|
||||
`**createIndex**(indexName, options): Promise<void>`
|
||||
|
||||
Used to create an index
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -160,7 +180,7 @@ Used to create an index
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -178,13 +198,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### deleteAllDocuments
|
||||
### deleteAllDocuments
|
||||
|
||||
`**deleteAllDocuments**(indexName): Promise<void>`
|
||||
|
||||
Used to delete all documents
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -198,7 +218,7 @@ Used to delete all documents
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -216,13 +236,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### deleteDocument
|
||||
### deleteDocument
|
||||
|
||||
`**deleteDocument**(indexName, document_id): Promise<void>`
|
||||
|
||||
Used to delete document
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -245,7 +265,7 @@ Used to delete document
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -263,13 +283,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### getIndex
|
||||
### getIndex
|
||||
|
||||
`**getIndex**(indexName): Promise<void>`
|
||||
|
||||
Used to get an index
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -283,7 +303,7 @@ Used to get an index
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -301,13 +321,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### replaceDocuments
|
||||
### replaceDocuments
|
||||
|
||||
`**replaceDocuments**(indexName, documents, type): Promise<void>`
|
||||
|
||||
Used to replace documents
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -339,7 +359,7 @@ Used to replace documents
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -357,13 +377,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
#### search
|
||||
### search
|
||||
|
||||
`**search**(indexName, query, options): Promise<{ hits: unknown[] }>`
|
||||
|
||||
Used to search for a document in an index
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -395,7 +415,7 @@ Used to search for a document in an index
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<{ hits: unknown[] }>
|
||||
|
||||
@@ -413,13 +433,13 @@ Promise<{ hits: unknown[] }>
|
||||
|
||||
___
|
||||
|
||||
#### updateSettings
|
||||
### updateSettings
|
||||
|
||||
`**updateSettings**(indexName, settings): Promise<void>`
|
||||
|
||||
Used to update the settings of an index
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -442,7 +462,7 @@ Used to update the settings of an index
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user