Skip to main content

@lab08/nestjs-s3

Classes​

Interfaces​

Type aliases​

CopyObjectOptions​

Ƭ CopyObjectOptions: Omit<PutObjectCommandInput, "Bucket" | "Key" | "CopySource"> & DisableAutoPrefix & PrefixContext

Defined in​

types/object-command-options.type.ts:19

DeleteObjectOptions​

Ƭ DeleteObjectOptions: Omit<DeleteObjectCommandInput, "Bucket" | "Key"> & DisableAutoPrefix & PrefixContext

Defined in​

types/object-command-options.type.ts:18

DeleteObjectsOptions​

Ƭ DeleteObjectsOptions: Omit<DeleteObjectsCommandInput, "Bucket" | "Delete"> & DisableAutoPrefix & PrefixContext

Defined in​

types/object-command-options.type.ts:12

DisableAutoPrefix​

Ƭ DisableAutoPrefix: Object

Type declaration​

NameType
disableAutoPrefix?boolean

Defined in​

types/prefix.type.ts:1

DownloadOptions​

Ƭ DownloadOptions: Object

Type declaration​

NameType
createPath?boolean
filename?string | null
mode?number | string

Defined in​

types/download-options.type.ts:1

GetObjectOptions​

Ƭ GetObjectOptions: Omit<GetObjectCommandInput, "Bucket" | "Key"> & DisableAutoPrefix & PrefixContext

Defined in​

types/object-command-options.type.ts:11

ListObjectsOptions​

Ƭ ListObjectsOptions: Omit<ListObjectsCommandInput, "Bucket">

Defined in​

types/object-command-options.type.ts:22

ListObjectsV2Options​

Ƭ ListObjectsV2Options: Omit<ListObjectsV2CommandInput, "Bucket">

Defined in​

types/object-command-options.type.ts:23

OptionsWithAutoPrefix​

Ƭ OptionsWithAutoPrefix: PutObjectOptions | DeleteObjectOptions | DeleteObjectsOptions | GetObjectOptions | CopyObjectOptions

Defined in​

types/object-command-options.type.ts:24

PrefixAlgorithm​

Ƭ PrefixAlgorithm: (remote: string, prefix?: string, bucket?: string) => string

Type declaration​

â–¸ (remote, prefix?, bucket?): string

Parameters​
NameType
remotestring
prefix?string
bucket?string
Returns​

string

Defined in​

types/prefix-algorithm.type.ts:1

PrefixContext​

Ƭ PrefixContext: Object

Type declaration​

NameType
prefixContext?any

Defined in​

types/prefix.type.ts:3

PutObjectOptions​

Ƭ PutObjectOptions: Omit<PutObjectCommandInput, "Bucket" | "Body" | "Key"> & DisableAutoPrefix & PrefixContext

Defined in​

types/object-command-options.type.ts:15

PutSignedUrl​

Ƭ PutSignedUrl: Object

Type declaration​

NameType
remotestring
urlstring

Defined in​

types/signed-url.type.ts:1

S3AsyncConfig​

Ƭ S3AsyncConfig: Pick<ModuleMetadata, "imports" | "providers"> & { inject?: (Type<unknown> | string | symbol | Abstract<unknown>)[] ; prefixAlgorithmInject?: (Type<unknown> | string | symbol | Abstract<unknown>)[] ; prefixAlgorithmFactory?: (...args: any[]) => IPrefixAlgorithm | Promise<IPrefixAlgorithm> ; useFactory: (...args: any[]) => Omit<S3Config, "prefixAlgorithm"> | Promise<Omit<S3Config, "prefixAlgorithm">> }

Defined in​

types/s3-config.type.ts:15

S3Config​

Ƭ S3Config: Object

Type declaration​

NameType
accessKeyIdstring
endPoint?string
prefix?string
prefixAlgorithm?IPrefixAlgorithm
regionstring
secretAccessKeystring

Defined in​

types/s3-config.type.ts:6

Variables​

DEFAULT_EXPIRES_IN​

• DEFAULT_EXPIRES_IN: 3600

Defined in​

constants.ts:4

PREFIX_ALGORITHM​

• PREFIX_ALGORITHM: "prefix.algorithm"

Defined in​

constants.ts:3

S3_CONFIG​

• S3_CONFIG: "s3.config"

Defined in​

constants.ts:1

S3_SERVICE​

• S3_SERVICE: "s3.service"

Defined in​

constants.ts:2

Functions​

createS3ServiceProvider​

â–¸ Const createS3ServiceProvider(): Provider<any>

Returns​

Provider<any>

Defined in​

s3-service.factory.ts:6