Documentation / @etherfold/processor-entities / SnapshotLocation

Type Alias: SnapshotLocation

SnapshotLocation = string | { head?: string; url: string; }

Defined in: packages/processor-entities/src/snapshot.ts:76

Where a snapshot is published.

A bare string is the snapshot DOCUMENT itself, and choosing between mirrors then reads only its first line (the head) before deciding whether to read on. The object form adds an optional head: that same first line, published as a small JSON document of its own (SnapshotHead), which is what a client fetches to decide between mirrors before opening any body. That is the entity-path counterpart of the free-form path's separate lastSync file, and it is optional for the same reason it is there: a mirror that publishes only the snapshot is still usable, it just costs a full download to compare.