@waylis/core / FileManager
Interface: FileManager
Defined in: src/file/file.ts:100
High-level interface for managing files and metadata.
Methods
deleteFile()
deleteFile(id: string): Promise<null | FileMeta>;Defined in: src/file/file.ts:128
Delete a file by ID.
Parameters
id
string
File identifier.
Returns
Promise<null | FileMeta>
Deleted metadata or null if not found.
downloadFile()
downloadFile(id: string): Promise<ReadableStream>;Defined in: src/file/file.ts:121
Download a file by ID.
Parameters
id
string
File identifier.
Returns
Promise<ReadableStream>
File content as a readable stream.
generateFileMeta()
generateFileMeta(meta: CreateFileMetaParams): FileMeta;Defined in: src/file/file.ts:135
Generate metadata for a file.
Parameters
meta
File metadata parameters.
Returns
Complete file metadata object.
getFileMeta()
getFileMeta(id: string): Promise<null | FileMeta>;Defined in: src/file/file.ts:106
Retrieve metadata of a file by ID.
Parameters
id
string
File identifier.
Returns
Promise<null | FileMeta>
File metadata if found, otherwise null.
uploadFile()
uploadFile(bytes: ReadableStream | Buffer<ArrayBufferLike>, meta: CreateFileMetaParams): Promise<FileMeta>;Defined in: src/file/file.ts:114
Upload a new file with metadata.
Parameters
bytes
File content as a stream or buffer.
ReadableStream | Buffer<ArrayBufferLike>
meta
File metadata parameters.
Returns
Promise<FileMeta>
Stored file metadata.