ow
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T = any

Hierarchy

  • Predicate<Set<T>>
    • SetPredicate

Implements

  • BasePredicate<Set<T>>

Index

Accessors

empty

  • get empty(): this

nonEmpty

  • get nonEmpty(): this

not

  • get not(): this

Methods

Protected addValidator

  • addValidator(validator: Validator<Set<T>>): this
  • Register a new validator.

    Parameters

    • validator: Validator<Set<T>>

      Validator to register.

    Returns this

deepEqual

  • deepEqual(expected: Set<T>): this
  • Test a Set to be deeply equal to the provided Set.

    Parameters

    • expected: Set<T>

      Expected Set to match.

    Returns this

has

  • has(...items: readonly T[]): this
  • Test a Set to include all the provided items. The items are tested by identity, not structure.

    Parameters

    • Rest ...items: readonly T[]

      The items that should be a item in the Set.

    Returns this

hasAny

  • hasAny(...items: readonly T[]): this
  • Test a Set to include any of the provided items. The items are tested by identity, not structure.

    Parameters

    • Rest ...items: readonly T[]

      The items that could be a item in the Set.

    Returns this

is

  • is(validator: (value: Set<T>) => boolean | string): 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: Set<T>) => boolean | string

      Validation function.

        • (value: Set<T>): boolean | string
        • Parameters

          • value: Set<T>

          Returns boolean | string

    Returns this

maxSize

  • maxSize(size: number): this
  • Test a Set to have a maximum size.

    Parameters

    • size: number

      The maximum size of the Set.

    Returns this

message

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

    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 `🌈`

    Parameters

    • newMessage: string | ValidatorMessageBuilder<Set<T>>

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

    Returns this

minSize

  • minSize(size: number): this
  • Test a Set to have a minimum size.

    Parameters

    • size: number

      The minimum size of the Set.

    Returns this

ofType

  • ofType(predicate: Predicate<T>): this
  • Test all the items in the Set to match the provided predicate.

    Parameters

    • predicate: Predicate<T>

      The predicate that should be applied against every item in the Set.

    Returns this

size

  • size(size: number): this

validate

  • 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

    Returns this