Skip to main content

Class: abstract AbstractFileService

file-storage/src.AbstractFileService

Extended By​

Constructors​

new AbstractFileService()​

new AbstractFileService(): AbstractFileService

Returns​

AbstractFileService

Properties​

DEFAULT_FILE_NAME_FULL_LENGTH​

protected DEFAULT_FILE_NAME_FULL_LENGTH: number = 64

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:12

Methods​

abstract abortMultiPartUpload​

abstract abortMultiPartUpload(uploadId, bucket, key): Promise<void>

Parameters​

▪ uploadId: string

▪ bucket: string

▪ key: string

Returns​

Promise<void>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:21

abstract completeMultiPartUpload​

abstract completeMultiPartUpload(uploadId, bucket, key, parts): Promise<void>

Parameters​

▪ uploadId: string

▪ bucket: string

▪ key: string

▪ parts: CompletedPartDTO[]

Returns​

Promise<void>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:27

abstract downloadFile​

abstract downloadFile(bucket, key): Promise<string>

Parameters​

▪ bucket: string

▪ key: string

Returns​

Promise<string>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:65

abstract downloadStream​

abstract downloadStream(bucket, key): Promise<Readable>

Parameters​

▪ bucket: string

▪ key: string

Returns​

Promise<Readable>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:67

abstract generateDownloadFilePreSignUrl​

abstract generateDownloadFilePreSignUrl(bucket, key, expiresInSeconds?): Promise<string>

Parameters​

▪ bucket: string

▪ key: string

▪ expiresInSeconds?: number

Returns​

Promise<string>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:52

generateFileKey​

protected generateFileKey(uniqueFileNameWithoutExtension, file, folder?): string

Parameters​

▪ uniqueFileNameWithoutExtension: string

▪ file: FileDefinition

▪ folder?: string

Returns​

string

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:69

abstract generateUploadFilePreSignUrlPost​

abstract generateUploadFilePreSignUrlPost(bucket, file, folder?, options?): Promise<FileUploadPreSignUrlPostResult>

Parameters​

▪ bucket: string

▪ file: FileDefinition

▪ folder?: string

▪ options?: object

▪ options.expiresInSeconds?: number

▪ options.fields?: Record<string, string>

▪ options.maxSize?: number

Returns​

Promise<FileUploadPreSignUrlPostResult>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:34

abstract generateUploadFilePreSignUrlPut​

abstract generateUploadFilePreSignUrlPut(bucket, file, folder?, expiresInSeconds?): Promise<FileUploadPreSignUrlPutResult>

Parameters​

▪ bucket: string

▪ file: FileDefinition

▪ folder?: string

▪ expiresInSeconds?: number

Returns​

Promise<FileUploadPreSignUrlPutResult>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:45

abstract startMultiPartUpload​

abstract startMultiPartUpload(bucket, file, partSize?, folder?): Promise<StartMultipartUploadInfo>

Parameters​

▪ bucket: string

▪ file: Required<FileDefinition>

▪ partSize?: number

▪ folder?: string

Returns​

Promise<StartMultipartUploadInfo>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:14

truncateFileName​

protected truncateFileName(fileName, maxLength): string

Parameters​

▪ fileName: string

▪ maxLength: number

Returns​

string

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:87

abstract uploadFile​

abstract uploadFile(bucket, file, body, folder?): Promise<UploadedFileInfo>

Parameters​

▪ bucket: string

▪ file: FileDefinition

▪ body: string | Buffer | Uint8Array | Readable

▪ folder?: string

Returns​

Promise<UploadedFileInfo>

Source​

libs/file-storage/src/lib/services/abstract-file.service.ts:58

Generated using typedoc-plugin-markdown and TypeDoc