Class ConditionalValidations`Abstract`

Set of conditional rules to mark a field as required using runtime checks

Hierarchy (View Summary)

ConditionalValidations

Index

Constructors

Methods

use requiredWhen requiredIfExists requiredIfAnyExists requiredIfMissing requiredIfAnyMissing

Constructors

constructor

new ConditionalValidations(): ConditionalValidations
Returns ConditionalValidations

Methods

`Abstract`use

use(validation: Validation<any> | RuleBuilder): this
Parameters
- validation: Validation<any> | RuleBuilder
Returns this
- Defined in src/schema/base/conditional_rules.ts:17

requiredWhen

requiredWhen<Operator extends ComparisonOperators>(
    otherField: string,
    operator: Operator,
    expectedValue: Operator extends ArrayComparisonOperators
        ? (string | number | boolean)[]
        : Operator extends NumericComparisonOperators
            ? number
            : string
            | number
            | boolean,
): this
Define a callback to conditionally require a field at runtime.

The callback method should return "true" to mark the field as required, or "false" to skip the required validation
Type Parameters
- Operator extends ComparisonOperators
Parameters
- otherField: string
- operator: Operator
- expectedValue: Operator extends ArrayComparisonOperators
      ? (string | number | boolean)[]
      : Operator extends NumericComparisonOperators
          ? number
          : string
          | number
          | boolean
Returns this
- Defined in src/schema/base/conditional_rules.ts:27
requiredWhen(callback: (field: FieldContext) => boolean): this
Define a callback to conditionally require a field at runtime.

The callback method should return "true" to mark the field as required, or "false" to skip the required validation
Parameters
- callback: (field: FieldContext) => boolean
Returns this
- Defined in src/schema/base/conditional_rules.ts:36

requiredIfExists

requiredIfExists(fields: string | string[]): ConditionalValidations
Mark the field under validation as required when all the other fields are present with value other than undefined or null.
Parameters
- fields: string | string[]
Returns ConditionalValidations
- Defined in src/schema/base/conditional_rules.ts:96

requiredIfAnyExists

requiredIfAnyExists(fields: string[]): ConditionalValidations
Mark the field under validation as required when any one of the other fields are present with non-nullable value.
Parameters
- fields: string[]
Returns ConditionalValidations
- Defined in src/schema/base/conditional_rules.ts:112

requiredIfMissing

requiredIfMissing(fields: string | string[]): ConditionalValidations
Mark the field under validation as required when all the other fields are missing or their value is undefined or null.
Parameters
- fields: string | string[]
Returns ConditionalValidations
- Defined in src/schema/base/conditional_rules.ts:127

requiredIfAnyMissing

requiredIfAnyMissing(fields: string[]): ConditionalValidations
Mark the field under validation as required when any one of the other fields are missing.
Parameters
- fields: string[]
Returns ConditionalValidations
- Defined in src/schema/base/conditional_rules.ts:142