NoteService
Hierarchy
TransactionBaseService↳
NoteService
Constructors
constructor
new NoteService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/note.ts:28
Properties
__configModule__
Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
eventBus_
Protected Readonly eventBus_: EventBusService
Defined in
medusa/src/services/note.ts:26
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
noteRepository_
Protected Readonly noteRepository_: Repository<Note>
Defined in
medusa/src/services/note.ts:25
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Events
Static Readonly Events: Object
Type declaration
| Name | Type |
|---|---|
CREATED | string |
DELETED | string |
UPDATED | string |
Defined in
medusa/src/services/note.ts:19
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
create
create(data, config?): Promise<Note>
Creates a note associated with a given author
Parameters
| Name | Description |
|---|---|
data | CreateNoteInput |
config | object |
config.metadata | Record<string, unknown> |
Returns
Promise<Note>
-Promise: resolves to the creation result
-Note:
Defined in
medusa/src/services/note.ts:119
delete
delete(noteId): Promise<void>
Deletes a given note
Parameters
| Name | Description |
|---|---|
noteId | string |
Returns
Promise<void>
-Promise:
Defined in
medusa/src/services/note.ts:177
list
list(selector, config?): Promise<Note[]>
Fetches all notes related to the given selector
Parameters
| Name | Description |
|---|---|
selector | Selector<Note> |
config | FindConfig<Note> |
Returns
Promise<Note[]>
-Promise: notes related to the given search.
-Note[]:
-Note:
Defined in
medusa/src/services/note.ts:77
listAndCount
listAndCount(selector, config?): Promise<[Note[], number]>
Fetches all notes related to the given selector
Parameters
| Name | Description |
|---|---|
selector | Selector<Note> |
config | FindConfig<Note> |
Returns
Promise<[Note[], number]>
-Promise: notes related to the given search.
-Note[]:
-number: (optional)
Defined in
medusa/src/services/note.ts:98
retrieve
retrieve(noteId, config?): Promise<Note>
Retrieves a specific note.
Parameters
| Name | Description |
|---|---|
noteId | string |
config | FindConfig<Note> |
Returns
Promise<Note>
-Promise: which resolves to the requested note.
-Note:
Defined in
medusa/src/services/note.ts:42
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
update(noteId, value): Promise<Note>
Updates a given note with a new value
Parameters
| Name | Description |
|---|---|
noteId | string |
value | string |
Returns
Promise<Note>
-Promise: resolves to the updated element
-Note:
Defined in
medusa/src/services/note.ts:155
withTransaction
withTransaction(transactionManager?): NoteService
Parameters
| Name |
|---|
transactionManager? |
Returns
-NoteService:
Inherited from
TransactionBaseService.withTransaction