JSONPath Tools / @jsonpath-tools/jsonpath / DataTypeAnnotation

Class: DataTypeAnnotation

Annotation of a data type (description, example values, ...).

Constructors

new DataTypeAnnotation()

new DataTypeAnnotation(
   title, 
   description, 
   deprecated, 
   readOnly, 
   writeOnly, 
   defaultValue, 
   exampleValues): DataTypeAnnotation

Parameters

title

string

Title.

description

string

Description.

deprecated

boolean

Whether it is deprecated.

readOnly

boolean

Whether it is read-only.

writeOnly

boolean

Whether it is write-only.

defaultValue

Default value or undefined if no default value is defined.

undefined | JSONValue

exampleValues

readonly JSONValue[]

Example of values.

Returns

DataTypeAnnotation

Properties

defaultValue

readonly defaultValue: undefined | JSONValue;

Default value or undefined if no default value is defined.

---

deprecated

readonly deprecated: boolean;

Whether it is deprecated.

---

description

readonly description: string;

Description.

---

exampleValues

readonly exampleValues: readonly JSONValue[];

Example of values.

---

readOnly

readonly readOnly: boolean;

Whether it is read-only.

---

title

readonly title: string;

Title.

---

writeOnly

readonly writeOnly: boolean;

Whether it is write-only.

---

EMPTY_SET

readonly static EMPTY_SET: ReadonlySet<DataTypeAnnotation>;