Skip to content

Commit fa94c33

Browse files
docs(README.md): update
1 parent b4cfa83 commit fa94c33

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -898,12 +898,8 @@ isNumberType(NUMBER_NEW_INSTANCE); // false
898898

899899
### isObject
900900

901-
![update][update]
902-
903901
`4.0.0`: The function no longer checks the `key` but has `callback` instead. Use [`isObjectKeyIn`](#isobjectkeyin) or [`isObjectKey`](#isobjectkey) to check object with the [`Key`][key] .
904902

905-
`4.0.3`: Type variable `Obj` default value is set to `object`.
906-
907903
Use `isObject()` or `is.object()` to check if **any** `value` is an `object` of a generic `Obj` type and [`Object`][object] instance.
908904

909905
```typescript
@@ -1134,10 +1130,6 @@ isObjectKey(CLASS, [SYMBOL_NUMBER, SYMBOL_STRING]); // false
11341130

11351131
### isObjectKeyIn
11361132

1137-
![update][update]
1138-
1139-
`4.0.3`: Type variable `Type` default value is set to `object`.
1140-
11411133
Use `isObjectKeyIn()` or `is.objectKeyIn()` to check if **any** `value` is an [`Object`][object] with the `key` of the [`Key`][key] type by using the `in` operator. The function uses operator [`in`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/in) to find the key.
11421134

11431135
```typescript
@@ -1931,8 +1923,12 @@ The **return value** is a `boolean` indicating whether or not the `value` is a `
19311923

19321924
### guardObject
19331925

1926+
![update][update]
1927+
19341928
`4.0.0`: The function has a properly working callback cause of the updated [`isObject`](#isobject).
19351929

1930+
`4.0.3`: Type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1931+
19361932
Use `guardObject()` or `guard.is.object()` to guard the `value` to be an `object` of a generic `Obj` type.
19371933

19381934
```typescript
@@ -1957,10 +1953,14 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
19571953

19581954
### guardObjectKey
19591955

1956+
![update][update]
1957+
19601958
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional instead of the [`guardObject`](#guardobject).
19611959

19621960
`4.0.1`: Fix guards the `key` by changing its type to `keyof Obj` instead of just a [`Key`][key].
19631961

1962+
`4.0.3`: Fix type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1963+
19641964
Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an `object` of a generic `Obj` type that contains the `key`.
19651965

19661966
```typescript

packages/type/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -898,12 +898,8 @@ isNumberType(NUMBER_NEW_INSTANCE); // false
898898

899899
### isObject
900900

901-
![update][update]
902-
903901
`4.0.0`: The function no longer checks the `key` but has `callback` instead. Use [`isObjectKeyIn`](#isobjectkeyin) or [`isObjectKey`](#isobjectkey) to check object with the [`Key`][key] .
904902

905-
`4.0.3`: Type variable `Obj` default value is set to `object`.
906-
907903
Use `isObject()` or `is.object()` to check if **any** `value` is an `object` of a generic `Obj` type and [`Object`][object] instance.
908904

909905
```typescript
@@ -1134,10 +1130,6 @@ isObjectKey(CLASS, [SYMBOL_NUMBER, SYMBOL_STRING]); // false
11341130

11351131
### isObjectKeyIn
11361132

1137-
![update][update]
1138-
1139-
`4.0.3`: Type variable `Type` default value is set to `object`.
1140-
11411133
Use `isObjectKeyIn()` or `is.objectKeyIn()` to check if **any** `value` is an [`Object`][object] with the `key` of the [`Key`][key] type by using the `in` operator. The function uses operator [`in`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/in) to find the key.
11421134

11431135
```typescript
@@ -1931,8 +1923,12 @@ The **return value** is a `boolean` indicating whether or not the `value` is a `
19311923

19321924
### guardObject
19331925

1926+
![update][update]
1927+
19341928
`4.0.0`: The function has a properly working callback cause of the updated [`isObject`](#isobject).
19351929

1930+
`4.0.3`: Type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1931+
19361932
Use `guardObject()` or `guard.is.object()` to guard the `value` to be an `object` of a generic `Obj` type.
19371933

19381934
```typescript
@@ -1957,10 +1953,14 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
19571953

19581954
### guardObjectKey
19591955

1956+
![update][update]
1957+
19601958
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional instead of the [`guardObject`](#guardobject).
19611959

19621960
`4.0.1`: Fix guards the `key` by changing its type to `keyof Obj` instead of just a [`Key`][key].
19631961

1962+
`4.0.3`: Fix type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1963+
19641964
Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an `object` of a generic `Obj` type that contains the `key`.
19651965

19661966
```typescript

0 commit comments

Comments
 (0)