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

chore(docs): Generated Services Reference (automated) (#4560)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-07-20 11:11:28 +03:00
committed by GitHub
parent e8b27b0cde
commit 6ee80794c9
58 changed files with 1686 additions and 1547 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/content/references/services/classes/NoteService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L27)
[medusa/src/services/note.ts:28](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L28)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L25)
[medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L26)
___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
[medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L24)
[medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L25)
___
@@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
@@ -132,7 +132,7 @@ ___
#### Defined in
[medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L18)
[medusa/src/services/note.ts:19](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L19)
## Accessors
@@ -150,7 +150,7 @@ TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
@@ -189,7 +189,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
@@ -215,7 +215,7 @@ resolves to the creation result
#### Defined in
[medusa/src/services/note.ts:97](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L97)
[medusa/src/services/note.ts:119](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L119)
___
@@ -237,7 +237,7 @@ Deletes a given note
#### Defined in
[medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L155)
[medusa/src/services/note.ts:177](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L177)
___
@@ -262,7 +262,32 @@ notes related to the given search.
#### Defined in
[medusa/src/services/note.ts:76](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L76)
[medusa/src/services/note.ts:77](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L77)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Note`[], `number`]\>
Fetches all notes related to the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Note`\> | the query object for find |
| `config` | `FindConfig`<`Note`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<[`Note`[], `number`]\>
notes related to the given search.
#### Defined in
[medusa/src/services/note.ts:98](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L98)
___
@@ -287,7 +312,7 @@ which resolves to the requested note.
#### Defined in
[medusa/src/services/note.ts:41](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L41)
[medusa/src/services/note.ts:42](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L42)
___
@@ -311,7 +336,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
@@ -336,7 +361,7 @@ resolves to the updated element
#### Defined in
[medusa/src/services/note.ts:133](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/note.ts#L133)
[medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/note.ts#L155)
___
@@ -360,4 +385,4 @@ TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L20)