@freedomofpress/webcat
    Preparing search index...

    Interface WebcatConfig

    Global WEBCAT configuration. See defaults.

    interface WebcatConfig {
        bundlePath: string;
        bundlePrevPath: string;
        chainId: string;
        checkInterval?: number;
        connectionName: string;
        endpoint: string;
        fetchTimeout?: number;
        iconPaths: PathTemplate;
        localDataPath: string;
        namespace: string;
        nonOriginCacheSize: number;
        originCacheSize: number;
        pagePaths: PathTemplate;
        staticHookPath: string;
        updateInterval?: number;
        validatorSet: ValidatorJson;
    }
    Index
    bundlePath: string

    The path to bundle.json.

    bundlePrevPath: string

    The path to bundle-prev.json.

    chainId: string

    Expected CometBFT chain ID; blocks from any other chain are rejected.

    checkInterval?: 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.

    connectionName: string

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

    endpoint: string

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

    fetchTimeout?: number

    The timeout, in milliseconds, of update download attempts.

    iconPaths: PathTemplate

    Template for icon paths.

    localDataPath: string

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

    namespace: string

    A string prefix used for all persisted keys.

    nonOriginCacheSize: number

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

    originCacheSize: number

    The number of OriginState objects to cache locally.

    pagePaths: PathTemplate

    Template for page paths.

    staticHookPath: string

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

    updateInterval?: 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.

    validatorSet: ValidatorJson

    The set of CometBFT validators to verify enrollments against.