NoteService
constructor
Parameters
__namedParametersInjectedDependenciesRequiredProperties
__container__anyRequiredmanager_EntityManagerRequiredtransactionManager_undefined | EntityManagerRequiredEventsobjectRequiredEvents.CREATEDstringRequiredDefault: "note.created"
Events.DELETEDstringRequiredDefault: "note.deleted"
Events.UPDATEDstringRequiredDefault: "note.updated"
__configModule__Record<string, unknown>__moduleDeclaration__Record<string, unknown>Accessors
activeManager_
Returns
EntityManagerEntityManagerRequiredMethods
atomicPhase_
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
TResultobjectRequiredTErrorobjectRequiredParameters
work(transactionManager: EntityManager) => Promise<TResult>Requiredthe transactional work to be done
isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>Potential error handler
Returns
PromisePromise<TResult>Requiredthe result of the transactional work
create
Creates a note associated with a given author
Parameters
dataCreateNoteInputRequiredthe note to create
configobjectRequiredany configurations if needed, including meta data
config.metadataRecord<string, unknown>RequiredReturns
resolves to the creation result
delete
Deletes a given note
Parameters
noteIdstringRequiredid of the note to delete
Returns
PromisePromise<void>Requiredlist
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.
retrieve
Retrieves a specific note.
Parameters
noteIdstringRequiredthe id of the note to retrieve.
any options needed to query for the result.
Default: {}
Returns
which resolves to the requested note.
shouldRetryTransaction_
Parameters
errRecord<string, unknown> | objectRequiredReturns
booleanbooleanRequiredupdate
Updates a given note with a new value
Parameters
noteIdstringRequiredthe id of the note to update
valuestringRequiredthe new value
Returns
resolves to the updated element
withTransaction
Parameters
transactionManagerEntityManagerReturns
NoteServiceobjectRequiredWas this section helpful?