Class AbstractObjectSchema

Abstract schema, for inheritance

Hierarchy

AbstractObjectSchema

Implements

ObjectSchemaI

Index

Constructors

constructor

Properties

raw

Methods

Constructors

constructor

new AbstractObjectSchema(raw: RawObjectSchema): AbstractObjectSchema

- Defined in usage/schema.ts:50
Constructor

Parameters
- raw: RawObjectSchema
  
  Raw schema
Returns AbstractObjectSchema

Properties

Private raw

raw: RawObjectSchema

Methods

getRawSchema

getRawSchema(): RawObjectSchema

Implementation of ObjectSchemaI.getRawSchema
- Defined in usage/schema.ts:57
Gets the raw schema, as object type

Returns RawObjectSchema

provideTestError

provideTestError(object: any): Error

Implementation of ObjectSchemaI.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

Implementation of ObjectSchemaI.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

Implementation of ObjectSchemaI.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

Generated using TypeDoc