@salesforce/b2c-tooling-sdk / operations/debug / SdapiClient

Class: SdapiClient

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:56

Constructors

Constructor

new SdapiClient(config): SdapiClient

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:61

Parameters

config

SdapiClientConfig

Returns

SdapiClient

Methods

createClient()

createClient(): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:75

Returns

Promise<void>

---

deleteBreakpoint()

deleteBreakpoint(id): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:112

Parameters

id

number

Returns

Promise<void>

---

deleteBreakpoints()

deleteBreakpoints(): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:108

Returns

Promise<void>

---

deleteClient()

deleteClient(): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:79

Returns

Promise<void>

---

evaluate()

evaluate(threadId, frameIndex, expr): Promise<SdapiEvalResult>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:197

Evaluates a JavaScript expression in a frame context.

Parameters

threadId

number

The thread ID of the halted thread.

frameIndex

number

The stack frame index (0 = topmost frame).

expr

string

The JavaScript expression to evaluate.

Returns

Promise<SdapiEvalResult>

Promise resolving to the evaluation result.

---

getBreakpoints()

getBreakpoints(): Promise<SdapiBreakpoint[]>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:91

Retrieves all currently set breakpoints for the debugger session.

Returns

Promise<SdapiBreakpoint[]>

Promise resolving to array of breakpoints, or empty array if none are set.

---

getMembers()

getMembers(threadId, frameIndex, objectPath?, start?, count?): Promise<SdapiObjectMembers>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:174

Parameters

threadId

number

frameIndex

number

objectPath?

string

start?

number

count?

number

Returns

Promise<SdapiObjectMembers>

---

getThread()

getThread(threadId): Promise<SdapiScriptThread>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:134

Retrieves a specific thread by ID.

Parameters

threadId

number

The thread identifier.

Returns

Promise<SdapiScriptThread>

Promise resolving to the thread object with its current state.

---

getThreads()

getThreads(): Promise<SdapiScriptThread[]>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:124

Gets all active script threads.

Returns

Promise<SdapiScriptThread[]>

Promise resolving to array of script threads, or empty array if none are active.

---

getVariables()

getVariables(threadId, frameIndex): Promise<SdapiObjectMembers>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:170

Parameters

threadId

number

frameIndex

number

Returns

Promise<SdapiObjectMembers>

---

resetThreads()

resetThreads(): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:138

Returns

Promise<void>

---

resume()

resume(threadId): Promise<SdapiScriptThread>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:146

Parameters

threadId

number

Returns

Promise<SdapiScriptThread>

---

setBreakpoints()

setBreakpoints(breakpoints): Promise<SdapiBreakpoint[]>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:101

Sets or replaces breakpoints for the debugger.

Parameters

breakpoints

BreakpointInput[]

Array of breakpoint definitions to set.

Returns

Promise<SdapiBreakpoint[]>

Promise resolving to array of confirmed breakpoints from the server.

---

stepInto()

stepInto(threadId): Promise<SdapiScriptThread>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:154

Parameters

threadId

number

Returns

Promise<SdapiScriptThread>

---

stepOut()

stepOut(threadId): Promise<SdapiScriptThread>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:158

Parameters

threadId

number

Returns

Promise<SdapiScriptThread>

---

stepOver()

stepOver(threadId): Promise<SdapiScriptThread>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:150

Parameters

threadId

number

Returns

Promise<SdapiScriptThread>

---

stopThread()

stopThread(threadId): Promise<void>

Defined in: packages/b2c-tooling-sdk/src/operations/debug/sdapi-client.ts:162

Parameters

threadId

number

Returns

Promise<void>