chore(docs): Generated References (#5743)
Generated the following references: - `entities` - `inventory` - `js-client` - `pricing` - `product` - `services` - `stock-location` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -12,11 +12,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
#### constructor
|
||||
|
||||
`Protected **new AbstractSearchService**(container, options)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -64,35 +64,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
## Accessors
|
||||
|
||||
### options
|
||||
#### options
|
||||
|
||||
`get**options**(): Record<string, unknown>`
|
||||
|
||||
#### Returns
|
||||
|
||||
`Record<string, unknown>`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Record",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
**options**: [object Object]
|
||||
|
||||
## Methods
|
||||
|
||||
### addDocuments
|
||||
#### addDocuments
|
||||
|
||||
`Abstract **addDocuments**(indexName, documents, type): unknown`
|
||||
|
||||
Used to index documents by the search engine provider
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -124,7 +108,7 @@ Used to index documents by the search engine provider
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -142,13 +126,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={[
|
||||
{
|
||||
@@ -171,7 +155,7 @@ Used to create an index
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -189,13 +173,13 @@ Used to create an index
|
||||
|
||||
___
|
||||
|
||||
### deleteAllDocuments
|
||||
#### deleteAllDocuments
|
||||
|
||||
`Abstract **deleteAllDocuments**(indexName): unknown`
|
||||
|
||||
Used to delete all documents
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -209,7 +193,7 @@ Used to delete all documents
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -227,13 +211,13 @@ Used to delete all documents
|
||||
|
||||
___
|
||||
|
||||
### deleteDocument
|
||||
#### deleteDocument
|
||||
|
||||
`Abstract **deleteDocument**(indexName, document_id): unknown`
|
||||
|
||||
Used to delete document
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -256,7 +240,7 @@ Used to delete document
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -274,13 +258,13 @@ Used to delete document
|
||||
|
||||
___
|
||||
|
||||
### getIndex
|
||||
#### getIndex
|
||||
|
||||
`Abstract **getIndex**(indexName): unknown`
|
||||
|
||||
Used to get an index
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -294,7 +278,7 @@ Used to get an index
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -312,13 +296,13 @@ Used to get an index
|
||||
|
||||
___
|
||||
|
||||
### replaceDocuments
|
||||
#### replaceDocuments
|
||||
|
||||
`Abstract **replaceDocuments**(indexName, documents, type): unknown`
|
||||
|
||||
Used to replace documents
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -350,7 +334,7 @@ Used to replace documents
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -368,13 +352,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={[
|
||||
{
|
||||
@@ -406,7 +390,7 @@ Used to search for a document in an index
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
@@ -424,13 +408,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={[
|
||||
{
|
||||
@@ -453,7 +437,7 @@ Used to update the settings of an index
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`unknown`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user