Class ArrayObjectSchema

Schema for Array

Hierarchy

AbstractObjectSchema
- ArrayObjectSchema

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new ArrayObjectSchema(itemsSchema: ObjectSchemaI): ArrayObjectSchema

Overrides AbstractObjectSchema.constructor
- Defined in usage/array.ts:26
Constructor

Parameters
- itemsSchema: ObjectSchemaI
Returns ArrayObjectSchema

Properties

Private schema

schema: ArrayRawSchema

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

withDefaultValue

withDefaultValue(defaultValue: any[]): ArrayObjectSchema

- Defined in usage/array.ts:40
Sets default value, in case the object is null, undefined or cannot be parsed

Parameters
- defaultValue: any[]
  
  The default value
Returns ArrayObjectSchema
self

withId

withId(id: string): ArrayObjectSchema

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

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

withMaxLength

withMaxLength(maxLength: number): ArrayObjectSchema

- Defined in usage/array.ts:50
Sets max length for the array. If the array length is greater than this value, it will be truncated.

Parameters
- maxLength: number
  
  The max length for the array.
Returns ArrayObjectSchema
self

Static create

create(itemsSchema: ObjectSchemaI): ArrayObjectSchema

- Defined in usage/array.ts:17
Creates array schema

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

Generated using TypeDoc