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

chore(docs): Generated References (#5516)

Browse Source 
Generated the following references:
- `js-client`
- `pricing`
- `services`

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-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
www/apps/docs/content/references/services/classes/NoteService.md
View File

@@ -1,4 +1,4 @@
# Class: NoteService
# NoteService
## Hierarchy
@@ -10,12 +10,12 @@
### constructor
• **new NoteService**(`«destructured»`)
**new NoteService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -24,13 +24,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/note.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L28)
[medusa/src/services/note.ts:28](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L28)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -38,13 +38,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -52,13 +52,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -66,23 +66,23 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
`Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L26)
[medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L26)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -90,23 +90,23 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### noteRepository\_
• `Protected` `Readonly` **noteRepository\_**: `Repository`<`Note`\>
`Protected` `Readonly` **noteRepository\_**: `Repository`<`Note`\>
#### Defined in
[medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L25)
[medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L25)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -114,13 +114,13 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
`Static` `Readonly` **Events**: `Object`
#### Type declaration
@@ -132,47 +132,47 @@ ___
#### Defined in
[medusa/src/services/note.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L19)
[medusa/src/services/note.ts:19](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L19)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
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
| Name |
| :------ |
| `TResult` |
| `TError` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
@@ -181,7 +181,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -189,68 +189,71 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### create
▸ **create**(`data`, `config?`): `Promise`<`Note`\>
**create**(`data`, `config?`): `Promise`<`Note`\>
Creates a note associated with a given author
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `data` | `CreateNoteInput` | the note to create |
| `config` | `Object` | any configurations if needed, including meta data |
| `config.metadata` | `Record`<`string`, `unknown`\> | - |
| `config` | `object` | any configurations if needed, including meta data |
| `config.metadata` | Record<`string`, `unknown`\> |
#### Returns
`Promise`<`Note`\>
resolves to the creation result
-`Promise`: resolves to the creation result
-`Note`:
#### Defined in
[medusa/src/services/note.ts:119](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L119)
[medusa/src/services/note.ts:119](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L119)
___
### delete
▸ **delete**(`noteId`): `Promise`<`void`\>
**delete**(`noteId`): `Promise`<`void`\>
Deletes a given note
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `noteId` | `string` | id of the note to delete |
#### Returns
`Promise`<`void`\>
-`Promise`:
#### Defined in
[medusa/src/services/note.ts:177](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L177)
[medusa/src/services/note.ts:177](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L177)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`Note`[]\>
**list**(`selector`, `config?`): `Promise`<`Note`[]\>
Fetches all notes related to the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `Selector`<`Note`\> | the query object for find |
| `config` | `FindConfig`<`Note`\> | the configuration used to find the objects. contains relations, skip, and take. |
@@ -258,24 +261,26 @@ Fetches all notes related to the given selector
`Promise`<`Note`[]\>
notes related to the given search.
-`Promise`: notes related to the given search.
-`Note[]`:
-`Note`:
#### Defined in
[medusa/src/services/note.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L77)
[medusa/src/services/note.ts:77](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L77)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Note`[], `number`]\>
**listAndCount**(`selector`, `config?`): `Promise`<[`Note`[], `number`]\>
Fetches all notes related to the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `Selector`<`Note`\> | the query object for find |
| `config` | `FindConfig`<`Note`\> | the configuration used to find the objects. contains relations, skip, and take. |
@@ -283,24 +288,26 @@ Fetches all notes related to the given selector
`Promise`<[`Note`[], `number`]\>
notes related to the given search.
-`Promise`: notes related to the given search.
-`Note[]`:
-`number`: (optional)
#### Defined in
[medusa/src/services/note.ts:98](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L98)
[medusa/src/services/note.ts:98](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L98)
___
### retrieve
▸ **retrieve**(`noteId`, `config?`): `Promise`<`Note`\>
**retrieve**(`noteId`, `config?`): `Promise`<`Note`\>
Retrieves a specific note.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `noteId` | `string` | the id of the note to retrieve. |
| `config` | `FindConfig`<`Note`\> | any options needed to query for the result. |
@@ -308,48 +315,51 @@ Retrieves a specific note.
`Promise`<`Note`\>
which resolves to the requested note.
-`Promise`: which resolves to the requested note.
-`Note`:
#### Defined in
[medusa/src/services/note.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L42)
[medusa/src/services/note.ts:42](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L42)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
▸ **update**(`noteId`, `value`): `Promise`<`Note`\>
**update**(`noteId`, `value`): `Promise`<`Note`\>
Updates a given note with a new value
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `noteId` | `string` | the id of the note to update |
| `value` | `string` | the new value |
@@ -357,32 +367,35 @@ Updates a given note with a new value
`Promise`<`Note`\>
resolves to the updated element
-`Promise`: resolves to the updated element
-`Note`:
#### Defined in
[medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/note.ts#L155)
[medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/note.ts#L155)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`NoteService`](NoteService.md)
**withTransaction**(`transactionManager?`): [`NoteService`](NoteService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`NoteService`](NoteService.md)
-`NoteService`:
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)