Skip to main content

Class: NoteService

Hierarchy

  • TransactionBaseService

    NoteService

Constructors

constructor

new NoteService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/note.ts:29

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/note.ts:27


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/note.ts:24


noteRepository_

Protected Readonly noteRepository_: typeof NoteRepository

Defined in

packages/medusa/src/services/note.ts:26


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/note.ts:25


Events

Static Readonly Events: Object

Type declaration

NameType
CREATEDstring
DELETEDstring
UPDATEDstring

Defined in

packages/medusa/src/services/note.ts:18

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

NameTypeDescription
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

packages/medusa/src/interfaces/transaction-base-service.ts:50


create

create(data, config?): Promise<Note>

Creates a note associated with a given author

Parameters

NameTypeDescription
dataCreateNoteInputthe note to create
configObjectany configurations if needed, including meta data
config.metadataRecord<string, unknown>-

Returns

Promise<Note>

resolves to the creation result

Defined in

packages/medusa/src/services/note.ts:103


delete

delete(noteId): Promise<void>

Deletes a given note

Parameters

NameTypeDescription
noteIdstringid of the note to delete

Returns

Promise<void>

Defined in

packages/medusa/src/services/note.ts:161


list

list(selector, config?): Promise<Note[]>

Fetches all notes related to the given selector

Parameters

NameTypeDescription
selectorSelector<Note>the query object for find
configFindConfig<Note>the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<Note[]>

notes related to the given search.

Defined in

packages/medusa/src/services/note.ts:82


retrieve

retrieve(noteId, config?): Promise<Note>

Retrieves a specific note.

Parameters

NameTypeDescription
noteIdstringthe id of the note to retrieve.
configFindConfig<Note>any options needed to query for the result.

Returns

Promise<Note>

which resolves to the requested note.

Defined in

packages/medusa/src/services/note.ts:47


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31


update

update(noteId, value): Promise<Note>

Updates a given note with a new value

Parameters

NameTypeDescription
noteIdstringthe id of the note to update
valuestringthe new value

Returns

Promise<Note>

resolves to the updated element

Defined in

packages/medusa/src/services/note.ts:139


withTransaction

withTransaction(transactionManager?): NoteService

Parameters

NameType
transactionManager?EntityManager

Returns

NoteService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14