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

    Type Alias RouteCommon

    the declaration fields every strategy shares

    type RouteCommon = {
        documentBytes?: number;
        freshness?: Partial<Freshness>;
        mode?: Mode;
        offline?: OfflineRule;
        persist?: boolean;
        provision?: { futureViews?: number; reuse?: number };
        retention?: Retention;
        scope?: Scope;
        sync?: SyncRule;
        catalogue?(
            ctx: RouteContext,
        ): readonly CatalogueGuess[] | Promise<readonly CatalogueGuess[]>;
        depends?(ctx: RouteContext): readonly string[] | Promise<readonly string[]>;
    }
    Index
    documentBytes? freshness? mode? offline? persist? provision? retention? scope? sync?
    catalogue? depends?
    documentBytes?: number

    compressed bytes of the document this route renders, which a catalogue entry for it replaces; the server's prior when absent

    freshness?: Partial<Freshness>
    mode?: Mode

    shadow renders locally and compares but never serves; the server's mode when absent

    offline?: OfflineRule
    persist?: boolean

    keep the artifact across worker restarts; default true

    provision?: { futureViews?: number; reuse?: number }

    overrides the provisioning priors for this route when the server decides whether to ship it

    retention?: Retention

    a principal route's at-rest key; default session

    scope?: Scope
    sync?: SyncRule

    how a soft route past its bound refreshes; default background

    • Pages a device on this route may open next, each with the share of devices expected to (from the site's own nextShare over the sink, link position, or a fixed prior). The server ships the data of those that repay their transfer, never their HTML. Only template, projection and data routes can be entries.

      Parameters

      Returns readonly CatalogueGuess[] | Promise<readonly CatalogueGuess[]>

    • tags the artifact is built from; records and projections the load registers are added

      Parameters

      Returns readonly string[] | Promise<readonly string[]>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods