Variable: IsEnumValidatorDefinition

validation/src.IsEnumValidatorDefinition

const IsEnumValidatorDefinition: object

Type declaration

decorator

decorator: (enumType, validationOptions) => <TFunction, Y>(target, propertyKey?, descriptor?) => void = IsStringEnumLocalized

Parameters

▪ enumType: object | string[]

▪ validationOptions: ValidationOptions= {}

Returns

function

<TFunction, Y>(target, propertyKey?, descriptor?): void

Function that returns a new decorator that applies all decorators provided by param

Useful to build new decorators (or a decorator factory) encapsulating multiple decorators related with the same feature

Type parameters

▪ TFunction extends Function

▪ Y

Parameters

▪ target: object | TFunction

▪ propertyKey?: string | symbol

▪ descriptor?: TypedPropertyDescriptor<Y>

Returns

void

Public Api

Source

node_modules/@nestjs/common/decorators/core/apply-decorators.d.ts:10

defaultValidationMessage

defaultValidationMessage: string = 'validation.STRING_ENUM'

name

name: string = IS_ENUM

validator

validator: (value, entity) => boolean = isEnum

Checks if a given value is the member of the provided enum.

Parameters

▪ value: unknown

▪ entity: any

Returns

boolean

Source

libs/validation/src/lib/validators/primitives/enum.validator.ts:18

---

Generated using typedoc-plugin-markdown and TypeDoc