ui/blueskylogging/logVariableChecker¶

Interfaces¶

VariableCheckerDeps¶

Defined in: ui/blueskylogging/logVariableChecker.ts:18

Properties¶

sendCommand¶

sendCommand: (command) => unknown;

Defined in: ui/blueskylogging/logVariableChecker.ts:20

Sends a console command to BlueSky (usually window.app.sendCommand).

Parameters¶

command¶

string

Returns¶

unknown

isConnected¶

isConnected: () => boolean;

Defined in: ui/blueskylogging/logVariableChecker.ts:22

Whether a BlueSky server is connected; when false the check is skipped.

Returns¶

boolean

timeoutMs?¶

optional timeoutMs?: number;

Defined in: ui/blueskylogging/logVariableChecker.ts:24

How long to wait for BlueSky's echo reply (default 2500 ms).

Type Aliases¶

VariableCheckResult¶

type VariableCheckResult = "found" | "not-found" | "unknown";

Defined in: ui/blueskylogging/logVariableChecker.ts:16

Functions¶

checkLogVariable()¶

function checkLogVariable(name, deps): Promise<VariableCheckResult>;

Defined in: ui/blueskylogging/logVariableChecker.ts:94

Check whether name exists in the running simulation's variable explorer. Returns 'unknown' when no server is connected or no reply arrives in time (callers should treat 'unknown' as "unverified", not as missing).

Parameters¶

name¶

string

deps¶

VariableCheckerDeps

Returns¶

Promise\<VariableCheckResult>

checkLogVariables()¶

function checkLogVariables(names, deps): Promise<Map<string, VariableCheckResult>>;

Defined in: ui/blueskylogging/logVariableChecker.ts:102

Check several variables (serialized); resolves to a name → result map.

Parameters¶

names¶

readonly string[]

deps¶

VariableCheckerDeps

Returns¶

Promise\<Map\<string, VariableCheckResult>>

discoverVariableAttributes()¶

function discoverVariableAttributes(parent, deps): Promise<string[] | null>;

Defined in: ui/blueskylogging/logVariableChecker.ts:122

Discover the attribute names under a variable-explorer object (e.g. 'traf', 'traf.perf') by parsing the Attributes: line of its LSVAR reply. Resolves to the attribute names (WITHOUT the parent prefix), [] when the variable exists but has no listed attributes (a leaf), and null when it does not exist, no server is connected, or no reply arrives in time. Serialized on the same queue as availability checks so replies never cross-match.

Parameters¶

parent¶

string

deps¶

VariableCheckerDeps

Returns¶

Promise\<string[] | null>