JSONPath Tools

Appearance

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 ​

Properties ​

annotations ​

ts
readonly annotations: ReadonlySet<DataTypeAnnotation>;

Inherited from ​

DataType.annotations

propertyTypes ​

ts
readonly propertyTypes: ReadonlyMap<string, DataType>;

requiredProperties ​

ts
readonly requiredProperties: ReadonlySet<string>;

restPropertyType ​

ts
readonly restPropertyType: DataType;

Methods ​

addAnnotations() ​

ts
addAnnotations(annotations): DataType

Parameters ​

annotations ​

ReadonlySet<DataTypeAnnotation>

Returns ​

DataType

Inherited from ​

DataType.addAnnotations

changeTypeAtPath() ​

ts
changeTypeAtPath(path, operation): DataType

Parameters ​

path ​

NormalizedPath

operation ​

(currentType) => DataType

Returns ​

DataType

Overrides ​

DataType.changeTypeAtPath

coerceMultiline() ​

ts
protected coerceMultiline(strings, multiline): boolean

Parameters ​

strings ​

string[]

multiline ​

boolean

Returns ​

boolean

Inherited from ​

DataType.coerceMultiline

collectAnnotations() ​

ts
collectAnnotations(): Set<DataTypeAnnotation>

Returns ​

Set<DataTypeAnnotation>

Inherited from ​

DataType.collectAnnotations

collectAnnotationsToSet() ​

ts
collectAnnotationsToSet(annotations): void

Parameters ​

annotations ​

Set<DataTypeAnnotation>

Returns ​

void

Inherited from ​

DataType.collectAnnotationsToSet

collectKnownLiterals() ​

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

Returns ​

Set<null | string | number | boolean>

Inherited from ​

DataType.collectKnownLiterals

collectKnownLiteralsToSet() ​

ts
collectKnownLiteralsToSet(literals): void

Parameters ​

literals ​

Set<null | string | number | boolean>

Returns ​

void

Overrides ​

DataType.collectKnownLiteralsToSet

collectKnownPathSegments() ​

ts
collectKnownPathSegments(): Set<NormalizedPathSegment>

Returns ​

Set<NormalizedPathSegment>

Inherited from ​

DataType.collectKnownPathSegments

collectKnownPathSegmentsToSet() ​

ts
collectKnownPathSegmentsToSet(pathSegments): void

Parameters ​

pathSegments ​

Set<NormalizedPathSegment>

Returns ​

void

Overrides ​

DataType.collectKnownPathSegmentsToSet

createIndentationString() ​

ts
protected createIndentationString(level): string

Parameters ​

level ​

number

Returns ​

string

Inherited from ​

DataType.createIndentationString

getChildrenType() ​

ts
getChildrenType(): DataType

Returns ​

DataType

Overrides ​

DataType.getChildrenType

getDescendantType() ​

ts
getDescendantType(): DataType

Returns ​

DataType

Overrides ​

DataType.getDescendantType

getTypeAtPath() ​

ts
getTypeAtPath(path): DataType

Parameters ​

path ​

NormalizedPath

Returns ​

DataType

Inherited from ​

DataType.getTypeAtPath

getTypeAtPathSegment() ​

ts
getTypeAtPathSegment(segment): DataType

Parameters ​

segment ​

NormalizedPathSegment

Returns ​

DataType

Overrides ​

DataType.getTypeAtPathSegment

setPathExistence() ​

ts
setPathExistence(path): DataType

Parameters ​

path ​

NormalizedPath

Returns ​

DataType

Overrides ​

DataType.setPathExistence

toString() ​

ts
toString(simplified, multiline): string

Parameters ​

simplified ​

boolean = false

multiline ​

boolean = false

Returns ​

string

Inherited from ​

DataType.toString

toStringInternal() ​

ts
toStringInternal(
   simplified, 
   multiline, 
   level): string

Parameters ​

simplified ​

boolean

multiline ​

boolean

level ​

number

Returns ​

string

Overrides ​

DataType.toStringInternal

withAnnotations() ​

ts
withAnnotations(annotations): DataType

Parameters ​

annotations ​

ReadonlySet<DataTypeAnnotation>

Returns ​

DataType

Overrides ​

DataType.withAnnotations

create() ​

ts
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