@drupflare/spool - v0.1.0
    Preparing search index...

    Type Alias SpoolOptions

    what createSpool takes

    type SpoolOptions = {
        assets?: AssetMode;
        beacons?: readonly string[];
        catalogueBytes?: number;
        catalogueSize?: Sizer;
        cdn?: { integrity: string; url?: string };
        collectors?: readonly CollectorConfig[];
        identity?: IdentityOptions;
        logout?: readonly string[];
        meter?: () => number;
        mode?: Mode;
        provision?: ProvisionConfig;
        routes: readonly Route[];
        shadowSample?: number;
        sink?: Sink;
        store: VersionStore;
        thirdParty?: ThirdPartyConfig;
        views?: boolean;
        work?: WorkSeries;
        worker?: string;
    }
    Index
    assets? beacons? catalogueBytes? catalogueSize? cdn? collectors? identity? logout? meter? mode? provision? routes shadowSample? sink? store thirdParty? views? work? worker?
    assets?: AssetMode

    how the worker treats same-origin subresources; default cache

    beacons?: readonly string[]

    same-origin POST paths the worker queues and flushes in one request

    catalogueBytes?: number

    the most compressed bytes of entries one catalogue bundle may carry; default 32 KiB

    catalogueSize?: Sizer

    measures an entry's compressed bytes for the catalogue; default Brotli, gzip where the runtime has no Brotli stream

    cdn?: { integrity: string; url?: string }

    serve the page runtime from a CDN with SRI; omitted, it is served from /.spool/<version>/client.js. url defaults to this version's cdn.drupflare.com build, whose integrity is in the release notes and in dist/cdn/manifest.json.

    collectors?: readonly CollectorConfig[]

    cross-origin analytics collectors the worker holds and delivers later

    identity?: IdentityOptions
    logout?: readonly string[]

    same-origin paths whose request ends the session; the worker wipes the principal store first

    meter?: () => number

    reads a millisecond clock for work; default performance.now, which is elapsed time and not CPU

    mode?: Mode

    the mode for routes that do not name one; default serve. shadow never serves locally

    provision?: ProvisionConfig

    priors the worker uses before its own telemetry exists, and the server uses to leave out an artifact whose transfer its expected reuse does not repay

    routes: readonly Route[]
    shadowSample?: number

    the share of views, 0 to 1, that run in shadow while the mode is serve; default 0

    sink?: Sink
    store: VersionStore
    thirdParty?: ThirdPartyConfig

    the opt-in worker cache for versioned cross-origin files

    views?: boolean

    whether the worker queues a spool.view per page view; default true

    work?: WorkSeries

    records the time each request took, by route; read it with work.samples()

    worker?: string

    a bundled worker to serve in place of the embedded one, such as a bundle of serve(config, renderers) from @drupflare/spool/sw; it finds the config in self.__SPOOL_CONFIG__

    Settings
    Member Visibility

    On This Page
    Properties