Skip to content

Interface: ModifyOptions ​

Defined in: netconf/src/operations/subscriptions/types.ts:59

What modify() can change: the filter, the stop-time, and for a datastore subscription its period or dampening.

Extends ​

Properties ​

anchorTime? ​

ts
readonly anchorTime?: string | Date;

Defined in: netconf/src/operations/subscriptions/types.ts:67

With period: align the new periods to this time (RFC 3339 string or Date).


dampeningPeriod? ​

ts
readonly dampeningPeriod?: number;

Defined in: netconf/src/operations/subscriptions/types.ts:69

Datastore subscriptions with on-change updates: the new dampening period, in centiseconds.


filter? ​

ts
readonly filter?: Filter;

Defined in: netconf/src/operations/subscriptions/types.ts:61

The new filter. Required for a stream subscription (RFC 8639 makes the target mandatory).


period? ​

ts
readonly period?: number;

Defined in: netconf/src/operations/subscriptions/types.ts:65

Datastore subscriptions with periodic updates: the new period, in centiseconds.


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


stopTime? ​

ts
readonly stopTime?: string | Date;

Defined in: netconf/src/operations/subscriptions/types.ts:63

The new stop-time (RFC 3339 string or Date).


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.