Skip to content

Interface: ModulesOptions ​

Defined in: netconf/src/client-modules.ts:94

Options for modules().

Extends ​

Properties ​

datastore? ​

ts
readonly datastore?: DatastoreRef;

Defined in: netconf/src/client-modules.ts:96

The datastore whose modules to list (default running). Not with schema.


declared? ​

ts
readonly declared?: boolean;

Defined in: netconf/src/client-modules.ts:102

Read and compile each implemented module's source, adding declared and undeclared.


module? ​

ts
readonly module?: string;

Defined in: netconf/src/client-modules.ts:100

Only the modules with this name.


refresh? ​

ts
readonly refresh?: boolean;

Defined in: netconf/src/client-modules.ts:104

Read the YANG library again instead of using this session's read.


schema? ​

ts
readonly schema?: string;

Defined in: netconf/src/client-modules.ts:98

A YANG library schema by name, instead of a datastore.


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.