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

chore: fixed commit branch on generate reference action (#1857)

Browse Source 
* fixed commit branch

* fixes after yarn upgrade
This commit is contained in:
Shahed Nasser
2022-07-15 18:08:07 +03:00
committed by GitHub
parent 32b066d923
commit e134f6d237
49 changed files with 13599 additions and 11325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -24,7 +24,7 @@ BaseService.constructor
#### Defined in
[services/note.js:12](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L12)
[services/note.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L12)
## Properties
@@ -42,7 +42,7 @@ BaseService.constructor
#### Defined in
[services/note.js:6](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L6)
[services/note.js:6](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L6)
## Methods
@@ -50,24 +50,20 @@ BaseService.constructor
▸ **create**(`data`, `config?`): `Promise`<`any`\>
Creates a note associated with a given author
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateNoteInput` | the note to create |
| `config` | `any` | any configurations if needed, including meta data |
| `data` | `CreateNoteInput` | |
| `config` | `any` | |
#### Returns
`Promise`<`any`\>
resolves to the creation result
#### Defined in
[services/note.js:98](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L98)
[services/note.js:98](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L98)
___
@@ -75,13 +71,11 @@ ___
▸ **delete**(`noteId`): `Promise`<`any`\>
Deletes a given note
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `any` | id of the note to delete |
| `noteId` | `any` | |
#### Returns
@@ -89,7 +83,7 @@ Deletes a given note
#### Defined in
[services/note.js:154](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L154)
[services/note.js:154](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L154)
___
@@ -97,27 +91,23 @@ ___
▸ **list**(`selector`, `config?`): `Promise`<`Note`[]\>
Fetches all notes related to the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | the query object for find |
| `config` | `Object` | the configuration used to find the objects. contains relations, skip, and take. |
| `config.relations` | `string`[] | Which relations to include in the resulting list of Notes. |
| `config.skip` | `number` | How many Notes to skip in the resulting list of Notes. |
| `config.take` | `number` | How many Notes to take in the resulting list of Notes. |
| `selector` | `any` | |
| `config` | `Object` | |
| `config.relations` | `string`[] | |
| `config.skip` | `number` | |
| `config.take` | `number` | |
#### Returns
`Promise`<`Note`[]\>
notes related to the given search.
#### Defined in
[services/note.js:77](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L77)
[services/note.js:77](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L77)
___
@@ -125,24 +115,20 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`Note`\>
Retrieves a specific note.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the note to retrieve. |
| `config` | `any` | any options needed to query for the result. |
| `id` | `string` | |
| `config` | `any` | |
#### Returns
`Promise`<`Note`\>
which resolves to the requested note.
#### Defined in
[services/note.js:51](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L51)
[services/note.js:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L51)
___
@@ -150,24 +136,20 @@ ___
▸ **update**(`noteId`, `value`): `Promise`<`any`\>
Updates a given note with a new value
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `any` | the id of the note to update |
| `value` | `any` | the new value |
| `noteId` | `any` | |
| `value` | `any` | |
#### Returns
`Promise`<`any`\>
resolves to the updated element
#### Defined in
[services/note.js:131](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L131)
[services/note.js:131](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L131)
___
@@ -175,20 +157,16 @@ ___
▸ **withTransaction**(`transactionManager`): [`NoteService`](NoteService.md)
Sets the service's manager to a given transaction manager
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `transactionManager` | `EntityManager` | the manager to use |
| `transactionManager` | `EntityManager` | |
#### Returns
[`NoteService`](NoteService.md)
a cloned note service
#### Defined in
[services/note.js:30](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/note.js#L30)
[services/note.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L30)