Type Alias IFileStorageAdapter

IFileStorageAdapter: {
    add(key: string, content: WritableFileAdapterContent): Promise<boolean>;
    addStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
    copy(source: string, destination: string): Promise<FileWriteEnum>;
    copyAndReplace(source: string, destination: string): Promise<boolean>;
    exists(key: string): Promise<boolean>;
    getBytes(key: string): Promise<null | Uint8Array<ArrayBufferLike>>;
    getMetaData(key: string): Promise<null | FileAdapterMetadata>;
    getStream(key: string): Promise<null | FileAdapterStream>;
    move(source: string, destination: string): Promise<FileWriteEnum>;
    moveAndReplace(source: string, destination: string): Promise<boolean>;
    put(key: string, content: WritableFileAdapterContent): Promise<boolean>;
    putStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
    removeByPrefix(prefix: string): Promise<void>;
    removeMany(keys: string[]): Promise<boolean>;
    update(key: string, content: WritableFileAdapterContent): Promise<boolean>;
    updateStream(
        key: string,
        stream: WritableFileAdapterStream,
    ): Promise<boolean>;
}

The IFileStorageAdapter contract defines a way for storing files independent of storage.

IMPORT_PATH: "@daiso-tech/core/file-storage/contracts"

Type declaration

Settings

Member Visibility