8.8.1.1.1.2.13. Settings

interface Settings()

getDetailedSettings()

Get a detailed list of all debugger settings.

let settings = session.settings.getDetailedSettings();

// print details of settings
for (const setting of settings) {
  console.log(`${setting.id}:`);
  console.log(`  type: ${setting.type}`);
  console.log(`  name: ${setting.name}`);
  console.log(`  value: ${setting.value}`);
  if (setting.allowedValues) {
    console.log(`  allowedValues: ${JSON.stringify(setting.allowedValues)}`);
  }
  if (setting.allowedRange) {
    console.log(`  allowedRange: [${setting.allowedRange.min}, ${setting.allowedRange.max}]`);
  }
  console.log("");
}

Returns:

A list of objects which detail each debugger setting.

Return type:

DebugSetting[]

get(settingId: string)

Get the value of a specific debugger setting.

// Get a boolean indicating if debugger is configured to auto run to a label on reset
let autoRun = session.settings.get("AutoRunToLabelOnReset");

// print the label (a string) to which the debugger will run to on a restart or reset (if configured to do so)
console.log(session.settings.get("AutoRunToLabelName"));

Parameters:

• settingId (string) -- The identifier for the desired setting.

Returns:

The value of the setting.

Return type:

boolean | number | string

set(settingId: string, value: boolean | number | string)

Set the value of a specific debugger setting.

// Configure the debugger to auto-run to a label named SYSCFG_DL_init on reset
session.settings.set("AutoRunToLabelName", "SYSCFG_DL_init");
session.settings.set("AutoRunToLabelOnReset", true);

Parameters:

• settingId (string) -- The identifier for the desired setting.

• value (boolean | number | string) -- The new value of the setting.

Return type:

void