Class LengthRule

Hierarchy

Rule
- LengthRule

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new LengthRule(config: LengthRuleConfig): LengthRule

Overrides Rule.constructor
- Defined in selective/rule/length.ts:13
Parameters
- config: LengthRuleConfig
Returns LengthRule

Properties

config

config: LengthRuleConfig

defaultLevel

defaultLevel: ValidationLevel

defaultMessage

defaultMessage: string = 'Value needs to have the correct length.'

Accessors

isRequired

get isRequired(): boolean

Overrides Rule.isRequired
- Defined in selective/rule/length.ts:59
Field is considered required when there is a min value..

Returns boolean

level

get level(): ValidationLevel

Inherited from Rule.level
- Defined in selective/validationRules.ts:158
Validation level to use if the validation fails.

Returns ValidationLevel

message

get message(): string

Inherited from Rule.message
- Defined in selective/validationRules.ts:165
Error message from the config or fall back to the default.

Returns string

Methods

allowAdd

allowAdd(value: any): boolean

Overrides Rule.allowAdd
- Defined in selective/rule/length.ts:18
Default to allowing adding.

Parameters
- value: any
Returns boolean

allowRemove

allowRemove(value: any): boolean

Overrides Rule.allowRemove
- Defined in selective/rule/length.ts:33
Default to allowing removal.

Parameters
- value: any
Returns boolean

Private cleanValue

cleanValue(value: any): any

- Defined in selective/rule/length.ts:48
Parameters
- value: any
Returns any

validate

validate(value: any): null | string

Overrides Rule.validate
- Defined in selective/rule/length.ts:63
Validates the field using the current value.

If there is an error with the validation, return an error message string to be displayed to the user.

Parameters
- value: any
Returns null | string

Generated using TypeDoc