Class RecursiveObjectSchema

Schema for recursive references

Hierarchy

AbstractObjectSchema
- RecursiveObjectSchema

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new RecursiveObjectSchema(): RecursiveObjectSchema

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

Returns RecursiveObjectSchema

Properties

Private schema

schema: RecursiveRawSchema

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

withLevelsUp

withLevelsUp(up: number): RecursiveObjectSchema

- Defined in usage/recursive.ts:37
Set number of levels up to raise in the schema. Defaults to 1 (parent)

Parameters
- up: number
  
  Levels to raise in the schema
Returns RecursiveObjectSchema
self

withMaxRecursion

withMaxRecursion(maxRecursion: number): RecursiveObjectSchema

- Defined in usage/recursive.ts:57
Sets max recursion allowed. Default has no limit.

Parameters
- maxRecursion: number
  
  Max levels of recursion allowed
Returns RecursiveObjectSchema
self

withReference

withReference(ref: string): RecursiveObjectSchema

- Defined in usage/recursive.ts:47
Sets the recursive reference, based on parent id

Parameters
- ref: string
  
  The Node id to reference
Returns RecursiveObjectSchema
self

Static create

create(): RecursiveObjectSchema

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

Returns RecursiveObjectSchema
a new instance of RecursiveObjectSchema

Generated using TypeDoc