storage.Interface.StorageDriverContract

@sclable/nestjs-libs / storage / StorageDriverContract

Interface: StorageDriverContract

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:7

Methods

createBucket()

createBucket(bucket): Promise<void>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:8

Parameters

bucket

string

Returns

Promise<void>

---

deleteObject()

deleteObject(bucket, id): Promise<boolean>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:17

Parameters

bucket

string

id

string

Returns

Promise<boolean>

---

getDownloadUrl()

getDownloadUrl(bucket, id, filename): Promise<string>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:19

Parameters

bucket

string

id

string

filename

string

Returns

Promise<string>

---

getMetaData()

getMetaData(bucket, id): Promise<FileMetaData | null>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:18

Parameters

bucket

string

id

string

Returns

Promise<FileMetaData | null>

---

getObject()

getObject(bucket, id): Promise<Buffer<ArrayBufferLike>>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:15

Parameters

bucket

string

id

string

Returns

Promise<Buffer<ArrayBufferLike>>

---

getObjectStream()

getObjectStream(bucket, id): Promise<ReadableStream>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:16

Parameters

bucket

string

id

string

Returns

Promise<ReadableStream>

---

getUploadUrl()

getUploadUrl(bucket, id, onUploaded): Promise<string>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:21

Parameters

bucket

string

id

string

onUploaded

(record) => void

Returns

Promise<string>

---

putObject()

putObject(bucket, id, content, metadata?): Promise<string>

Defined in: packages/storage/src/contracts/storage-driver.contract.ts:9

Parameters

bucket

string

id

string

content

Buffer<ArrayBufferLike> | Readable

metadata?

FileMetaData

Returns

Promise<string>