Interface: ParamDescriptor
Defined in: netconf/src/operations/extension.ts:50
One argument of an operation. Plain data: safe to serialize to JSON.
Properties
default?
readonly default?: string | number | boolean;Defined in: netconf/src/operations/extension.ts:66
The value used when the argument is left out.
description
readonly description: string;Defined in: netconf/src/operations/extension.ts:58
A one-line description, for help text.
extension?
readonly extension?: string;Defined in: netconf/src/operations/extension.ts:72
Set when an extension added this parameter to a base operation.
kind
readonly kind: "positional" | "option";Defined in: netconf/src/operations/extension.ts:54
Positional arguments come first, in descriptor order; options are named.
multiple?
readonly multiple?: boolean;Defined in: netconf/src/operations/extension.ts:64
True when the argument can be given more than once; its value is then an array.
name
readonly name: string;Defined in: netconf/src/operations/extension.ts:52
The option name in the library API (confirmTimeout). Tools derive their own spelling.
required?
readonly required?: boolean;Defined in: netconf/src/operations/extension.ts:62
True when the argument must be given.
requires?
readonly requires?: readonly string[];Defined in: netconf/src/operations/extension.ts:68
Capabilities needed whenever this argument is given.
type
readonly type: OperationParamType;Defined in: netconf/src/operations/extension.ts:56
How to read the value: string, number, XML, filter, datastore name and so on.
valueRequires?
readonly valueRequires?: Readonly<Record<string, readonly string[]>>;Defined in: netconf/src/operations/extension.ts:70
Capabilities needed only for particular values ({ candidate: [':candidate'] }).
values?
readonly values?: readonly string[];Defined in: netconf/src/operations/extension.ts:60
The allowed values, when the set is fixed.