@waylis/core

---

@waylis/core / DiskFileStorage

Class: DiskFileStorage

Defined in: file/storage/disk.ts:9

File storage implementation that saves files to the local disk.

Implements

• FileStorage

Constructors

Constructor

new DiskFileStorage(storagePath?: string): DiskFileStorage;

Defined in: file/storage/disk.ts:17

Create a new disk-based file storage.

Parameters

storagePath?

string

Optional root directory path (defaults to "files").

Returns

DiskFileStorage

Properties

Property	Type	Default value	Description	Defined in
isOpen	boolean	false	Indicates whether the storage connection is open.	file/storage/disk.ts:10

Methods

close()

close(): Promise<void>;

Defined in: file/storage/disk.ts:36

Close the storage connection.

Returns

Promise<void>

Implementation of

FileStorage.close

---

deleteByID()

deleteByID(id: string): Promise<boolean>;

Defined in: file/storage/disk.ts:72

Delete a file from storage by its ID.

Parameters

id

string

File identifier.

Returns

Promise<boolean>

True if deletion succeeded.

Implementation of

FileStorage.deleteByID

---

download()

download(metadata: FileMeta): Promise<ReadableStream>;

Defined in: file/storage/disk.ts:60

Download a file from storage.

Parameters

metadata

FileMeta

File metadata.

Returns

Promise<ReadableStream>

File content as a readable stream.

Implementation of

FileStorage.download

---

open()

open(): Promise<void>;

Defined in: file/storage/disk.ts:32

Open the storage connection.

Returns

Promise<void>

Implementation of

FileStorage.open

---

upload()

upload(bytes: ReadableStream | Buffer<ArrayBufferLike>, metadata: FileMeta): Promise<boolean>;

Defined in: file/storage/disk.ts:40

Upload a file into storage.

Parameters

bytes

File content as a stream or buffer.

ReadableStream | Buffer<ArrayBufferLike>

metadata

FileMeta

Associated file metadata.

Returns

Promise<boolean>

True if upload succeeded.

Implementation of

FileStorage.upload