Skip to content

Commit c17d11e

Browse files
sciborrudnickisciborrudnicki
committed
docs(README.md): update
1 parent 8229336 commit c17d11e

File tree

1 file changed

+55
-9
lines changed

1 file changed

+55
-9
lines changed

‎README.md

+55-9
Original file line numberDiff line numberDiff line change
@@ -1865,7 +1865,7 @@ Matchers that use the `toBe()` method of `jasmine.Matchers`.
18651865
| [`boolean()`](#testingtobematchersprototypeboolean) | Expects provided `value` to be a [`boolean`][js-boolean] type |
18661866
| [`class()`](#testingtobematchersprototypeclass) | Expects provided `value` to be a [`class`][js-classes] |
18671867
| [`date()`](#testingtobematchersprototypedate) | Expects provided `value` to be a [`Date`][js-date] |
1868-
| [`defined()`](#testingtobematchersprototypdefined) | Expects provided `value` to be defined |
1868+
| [`defined()`](#testingtobematchersprototypedefined) | Expects provided `value` to be defined |
18691869
| [`false()`](#testingtobematchersprototypefalse) | Expects provided `value` to be [`false`][js-boolean] |
18701870
| [`function()`](#testingtobematchersprototypefunction) | Expects provided `value` to be [`function`][js-function] |
18711871
| [`instance()`](#testingtobematchersprototypeinstance) | Expects provided `value` to be an instance of the given class from the `constructor` |
@@ -1888,6 +1888,8 @@ Matchers that use the `toBe()` method of `jasmine.Matchers`.
18881888

18891889
### `TestingToBeMatchers.prototype.array()`
18901890

1891+
![new][new]
1892+
18911893
Expects provided `value` to be an [`array`][js-array]. The method uses [`isArray()`](https://github.com/angular-package/type#isarray) function from the [`@angular-package/type`][type-github-readme].
18921894

18931895
```typescript
@@ -1942,6 +1944,8 @@ testing.describe('Expects provided value', () => {
19421944

19431945
### `TestingToBeMatchers.prototype.bigint()`
19441946

1947+
![new][new]
1948+
19451949
Expects provided `value` to be [`bigint`][js-bigint] type. The method uses [`isBigInt()`](https://github.com/angular-package/type#isbigint) function from the [`@angular-package/type`][type-github-readme].
19461950

19471951
```typescript
@@ -1961,7 +1965,7 @@ public bigint(
19611965

19621966
| Name: type | Description |
19631967
| :--------------------------- | :---------- |
1964-
| `value: Value` | The `value` of any type that is checked against the [`bigint`][js-bigint], and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
1968+
| `value: any` | The `value` of any type that is checked against the [`bigint`][js-bigint] and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
19651969
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
19661970
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) [`bigint`][js-bigint] |
19671971

@@ -1996,6 +2000,8 @@ testing.describe('Expects provided value', () => {
19962000

19972001
### `TestingToBeMatchers.prototype.boolean()`
19982002

2003+
![new][new]
2004+
19992005
Expects provided `value` to be [`boolean`][js-boolean]. The method uses [`isBoolean()`](https://github.com/angular-package/type#isboolean) function from the [`@angular-package/type`][type-github-readme].
20002006

20012007
```typescript
@@ -2015,7 +2021,7 @@ public boolean(
20152021

20162022
| Name: type | Description |
20172023
| :--------------------------- | :---------- |
2018-
| `value: any` | The `value` of any type that is checked against the [`boolean`][js-boolean], and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2024+
| `value: any` | The `value` of any type that is checked against the [`boolean`][js-boolean] and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
20192025
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
20202026
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) [`boolean`][js-boolean] |
20212027

@@ -2050,6 +2056,8 @@ testing.describe('Expects provided value', () => {
20502056

20512057
### `TestingToBeMatchers.prototype.class()`
20522058

2059+
![new][new]
2060+
20532061
Expects provided `value` to be [`class`][js-classes]. The method uses [`isClass()`](https://github.com/angular-package/type#isclass) function from the [`@angular-package/type`][type-github-readme].
20542062

20552063
```typescript
@@ -2069,7 +2077,7 @@ public class(
20692077

20702078
| Name: type | Description |
20712079
| :--------------------------- | :---------- |
2072-
| `value: any` | The `value` of any type that is checked against the [`class`][js-classes], and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2080+
| `value: any` | The `value` of any type that is checked against the [`class`][js-classes] and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
20732081
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
20742082
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) [`class`][js-classes] |
20752083

@@ -2103,6 +2111,8 @@ testing.describe('Expects provided value', () => {
21032111

21042112
### `TestingToBeMatchers.prototype.date()`
21052113

2114+
![new][new]
2115+
21062116
Expects provided `value` to be a [`date`][js-date]. The method uses [`isDate()`](https://github.com/angular-package/type#isdate) function from the [`@angular-package/type`][type-github-readme].
21072117

21082118
```typescript
@@ -2122,7 +2132,7 @@ public date(
21222132

21232133
| Name: type | Description |
21242134
| :--------------------------- | :---------- |
2125-
| `value: any` | The `value` of any type that is checked against [`date`][js-date], and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2135+
| `value: any` | The `value` of any type that is checked against [`date`][js-date] and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
21262136
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
21272137
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) a [`date`][js-date] |
21282138

@@ -2156,6 +2166,8 @@ testing.describe('Expects provided value', () => {
21562166

21572167
### `TestingToBeMatchers.prototype.defined()`
21582168

2169+
![new][new]
2170+
21592171
Expects provided `value` to be defined. The method uses [`isDefined()`](https://github.com/angular-package/type#isdefined) function from the [`@angular-package/type`][type-github-readme].
21602172

21612173
```typescript
@@ -2175,7 +2187,7 @@ public defined(
21752187

21762188
| Name: type | Description |
21772189
| :--------------------------- | :---------- |
2178-
| `value: any` | The `value` of any type that is checked to the defined and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2190+
| `value: any` | The `value` of any type that is checked against defined and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
21792191
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
21802192
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) defined |
21812193

@@ -2208,6 +2220,8 @@ testing.describe('Expects provided value', () => {
22082220

22092221
### `TestingToBeMatchers.prototype.false()`
22102222

2223+
![new][new]
2224+
22112225
Expects provided `value` to be `false`. The method uses [`isFalse()`](https://github.com/angular-package/type#isfalse) function from the [`@angular-package/type`][type-github-readme].
22122226

22132227
```typescript
@@ -2261,6 +2275,8 @@ testing.describe('Expects provided value', () => {
22612275

22622276
### `TestingToBeMatchers.prototype.function()`
22632277

2278+
![new][new]
2279+
22642280
Expects provided `value` to be [`function`][js-function]. The method uses [`isFunction()`](https://github.com/angular-package/type#isfunction) function from the [`@angular-package/type`][type-github-readme].
22652281

22662282
```typescript
@@ -2314,6 +2330,8 @@ testing.describe('Expects provided value', () => {
23142330

23152331
### `TestingToBeMatchers.prototype.instance()`
23162332

2333+
![new][new]
2334+
23172335
Expects provided `value` to be [`function`][js-function]. The method uses [`isFunction()`](https://github.com/angular-package/type#isfunction) function from the [`@angular-package/type`][type-github-readme].
23182336

23192337
```typescript
@@ -2371,6 +2389,8 @@ testing.describe('Expects provided value', () => {
23712389

23722390
### `TestingToBeMatchers.prototype.key()`
23732391

2392+
![new][new]
2393+
23742394
Expects provided `value` to be property key. The method uses [`isKey()`](https://github.com/angular-package/type#iskey) function from the [`@angular-package/type`][type-github-readme].
23752395

23762396
```typescript
@@ -2424,6 +2444,8 @@ testing.describe('Expects provided value', () => {
24242444

24252445
### `TestingToBeMatchers.prototype.null()`
24262446

2447+
![new][new]
2448+
24272449
Expects provided `value` to be property key. The method uses [`isNull()`](https://github.com/angular-package/type#isnull) function from the [`@angular-package/type`][type-github-readme].
24282450

24292451
```typescript
@@ -2477,6 +2499,8 @@ testing.describe('Expects provided value', () => {
24772499

24782500
### `TestingToBeMatchers.prototype.number()`
24792501

2502+
![new][new]
2503+
24802504
Expects provided `value` to be [`number`][js-number]. The method uses [`isNumber()`](https://github.com/angular-package/type#isnumber) function from the [`@angular-package/type`][type-github-readme].
24812505

24822506
```typescript
@@ -2530,6 +2554,8 @@ testing.describe('Expects provided value', () => {
25302554

25312555
### `TestingToBeMatchers.prototype.numberBetween()`
25322556

2557+
![new][new]
2558+
25332559
Expects provided `value` to be [`number`][js-number] between a range. The method uses [`isNumberBetween()`](https://github.com/angular-package/type#isnumberbetween) function from the [`@angular-package/type`][type-github-readme].
25342560

25352561
```typescript
@@ -2598,6 +2624,8 @@ testing.describe('Expects provided value', () => {
25982624

25992625
### `TestingToBeMatchers.prototype.object()`
26002626

2627+
![new][new]
2628+
26012629
Expects provided `value` to be an [`object`][js-object]. The method uses [`isObject()`](https://github.com/angular-package/type#isobject) function from the [`@angular-package/type`][type-github-readme].
26022630

26032631
```typescript
@@ -2651,6 +2679,8 @@ testing.describe('Expects provided value', () => {
26512679

26522680
### `TestingToBeMatchers.prototype.objectKey()`
26532681

2682+
![new][new]
2683+
26542684
Expects provided `value` to be an [`object`][js-object] with given keys. The method uses [`isObjectKey()`](https://github.com/angular-package/type#isobjectkey) function from the [`@angular-package/type`][type-github-readme].
26552685

26562686
```typescript
@@ -2672,7 +2702,7 @@ public objectKey(
26722702
| Name: type | Description |
26732703
| :--------------------------- | :---------- |
26742704
| `value: any` | The `value` of any type that is checked against the `object` that contains given keys and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2675-
| `key: Key | Key[]` | Property name of `Key` type or an [`array`][js-array] of property names of `Key` type of [`object`][js-object] from the provided `value` |
2705+
| `key: Key \| Key[]` | Property name of [`Key`](https://github.com/angular-package/type#key) type or an [`array`][js-array] of property names of [`Key`](https://github.com/angular-package/type#key) type of [`object`][js-object] from the provided `value` |
26762706
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
26772707
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) an [`object`][js-object] with all given keys |
26782708

@@ -2707,6 +2737,8 @@ testing.describe('Expects provided value', () => {
27072737

27082738
### `TestingToBeMatchers.prototype.objectKeyIn()`
27092739

2740+
![new][new]
2741+
27102742
Expects provided `value` to be an [`object`][js-object] with given keys. The method uses [`isObjectKeyIn()`](https://github.com/angular-package/type#isobjectkeyin) function from the [`@angular-package/type`][type-github-readme].
27112743

27122744
```typescript
@@ -2728,7 +2760,7 @@ public objectKeyIn(
27282760
| Name: type | Description |
27292761
| :--------------------------- | :---------- |
27302762
| `value: any` | The `value` of any type that is checked against the [`object`][js-object] that contains given keys and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2731-
| `key: Key | Key[]` | Property name of `Key` type or an [`array`][js-array] of property names of `Key` type of [`object`][js-object] from the provided `value` |
2763+
| `key: Key \| Key[]` | Property name of [`Key`](https://github.com/angular-package/type#key) type or an [`array`][js-array] of property names of [`Key`](https://github.com/angular-package/type#key) type of [`object`][js-object] from the provided `value` |
27322764
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
27332765
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) an [`object`][js-object] with all given keys |
27342766

@@ -2762,6 +2794,8 @@ testing.describe('Expects provided value', () => {
27622794

27632795
### `TestingToBeMatchers.prototype.objectKeys()`
27642796

2797+
![new][new]
2798+
27652799
Expects provided `value` to be an [`object`][js-object] with some of the given keys. The method uses [`isObjectKeyIn()`](https://github.com/angular-package/type#isobjectkeys) function from the [`@angular-package/type`][type-github-readme].
27662800

27672801
```typescript
@@ -2783,7 +2817,7 @@ public objectKeys(
27832817
| Name: type | Description |
27842818
| :--------------------------- | :---------- |
27852819
| `value: any` | The `value` of any type that is checked against the [`object`][js-object] that contains some of the given keys and the result of its check is passed to the [`expect()`][jasmine-expect] function of jasmine |
2786-
| `key: Key[]` | An [`array`][js-array] of property names of the `Key` type of [`object`][js-object] from the provided `value` |
2820+
| `key: Key[]` | An [`array`][js-array] of property names of the [`Key`](https://github.com/angular-package/type#key) type of [`object`][js-object] from the provided `value` |
27872821
| `expected: boolean` | The expected value of a [`boolean`][js-boolean] to compare against the result of the `value` check that is passed to the `toBe()` method of `jasmine.Matchers` |
27882822
| `expectationFailOutput: any` | An additional message when the matcher fails, by default, states the `value` should be (or not) an [`object`][js-object] with some given keys |
27892823

@@ -2817,6 +2851,8 @@ testing.describe('Expects provided value', () => {
28172851

28182852
### `TestingToBeMatchers.prototype.regexp()`
28192853

2854+
![new][new]
2855+
28202856
Expects provided `value` to be [`RegExp`][js-regexp]. The method uses [`isRegExp()`](https://github.com/angular-package/type#isregexp) function from the [`@angular-package/type`][type-github-readme].
28212857

28222858
```typescript
@@ -2871,6 +2907,8 @@ testing.describe('Expects provided value', () => {
28712907

28722908
### `TestingToBeMatchers.prototype.string()`
28732909

2910+
![new][new]
2911+
28742912
Expects provided `value` to be [`string`][js-string]. The method uses [`isString()`](https://github.com/angular-package/type#isstring) function from the [`@angular-package/type`][type-github-readme].
28752913

28762914
```typescript
@@ -2924,6 +2962,8 @@ testing.describe('Expects provided value', () => {
29242962

29252963
### `TestingToBeMatchers.prototype.stringOfLength()`
29262964

2965+
![new][new]
2966+
29272967
Expects provided `value` to be [`string`][js-string] of the length between the given minimum to maximum. The method uses [`isStringLength()`](https://github.com/angular-package/type#isstringlength) function from the [`@angular-package/type`][type-github-readme].
29282968

29292969
```typescript
@@ -2992,6 +3032,8 @@ testing.describe('Expects provided value', () => {
29923032

29933033
### `TestingToBeMatchers.prototype.symbol()`
29943034

3035+
![new][new]
3036+
29953037
Expects provided `value` to be [`symbol`][js-symbol]. The method uses [`isSymbol()`](https://github.com/angular-package/type#issymbol) function from the [`@angular-package/type`][type-github-readme].
29963038

29973039
```typescript
@@ -3044,6 +3086,8 @@ testing.describe('Expects provided value', () => {
30443086

30453087
### `TestingToBeMatchers.prototype.true()`
30463088

3089+
![new][new]
3090+
30473091
Expects provided `value` to be `true`. The method uses [`isTrue()`](https://github.com/angular-package/type#istrue) function from the [`@angular-package/type`][type-github-readme].
30483092

30493093
```typescript
@@ -3096,6 +3140,8 @@ testing.describe('Expects provided value', () => {
30963140

30973141
### `TestingToBeMatchers.prototype.undefined()`
30983142

3143+
![new][new]
3144+
30993145
Expects provided `value` to be `undefined`. The method uses [`isUndefined()`](https://github.com/angular-package/type#isundefined) function from the [`@angular-package/type`][type-github-readme].
31003146

31013147
```typescript

0 commit comments

Comments
 (0)