Skip to content

Interface: CandidateChangesOptions ​

Defined in: netconf/src/operations/transaction.ts:227

Options for getCandidateChanges().

Extends ​

Extended by ​

Properties ​

filter? ​

ts
readonly filter?: 
  | YangJsonObject
  | Filter;

Defined in: netconf/src/operations/transaction.ts:233

Compare only part of the configuration: subtree(...), xpath(...) (needs :xpath), or an RFC 7951 JSON object. The same filter is sent with both reads.


json? ​

ts
readonly json?: JsonOptions;

Defined in: netconf/src/operations/transaction.ts:235

JSON input options for a JSON filter (see JsonOptions).


signal? ​

ts
readonly signal?: AbortSignal;

Defined in: netconf/src/messages/session.ts:100

Stop waiting for the reply. NETCONF has no way to cancel an RPC, so the server still processes it; its reply is discarded when it arrives.

Inherited from ​

RpcOptions.signal


timeout? ​

ts
readonly timeout?: number;

Defined in: netconf/src/messages/session.ts:95

Milliseconds to wait for the reply. Default: the session's timeouts.rpc. Infinity waits with no limit, and values above 2,147,483,647 are shortened to it. A value that is not a number rejects with a TypeError, and zero, a negative number or NaN with a RangeError, before anything is sent.

Inherited from ​

RpcOptions.timeout

Released under the MIT Licence.