lib-iitc-manager
    Preparing search index...

    Interface ManagerConfig

    Environment parameters for an instance of Manager class. Specifying only the "storage" parameter is enough to run in lightweight form, but for full functionality you also need to specify callbacks.

    interface ManagerConfig {
        channel?: Channel;
        gm_api?: GmApiConfig;
        inject_plugin?: (plugin: Plugin) => void;
        inject_user_script?: (code: string) => void;
        is_daemon?: boolean;
        message?: (message: string, args?: string | string[]) => void;
        network_host?: NetworkHost;
        plugin_event?: (event: PluginEventData) => void;
        progressbar?: (is_show: boolean) => void;
        source_url_prefix?: string;
        storage: StorageAPI;
        use_fetch_head_method?: boolean;
    }
    Index

    Properties

    channel? gm_api? inject_plugin? inject_user_script? is_daemon? message? network_host? plugin_event? progressbar? source_url_prefix? storage use_fetch_head_method?

    Properties

    channel?: Channel

    Update channel for IITC and plugins.

    gm_api?: GmApiConfig

    GM API configuration. If provided, enables GM API wrapping for injected plugins. The bridge adapter code is injected before the GM factory, and plugins are automatically wrapped with GM API bindings in inject().

    inject_plugin?: (plugin: Plugin) => void

    Calls a function that injects UserScript plugin into the Ingress Intel window.

    Type Declaration

      • (plugin: Plugin): void

      • Parameters

        • plugin: Plugin

          UserScript plugin to run in the Ingress Intel window.

        Returns void

    inject_user_script?: (code: string) => void

    Calls a function that injects UserScript code into the Ingress Intel window.

    Type Declaration

      • (code: string): void

      • Parameters

        • code: string

          UserScript code to run in the Ingress Intel window.

        Returns void

    since version 1.5.0. Use ManagerConfig.inject_plugin instead.

    is_daemon?: boolean

    In daemon mode, the class does not terminate and runs a periodic check for updates. Default: true.

    message?: (message: string, args?: string | string[]) => void

    Sends an information message to user. You then need to map the message name to human-readable text in application.

    Type Declaration

      • (message: string, args?: string | string[]): void

      • Parameters

        • message: string

          The name of the message sent to user.

        • Optionalargs: string | string[]

          A single substitution string, or an array of substitution strings.

        Returns void

    network_host?: NetworkHost

    URLs of repositories with IITC and plugins for different release branches. If the parameter is not specified, the default values are used.

    plugin_event?: (event: PluginEventData) => void

    Called to handle changes in plugin status for multiple plugins at once, such as enabling, disabling, or updating.

    Type Declaration

    progressbar?: (is_show: boolean) => void

    Controls progress bar display.

    Type Declaration

      • (is_show: boolean): void

      • Parameters

        • is_show: boolean

          Whether to show the progress bar.

        Returns void

    source_url_prefix?: string

    URL prefix for //# sourceURL= comments added to injected scripts. Used to group scripts under the host application in browser DevTools. Example: browser.runtime.getURL('') -> chrome-extension://abc123/

    storage: StorageAPI

    Platform-dependent data storage class. For example, "browser.storage.local" in webextensions.

    use_fetch_head_method?: boolean

    Allow HEAD requests for version checking. Some fetch implementations don't support HEAD method, set to false to always use GET. Default: true.

    Settings

    Member Visibility

    On This Page

    Properties