NoteService
constructor
Parameters
__namedParameters
InjectedDependenciesRequiredProperties
manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequired__container__
anyRequiredEvents
objectRequiredEvents.CREATED
stringRequiredDefault: "note.created"
Events.UPDATED
stringRequiredDefault: "note.updated"
Events.DELETED
stringRequiredDefault: "note.deleted"
__configModule__
Record<string, unknown>__moduleDeclaration__
Record<string, unknown>Accessors
activeManager_
Returns
EntityManager
EntityManagerRequiredMethods
withTransaction
Parameters
transactionManager
EntityManagerReturns
this
thisRequiredshouldRetryTransaction_
Parameters
err
Record<string, unknown> | objectRequiredReturns
boolean
booleanRequiredatomicPhase_
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
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>Requiredthe 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
Promise<TResult>Requiredthe result of the transactional work
retrieve
Retrieves a specific note.
Parameters
noteId
stringRequiredthe id of the note to retrieve.
any options needed to query for the result.
Default: {}
Returns
which resolves to the requested note.
list
Fetches all notes related to the given selector
Parameters
the query object for find
the configuration used to find the objects. contains relations, skip, and take.
Returns
notes related to the given search.
listAndCount
Fetches all notes related to the given selector
Parameters
the query object for find
the configuration used to find the objects. contains relations, skip, and take.
Returns
notes related to the given search.
create
Creates a note associated with a given author
Parameters
data
CreateNoteInputRequiredthe note to create
config
objectRequiredany configurations if needed, including meta data
config.metadata
Record<string, unknown>RequiredReturns
resolves to the creation result
update
Updates a given note with a new value
Parameters
noteId
stringRequiredthe id of the note to update
value
stringRequiredthe new value
Returns
resolves to the updated element
delete
Deletes a given note
Parameters
noteId
stringRequiredid of the note to delete
Returns
Promise
Promise<void>RequiredDeletes a given note
Was this section helpful?