Remote / foldkit-remote/persistence

SnapshotOptions

interface · packages/remote/src/persistence.ts:224

interface SnapshotOptions {
  readonly scope?: string | undefined
  readonly maxBytes?: number | undefined
}

Members

SnapshotOptions.scope

property · packages/remote/src/persistence.ts:230

readonly scope?: string | undefined

Who or what the snapshot is for (a user id, a tenant, a build). A snapshot taken under another scope is discarded rather than shown to the wrong reader. Default: unscoped, which only matches unscoped.

SnapshotOptions.maxBytes

property · packages/remote/src/persistence.ts:236

readonly maxBytes?: number | undefined

The most bytes a snapshot takes. One past it drops the batches read least recently until it fits (Snapshot.recency); with no order it is not written. A stored text past it is not read.