@waylis/core / FileStorage
Interface: FileStorage
Defined in: src/file/file.ts:20
Abstraction for file storage operations.
Properties
isOpen
isOpen: boolean;Defined in: src/file/file.ts:44
Indicates whether the storage connection is open.
Methods
close()
close(): Promise<void>;Defined in: src/file/file.ts:50
Close the storage connection.
Returns
Promise<void>
deleteByID()
deleteByID(id: string): Promise<boolean>;Defined in: src/file/file.ts:41
Delete a file from storage by its ID.
Parameters
id
string
File identifier.
Returns
Promise<boolean>
True if deletion succeeded.
download()
download(metadata: FileMeta): Promise<ReadableStream>;Defined in: src/file/file.ts:34
Download a file from storage.
Parameters
metadata
File metadata.
Returns
Promise<ReadableStream>
File content as a readable stream.
open()
open(): Promise<void>;Defined in: src/file/file.ts:47
Open the storage connection.
Returns
Promise<void>
upload()
upload(bytes: ReadableStream | Buffer<ArrayBufferLike>, metadata: FileMeta): Promise<boolean>;Defined in: src/file/file.ts:27
Upload a file into storage.
Parameters
bytes
File content as a stream or buffer.
ReadableStream | Buffer<ArrayBufferLike>
metadata
Associated file metadata.
Returns
Promise<boolean>
True if upload succeeded.