asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
216faf0369f6920d4e1e615c8a3e0999573defa9
medusa-store/docs/content/references/services/classes/NoteService.md
github-actions[bot] 5c8ef2d370 chore(docs): Generated Services Reference (automated) (#4206) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-05-31 16:44:22 +03:00

364 lines
8.1 KiB
Markdown
Raw Blame History

# Class: NoteService
## Hierarchy
- `TransactionBaseService`
↳ **`NoteService`**
## Constructors
### constructor
• **new NoteService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L27)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L25)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Inherited from
TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### noteRepository\_
• `Protected` `Readonly` **noteRepository\_**: `Repository`<`Note`\>
#### Defined in
[medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L24)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CREATED` | `string` |
| `DELETED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L18)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `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` |
#### Parameters
| Name | Type | 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 |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### create
▸ **create**(`data`, `config?`): `Promise`<`Note`\>
Creates a note associated with a given author
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateNoteInput` | the note to create |
| `config` | `Object` | any configurations if needed, including meta data |
| `config.metadata` | `Record`<`string`, `unknown`\> | - |
#### Returns
`Promise`<`Note`\>
resolves to the creation result
#### Defined in
[medusa/src/services/note.ts:97](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L97)
___
### delete
▸ **delete**(`noteId`): `Promise`<`void`\>
Deletes a given note
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `string` | id of the note to delete |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L155)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`Note`[]\>
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`[]\>
notes related to the given search.
#### Defined in
[medusa/src/services/note.ts:76](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L76)
___
### retrieve
▸ **retrieve**(`noteId`, `config?`): `Promise`<`Note`\>
Retrieves a specific note.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `string` | the id of the note to retrieve. |
| `config` | `FindConfig`<`Note`\> | any options needed to query for the result. |
#### Returns
`Promise`<`Note`\>
which resolves to the requested note.
#### Defined in
[medusa/src/services/note.ts:41](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L41)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
▸ **update**(`noteId`, `value`): `Promise`<`Note`\>
Updates a given note with a new value
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `string` | the id of the note to update |
| `value` | `string` | the new value |
#### Returns
`Promise`<`Note`\>
resolves to the updated element
#### Defined in
[medusa/src/services/note.ts:133](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/note.ts#L133)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`NoteService`](NoteService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`NoteService`](NoteService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
Reference in New Issue View Git Blame Copy Permalink