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

80
www/apps/docs/content/references/services/classes/NoteService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new NoteService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -132,29 +132,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -162,6 +146,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -183,7 +169,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -215,7 +201,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -233,13 +219,13 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(data, config?): Promise&#60;[Note](Note.mdx)&#62;`
Creates a note associated with a given author
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -271,7 +257,7 @@ Creates a note associated with a given author
}
]} />
#### Returns
##### Returns
Promise&#60;[Note](Note.mdx)&#62;
@@ -289,13 +275,13 @@ Promise&#60;[Note](Note.mdx)&#62;
___
### delete
#### delete
`**delete**(noteId): Promise&#60;void&#62;`
Deletes a given note
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -309,7 +295,7 @@ Deletes a given note
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -327,13 +313,13 @@ Promise&#60;void&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[Note](Note.mdx)[]&#62;`
Fetches all notes related to the given selector
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -356,7 +342,7 @@ Fetches all notes related to the given selector
}
]} />
#### Returns
##### Returns
Promise&#60;[Note](Note.mdx)[]&#62;
@@ -374,13 +360,13 @@ Promise&#60;[Note](Note.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[Note](Note.mdx)[], number]&#62;`
Fetches all notes related to the given selector
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -403,7 +389,7 @@ Fetches all notes related to the given selector
}
]} />
#### Returns
##### Returns
Promise&#60;[[Note](Note.mdx)[], number]&#62;
@@ -421,13 +407,13 @@ Promise&#60;[[Note](Note.mdx)[], number]&#62;
___
### retrieve
#### retrieve
`**retrieve**(noteId, config?): Promise&#60;[Note](Note.mdx)&#62;`
Retrieves a specific note.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -450,7 +436,7 @@ Retrieves a specific note.
}
]} />
#### Returns
##### Returns
Promise&#60;[Note](Note.mdx)&#62;
@@ -468,11 +454,11 @@ Promise&#60;[Note](Note.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -486,7 +472,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -504,13 +490,13 @@ ___
___
### update
#### update
`**update**(noteId, value): Promise&#60;[Note](Note.mdx)&#62;`
Updates a given note with a new value
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -533,7 +519,7 @@ Updates a given note with a new value
}
]} />
#### Returns
##### Returns
Promise&#60;[Note](Note.mdx)&#62;
@@ -551,11 +537,11 @@ Promise&#60;[Note](Note.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [NoteService](NoteService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -569,7 +555,7 @@ ___
}
]} />
#### Returns
##### Returns
[NoteService](NoteService.mdx)