Variable ValidatorsConst

Type declaration

• notEmpty:function

  • notEmpty(value: string, fieldName?: string): Result<string, DomainError>

    Validates that a string is not empty.

    Parameters

    • value: string

      The string to validate
    • fieldName: string = 'Field'

      Name of the field for error messages

    Returns Result<string, DomainError>

    Success with trimmed string or Failure

    Example

    const result = Validators.notEmpty(name, 'Name');
    Copy

• length:function

  • length(
        value: string,
        options: { min?: number; max?: number; fieldName?: string },
    ): Result<string, DomainError>

    Validates string length.

    Parameters

    • value: string

      The string to validate
    • options: { min?: number; max?: number; fieldName?: string }

      Validation options (min, max, fieldName)

    Returns Result<string, DomainError>

    Success with trimmed string or Failure

    Example

    const result = Validators.length(name, { min: 3, max: 50, fieldName: 'Name' });
    Copy

• range:function

  • range(
        value: number,
        options: { min?: number; max?: number; fieldName?: string },
    ): Result<number, DomainError>

    Validates number range.

    Parameters

    • value: number

      The number to validate
    • options: { min?: number; max?: number; fieldName?: string }

      Validation options (min, max, fieldName)

    Returns Result<number, DomainError>

    Success with number or Failure

    Example

    const result = Validators.range(price, { min: 0, max: 10000, fieldName: 'Price' });
    Copy

• pattern:function

  • pattern(
        value: string,
        regex: RegExp,
        errorMessage?: string,
    ): Result<string, DomainError>

    Validates against a regex pattern.

    Parameters

    • value: string

      The string to validate
    • regex: RegExp

      The regular expression pattern
    • errorMessage: string = 'Invalid format'

      Custom error message

    Returns Result<string, DomainError>

    Success with string or Failure

    Example

    const result = Validators.pattern(code, /^[A-Z]{3}$/, 'Code must be 3 uppercase letters');
    Copy

• email:function

  • email(value: string): Result<string, DomainError>

    Validates email format.

    Parameters

    • value: string

      The email string to validate

    Returns Result<string, DomainError>

    Success with email or Failure

    Example

    const result = Validators.email('user@example.com');
    Copy

• url:function

  • url(value: string): Result<string, DomainError>

    Validates URL format.

    Parameters

    • value: string

      The URL string to validate

    Returns Result<string, DomainError>

    Success with URL or Failure

    Example

    const result = Validators.url('https://example.com');
    Copy

• compose:function

  • compose<T>(
        ...validators: (value: T) => Result<T, DomainError>[],
    ): (value: T) => Result<T, DomainError>

    Composes multiple validators into a single validator. Validators are executed in order, stopping at first failure.

    Type Parameters

    • T

    Parameters

    • ...validators: (value: T) => Result<T, DomainError>[]

      Array of validator functions

    Returns (value: T) => Result<T, DomainError>

    A composed validator function

    Example

    const emailValidator = Validators.compose(
      (v) => Validators.notEmpty(v, 'Email'),
      (v) => Validators.length(v, { max: 254 }),
      (v) => Validators.email(v)
    );
    
    const result = emailValidator('user@example.com');
    Copy