Class CustomObjectSchema

Custom sanitizer schema

Hierarchy

AbstractObjectSchema
- CustomObjectSchema

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new CustomObjectSchema(test: (object: any) => boolean, sanitize: (object: any) => any): CustomObjectSchema

Overrides AbstractObjectSchema.constructor
- Defined in usage/custom.ts:28
Constructor

Parameters
- test: (object: any) => boolean
  
  Schema tester
  - - (object: any): boolean
    - Parameters
      - object: any
      Returns boolean
- sanitize: (object: any) => any
  
  Schema sanitizer
  - - (object: any): any
    - Parameters
      - object: any
      Returns any
Returns CustomObjectSchema

Properties

Private schema

schema: CustomSanitizeRawSchema

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

withSanitizer

withSanitizer(sanitize: (object: any) => any): CustomObjectSchema

- Defined in usage/custom.ts:52
Sets custom sanitizer

Parameters
- sanitize: (object: any) => any
  
  Schema sanitizer
  - - (object: any): any
    - Parameters
      - object: any
      Returns any
Returns CustomObjectSchema
self

withTester

withTester(test: (object: any) => boolean): CustomObjectSchema

- Defined in usage/custom.ts:42
Sets custom tester

Parameters
- test: (object: any) => boolean
  
  Schema tester
  - - (object: any): boolean
    - Parameters
      - object: any
      Returns boolean
Returns CustomObjectSchema
self

Static create

create(): CustomObjectSchema

- Defined in usage/custom.ts:17
Creates a custom object schema. You can set custom tester and sanitizer functions.

Returns CustomObjectSchema
a new instance of CustomObjectSchema

Generated using TypeDoc