ObjectSchema class

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

Signature:

export declare class ObjectSchema extends Schema 

Extends: Schema

Constructors

Constructor Modifiers Description
(constructor)(schemaParams, properties, optionalProperties) Constructs a new instance of the ObjectSchema class

Properties

Property Modifiers Type Description
optionalProperties string[]
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

Parameter Type Description
schemaParams SchemaParams
properties { [k: string]: TypedSchema; }
optionalProperties string[]

ObjectSchema.optionalProperties

Signature:

optionalProperties: string[];

ObjectSchema.properties

Signature:

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