Skip to content

Documentation / @tenancy-node/storage-s3 / S3Storage

Class: S3Storage ​

Defined in: index.ts:46

Almacenamiento en S3 o compatible: bucket/bolivar/logo.png.

Implements ​

Constructors ​

Constructor ​

new S3Storage(options): S3Storage

Defined in: index.ts:51

Parameters ​

options ​

S3StorageOptions

Returns ​

S3Storage

Properties ​

client ​

readonly client: S3Client

Defined in: index.ts:48


name ​

readonly name: "s3" = 's3'

Defined in: index.ts:47

Implementation of ​

StorageDriver.name

Methods ​

close() ​

close(): Promise<void>

Defined in: index.ts:170

Returns ​

Promise<void>

Implementation of ​

StorageDriver.close


delete() ​

delete(key): Promise<void>

Defined in: index.ts:103

Parameters ​

key ​

string

Returns ​

Promise<void>

Implementation of ​

StorageDriver.delete


deletePrefix() ​

deletePrefix(prefix): Promise<void>

Defined in: index.ts:134

Borra todo lo que empieza con prefix (por ejemplo, al eliminar un tenant).

Parameters ​

prefix ​

string

Returns ​

Promise<void>

Implementation of ​

StorageDriver.deletePrefix


exists() ​

exists(key): Promise<boolean>

Defined in: index.ts:91

Parameters ​

key ​

string

Returns ​

Promise<boolean>

Implementation of ​

StorageDriver.exists


get() ​

get(key): Promise<Uint8Array<ArrayBufferLike> | undefined>

Defined in: index.ts:79

Contenido del archivo, o undefined si no existe.

Parameters ​

key ​

string

Returns ​

Promise<Uint8Array<ArrayBufferLike> | undefined>

Implementation of ​

StorageDriver.get


list() ​

list(prefix): Promise<StoredFile[]>

Defined in: index.ts:109

Archivos cuya llave empieza con prefix.

Parameters ​

prefix ​

string

Returns ​

Promise<StoredFile[]>

Implementation of ​

StorageDriver.list


ping() ​

ping(): Promise<void>

Defined in: index.ts:166

Returns ​

Promise<void>

Implementation of ​

StorageDriver.ping


put() ​

put(key, body, options?): Promise<void>

Defined in: index.ts:68

Parameters ​

key ​

string

body ​

string | Uint8Array<ArrayBufferLike>

options? ​

PutOptions = {}

Returns ​

Promise<void>

Implementation of ​

StorageDriver.put


url() ​

url(key, options?): Promise<string>

Defined in: index.ts:153

URL para descargar el archivo (pública o firmada).

Parameters ​

key ​

string

options? ​
expiresInSeconds? ​

number

Returns ​

Promise<string>

Implementation of ​

StorageDriver.url

Publicado bajo la licencia MIT.