Class BooleanObjectSchema

Schema for boolean

Hierarchy

AbstractObjectSchema
- BooleanObjectSchema

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new BooleanObjectSchema(): BooleanObjectSchema

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

Returns BooleanObjectSchema

Properties

Private schema

schema: BooleanRawSchema

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: boolean): BooleanObjectSchema

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

Parameters
- defaultValue: boolean
  
  The default value
Returns BooleanObjectSchema
self

withEnumeration

withEnumeration(enumeration: boolean[]): BooleanObjectSchema

- Defined in usage/boolean.ts:47
Sets an enumeration of allowed values

Parameters
- enumeration: boolean[]
  
  The enumeration
Returns BooleanObjectSchema
self

Static create

create(): BooleanObjectSchema

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

Returns BooleanObjectSchema
a new instance of BooleanObjectSchema

Generated using TypeDoc