TypeScript API / laikacms/catalog / parseCatalog

Function: parseCatalog()

function parseCatalog(data): LaikaResult<{
  collections?: {
   [key: string]: 
     | {
     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;
     };
   }
     | {
     accept?: readonly string[];
     directory?: string;
     key: string;
     name?: string;
     pathFormat?: string;
     recursive?: boolean;
     type: "media";
     url?: string;
   };
  };
}>;

Parameters

Parameter	Type
data	unknown

Returns

LaikaResult<{ collections?: { [key: string]: | { 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; }; } | { accept?: readonly string[]; directory?: string; key: string; name?: string; pathFormat?: string; recursive?: boolean; type: "media"; url?: string; }; }; }>