Class InMemoryStorageDriver

In-memory storage driver. Useful for testing. It does not persist data between runs, DO NOT USE IN PRODUCTION.

Hierarchy (view full)

StorageDriver<null, null>
- 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 InMemoryStorageDriver(config): InMemoryStorageDriver
Parameters
- config: null
Returns InMemoryStorageDriver
Inherited from StorageDriver.constructor
- Defined in packages/storage/src/StorageDriver.ts:15

Properties

`Protected` `Readonly` blobs

blobs: Map<string, string | Buffer> = ...

`Protected` config

config: null

Methods

alive

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

Returns Promise<void>
Overrides StorageDriver.alive
- Defined in packages/storage/src/drivers/InMemoryStorageDriver.ts:227

append

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

copy

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

delete

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

deleteRecursive

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

driver

driver(): null
Returns the driver.

Returns null
Overrides StorageDriver.driver
- Defined in packages/storage/src/drivers/InMemoryStorageDriver.ts:66

exists

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

get

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

getBuffer

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

getConfig

getConfig(): null
Returns null
Inherited from StorageDriver.getConfig
- 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>
Inherited from StorageDriver.getSignedUrl
- 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>
Overrides StorageDriver.getStat
- Defined in packages/storage/src/drivers/InMemoryStorageDriver.ts:122

getStream

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

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
Overrides StorageDriver.getUrl
- Defined in packages/storage/src/drivers/InMemoryStorageDriver.ts:149

listFilesRecursive

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

move

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

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>
Overrides StorageDriver.prepend
- Defined in packages/storage/src/drivers/InMemoryStorageDriver.ts:201

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>
Overrides StorageDriver.put
- Defined in packages/storage/src/drivers/InMemoryStorageDriver.ts:168