Skip to content

Commit e3aaa2e

Browse files
refactor(TestingToBeMatchers): update stringOfLength() method expectionalFailOutput parameter and update jsdoc.
1 parent f8068f2 commit e3aaa2e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/lib/testing-tobe-matchers.class.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -536,11 +536,11 @@ export class TestingToBeMatchers extends TestingExpect {
536536
}
537537

538538
/**
539-
* Expects provided value to be a `string` type or an instance of a `String` of the specified length. The method uses `isStringLength()`
539+
* Expects provided value to be a `string` type or an instance of a `String` of the given length. The method uses `isStringLength()`
540540
* function from the `@angular-package/type`.
541-
* @param value The value of any type that is checked against a `string` type or an instance of a `String` of the specified `length` and
541+
* @param value The value of any type that is checked against a `string` type or an instance of a `String` of the given `length` and
542542
* the result of its check is passed to the `expect()` function of jasmine.
543-
* @param length The length of generic type variable `Length` for the given `value`,
543+
* @param length The **length** of generic type variable `Length` for the given `value`,
544544
* @param expected The expected `value` of a `boolean` to compare against the result of the `value` check that is passed to the `toBe()`
545545
* method of `jasmine.Matchers`.
546546
* @param expectationFailOutput An additional message when the matcher fails, by default, states the value should be (or not) a `string`
@@ -553,7 +553,7 @@ export class TestingToBeMatchers extends TestingExpect {
553553
expected: jasmine.Expected<boolean> = true,
554554
expectationFailOutput: any = `${this.expectationFailOutput} ${
555555
this.getNot() === true ? `not` : ``
556-
} be a \`string\` type or an instance of a \`String\` of the \`length\` equal to ${length}`
556+
} be a \`string\` type or an instance of a \`String\` of the specified \`length\` equal to ${length}`
557557
): this {
558558
this.toBe(is.stringLength(value, length), expected, expectationFailOutput);
559559
return this;
@@ -562,8 +562,8 @@ export class TestingToBeMatchers extends TestingExpect {
562562
/**
563563
* Expects provided value to be a `string` type or an instance of a `String` of the length between the given minimum and maximum. The
564564
* method uses `isStringLengthBetween()` function from the `@angular-package/type`.
565-
* @param value The value of any type that is checked against a `string` type or an instance of a `String` of the specified `length` and
566-
* the result of its check is passed to the `expect()` function of jasmine.
565+
* @param value The value of any type that is checked against a `string` type or an instance of a `String` of the given `min` and `max`
566+
* and the result of its check is passed to the `expect()` function of jasmine.
567567
* @param min The **minimum** length of generic type variable `Min` of the given `value`.
568568
* @param max The **maximum** length of generic type variable `Max` of the given `value`.
569569
* @param expected The expected `value` of a `boolean` to compare against the result of the `value` check that is passed to the `toBe()`

0 commit comments

Comments
 (0)