Skip to content

TypeScript API / laikacms/storage / ChangesSupportEnabled

Variable: ChangesSupportEnabled ​

ts
const ChangesSupportEnabled: Struct<{
  changeFeed: Boolean;
  description: String;
  supported: Literal<true>;
  syncToken: Boolean;
}>;

Advertises the change-signal surface of a repository:

  • syncToken: getSyncToken returns an opaque per-scope token that changes whenever anything inside the scope (a folder, or the whole store) changes.
  • changeFeed: listChanges enumerates what changed since a previously obtained sync token.

A true flag means callers can rely on the method; false means the method fails with NotImplementedError. Shared between Documents and Assets so a single semantic is used everywhere.

Released under the MIT License.