Variable: withDefaults
ts
const withDefaults: object;Defined in: netconf/src/operations/with-defaults.ts:125
The with-defaults extension. Enable it with connect({ extensions: [withDefaults] }).
Type Declaration
augments
ts
readonly augments: readonly [Augment, Augment, Augment];Parameters this extension adds to base operations.
content
ts
readonly content: (ctx) => WithDefaultsContent;Content layer: called once per client, after the hello, with the same context as ops. The result becomes client.content.<id>: calls that hand back decoded, typed data. State shared with ops belongs in a WeakMap keyed by ctx.sessionKey.
Parameters
ctx
Returns
description
ts
readonly description: "RFC 6243: choose how nodes at their default values are reported" = 'RFC 6243: choose how nodes at their default values are reported';A one-line summary of the extension.
id
ts
readonly id: "withDefaults" = 'withDefaults';Becomes client.ops.<id> and client.content.<id>, for the layers the extension contributes to.
requires
ts
readonly requires: readonly [":with-defaults:1.0"];Capabilities the server must advertise, checked after the hello under capabilityCheck.