JSONPath Tools / @jsonpath-tools/jsonpath / ObjectDataType

Class: ObjectDataType

Data type for JSON objects. Contains all JSON objects that meet criteria from propertyTypes, restPropertyType and requiredProperties.

Extends

• DataType

Properties

annotations

readonly annotations: ReadonlySet<DataTypeAnnotation>;

Inherited from

DataType.annotations

---

propertyTypes

readonly propertyTypes: ReadonlyMap<string, DataType>;

---

requiredProperties

readonly requiredProperties: ReadonlySet<string>;

---

restPropertyType

readonly restPropertyType: DataType;

Methods

addAnnotations()

addAnnotations(annotations): DataType;

Parameters

annotations

ReadonlySet<DataTypeAnnotation>

Returns

DataType

Inherited from

DataType.addAnnotations

---

changeTypeAtPath()

changeTypeAtPath(path, operation): DataType;

Parameters

path

NormalizedPath

operation

(currentType) => DataType

Returns

DataType

Overrides

DataType.changeTypeAtPath

---

coerceMultiline()

protected coerceMultiline(strings, multiline): boolean;

Parameters

strings

string[]

multiline

boolean

Returns

boolean

Inherited from

DataType.coerceMultiline

---

collectAnnotations()

collectAnnotations(): Set<DataTypeAnnotation>;

Returns

Set<DataTypeAnnotation>

Inherited from

DataType.collectAnnotations

---

collectAnnotationsToSet()

collectAnnotationsToSet(annotations): void;

Parameters

annotations

Set<DataTypeAnnotation>

Returns

void

Inherited from

DataType.collectAnnotationsToSet

---

collectKnownLiterals()

collectKnownLiterals(): Set<string | number | boolean | null>;

Returns

Set<string | number | boolean | null>

Inherited from

DataType.collectKnownLiterals

---

collectKnownLiteralsToSet()

collectKnownLiteralsToSet(literals): void;

Parameters

literals

Set<string | number | boolean | null>

Returns

void

Overrides

DataType.collectKnownLiteralsToSet

---

collectKnownPathSegments()

collectKnownPathSegments(): Set<NormalizedPathSegment>;

Returns

Set<NormalizedPathSegment>

Inherited from

DataType.collectKnownPathSegments

---

collectKnownPathSegmentsToSet()

collectKnownPathSegmentsToSet(pathSegments): void;

Parameters

pathSegments

Set<NormalizedPathSegment>

Returns

void

Overrides

DataType.collectKnownPathSegmentsToSet

---

createIndentationString()

protected createIndentationString(level): string;

Parameters

level

number

Returns

string

Inherited from

DataType.createIndentationString

---

getChildrenType()

getChildrenType(): DataType;

Returns

DataType

Overrides

DataType.getChildrenType

---

getDescendantType()

getDescendantType(): DataType;

Returns

DataType

Overrides

DataType.getDescendantType

---

getTypeAtPath()

getTypeAtPath(path): DataType;

Parameters

path

NormalizedPath

Returns

DataType

Inherited from

DataType.getTypeAtPath

---

getTypeAtPathSegment()

getTypeAtPathSegment(segment): DataType;

Parameters

segment

NormalizedPathSegment

Returns

DataType

Overrides

DataType.getTypeAtPathSegment

---

setPathExistence()

setPathExistence(path): DataType;

Parameters

path

NormalizedPath

Returns

DataType

Overrides

DataType.setPathExistence

---

toString()

toString(simplified?, multiline?): string;

Parameters

simplified?

boolean = false

multiline?

boolean = false

Returns

string

Inherited from

DataType.toString

---

toStringInternal()

toStringInternal(
   simplified, 
   multiline, 
   level): string;

Parameters

simplified

boolean

multiline

boolean

level

number

Returns

string

Overrides

DataType.toStringInternal

---

withAnnotations()

withAnnotations(annotations): DataType;

Parameters

annotations

ReadonlySet<DataTypeAnnotation>

Returns

DataType

Overrides

DataType.withAnnotations

---

create()

static create(
   propertyTypes, 
   restPropertyType, 
   requiredProperties, 
   annotations?): ObjectDataType | NeverDataType;

Parameters

propertyTypes

ReadonlyMap<string, DataType>

restPropertyType

DataType

requiredProperties

ReadonlySet<string>

annotations?

ReadonlySet<DataTypeAnnotation> = DataTypeAnnotation.EMPTY_SET

Returns

ObjectDataType | NeverDataType