Skip to content

TypeScript API / laikacms/catalog / DocumentCollectionSettingsSchema

Variable: DocumentCollectionSettingsSchema ​

ts
const DocumentCollectionSettingsSchema: StandardSchemaV1<{
  directory?: string;
  documentDescriptionKey?: string;
  documentStatusKey?: string;
  documentTitleKey?: string;
  format?: string;
  key: string;
  name?: string;
  recursive?: boolean;
  revisionDirectory?: string;
  type: "document";
  unpublishedStatuses?: {
   [key: string]: object;
  };
}, {
  directory?: string;
  documentDescriptionKey?: string;
  documentStatusKey?: string;
  documentTitleKey?: string;
  format?: string & Brand<"StorageFormat">;
  key: string;
  name?: string;
  recursive?: boolean;
  revisionDirectory?: string;
  type: "document";
  unpublishedStatuses?: {
   [key: string]: object;
  };
}> & Struct<{
  directory: optional<String>;
  documentDescriptionKey: optional<String>;
  documentStatusKey: optional<String>;
  documentTitleKey: optional<String>;
  format: optional<brand<String, "StorageFormat">>;
  key: String;
  name: optional<String>;
  recursive: optional<Boolean>;
  revisionDirectory: optional<String>;
  type: Literal<"document">;
  unpublishedStatuses: optional<$Record<String, StandardSchemaV1<{
     directory: string;
     name: string;
   }, {
     directory: string;
     name: string;
   }> & Struct<{
     directory: String;
     name: String;
  }>>>;
}>;

Released under the MIT License.