docs: TSDoc + reference of fulfillment service (#5761)

This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions

View File

@@ -10,13 +10,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [ISearchService](../interfaces/ISearchService.mdx)
## Constructors
#### constructor
## constructor
`Protected **new AbstractSearchService**(container, options)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -39,6 +37,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -62,21 +62,41 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### options
### options
**options**: [object Object]
`get**options**(): Record&#60;string, unknown&#62;`
#### Returns
`Record<string, unknown>`
<ParameterTypes parameters={[
{
"name": "Record",
"type": "`Record<string, unknown>`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### addDocuments
### addDocuments
`Abstract **addDocuments**(indexName, documents, type): unknown`
Used to index documents by the search engine provider
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -108,7 +128,7 @@ Used to index documents by the search engine provider
}
]} />
##### Returns
#### Returns
`unknown`
@@ -126,13 +146,13 @@ Used to index documents by the search engine provider
___
#### createIndex
### createIndex
`Abstract **createIndex**(indexName, options): unknown`
Used to create an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -155,7 +175,7 @@ Used to create an index
}
]} />
##### Returns
#### Returns
`unknown`
@@ -173,13 +193,13 @@ Used to create an index
___
#### deleteAllDocuments
### deleteAllDocuments
`Abstract **deleteAllDocuments**(indexName): unknown`
Used to delete all documents
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -193,7 +213,7 @@ Used to delete all documents
}
]} />
##### Returns
#### Returns
`unknown`
@@ -211,13 +231,13 @@ Used to delete all documents
___
#### deleteDocument
### deleteDocument
`Abstract **deleteDocument**(indexName, document_id): unknown`
Used to delete document
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -240,7 +260,7 @@ Used to delete document
}
]} />
##### Returns
#### Returns
`unknown`
@@ -258,13 +278,13 @@ Used to delete document
___
#### getIndex
### getIndex
`Abstract **getIndex**(indexName): unknown`
Used to get an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -278,7 +298,7 @@ Used to get an index
}
]} />
##### Returns
#### Returns
`unknown`
@@ -296,13 +316,13 @@ Used to get an index
___
#### replaceDocuments
### replaceDocuments
`Abstract **replaceDocuments**(indexName, documents, type): unknown`
Used to replace documents
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -334,7 +354,7 @@ Used to replace documents
}
]} />
##### Returns
#### Returns
`unknown`
@@ -352,13 +372,13 @@ Used to replace documents
___
#### search
### search
`Abstract **search**(indexName, query, options): unknown`
Used to search for a document in an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -390,7 +410,7 @@ Used to search for a document in an index
}
]} />
##### Returns
#### Returns
`unknown`
@@ -408,13 +428,13 @@ Used to search for a document in an index
___
#### updateSettings
### updateSettings
`Abstract **updateSettings**(indexName, settings): unknown`
Used to update the settings of an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -437,7 +457,7 @@ Used to update the settings of an index
}
]} />
##### Returns
#### Returns
`unknown`