Class EnumType<T>

this constraint class adds specific checks for a specific class instances.

Type Parameters

T extends Record<string, number | string>

Hierarchy (View Summary)

Type<T>
- EnumType

Index

Constructors

Properties

baseType keys message? name? tests type cache

Methods

check errorMessage isValid nullable optional params4 required test toJSON toString validate create get getConstraints getTypes patch register registerFactory

Constructors

constructor

new EnumType<T extends Record<string, string | number>>(
type: T,
name?: string,
): EnumType<T>
Type Parameters
- T extends Record<string, string | number>
Parameters
- type: T
- Optionalname: string
Returns EnumType<T>
Overrides Type<T>.constructor
- Defined in libs/core/src/lib/validation/type/enum-type.ts:30

Properties

baseType

baseType: string = "string"

keys

keys: any[]

`Optional`message

message?: string

`Optional`name

name?: string

tests

tests: Test<T>[] = []

type

type: T

`Static`cache

cache: {} = {}

Methods

check

check(object: T, context: ValidationContext): void
Parameters
- object: T
- context: ValidationContext
Returns void
Inherited from Type.check
- Defined in libs/core/src/lib/validation/type/type.ts:350

errorMessage

errorMessage(message: string): Type<T>
Parameters
- message: string
Returns Type<T>
Inherited from Type.errorMessage
- Defined in libs/core/src/lib/validation/type/type.ts:278

isValid

isValid(object: T): boolean
Parameters
- object: T
Returns boolean
Inherited from Type.isValid
- Defined in libs/core/src/lib/validation/type/type.ts:269

nullable

nullable(): Type<T>
Returns Type<T>
Inherited from Type.nullable
- Defined in libs/core/src/lib/validation/type/type.ts:309

optional

optional(): Type<T>
Returns Type<T>
Inherited from Type.optional
- Defined in libs/core/src/lib/validation/type/type.ts:300

params4

params4(constraint: string): any
Parameters
- constraint: string
Returns any
Inherited from Type.params4
- Defined in libs/core/src/lib/validation/type/type.ts:317

required

required(): Type<T>
Returns Type<T>
Inherited from Type.required
- Defined in libs/core/src/lib/validation/type/type.ts:291

test

test(test: Test<T>): Type<T>
Parameters
- test: Test<T>
Returns Type<T>
Inherited from Type.test
- Defined in libs/core/src/lib/validation/type/type.ts:284

toJSON

toJSON(): Record<string, any>
Returns Record<string, any>
Inherited from Type.toJSON
- Defined in libs/core/src/lib/validation/type/type.ts:237

toString

toString(): string
Returns string
Inherited from Type.toString
- Defined in libs/core/src/lib/validation/type/type.ts:325

validate

validate(object: T): void
Parameters
- object: T
Returns void
Inherited from Type.validate
- Defined in libs/core/src/lib/validation/type/type.ts:261

`Static`create

create(typeName: string, constraints?: Record<string, any>): Type<any>
Parameters
- typeName: string
- Optionalconstraints: Record<string, any>
Returns Type<any>
Inherited from Type.create
- Defined in libs/core/src/lib/validation/type/type.ts:142

`Static`get

get(type: string): Type<any> | undefined
Parameters
- type: string
Returns Type<any> | undefined
Inherited from Type.get
- Defined in libs/core/src/lib/validation/type/type.ts:174

`Static`getConstraints

getConstraints(typeName: string): ConstraintMethodDescriptor[]
Parameters
- typeName: string
Returns ConstraintMethodDescriptor[]
Inherited from Type.getConstraints
- Defined in libs/core/src/lib/validation/type/type.ts:101

`Static`getTypes

getTypes(): string[]
Returns string[]
Inherited from Type.getTypes
- Defined in libs/core/src/lib/validation/type/type.ts:97

`Static`patch

patch(object: any, property: string, evaluate: () => any): void
Parameters
- object: any
- property: string
- evaluate: () => any
Returns void
Inherited from Type.patch
- Defined in libs/core/src/lib/validation/type/type.ts:194

`Static`register

register(constraint: Type<any>): typeof Type
Parameters
- constraint: Type<any>
Returns typeof Type
Inherited from Type.register
- Defined in libs/core/src/lib/validation/type/type.ts:168

`Static`registerFactory

registerFactory(typeName: string, typeClass: new () => Type<any>): void
Parameters
- typeName: string
- typeClass: new () => Type<any>
Returns void
Inherited from Type.registerFactory
- Defined in libs/core/src/lib/validation/type/type.ts:111