Type Alias IReadableFile

IReadableFile: {
    key: IKey;
    exists(): ITask<boolean>;
    getArrayBuffer(): ITask<null | ArrayBuffer>;
    getArrayBufferOrFail(): ITask<ArrayBuffer>;
    getBuffer(): ITask<null | Buffer<ArrayBufferLike>>;
    getBufferOrFail(): ITask<Buffer<ArrayBufferLike>>;
    getBytes(): ITask<null | Uint8Array<ArrayBufferLike>>;
    getBytesOrFail(): ITask<Uint8Array<ArrayBufferLike>>;
    getMetadata(): ITask<null | FileMetadata>;
    getMetadataOrFail(): ITask<FileMetadata>;
    getPublicUrl(): ITask<null | string>;
    getPublicUrlOrFail(): ITask<string>;
    getReadable(): ITask<null | Readable>;
    getReadableOrFail(): ITask<Readable>;
    getReadableStream(): ITask<
        null
        | ReadableStream<Uint8Array<ArrayBufferLike>>,
    >;
    getReadableStreamOrFail(): ITask<
        ReadableStream<Uint8Array<ArrayBufferLike>>,
    >;
    getSignedDownloadUrl(
        options?: FileDownloadUrlOptions,
    ): ITask<null | string>;
    getSignedDownloadUrlOrFail(options?: FileUploadUrlOptions): ITask<string>;
    getText(): ITask<null | string>;
    getTextOrFail(): ITask<string>;
    missing(): ITask<boolean>;
}

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

Type declaration

Settings

Member Visibility