Skip to content

Interface: TransactionOptions ​

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

Options for withCandidate. timeout applies to each request, and signal to each one but the cleanup. See Options.

Extends ​

Properties ​

capabilityCheck? ​

ts
readonly capabilityCheck?: CapabilityCheck;

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

How capabilities are checked before sending. Default 'strict'. Pass the client's policy to match it.


confirmed? ​

ts
readonly confirmed?: boolean | ConfirmedCommitOptions;

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

Commit as a confirmed commit and return a PendingCommit to confirm or cancel it. true uses the server's timeout.


lock? ​

ts
readonly lock?: boolean;

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

Lock the datastores for the transaction. Default true. Set false for servers that can't lock.


lockRunning? ​

ts
readonly lockRunning?: boolean;

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

Also lock running, before the candidate (RFC 6241 Appendix E.1). Default true. Ignored when lock is false.


onStep? ​

ts
readonly onStep?: (step) => void;

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

Called as each request succeeds (lock, discard-changes, edit-config, validate, commit, unlock, cancel-commit), including cleanup after a failure. A failed request isn't reported: the rejection says where it failed. A listener that throws is logged and ignored.

Parameters ​

step ​

ConfigureStep

Returns ​

void


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


validate? ​

ts
readonly validate?: boolean | "auto";

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

'auto' (default): validate when the server advertises :validate. true always validates, false never.

Released under the MIT Licence.