IFileService

internal.internal.IFileService

Implemented by

• AbstractFileService

Properties

__configModule__Record<string, unknown>

__container__anyRequired

__moduleDeclaration__Record<string, unknown>

manager_EntityManagerRequired

transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

EntityManagerEntityManagerRequired

Inherited from

TransactionBaseService.activeManager_

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.

TResultobjectRequired

TErrorobjectRequired

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required

the 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

Promise<TResult>

PromisePromise<TResult>Required

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

---

delete

delete(fileData): Promise<void>

remove file from fileservice

Parameters

fileDataDeleteFileTypeRequired

Remove file described by record

Returns

Promise<void>

PromisePromise<void>Required

---

getDownloadStream

getDownloadStream(fileData): Promise<ReadableStream>

download file from fileservice as stream

Parameters

fileDataGetUploadedFileTypeRequired

file metadata relevant for fileservice to download the file

Returns

Promise<ReadableStream>

PromisePromise<ReadableStream>Required

readable stream of the file to download

---

getPresignedDownloadUrl

getPresignedDownloadUrl(fileData): Promise<string>

Generate a presigned download url to obtain a file

Parameters

fileDataGetUploadedFileTypeRequired

file metadata relevant for fileservice to download the file

Returns

Promise<string>

PromisePromise<string>Required

presigned url to download the file

---

getUploadStreamDescriptor

getUploadStreamDescriptor(fileData): Promise<FileServiceGetUploadStreamResult>

upload file to fileservice from stream

Parameters

fileDataUploadStreamDescriptorTypeRequired

file metadata relevant for fileservice to create and upload the file

Returns

Promise<FileServiceGetUploadStreamResult>

PromisePromise<FileServiceGetUploadStreamResult>Required

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

booleanboolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

---

upload

upload(file): Promise<FileServiceUploadResult>

upload file to fileservice

Parameters

fileFileRequired

Multer file from express multipart/form-data

Returns

Promise<FileServiceUploadResult>

PromisePromise<FileServiceUploadResult>Required

---

uploadProtected

uploadProtected(file): Promise<FileServiceUploadResult>

upload private file to fileservice

Parameters

fileFileRequired

Multer file from express multipart/form-data

Returns

Promise<FileServiceUploadResult>

PromisePromise<FileServiceUploadResult>Required

---

withTransaction

withTransaction(transactionManager?): IFileService

Parameters

transactionManagerEntityManager

Returns

IFileService

IFileServiceIFileServiceRequired

Inherited from

TransactionBaseService.withTransaction