fast-fs-hash - v0.0.0-rc4
    Preparing search index...

    Interface FileHashCacheWriteOptions

    Options for FileHashCacheSession.write and FileHashCache.overwrite.

    Contains only per-write data (user values, payloads, signal). To change files, version, fingerprint, or rootPath, use FileHashCache.configure or the corresponding setters before calling write.

    interface FileHashCacheWriteOptions {
        compressedPayloads?: readonly Uint8Array<ArrayBufferLike>[] | null;
        lockTimeoutMs?: number;
        payloadValue0?: number;
        payloadValue1?: number;
        payloadValue2?: number;
        payloadValue3?: number;
        signal?: AbortSignal | null;
        uncompressedPayloads?: readonly Uint8Array<ArrayBufferLike>[] | null;
    }
    Index

    Properties

    compressedPayloads? lockTimeoutMs? payloadValue0? payloadValue1? payloadValue2? payloadValue3? signal? uncompressedPayloads?

    Properties

    compressedPayloads?: readonly Uint8Array<ArrayBufferLike>[] | null

    Opaque binary payloads stored LZ4-compressed inside the cache body. Default: preserves old value (or null for overwrite).

    lockTimeoutMs?: number

    Lock acquisition timeout in ms (overwrite/lockFailed only). -1 = block forever, 0 = non-blocking.

    payloadValue0?: number

    Payload f64 value (slot 0). Default: preserves old value (or 0 for overwrite).

    payloadValue1?: number

    Payload f64 value (slot 1). Default: preserves old value (or 0 for overwrite).

    payloadValue2?: number

    Payload f64 value (slot 2). Default: preserves old value (or 0 for overwrite).

    payloadValue3?: number

    Payload f64 value (slot 3). Default: preserves old value (or 0 for overwrite).

    signal?: AbortSignal | null

    Optional AbortSignal to cancel the hash phase.

    uncompressedPayloads?: readonly Uint8Array<ArrayBufferLike>[] | null

    Opaque binary payloads stored raw (uncompressed) in a dedicated section directly after the header — readable without decompressing the body. Default: preserves old value (or null for overwrite).

    Settings

    Member Visibility

    On This Page

    Properties