Interface ObjectSchemaI

Javascript object schema interface (any)

Hierarchy

ObjectSchemaI

Implemented by

AbstractObjectSchema

Index

Methods

Methods

getRawSchema

getRawSchema(): RawObjectSchema

- Defined in usage/schema.ts:16
Gets the raw schema, as object type

Returns RawObjectSchema

provideTestError

provideTestError(object: any): Error

- Defined in usage/schema.ts:30
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

- Defined in usage/schema.ts:37
Sanitizes an object.

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

test

test(object: any): boolean

- Defined in usage/schema.ts:23
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