procon-ip - v2.0.0
    Preparing search index...

    Interface IGetStateServiceConfig

    interface IGetStateServiceConfig {
        basicAuth: boolean;
        controllerUrl: string;
        errorTolerance: number;
        password?: string;
        requestHeaders?: Record<string, string>;
        timeout: number;
        updateInterval: number;
        username?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

      Forward-compatible escape hatch for ad-hoc config keys.

    Index

    Properties

    basicAuth controllerUrl errorTolerance password? requestHeaders? timeout updateInterval username?

    Properties

    basicAuth: boolean

    Enable HTTP basic auth (uses username and password).

    controllerUrl: string

    Controller base URL (e.g. "http://192.168.2.3"). Trailing slash optional.

    errorTolerance: number

    Number of consecutive identical failures tolerated before re-throwing.

    password?: string

    Optional basic-auth password.

    requestHeaders?: Record<string, string>

    Optional extra headers merged into every request.

    timeout: number

    Per-request timeout in milliseconds.

    updateInterval: number

    Interval between polls, in milliseconds.

    username?: string

    Optional basic-auth username.

    Settings

    Member Visibility

    On This Page

    Properties