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
@@ -20,15 +20,17 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Methods
#### addDocuments
### addDocuments
`**addDocuments**(indexName, documents, type): unknown`
Used to index documents by the search engine provider
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -60,7 +62,7 @@ Used to index documents by the search engine provider
}
]} />
##### Returns
#### Returns
`unknown`
@@ -78,13 +80,13 @@ Used to index documents by the search engine provider
___
#### createIndex
### createIndex
`**createIndex**(indexName, options): unknown`
Used to create an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -107,7 +109,7 @@ Used to create an index
}
]} />
##### Returns
#### Returns
`unknown`
@@ -125,13 +127,13 @@ Used to create an index
___
#### deleteAllDocuments
### deleteAllDocuments
`**deleteAllDocuments**(indexName): unknown`
Used to delete all documents
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -145,7 +147,7 @@ Used to delete all documents
}
]} />
##### Returns
#### Returns
`unknown`
@@ -163,13 +165,13 @@ Used to delete all documents
___
#### deleteDocument
### deleteDocument
`**deleteDocument**(indexName, document_id): unknown`
Used to delete document
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +194,7 @@ Used to delete document
}
]} />
##### Returns
#### Returns
`unknown`
@@ -210,13 +212,13 @@ Used to delete document
___
#### getIndex
### getIndex
`**getIndex**(indexName): unknown`
Used to get an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -230,7 +232,7 @@ Used to get an index
}
]} />
##### Returns
#### Returns
`unknown`
@@ -248,13 +250,13 @@ Used to get an index
___
#### replaceDocuments
### replaceDocuments
`**replaceDocuments**(indexName, documents, type): unknown`
Used to replace documents
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -286,7 +288,7 @@ Used to replace documents
}
]} />
##### Returns
#### Returns
`unknown`
@@ -304,13 +306,13 @@ Used to replace documents
___
#### search
### search
`**search**(indexName, query, options): unknown`
Used to search for a document in an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -342,7 +344,7 @@ Used to search for a document in an index
}
]} />
##### Returns
#### Returns
`unknown`
@@ -360,13 +362,13 @@ Used to search for a document in an index
___
#### updateSettings
### updateSettings
`**updateSettings**(indexName, settings): unknown`
Used to update the settings of an index
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -389,7 +391,7 @@ Used to update the settings of an index
}
]} />
##### Returns
#### Returns
`unknown`