Class StorageDriver<C, D>`Abstract`

Type Parameters

C = any
D = any

Hierarchy (view full)

StorageDriver
- FilesystemStorageDriver
- InMemoryStorageDriver

Index

Constructors

Properties

Methods

alive append copy delete deleteRecursive driver exists get getBuffer getConfig getSignedUrl getStat getStream getUrl listFilesRecursive move prepend put

Constructors

constructor

new StorageDriver<C, D>(config): StorageDriver<C, D>
Type Parameters
- C = any
- D = any
Parameters
- config: C
Returns StorageDriver<C, D>
- Defined in packages/storage/src/StorageDriver.ts:15

Properties

`Protected` config

config: C

Methods

alive

alive(): Promise<void>
Checks if the driver is alive or throw an exception.

Returns Promise<void>
- Defined in packages/storage/src/StorageDriver.ts:144

append

append(location, content): Promise<Response>
Appends content to a file.
Parameters
- location: string
- content: string | Buffer
Returns Promise<Response>
- Defined in packages/storage/src/StorageDriver.ts:27

copy

copy(src, dest): Promise<Response>
Copy a file to a location.
Parameters
- src: string
- dest: string
Returns Promise<Response>
- Defined in packages/storage/src/StorageDriver.ts:34

delete

delete(location): Promise<DeleteResponse>
Delete existing file.
Parameters
- location: string
Returns Promise<DeleteResponse>
- Defined in packages/storage/src/StorageDriver.ts:41

deleteRecursive

deleteRecursive(location): Promise<Response>
Delete all files in a directory.
Parameters
- location: string
Returns Promise<Response>
- Defined in packages/storage/src/StorageDriver.ts:48

driver

driver(): D
Returns the driver.

Returns D
- Defined in packages/storage/src/StorageDriver.ts:55

exists

exists(location): Promise<boolean>
Determines if a file or folder already exists.
Parameters
- location: string
Returns Promise<boolean>
- Defined in packages/storage/src/StorageDriver.ts:62

get

get(location, encoding?): Promise<string>
Returns the file contents as a string.
Parameters
- location: string
- Optional encoding: string
Returns Promise<string>
- Defined in packages/storage/src/StorageDriver.ts:69

getBuffer

getBuffer(location): Promise<Buffer>
Returns the file contents as a Buffer.
Parameters
- location: string
Returns Promise<Buffer>
- Defined in packages/storage/src/StorageDriver.ts:76

getConfig

getConfig(): C
Returns C
- Defined in packages/storage/src/StorageDriver.ts:20

getSignedUrl

getSignedUrl(location, options?): Promise<SignedUrlResponse>
Returns signed url for an existing file.
Parameters
- location: string
- Optional options: SignedUrlOptions
Returns Promise<SignedUrlResponse>
- Defined in packages/storage/src/StorageDriver.ts:83

getStat

getStat(location): Promise<StatResponse>
Returns file's size and modification date.
Parameters
- location: string
Returns Promise<StatResponse>
- Defined in packages/storage/src/StorageDriver.ts:90

getStream

getStream(location): Promise<ReadableStream>
Returns the stream for the given file.
Parameters
- location: string
Returns Promise<ReadableStream>
- Defined in packages/storage/src/StorageDriver.ts:97

getUrl

getUrl(location): string
Returns url for a given key. Note this method doesn't validates the existence of file or it's visibility status.
Parameters
- location: string
Returns string
- Defined in packages/storage/src/StorageDriver.ts:106

listFilesRecursive

listFilesRecursive(prefix?): AsyncIterable<string>
List all files with a given prefix.
Parameters
- Optional prefix: string
Returns AsyncIterable<string>
- Defined in packages/storage/src/StorageDriver.ts:137

move

move(src, dest): Promise<Response>
Move file to a new location.
Parameters
- src: string
- dest: string
Returns Promise<Response>
- Defined in packages/storage/src/StorageDriver.ts:113

prepend

prepend(location, content): Promise<Response>
Prepends content to a file.

WARNING: It's pretty inefficient as it copies the file to a temp file and then back to the original file. Try to avoid using this method at least for large files.
Parameters
- location: string
- content: string | Buffer
Returns Promise<Response>
- Defined in packages/storage/src/StorageDriver.ts:130

put

put(location, content): Promise<Response>
Creates a new file. This method will create missing directories on the fly.
Parameters
- location: string
- content: string | Buffer | ReadableStream
Returns Promise<Response>
- Defined in packages/storage/src/StorageDriver.ts:121