Interface CollectionComponent<E>

Methods that all collection validators must contain.

interface CollectionComponent<E> {
    contains(expected: E): this;
    contains(expected: E, name: string): this;
    containsAll(expected: Set<E>): this;
    containsAll(expected: E[]): this;
    containsAll(expected: Set<E>, name: string): this;
    containsAll(expected: E[], name: string): this;
    containsAny(expected: Set<E>): this;
    containsAny(expected: E[]): this;
    containsAny(expected: Set<E>, name: string): this;
    containsAny(expected: E[], name: string): this;
    containsExactly(expected: Set<E>): this;
    containsExactly(expected: E[]): this;
    containsExactly(expected: Set<E>, name: string): this;
    containsExactly(expected: E[], name: string): this;
    doesNotContain(unwanted: E): this;
    doesNotContain(unwanted: E, name: string): this;
    doesNotContainAll(unwanted: Set<E>): this;
    doesNotContainAll(unwanted: E[]): this;
    doesNotContainAll(unwanted: Set<E>, name: string): this;
    doesNotContainAll(unwanted: E[], name: string): this;
    doesNotContainAny(unwanted: Set<E>): this;
    doesNotContainAny(unwanted: E[]): this;
    doesNotContainAny(unwanted: Set<E>, name: string): this;
    doesNotContainAny(unwanted: E[], name: string): this;
    doesNotContainDuplicates(): this;
    doesNotContainExactly(unwanted: Set<E>): this;
    doesNotContainExactly(unwanted: E[]): this;
    doesNotContainExactly(unwanted: Set<E>, name: string): this;
    doesNotContainExactly(unwanted: E[], name: string): this;
    isEmpty(): this;
    isNotEmpty(): this;
    size(): UnsignedNumberValidator;
}

Type Parameters

  • E

    the type of elements in the collection

Hierarchy (View Summary)

Methods

contains containsAll containsAny containsExactly doesNotContain doesNotContainAll doesNotContainAny doesNotContainDuplicates doesNotContainExactly isEmpty isNotEmpty size

Methods

contains

  • contains(expected: E): this

  • Ensures that the collection contains an element.

    Parameters

    • expected: E

      the element

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if the collection does not contain expected

  • contains(expected: E, name: string): this

  • Ensures that the collection contains an element.

    Parameters

    • expected: E

      the element

    • name: string

      the name of the element

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection does not contain expected

containsAll

  • containsAll(expected: Set<E>): this

  • Ensures that the collection contains all the elements in expected.

    Parameters

    • expected: Set<E>

      the desired elements

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if the collection does not contain all the elements in expected

  • containsAll(expected: E[]): this

  • Ensures that the collection contains all the elements in expected.

    Parameters

    • expected: E[]

      the desired elements

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if the collection does not contain all the elements in expected

  • containsAll(expected: Set<E>, name: string): this

  • Ensures that the collection contains all the elements in expected.

    Parameters

    • expected: Set<E>

      the desired elements

    • name: string

      the name of the expected collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection does not contain all elements in expected

  • containsAll(expected: E[], name: string): this

  • Ensures that the collection contains all the elements in expected.

    Parameters

    • expected: E[]

      the desired elements

    • name: string

      the name of the expected collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection does not contain all elements in expected

containsAny

  • containsAny(expected: Set<E>): this

  • Ensures that the collection contains any elements in expected.

    Parameters

    • expected: Set<E>

      the desired elements

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if the collection does not contain any element in expected

  • containsAny(expected: E[]): this

  • Ensures that the collection contains any elements in expected.

    Parameters

    • expected: E[]

      the desired elements

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if the collection does not contain any element in expected

  • containsAny(expected: Set<E>, name: string): this

  • Ensures that the collection contains at least one element in expected.

    Parameters

    • expected: Set<E>

      the desired elements

    • name: string

      the name of the expected collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection does not contain any element in expected

  • containsAny(expected: E[], name: string): this

  • Ensures that the collection contains at least one element in expected.

    Parameters

    • expected: E[]

      the desired elements

    • name: string

      the name of the expected collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection does not contain any element in expected

containsExactly

  • containsExactly(expected: Set<E>): this

  • Ensures that the collection consists of the same elements as expected, irrespective of their order.

    In contrast, isEqualTo() requires the same element ordering.

    Parameters

    • expected: Set<E>

      the desired elements

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if:

    • the collection is missing any element in expected
    • the collection contains any element that is not in expected

  • containsExactly(expected: E[]): this

  • Ensures that the collection consists of the same elements as expected, irrespective of their order.

    In contrast, isEqualTo() requires the same element ordering.

    Parameters

    • expected: E[]

      the desired elements

    Returns this

    this

    Throws

    TypeError if the value or expected are undefined or null

    Throws

    RangeError if:

    • the collection is missing any element in expected
    • the collection contains any element that is not in expected

  • containsExactly(expected: Set<E>, name: string): this

  • Ensures that the collection consists of the same elements as expected, irrespective of their order.

    In contrast, isEqualTo() requires the same element ordering.

    Parameters

    • expected: Set<E>

      the desired elements

    • name: string

      the name of the expected collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection and expected contain different elements, irrespective of their order

  • containsExactly(expected: E[], name: string): this

  • Ensures that the collection consists of the same elements as expected, irrespective of their order.

    In contrast, isEqualTo() requires the same element ordering.

    Parameters

    • expected: E[]

      the desired elements

    • name: string

      the name of the expected collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection and expected contain different elements, irrespective of their order

doesNotContain

  • doesNotContain(unwanted: E): this

  • Ensures that the collection does not contain unwanted.

    Parameters

    • unwanted: E

      the unwanted element

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection contains unwanted

  • doesNotContain(unwanted: E, name: string): this

  • Ensures that the collection does not contain unwanted.

    Parameters

    • unwanted: E

      the unwanted element

    • name: string

      the name of the element

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection contains unwanted

doesNotContainAll

  • doesNotContainAll(unwanted: Set<E>): this

  • Allows the collection to contain some, but not all, elements from a collection.

    Parameters

    • unwanted: Set<E>

      the unwanted elements

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection contains all the elements of unwanted

  • doesNotContainAll(unwanted: E[]): this

  • Allows the collection to contain some, but not all, elements from a collection.

    Parameters

    • unwanted: E[]

      the unwanted elements

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection contains all the elements of unwanted

  • doesNotContainAll(unwanted: Set<E>, name: string): this

  • Allows the collection to contain some, but not all, elements from a collection.

    Parameters

    • unwanted: Set<E>

      the unwanted elements

    • name: string

      the name of the unwanted collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection contains all the elements in unwanted

  • doesNotContainAll(unwanted: E[], name: string): this

  • Allows the collection to contain some, but not all, elements from a collection.

    Parameters

    • unwanted: E[]

      the unwanted elements

    • name: string

      the name of the unwanted collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection contains all the elements in unwanted

doesNotContainAny

  • doesNotContainAny(unwanted: Set<E>): this

  • Ensures that the collection does not contain any of the elements in unwanted.

    Parameters

    • unwanted: Set<E>

      the unwanted elements

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection contains any of the elements in unwanted

  • doesNotContainAny(unwanted: E[]): this

  • Ensures that the collection does not contain any of the elements in unwanted.

    Parameters

    • unwanted: E[]

      the unwanted elements

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection contains any of the elements in unwanted

  • doesNotContainAny(unwanted: Set<E>, name: string): this

  • Ensures that the collection does not contain any of the elements in unwanted.

    Parameters

    • unwanted: Set<E>

      the unwanted elements

    • name: string

      the name of the unwanted collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection contains any of the elements in unwanted

  • doesNotContainAny(unwanted: E[], name: string): this

  • Ensures that the collection does not contain any of the elements in unwanted.

    Parameters

    • unwanted: E[]

      the unwanted elements

    • name: string

      the name of the unwanted collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection contains any of the elements in unwanted

doesNotContainDuplicates

  • doesNotContainDuplicates(): this

  • Ensures that the collection does not contain any duplicate elements.

    Returns this

    this

    Throws

    TypeError if the value is undefined or null

    Throws

    RangeError if the collection contains any duplicate elements

doesNotContainExactly

  • doesNotContainExactly(unwanted: Set<E>): this

  • Ensures that the collection and unwanted consist of different elements, irrespective of their order.

    Parameters

    • unwanted: Set<E>

      the unwanted elements

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection consists of the same elements as unwanted, irrespective of their order

  • doesNotContainExactly(unwanted: E[]): this

  • Ensures that the collection and unwanted consist of different elements, irrespective of their order.

    Parameters

    • unwanted: E[]

      the unwanted elements

    Returns this

    this

    Throws

    TypeError if the value or unwanted are undefined or null

    Throws

    RangeError if the collection consists of the same elements as unwanted, irrespective of their order

  • doesNotContainExactly(unwanted: Set<E>, name: string): this

  • Ensures that the collection and unwanted consist of different elements, irrespective of their order.

    Parameters

    • unwanted: Set<E>

      the unwanted elements

    • name: string

      the name of the unwanted collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection consists of the same elements as unwanted, irrespective of their order

  • doesNotContainExactly(unwanted: E[], name: string): this

  • Ensures that the collection and unwanted consist of different elements, irrespective of their order.

    Parameters

    • unwanted: E[]

      the unwanted elements

    • name: string

      the name of the unwanted collection

    Returns this

    this

    Throws

    TypeError if the value or any of the arguments are undefined or null

    Throws

    RangeError if:

    • name is empty
    • name contains whitespace
    • name is already in use by the value being validated or the validator context
    • the collection consists of the same elements as unwanted, irrespective of their order

isEmpty

isNotEmpty

size

Settings

Member Visibility

On This Page

Methods