@freedomofpress/webcat
    Preparing search index...

    Variable defaultsConst

    defaults: {
        bundlePath: "/.well-known/webcat/bundle.json";
        bundlePrevPath: "/.well-known/webcat/bundle-prev.json";
        chainId: "webcat-test-02";
        checkInterval: number;
        connectionName: "WEBCAT";
        endpoint: "https://webcat.freedom.press/";
        fetchTimeout: 3000;
        iconPaths: (p: PathTemplateProperties) => string;
        localDataPath: "data";
        namespace: "WEBCAT";
        nonOriginCacheSize: 8192;
        originCacheSize: 32;
        pagePaths: (p: PathTemplateProperties) => string;
        staticHookPath: "dist/hooks/content.js";
        updateInterval: number;
        validatorSet: ValidatorJson;
    } = ...

    Default WebcatConfig values.

    Type Declaration

    • ReadonlybundlePath: "/.well-known/webcat/bundle.json"

      The path to bundle.json.

    • ReadonlybundlePrevPath: "/.well-known/webcat/bundle-prev.json"

      The path to bundle-prev.json.

    • ReadonlychainId: "webcat-test-02"
    • ReadonlycheckInterval: number

      The time in milliseconds between enrollment update checks. Determines how often the extension is activated to check whether an update is due. An update is only downloaded if, at check time, updateInterval has elapsed since the last update.

    • ReadonlyconnectionName: "WEBCAT"

      The name of the connection that content script hooks use to communicate with the rest of the extension.

    • Readonlyendpoint: "https://webcat.freedom.press/"

      The update endpoint that serves verifiable enrollments as list.json and block.json.

    • ReadonlyfetchTimeout: 3000

      The timeout, in milliseconds, of update download attempts.

    • ReadonlyiconPaths: (p: PathTemplateProperties) => string

      Template for icon paths.

    • ReadonlylocalDataPath: "data"

      The path to bundled list.json and block.json files.

    • Readonlynamespace: "WEBCAT"

      A string prefix used for all persisted keys.

    • ReadonlynonOriginCacheSize: 8192

      The number of hostnames to store in-memory in the negative origin cache.

    • ReadonlyoriginCacheSize: 32

      The number of OriginState objects to cache locally.

    • ReadonlypagePaths: (p: PathTemplateProperties) => string

      Template for page paths.

    • ReadonlystaticHookPath: "dist/hooks/content.js"

      The path to the static hook content script file, relative to the extension root directory.

    • ReadonlyupdateInterval: number

      The minimum time in milliseconds between updates. Update checks are run periodically at an interval determined by this value. An update is only downloaded when a check runs and updateInterval has elapsed since the last update.

    • ReadonlyvalidatorSet: ValidatorJson

      The set of CometBFT validators to verify enrollments against.