Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias Site

    type Site = {
        createSiteExportTemplate(): SiteExportInterface;
        exportSite(siteId: string): Promise<SiteExportInterface>;
        exportSites(): Promise<SiteExportInterface>;
        importSites(
            importData: SiteExportInterface,
            siteId?: string,
            siteUrl?: string,
            resultCallback?: ResultCallback<SiteSkeleton>,
        ): Promise<SiteSkeleton[]>;
        readSite(siteId: string): Promise<SiteSkeleton>;
        readSites(): Promise<SiteSkeleton[]>;
        updateSite(siteId: string, siteData: SiteSkeleton): Promise<SiteSkeleton>;
    }
    Index
    • Import sites. Every site is tried: a site that cannot be imported does not stop the others.

      Parameters

      • importData: SiteExportInterface

        site import data

      • OptionalsiteId: string

        Optional site id. If supplied, only the site of that id is imported. Takes priority over siteUrl if both are provided.

      • OptionalsiteUrl: string

        Optional site url. If supplied, only the site of that url is imported.

      • OptionalresultCallback: ResultCallback<SiteSkeleton>

        Optional callback to process individual results. When given, the outcome of every site is passed to it as it happens (a failed site as an error that names it, with the cause nested) and a failed site does not throw: the sites that could be imported are returned. Without it, the failures are collected and thrown as one error after every site was tried.

      Returns Promise<SiteSkeleton[]>

      the imported sites