asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5743)

Browse Source 
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:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
www/apps/docs/content/references/services/classes/SearchService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new SearchService**(«destructured», options)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -69,35 +69,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### options
#### options
`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": []
}
]} />
**options**: [object Object]
## Methods
### addDocuments
#### addDocuments
`**addDocuments**(indexName, documents, type): Promise&#60;void&#62;`
Used to index documents by the search engine provider
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -129,7 +113,7 @@ Used to index documents by the search engine provider
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -147,13 +131,13 @@ Promise&#60;void&#62;
___
### createIndex
#### createIndex
`**createIndex**(indexName, options): Promise&#60;void&#62;`
Used to create an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -176,7 +160,7 @@ Used to create an index
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -194,13 +178,13 @@ Promise&#60;void&#62;
___
### deleteAllDocuments
#### deleteAllDocuments
`**deleteAllDocuments**(indexName): Promise&#60;void&#62;`
Used to delete all documents
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -214,7 +198,7 @@ Used to delete all documents
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -232,13 +216,13 @@ Promise&#60;void&#62;
___
### deleteDocument
#### deleteDocument
`**deleteDocument**(indexName, document_id): Promise&#60;void&#62;`
Used to delete document
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -261,7 +245,7 @@ Used to delete document
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -279,13 +263,13 @@ Promise&#60;void&#62;
___
### getIndex
#### getIndex
`**getIndex**(indexName): Promise&#60;void&#62;`
Used to get an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -299,7 +283,7 @@ Used to get an index
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -317,13 +301,13 @@ Promise&#60;void&#62;
___
### replaceDocuments
#### replaceDocuments
`**replaceDocuments**(indexName, documents, type): Promise&#60;void&#62;`
Used to replace documents
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -355,7 +339,7 @@ Used to replace documents
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -373,13 +357,13 @@ Promise&#60;void&#62;
___
### search
#### search
`**search**(indexName, query, options): Promise&#60;&#123; hits: unknown[] &#125;&#62;`
Used to search for a document in an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -411,7 +395,7 @@ Used to search for a document in an index
}
]} />
#### Returns
##### Returns
Promise&#60;&#123; hits: unknown[] &#125;&#62;
@@ -429,13 +413,13 @@ Promise&#60;&#123; hits: unknown[] &#125;&#62;
___
### updateSettings
#### updateSettings
`**updateSettings**(indexName, settings): Promise&#60;void&#62;`
Used to update the settings of an index
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -458,7 +442,7 @@ Used to update the settings of an index
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;