Class MapPredicate<T1, T2>

Type Parameters

  • T1 = unknown
  • T2 = unknown

Hierarchy

  • Predicate<Map<T1, T2>>
    • MapPredicate

Accessors

Methods

  • Register a new validator.

    Parameters

    • validator: Validator<Map<T1, T2>>

      Validator to register.

    Returns this

  • Test a Map to be deeply equal to the provided Map.

    Parameters

    • expected: Map<T1, T2>

      Expected Map to match.

    Returns this

  • Test a Map to include any of the provided keys. The keys are tested by identity, not structure.

    Parameters

    • Rest ...keys: readonly T1[]

      The keys that could be a key in the Map.

    Returns this

  • Test a Map to include any of the provided values. The values are tested by identity, not structure.

    Parameters

    • Rest ...values: readonly T2[]

      The values that could be a value in the Map.

    Returns this

  • Test a Map to include all the provided keys. The keys are tested by identity, not structure.

    Parameters

    • Rest ...keys: readonly T1[]

      The keys that should be a key in the Map.

    Returns this

  • Test a Map to include all the provided values. The values are tested by identity, not structure.

    Parameters

    • Rest ...values: readonly T2[]

      The values that should be a value in the Map.

    Returns this

  • Test if the value matches a custom validation function. The validation function should return true if the value passes the function. If the function either returns false or a string, the function fails and the string will be used as error message.

    Parameters

    • validator: ((value) => string | boolean)

      Validation function.

        • (value): string | boolean
        • Parameters

          Returns string | boolean

    Returns this

  • Test all the keys in the Map to match the provided predicate.

    Parameters

    • predicate: Predicate<T1>

      The predicate that should be applied against every key in the Map.

    Returns this

  • Test an Map to have a maximum size.

    Parameters

    • size: number

      The maximum size of the Map.

    Returns this

  • Provide a new error message to be thrown when the validation fails.

    Parameters

    • newMessage: string | ValidatorMessageBuilder<Map<T1, T2>>

      Either a string containing the new message or a function returning the new message.

    Returns this

    Example

    ow('🌈', 'unicorn', ow.string.equals('🦄').message('Expected unicorn, got rainbow'));
    //=> ArgumentError: Expected unicorn, got rainbow

    Example

    ow('🌈', ow.string.minLength(5).message((value, label) => `Expected ${label}, to have a minimum length of 5, got \`${value}\``));
    //=> ArgumentError: Expected string, to be have a minimum length of 5, got `🌈`
  • Test an Map to have a minimum size.

    Parameters

    • size: number

      The minimum size of the Map.

    Returns this

  • Test a Map to have a specific size.

    Parameters

    • size: number

      The size of the Map.

    Returns this

  • Test if the value matches a custom validation function. The validation function should return an object containing a validator and message. If the validator is false, the validation fails and the message will be used as error message. If the message is a function, the function is invoked with the label as argument to let you further customize the error message.

    Parameters

    • customValidator: CustomValidator<Map<T1, T2>>

      Custom validation function.

    Returns this

  • Test all the values in the Map to match the provided predicate.

    Parameters

    • predicate: Predicate<T2>

      The predicate that should be applied against every value in the Map.

    Returns this