Class AnyOfObjectSchema

Schema foor multiple options

Hierarchy

AbstractObjectSchema
- AnyOfObjectSchema

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new AnyOfObjectSchema(options: ObjectSchemaI[]): AnyOfObjectSchema

Overrides AbstractObjectSchema.constructor
- Defined in usage/anyof.ts:25
Constructor

Parameters
- options: ObjectSchemaI[]
Returns AnyOfObjectSchema

Properties

Private schema

schema: AnyOfRawSchema

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

withDefaultSchema

withDefaultSchema(defaultSchema: ObjectSchemaI): AnyOfObjectSchema

- Defined in usage/anyof.ts:45
Sets default schema if any of the options won't fit

Parameters
- defaultSchema: ObjectSchemaI
  
  The default schema
Returns AnyOfObjectSchema
self

withId

withId(id: string): AnyOfObjectSchema

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

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

Static create

create(options: ObjectSchemaI[]): AnyOfObjectSchema

- Defined in usage/anyof.ts:16
Creates anyof schema

Parameters
- options: ObjectSchemaI[]
Returns AnyOfObjectSchema
a new instance of AnyOfObjectSchema

Generated using TypeDoc