PropertySchema class
Represents a property found in a JSON schema.
Constructors
| Property |
Creates a new |
Properties
| children | Child properties if there are any. |
| entities | List of entity names. |
| expected |
List of expected only entity names. |
| name | Name for this property. |
| parent | Parent property schema if any. |
| path | Path to schema. |
| schema | JSON Schema object for this property. |
| type | JSON Schema type. |
Constructor Details
PropertySchema(string, object, PropertySchema[])
Creates a new PropertySchema instance.
new PropertySchema(path: string, schema: object, children?: PropertySchema[])Parameters
- path
-
string
Path to this property.
- schema
-
object
JSON schema fragment for this property.
- children
Optional. Child properties.
Property Details
children
Child properties if there are any.
PropertySchema[] childrenProperty Value
The child properties if there are any.
entities
List of entity names.
string[] entitiesProperty Value
string[]
A list of entity names.
expectedOnly
List of expected only entity names.
string[] expectedOnlyProperty Value
string[]
A List of expected only entity names.
name
Name for this property.
string nameProperty Value
string
The name for this property.
Remarks
Array brackets [] will have been removed.
parent
Parent property schema if any.
PropertySchema | undefined parentProperty Value
PropertySchema | undefined
The parent property schema if any.
path
Path to schema.
path: stringProperty Value
string
Remarks
Contains [] for arrays and . for path segments.
schema
JSON Schema object for this property.
schema: objectProperty Value
object
type
JSON Schema type.
string typeProperty Value
string
The JSON Schema type.
Method Details
isArray()
function isArray(): booleanReturns
boolean
true if the property is an array.
isEnum()
function isEnum(): booleanReturns
boolean
true if the property is an enum.