Skip to content

Commit 446cf30

Browse files
docs(README.md): update guardObjectKey
1 parent 18ed6aa commit 446cf30

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1845,6 +1845,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
18451845
![update][update]
18461846

18471847
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional instead of the [`guardObject`](#guardobject).
1848+
`4.0.1`: Fix guards the `key` by changing its type to `keyof Obj` instead just a [`Key`][key].
18481849

18491850
Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an `object` of a generic `Obj` type that contains the `key`.
18501851

packages/type/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1845,6 +1845,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
18451845
![update][update]
18461846

18471847
`4.0.0`: The function uses [`isObjectKey`](#isobjectkey) function to check the `value` and has [`callback`](#resultcallback) as optional instead of the [`guardObject`](#guardobject).
1848+
`4.0.1`: Fix guards the `key` by changing its type to `keyof Obj` instead just a [`Key`][key].
18481849

18491850
Use `guardObjectKey()` or `guard.is.objectKey()` to guard the `value` to be an `object` of a generic `Obj` type that contains the `key`.
18501851

0 commit comments

Comments
 (0)