Skip to main content

Class: S3FileService

file-storage/src.S3FileService

Extends​

Constructors​

new S3FileService(s3)​

new S3FileService(s3): S3FileService

Parameters​

▪ s3: NarrowPayloadBlobTypes<NodeJsRuntimeStreamingBlobPayloadInputTypes, SdkStream<IncomingMessage>, S3>

Returns​

S3FileService

Overrides​

AbstractFileService.constructor

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:36

Properties​

DEFAULT_FILE_NAME_FULL_LENGTH​

protected DEFAULT_FILE_NAME_FULL_LENGTH: number = 64

Inherited from​

AbstractFileService.DEFAULT_FILE_NAME_FULL_LENGTH

Source​

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

DEFAULT_UPLOAD_PRE_SIGN_URL_PARAMS​

protected DEFAULT_UPLOAD_PRE_SIGN_URL_PARAMS: object

Type declaration​

expiresInSeconds​

expiresInSeconds: number = 3600

maxSize​

maxSize: number

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:31

Methods​

abortMultiPartUpload​

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

Parameters​

▪ uploadId: string

▪ bucket: string

▪ key: string

▪ options?: Partial<AbortMultipartUploadCommandInput>

Returns​

Promise<void>

Overrides​

AbstractFileService.abortMultiPartUpload

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:92

completeMultiPartUpload​

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

Parameters​

▪ uploadId: string

▪ bucket: string

▪ key: string

▪ parts: CompletedPartDTO[]

▪ options?: Partial<CompleteMultipartUploadCommandInput>

Returns​

Promise<void>

Overrides​

AbstractFileService.completeMultiPartUpload

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:106

downloadFile​

downloadFile(bucket, key): Promise<string>

Parameters​

▪ bucket: string

▪ key: string

Returns​

Promise<string>

Overrides​

AbstractFileService.downloadFile

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:229

generateDownloadFilePreSignUrl​

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

Parameters​

▪ bucket: string

▪ key: string

▪ expiresInSeconds: number= 3600

Returns​

Promise<string>

Overrides​

AbstractFileService.generateDownloadFilePreSignUrl

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:165

generateFileKey​

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

Parameters​

▪ uniqueFileNameWithoutExtension: string

▪ file: FileDefinition

▪ folder?: string

Returns​

string

Inherited from​

AbstractFileService.generateFileKey

Source​

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

generateUploadFilePreSignUrlPost​

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

Parameters​

▪ bucket: string

▪ file: FileDefinition

▪ folder?: string

▪ options?: object

expiresInSeconds default value is 3600 seconds maxSize in bytes default value is 100MB

▪ options.expiresInSeconds?: number

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

▪ options.maxSize?: number

Returns​

Promise<FileUploadPreSignUrlPostResult>

Overrides​

AbstractFileService.generateUploadFilePreSignUrlPost

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:132

generateUploadFilePreSignUrlPut​

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

Parameters​

▪ bucket: string

▪ file: FileDefinition

▪ folder?: string

▪ expiresInSeconds?: number

Returns​

Promise<FileUploadPreSignUrlPutResult>

Overrides​

AbstractFileService.generateUploadFilePreSignUrlPut

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:181

startMultiPartUpload​

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

Parameters​

▪ bucket: string

▪ file: Required<FileDefinition>

▪ partSize: number= undefined

▪ folder?: string

▪ options?: Partial<CreateMultipartUploadCommandInput>

Returns​

Promise<StartMultipartUploadInfo>

Overrides​

AbstractFileService.startMultiPartUpload

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:43

truncateFileName​

protected truncateFileName(fileName, maxLength): string

Parameters​

▪ fileName: string

▪ maxLength: number

Returns​

string

Inherited from​

AbstractFileService.truncateFileName

Source​

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

uploadFile​

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

Parameters​

▪ bucket: string

▪ file: FileDefinition

▪ body: NodeJsRuntimeStreamingBlobPayloadInputTypes

▪ folder?: string

▪ options?: Omit<PutObjectCommandInput, "Bucket" | "Key">

Returns​

Promise<UploadedFileInfo>

Overrides​

AbstractFileService.uploadFile

Source​

libs/file-storage/src/lib/services/s3-file.service.ts:206

Generated using typedoc-plugin-markdown and TypeDoc