Setu-TS
    Preparing search index...

    Interface DiagnosticsPluginOptions

    Options for DiagnosticsPlugin — all required, all explicit.

    There is no environment fallback: importing the package, registering unrelated plugins, or setting a development environment variable never exposes an endpoint. The credentials are the fresh per-launch pair the trusted native launcher generated and handed to the application's composition in memory — never a value the plugin reads from the environment, a file, or a URL.

    0.8.0

    interface DiagnosticsPluginOptions {
        enabled: true;
        maxSessionLifetimeMs?: number;
        port: number;
        sessionId: string;
        sessionKey: Uint8Array;
        ttlMs?: number;
    }
    Index
    enabled maxSessionLifetimeMs? port sessionId sessionKey ttlMs?
    enabled: true

    The explicit opt-in, and deliberately the LITERAL true rather than a boolean: this is an acknowledgement, not a toggle.

    There is no disabled mode. enabled: false has never activated anything — it is refused at composition time so a half-configured development launch fails loudly instead of half-starting — so a caller reaching for the obvious enabled: !isProduction would not get an inert connector, they would get an application that throws at composition and never boots in production. Typing the literal makes that a COMPILE error instead, and points at the only correct shape: decide whether to construct the plugin at all.

    // Not a toggle — decide by INCLUSION, ideally from a development-only
    // entry point that production never imports.
    const plugins = [RuntimePlugin()];
    if (devtoolCredentials !== undefined) {
      plugins.push(DiagnosticsPlugin({ enabled: true, port, sessionId, sessionKey }));
    }
    maxSessionLifetimeMs?: number

    Absolute renewable-session lifetime in milliseconds, measured from activation on the runtime's monotonic clock. Omit this option to disable renewal and preserve the legacy status body and expiry timer behavior. When present it must be at least ttlMs and at most 43,200,000 (12 hours of awake time).

    port: number

    The IPv4 loopback port the runtime-owned listener binds. Only 1024–65535 is accepted; there is no port auto-selection and no fallback address.

    sessionId: string

    The 16-byte session ID as 32 lowercase hex characters, generated fresh by the trusted launcher for this launch.

    sessionKey: Uint8Array

    The 32-byte session key, generated fresh by the trusted launcher for this launch. Copied into a non-extractable Web Crypto HMAC-SHA-256 key at activation; the plugin's temporary copy is zeroed after import.

    ttlMs?: number

    Session lifetime in milliseconds, measured on the runtime's monotonic clock from activation. Defaults to 900,000 (15 minutes); accepted range is 1 through 3,600,000.

    Settings
    Member Visibility

    On This Page
    Properties