Class Joiful

Hierarchy

Joiful

Index

Constructors

constructor

Accessors

joi

Methods

Constructors

constructor

new Joiful(options?: JoifulOptions): Joiful

- Defined in src/joiful.ts:16
Parameters
- options: JoifulOptions = {}
Returns Joiful

Accessors

joi

get joi(): Root

- Defined in src/joiful.ts:20
Returns Root

Methods

any

any(): AnySchemaDecorator

- Defined in src/joiful.ts:27
Property decorator that allows the property to be any type.

Returns AnySchemaDecorator

array

array(options?: ArrayPropertyDecoratorOptions): ArraySchemaDecorator

- Defined in src/joiful.ts:32
Property decorator that constrains the property to be an array.

Parameters
- Optional options: ArrayPropertyDecoratorOptions
Returns ArraySchemaDecorator

boolean

boolean(): BooleanSchemaDecorator

- Defined in src/joiful.ts:37
Property decorator that constrains the property to be a boolean.

Returns BooleanSchemaDecorator

date

date(): DateSchemaDecorator

- Defined in src/joiful.ts:42
Property decorator that constrains the property to be a Date.

Returns DateSchemaDecorator

func

func(): FunctionSchemaDecorator

- Defined in src/joiful.ts:47
Property decorator that constrains the property to be a Function.

Returns FunctionSchemaDecorator

getSchema

getSchema(Class: AnyClass): undefined | ObjectSchema<any>

- Defined in src/joiful.ts:87
Returns the Joi schema associated with a class or undefined if there isn't one.

Parameters
- Class: AnyClass
Returns undefined | ObjectSchema<any>

hasSchema

hasSchema(Class: AnyClass): boolean

- Defined in src/joiful.ts:94
Returns whether the given class has a Joi schema associated with it

Parameters
- Class: AnyClass
Returns boolean

link

link(ref?: string): LinkSchemaDecorator

- Defined in src/joiful.ts:62
Property decorator that constrains the property to another schema. This allows defining classes that reference themself. e.g.

example

class TreeNode {

jf.string().required()

title: string;

jf.array().items((joi)

=> joi.link('...')) children: TreeNode[]; }

Parameters
- Optional ref: string
Returns LinkSchemaDecorator

number

number(): NumberSchemaDecorator

- Defined in src/joiful.ts:67
Property decorator that constrains the property to be a number.

Returns NumberSchemaDecorator

object

object(options?: ObjectPropertyDecoratorOptions): ObjectSchemaDecorator

- Defined in src/joiful.ts:72
Property decorator that constrains the property to be an object.

Parameters
- Optional options: ObjectPropertyDecoratorOptions
Returns ObjectSchemaDecorator

string

string(): StringSchemaDecorator

- Defined in src/joiful.ts:77
Property decorator that constrains the property to be a string.

Returns StringSchemaDecorator

validateParams

validateParams(options?: { validator?: Validator }): MethodDecorator

- Defined in src/joiful.ts:82
Method decorator that validates the parameters passed into the method.

Parameters
- Optional options: { validator?: Validator }
  - Optional validator?: Validator
Returns MethodDecorator

Generated using TypeDoc