Variable arrayValidatorsConst

Type declaration

• isArray:function

  • isArray(): Validator<unknown[], unknown>

  • Creates a validator that asserts that the input is an array.

    Note: arrays can only be readonly by type system, there is no native readonly js array. This validator assumes mutability, use the ArraySchema readonly() method to cast to a readonly array.

    Returns Validator<unknown[], unknown>

• maxLength:function

  • maxLength(max): Validator<readonly unknown[], readonly unknown[]>

  • Creates a validator that validates the input array has the given maximum length.

    Parameters

    • max: number

      The maximum number of elements (inclusive)

    Returns Validator<readonly unknown[], readonly unknown[]>

• minLength:function

  • minLength(min): Validator<readonly unknown[], readonly unknown[]>

  • Creates a validator that validates the input array has the given minimum length.

    Parameters

    • min: number

      The minimum number of elements (inclusive)

    Returns Validator<readonly unknown[], readonly unknown[]>

• tuple:function

  • tuple<U>(...validators): Validator<{
        [Index in string | number | symbol]: U[Index<Index>]
    }, readonly unknown[]>

  • Creates a validator that asserts that the input array is a tuple whose elements match the given validators.

    Type Parameters

    • U extends readonly any[]

    Parameters

    • Rest...validators: {
          [Index in string | number | symbol]: Validator<U[Index<Index>], unknown>
      }

    Returns Validator<{
        [Index in string | number | symbol]: U[Index<Index>]
    }, readonly unknown[]>

• withElements:function

  • withElements<U>(elementValidator): Validator<U[], readonly unknown[]>

  • Creates a validator that asserts that every element passes the given validator.

    Type Parameters

    • U

    Parameters

    • elementValidator: Validator<U, unknown>

    Returns Validator<U[], readonly unknown[]>