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

    Type Alias ApplicationTemplateCatalogOptions

    Which catalog to read. The first one that is given wins: catalog, then url, then the CDN.

    type ApplicationTemplateCatalogOptions = {
        catalog?: ApplicationTemplateCatalog | string | Uint8Array;
        channel?: ApplicationTemplateCatalogChannel;
        ignoreCache?: boolean;
        maxAgeMs?: number;
        refresh?: boolean;
        url?: string;
    }
    Index
    catalog?: ApplicationTemplateCatalog | string | Uint8Array

    A catalog the caller already has: the parsed object, its JSON text, or the bytes of the file (gzip or plain JSON). Nothing is requested.

    Which catalog of the CDN to read when neither catalog nor url is given. Default: production.

    ignoreCache?: boolean

    Download the catalog without validators and keep the result, whatever the cache holds; a failed download is an error, the old copy is not used. Only for the public source with the cache on. Default: false.

    maxAgeMs?: number

    How old a copy in the cache may be, in milliseconds, before the source is asked about it again. Default: 3,600,000 (one hour), the time the source allows a copy to be kept. Zero asks every time.

    refresh?: boolean

    Check the source now, whatever the age of the copy the cache holds: the request is still conditional, so a copy that is current costs no download. Without the cache, read again instead of using the catalog kept from an earlier read of this state. Default: false.

    url?: string

    An http(s) URL the caller names, for example a mirror of the catalog. Any host is accepted, on purpose: it is meant for a location the caller chooses, such as a mirror on a private network. Redirects are followed. It is requested without any credential of the tenant, and it is allowed in air-gapped mode, because the caller named it. A tool that passes arguments on behalf of someone else (the MCP tools of the library do not offer url, catalog or refresh) must not let that party choose it.