lincd/lib/interfaces/IFileStore.d.ts

LINCD is a JavaScript library for building user interfaces with linked data (also known as 'structured data', or RDF)

import type { Readable } from 'stream';
export interface IFileStore {
    /**
     * The base URL to access the filestore's files. For example:
     * - http://localhost:4000
     * - https://s3.amazonaws.com/my-bucket
     * - https://my-bucket.nyc3.digitaloceanspaces.com
     */
    readonly accessURL: string;
    init?(): Promise<any>;
    deleteFile(filePath: string): Promise<void>;
    fileExists(filePath: string): Promise<boolean>;
    getFile(filePath: string): Promise<Buffer | null>;
    listFiles(prefix?: string): Promise<string[]>;
    saveFile(filePath: string, fileContent: string | Uint8Array | Buffer | Readable, mimeType?: string, preventDuplicates?: boolean): Promise<string | null>;
}