Interface IIncludeOp<R>

all

any

endsWithMembers

• endsWithMembers(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection ends with the expected members in consecutive order at the end. Uses deep equality when in deep context, strict equality otherwise. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected ending sequence (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([1, 2, 3, 4]).includes.endsWithMembers([3, 4]);  // Passes
  expect([1, 2, 3, 4]).includes.endsWithMembers([2, 3]);  // Fails - doesn't end with [2, 3]
  Copy

members

• members(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection includes all members of the expected collection (order doesn't matter). Uses strict equality (===) for comparison. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected subset collection to check for (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([1, 2, 3, 4]).includes.members([2, 3]);  // Passes - all members present
  expect([1, 2, 3]).includes.members([1, 4]);     // Fails - 4 not present
  Copy

orderedMembers

• orderedMembers(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection includes all members of the expected collection in the same order (but may have additional members in between). Uses strict equality (===) for comparison. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected subset collection to check for (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([1, 2, 3, 4]).includes.orderedMembers([1, 2, 3]);  // Passes
  expect([1, 2, 3, 4]).includes.orderedMembers([2, 4]);     // Passes - with gaps
  expect([1, 2, 3, 4]).includes.orderedMembers([3, 2]);     // Fails - wrong order
  Copy

sameMembers

• sameMembers(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection has the same members as the expected collection, regardless of order. Uses deep equality when in deep context, strict equality otherwise. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected collection to compare against (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([{a: 1}, {b: 2}]).has.deep.include.sameMembers([{b: 2}, {a: 1}]);  // Passes
  expect([[1, 2], [3, 4]]).has.deep.include.sameMembers([[3, 4], [1, 2]]);  // Passes
  Copy

sameOrderedMembers

• sameOrderedMembers(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection has the same members in the same order as the expected collection. Uses deep equality when in deep context, strict equality otherwise. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected collection to compare against (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([{a: 1}, {b: 2}]).has.deep.include.sameOrderedMembers([{a: 1}, {b: 2}]);  // Passes
  expect([{a: 1}, {b: 2}]).has.deep.include.sameOrderedMembers([{b: 2}, {a: 1}]);  // Fails - different order
  Copy

startsWithMembers

• startsWithMembers(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection starts with the expected members in consecutive order from the beginning. Uses deep equality when in deep context, strict equality otherwise. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected starting sequence (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([1, 2, 3, 4]).includes.startsWithMembers([1, 2]);  // Passes
  expect([1, 2, 3, 4]).includes.startsWithMembers([2, 3]);  // Fails - doesn't start with [2, 3]
  Copy

subsequence

• subsequence(expected: ArrayLikeOrSizedIterable, evalMsg?: MsgSource): R

  Asserts that the target collection contains a subsequence matching the expected members. The members must appear in the specified order but don't need to be consecutive - other elements can appear between them. Uses deep equality when in deep context, strict equality otherwise. Both target and expected must conform to ArrayLikeOrSizedIterable but can be different concrete types.

  Parameters

  • expected: ArrayLikeOrSizedIterable

    The expected ordered subsequence (must be an ArrayLikeOrSizedIterable).

  • OptionalevalMsg: MsgSource

    Optional error message.

  Returns R

  Since

  0.1.5

  Example

  expect([1, 2, 3, 4, 5]).includes.subsequence([2, 4, 5]);  // Passes - in order with gaps
  expect([1, 2, 3, 4, 5]).includes.subsequence([5, 3, 1]);  // Fails - wrong order
  expect([{a: 1}, {b: 2}, {c: 3}]).deep.includes.subsequence([{a: 1}, {c: 3}]);  // Passes with deep equality
  Copy