Class RequireRule

Hierarchy

Rule
- RequireRule

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RequireRule(config: RequireRuleConfig): RequireRule

Overrides Rule.constructor
- Defined in selective/rule/require.ts:16
Parameters
- config: RequireRuleConfig
Returns RequireRule

Properties

config

config: RequireRuleConfig

defaultLevel

defaultLevel: ValidationLevel

defaultMessage

defaultMessage: string = 'Value is required. Cannot be empty.'

Accessors

isRequired

get isRequired(): boolean

Overrides Rule.isRequired
- Defined in selective/rule/require.ts:24
Required rule makes the field required.

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

Inherited from Rule.allowAdd
- Defined in selective/validationRules.ts:132
Default to allowing adding.

Parameters
- value: any
  
  Current value of the field.
Returns boolean

allowRemove

allowRemove(value: any): boolean

Inherited from Rule.allowRemove
- Defined in selective/validationRules.ts:142
Default to allowing removal.

Parameters
- value: any
  
  Current value of the field.
Returns boolean

validate

validate(value: any): null | string

Overrides Rule.validate
- Defined in selective/rule/require.ts:28
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