API reference › @evolu/common › local‑first/Storage › StorageConfig

Defined in: packages/common/src/local-first/Storage.ts:44

Extended by

• RelayConfig

Properties

isOwnerWithinQuota

readonly isOwnerWithinQuota: (ownerId: string & Brand<"Id"> & Brand<"OwnerId">, requiredBytes: number & Brand<"Int"> & Brand<"NonNegative"> & Brand<"Positive">) => Awaitable<boolean>;

Defined in: packages/common/src/local-first/Storage.ts:74

Callback called before an attempt to write, to check if an OwnerId has sufficient quota for the write.

The callback receives the OwnerId and the total bytes that would be stored after the write (current stored bytes plus incoming bytes), and returns a Awaitable boolean: true to allow the write, or false to deny it due to quota limits.

The callback can be synchronous (for SQLite or in-memory checks) or asynchronous (for calling remote APIs).

The callback returns a boolean rather than an error because error handling and logging are the responsibility of the callback implementation.

Example

// Client
// evolu.subscribeError

// Relay
isOwnerWithinQuota: (ownerId, requiredBytes) => {
  console.log(ownerId, requiredBytes);
  // Check error via evolu.subscribeError
  return true;
};