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: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
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.
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
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:119
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:177
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:77
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
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:42
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
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:155
withTransaction
▸ withTransaction(transactionManager?): NoteService
Parameters
| Name | Type |
|---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction