@backblaze-labs/b2-sdk - v0.2.0
    Preparing search index...

    Interface LocalSyncPath

    A file on the local filesystem discovered during a scan.

    interface LocalSyncPath {
        absolutePath: string;
        contentSha1?: string | null;
        contentSha1State?: SyncSha1State;
        fileIdentity?: LocalFileIdentity;
        modTimeMillis: number;
        relativePath: string;
        size: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    absolutePath: string

    Absolute filesystem path to the file.

    contentSha1?: string | null

    SHA-1 checksum state for compare modes that need content hashes.

    • undefined: not computed yet; the synchronizer may hash local files before comparing.
    • null: known to be unavailable; sha1 sync skips the pair with a surfaced event.
    • 40-character hex string: known verifiable digest.
    • other string: untrusted provider metadata such as B2's unverified:<hex> sentinel; consumers must not treat it as proof that bytes match. The sha1 synchronizer must verify untrusted B2 bytes before using them for equality, or transfer conservatively.

    Use parseSyncContentSha1, selectB2ComparableSha1, and untrustedSha1 from the sync entrypoint to construct or inspect this field without depending on sentinel strings.

    contentSha1State?: SyncSha1State

    Explicit SHA-1 trust and availability state. Prefer this field for custom scanners that can distinguish verified digests from untrusted provider metadata without relying on contentSha1 sentinel strings. When omitted, the synchronizer derives the state from contentSha1 for compatibility.

    fileIdentity?: LocalFileIdentity

    Optional filesystem identity used to reject scan-to-read races.

    modTimeMillis: number

    Last modification time in milliseconds since epoch.

    relativePath: string

    Path relative to the sync folder root, using forward slashes.

    size: number

    File size in bytes.