Class ObjectSchema

Object schema

Hierarchy

AbstractObjectSchema
- ObjectSchema

Index

Constructors

constructor

Properties

schema

Constructors

constructor

new ObjectSchema(): ObjectSchema

Overrides AbstractObjectSchema.constructor
- Defined in usage/object.ts:186
Constructor

Returns ObjectSchema

Properties

Private schema

schema: ObjectRawSchema

Methods

getRawSchema

getRawSchema(): RawObjectSchema

Inherited from AbstractObjectSchema.getRawSchema
- Defined in usage/schema.ts:57
Gets the raw schema, as object type

Returns RawObjectSchema

provideTestError

provideTestError(object: any): Error

Inherited from AbstractObjectSchema.provideTestError
- Defined in usage/schema.ts:75
Provides the reason test() returned false, if any

Parameters
- object: any
  
  The object to test
Returns Error
The provided error

sanitize

sanitize(object: any): any

Inherited from AbstractObjectSchema.sanitize
- Defined in usage/schema.ts:89
Sanitizes an object.

Parameters
- object: any
  
  The object to test
Returns any
The sanitized object

test

test(object: any): boolean

Inherited from AbstractObjectSchema.test
- Defined in usage/schema.ts:66
Tests the schema against an object

Parameters
- object: any
  
  The object to test
Returns boolean
true if it matches the schema, false if it does not match

withId

withId(id: string): ObjectSchema

- Defined in usage/object.ts:246
Sets the ID for this schema to be referenced by its children for recursion

Parameters
- id: string
  
  The identifier of the schema node
Returns ObjectSchema
self

withProperties

withProperties(props: {}): ObjectSchema

- Defined in usage/object.ts:214
Sets required properties for the object

Parameters
- props: {}
  
  Properties
  - [propName: string]: ObjectSchemaI
Returns ObjectSchema
self

withProperty

withProperty(propName: string, schema: ObjectSchemaI): ObjectSchema

- Defined in usage/object.ts:199
Add property to the object schema

Parameters
- propName: string
  
  The name of the property
- schema: ObjectSchemaI
  
  The schema for the property
Returns ObjectSchema
self

withPropertyFilter

withPropertyFilter(extraPropsFilter: (key: string) => boolean, extraPropsSchema: (key: string) => ObjectSchemaI): ObjectSchema

- Defined in usage/object.ts:232
Sets property filter for dynamic dictionaries

Parameters
- extraPropsFilter: (key: string) => boolean
  
  Function to filter the the propeties
  - - (key: string): boolean
    - Parameters
      - key: string
      Returns boolean
- extraPropsSchema: (key: string) => ObjectSchemaI
  
  Function to determine the schema to use in each case
  - - (key: string): ObjectSchemaI
    - Parameters
      - key: string
      Returns ObjectSchemaI
Returns ObjectSchema
self

Static anyOf

anyOf(schemas: ObjectSchemaI[]): AnyOfObjectSchema

- Defined in usage/object.ts:116
The object should match one of the provided schemas

Parameters
- schemas: ObjectSchemaI[]
  
  List of schemas
Returns AnyOfObjectSchema
a new schema instance

Static array

array(itemsSchema: ObjectSchemaI): ArrayObjectSchema

- Defined in usage/object.ts:91
Schema to represent an array

Parameters
- itemsSchema: ObjectSchemaI
  
  Schema for the items of the array
Returns ArrayObjectSchema
a new schema instance

Static boolean

boolean(): BooleanObjectSchema

- Defined in usage/object.ts:82
Schema to represent a boolean

Returns BooleanObjectSchema
a new schema instance

Static create

create(): ObjectSchema

- Defined in usage/object.ts:158
Schema for object type

Returns ObjectSchema
a new schema instance

Static custom

custom(): CustomObjectSchema

- Defined in usage/object.ts:50
Schema with custom tester and sanitizer

Returns CustomObjectSchema
a new schema instance

Static dict

dict(propsFilter: (key: string) => boolean, propsSchema: (key: string) => ObjectSchemaI): ObjectSchema

- Defined in usage/object.ts:177
Schema for dictionary (key => value)

Parameters
- propsFilter: (key: string) => boolean
  
  Property filter
  - - (key: string): boolean
    - Parameters
      - key: string
      Returns boolean
- propsSchema: (key: string) => ObjectSchemaI
  
  Function to determine schema for properties
  - - (key: string): ObjectSchemaI
    - Parameters
      - key: string
      Returns ObjectSchemaI
Returns ObjectSchema
a new schema instance

Static extend

extend(schema: ObjectSchemaI, ext: {}): ObjectSchemaI

- Defined in usage/object.ts:138
Extends schema. For object schemas with pre-defined keys

Parameters
- schema: ObjectSchemaI
  
  Parent schema
- ext: {}
  
  Extension info
  - [id: string]: {}
    - [prop: string]: ObjectSchemaI
Returns ObjectSchemaI
Extended schema

Static fromRaw

fromRaw(raw: ObjectRawSchema): ObjectSchemaI

- Defined in usage/object.ts:26
Schema from raw representation

Parameters
- raw: ObjectRawSchema
  
  Raw schema representation
Returns ObjectSchemaI
a new schema instance

Static integer

integer(): NumberObjectSchema

- Defined in usage/object.ts:74
Schema to represent an integer

Returns NumberObjectSchema
a new schema instance

Static null

null(): ObjectSchemaI

- Defined in usage/object.ts:34
Schema to represent the null value

Returns ObjectSchemaI
a new schema instance

Static number

number(): NumberObjectSchema

- Defined in usage/object.ts:66
Schema to represent a real number

Returns NumberObjectSchema
a new schema instance

Static object

object(props: {}): ObjectSchema

- Defined in usage/object.ts:167
Schema for object type (with a set of properties)

Parameters
- props: {}
  
  Properties
  - [propName: string]: ObjectSchemaI
Returns ObjectSchema
a new schema instance

Static optional

optional(schema: ObjectSchemaI): AnyOfObjectSchema

- Defined in usage/object.ts:125
Makes schema optional. This means undefined is allowed for test()

Parameters
- schema: ObjectSchemaI
  
  The schema
Returns AnyOfObjectSchema
a new schema instance

Static parent

parent(): RecursiveObjectSchema

- Defined in usage/object.ts:107
Parent recursive reference

Returns RecursiveObjectSchema
a new schema instance

Static recursive

recursive(): RecursiveObjectSchema

- Defined in usage/object.ts:99
Schema for recursive references

Returns RecursiveObjectSchema
a new schema instance

Static string

string(): StringObjectSchema

- Defined in usage/object.ts:58
Schema to represent a string

Returns StringObjectSchema
a new schema instance

Static undefined

undefined(): ObjectSchemaI

- Defined in usage/object.ts:42
Schema to represent the undefined value

Returns ObjectSchemaI
a new schema instance

Generated using TypeDoc