Docs for Release: 2.4.1
    Preparing search index...

    Interface ConfigData

    interface ConfigData {
        displayMethod?: "browser" | "none";
        existingServer: Server;
        host?: string;
        htmlFooter?: string;
        htmlHeader?: string;
        port: number;
        stayOpen?: boolean;
        style?: string;
        title?: string;
        unrefServer?: boolean;
    }
    Index

    Properties

    displayMethod? existingServer host? htmlFooter? htmlHeader? port stayOpen? style? title? unrefServer?

    Properties

    displayMethod?: "browser" | "none"

    How to display the panel.

    • browser (default) opens the default system browser,
    • none does not open any window. The server URL must be opened manually.
    existingServer: Server

    If provided, uses this existing HTTP server instead of starting a new one.

    host?: string

    Host to run local server on. Defaults to 'localhost'.

    htmlFooter?: string

    Extra custom HTML to inject into the panel after the categories (e.g. for custom footer).

    htmlHeader?: string

    Extra custom HTML to inject into the panel before the categories (e.g. for custom header).

    port: number

    Port to run local server on. Defaults to 0 (random available port).

    stayOpen?: boolean

    Whether to keep the listening server open after the window/browser is closed. Defaults to false.

    style?: string

    Custom CSS to inject into the panel.

    title?: string

    Optional title for the panel.

    unrefServer?: boolean

    If true, will unref the server, so that it will not block program exit. Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties