Skip to content

Commit ce85aaa

Browse files
docs(README.md): update
1 parent f44f000 commit ce85aaa

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1696,7 +1696,7 @@ guardClass<Class>(FUNCTION); // type error
16961696

16971697
![update][update]
16981698

1699-
`4.0.0`: The function deny [classes][classes] in check cause of updated [`isFunction`](#isfunction).
1699+
`4.0.0`: The function denies [classes][classes] in check cause of updated [`isFunction`](#isfunction).
17001700

17011701
Use `guardFunction()` or `guard.is.function()` to guard the `value` to be a [`Func`](#func) type.
17021702

@@ -1718,6 +1718,10 @@ The **return value** is a `boolean` indicating whether or not the `value` is a [
17181718

17191719
### guardInstance
17201720

1721+
![update][update]
1722+
1723+
`4.0.0`: The function uses an updated [`isInstance()`](#isinstance) function that uses [`isClass()`](#isclass).
1724+
17211725
Use `guardInstance()` or `guard.is.instance()` to guard the `value` to be an `object` of a generic `Obj` type equal to an `instance` of [`Constructor`](#constructor) type.
17221726

17231727
```typescript
@@ -1819,7 +1823,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
18191823

18201824
![update][update]
18211825

1822-
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional.
1826+
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional instead of the [`guardObject`](#guardobject).
18231827

18241828
Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an `object` of a generic `Obj` type that contains the `key` property of the [`Key`][key] type.
18251829

packages/type/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1696,7 +1696,7 @@ guardClass<Class>(FUNCTION); // type error
16961696

16971697
![update][update]
16981698

1699-
`4.0.0`: The function deny [classes][classes] in check cause of updated [`isFunction`](#isfunction).
1699+
`4.0.0`: The function denies [classes][classes] in check cause of updated [`isFunction`](#isfunction).
17001700

17011701
Use `guardFunction()` or `guard.is.function()` to guard the `value` to be a [`Func`](#func) type.
17021702

@@ -1718,6 +1718,10 @@ The **return value** is a `boolean` indicating whether or not the `value` is a [
17181718

17191719
### guardInstance
17201720

1721+
![update][update]
1722+
1723+
`4.0.0`: The function uses an updated [`isInstance()`](#isinstance) function that uses [`isClass()`](#isclass).
1724+
17211725
Use `guardInstance()` or `guard.is.instance()` to guard the `value` to be an `object` of a generic `Obj` type equal to an `instance` of [`Constructor`](#constructor) type.
17221726

17231727
```typescript
@@ -1819,7 +1823,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
18191823

18201824
![update][update]
18211825

1822-
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional.
1826+
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional instead of the [`guardObject`](#guardobject).
18231827

18241828
Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an `object` of a generic `Obj` type that contains the `key` property of the [`Key`][key] type.
18251829

0 commit comments

Comments
 (0)