Skip to content

Interface: YangOptions ​

Defined in: netconf/src/client-yang.ts:34

connect({ yang }): YANG schemas for RFC 7951 JSON output.

Properties ​

cache? ​

ts
readonly cache?: YangCache;

Defined in: netconf/src/client-yang.ts:51

Share fetched module text and compiled schemas with other clients given the same cache. Default: a cache for this client alone.


modules? ​

ts
readonly modules?: string | readonly string[] | ModuleSource;

Defined in: netconf/src/client-yang.ts:41

YANG modules to use before any other source: one or more directories of .yang or .yin files (named module.yang or module@revision.yang), or a @node-net/yang ModuleSource. Give them for modules the server can't serve, such as on a server without <get-schema>.


requireSchema? ​

ts
readonly requireSchema?: boolean;

Defined in: netconf/src/client-yang.ts:46

Refuse to convert data without a YANG schema (see JsonOptions.requireSchema). Overrides the device profile's yang.requireSchema; a call's own option overrides this.

Released under the MIT Licence.