joiful

Index

Classes

Interfaces

Type aliases

ValidationResult

Variables

Functions

Type aliases

ValidationResult

ValidationResult<T>: ValidationResultPass<T> | ValidationResultFail<T>

Type parameters

T

Variables

Const DEFAULT_INSTANCE

DEFAULT_INSTANCE: Joiful = ...

joi

joi: Root

Functions

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

isValidationFail

isValidationFail<T>(validationResult: ValidationResult<T>): validationResult is ValidationResultFail<T>

- Defined in src/validation.ts:63
Returns true if validation result failed validation.

Type parameters
- T
Parameters
- validationResult: ValidationResult<T>
  
  The validation result to test.
Returns validationResult is ValidationResultFail<T>

isValidationPass

isValidationPass<T>(validationResult: ValidationResult<T>): validationResult is ValidationResultPass<T>

- Defined in src/validation.ts:53
Returns true if validation result passed validation.

Type parameters
- T
Parameters
- validationResult: ValidationResult<T>
  
  The validation result to test.
Returns validationResult is ValidationResultPass<T>

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

validate

validate<T>(target: T, options?: ValidationOptions): ValidationResult<T>

- Defined in src/validation.ts:112
Validates an instance of a decorated class.

Type parameters
- T: undefined | null | {}
Parameters
- target: T
  
  Instance of decorated class to validate.
- Optional options: ValidationOptions
  
  Optional validation options to use. These override any default options.
Returns ValidationResult<T>

validateArrayAsClass

validateArrayAsClass<TClass, TInstance>(target: Partial<TInstance>[], Class: TClass, options?: undefined | ValidationOptions): ValidationResult<TInstance[]>

- Defined in src/validation.ts:162
Validates an array of plain old javascript objects against a decorated class.

Type parameters
- TClass: Constructor<any, TClass>
- TInstance = TClass extends Constructor<TInstance> ? TInstance : never
Parameters
- target: Partial<TInstance>[]
  
  Objects to validate.
- Class: TClass
- options: undefined | ValidationOptions = ...
  
  Optional validation options to use. These override any default options.
Returns ValidationResult<TInstance[]>

validateAsClass

validateAsClass<TClass, TInstance>(target: undefined | null | Partial<TInstance>, Class: TClass, options?: undefined | ValidationOptions): ValidationResult<TInstance>

- Defined in src/validation.ts:125
Validates a plain old javascript object against a decorated class.

Type parameters
- TClass: Constructor<any, TClass>
- TInstance = TClass extends Constructor<TInstance> ? TInstance : never
Parameters
- target: undefined | null | Partial<TInstance>
  
  Object to validate.
- Class: TClass
- options: undefined | ValidationOptions = ...
  
  Optional validation options to use. These override any default options.
Returns ValidationResult<TInstance>

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