ObjectSchema class

Schema class for "object" types. The properties param must be a map of Schema objects.

Signature:

exportdeclareclassObjectSchemaextendsSchema

Extends:Schema

Constructors

ConstructorModifiersDescription
(constructor)(schemaParams, properties, optionalProperties)Constructs a new instance of the ObjectSchema class

Properties

PropertyModifiersTypeDescription
optionalPropertiesstring[]
properties{ [k: string]: TypedSchema; }

ObjectSchema.(constructor)

Constructs a new instance of the ObjectSchema class

Signature:

constructor(schemaParams:SchemaParams,properties:{[k:string]:TypedSchema;},optionalProperties?:string[]);

Parameters

ParameterTypeDescription
schemaParamsSchemaParams
properties{ [k: string]: TypedSchema; }
optionalPropertiesstring[]

ObjectSchema.optionalProperties

Signature:

optionalProperties:string[];

ObjectSchema.properties

Signature:

properties:{[k:string]:TypedSchema;};