medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: NoteService

internal.internal.NoteService

Hierarchy

• TransactionBaseService

  ↳ NoteService

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/dist/services/note.d.ts:20

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

noteRepository_

• Protected Readonly noteRepository_: Repository<Note>

Defined in

packages/medusa/dist/services/note.d.ts:19

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

---

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
UPDATED	string

Defined in

packages/medusa/dist/services/note.d.ts:14

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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

packages/medusa/dist/interfaces/transaction-base-service.d.ts:24

---

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

packages/medusa/dist/services/note.d.ts:53

---

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

packages/medusa/dist/services/note.d.ts:67

---

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

packages/medusa/dist/services/note.d.ts:37

---

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

packages/medusa/dist/services/note.d.ts:46

---

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

packages/medusa/dist/services/note.d.ts:28

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

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

packages/medusa/dist/services/note.d.ts:62

---

withTransaction

▸ withTransaction(transactionManager?): NoteService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

NoteService

Inherited from

TransactionBaseService.withTransaction

Defined in

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