TypeScript API / laikacms/documents / DocumentsCapabilitiesSchema

Variable: DocumentsCapabilitiesSchema

const DocumentsCapabilitiesSchema: StandardSchemaV1<{
  changes:   | {
     description: string;
     supported: false;
   }
     | {
     changeFeed: boolean;
     description: string;
     supported: true;
     syncToken: boolean;
   };
  compatibilityDate: string;
  locks?:   | {
     description: string;
     supported: false;
   }
     | {
     description: string;
     scope: "in-process" | "shared";
     supported: true;
     transactional: boolean;
   };
  pagination:   | {
     description: string;
     supported: false;
   }
     | {
     description: string;
     styles: {
        cursor: boolean;
        offset: boolean;
        page: boolean;
     };
     supported: true;
   };
  versionTracking:   | {
     description: string;
     supported: false;
   }
     | {
     description: string;
     supported: true;
   };
}, {
  changes:   | {
     description: string;
     supported: false;
   }
     | {
     changeFeed: boolean;
     description: string;
     supported: true;
     syncToken: boolean;
   };
  compatibilityDate: string & Brand<"DocumentsRepositoryCompatibilityDate">;
  locks?:   | {
     description: string;
     supported: false;
   }
     | {
     description: string;
     scope: "in-process" | "shared";
     supported: true;
     transactional: boolean;
   };
  pagination:   | {
     description: string;
     supported: false;
   }
     | {
     description: string;
     styles: {
        cursor: boolean;
        offset: boolean;
        page: boolean;
     };
     supported: true;
   };
  versionTracking:   | {
     description: string;
     supported: false;
   }
     | {
     description: string;
     supported: true;
   };
}> & Struct<{
  changes: Union<readonly [Struct<{
     description: String;
     supported: Literal<false>;
   }>, Struct<{
     changeFeed: Boolean;
     description: String;
     supported: Literal<true>;
     syncToken: Boolean;
  }>]>;
  compatibilityDate: brand<String, "DocumentsRepositoryCompatibilityDate">;
  locks: optional<Union<readonly [Struct<{
     description: String;
     supported: Literal<false>;
   }>, Struct<{
     description: String;
     scope: Literals<readonly ["in-process", "shared"]>;
     supported: Literal<true>;
     transactional: Boolean;
  }>]>>;
  pagination: Union<readonly [Struct<{
     description: String;
     supported: Literal<false>;
   }>, Struct<{
     description: String;
     styles: Struct<{
        cursor: Boolean;
        offset: Boolean;
        page: Boolean;
     }>;
     supported: Literal<true>;
  }>]>;
  versionTracking: Union<readonly [Struct<{
     description: String;
     supported: Literal<false>;
   }>, Struct<{
     description: String;
     supported: Literal<true>;
  }>]>;
}>;

Capabilities advertised by a DocumentsRepository. Consumers use these to decide whether to drive pagination themselves, when to expect a backend to honor a given pagination style, etc.