Skip to content

Commit fcbd78e

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

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1858,7 +1858,7 @@ const guardObjectKey: GuardObjectKey =
18581858
| Parameter | Type | Description |
18591859
| :---------- | :--------------------------------: | :--------------------------------------------------------------------- |
18601860
| value | `Obj` | A generic `Obj` type `value` that contains the `key` to guard |
1861-
| key | keyof O`bj` \| (keyof `Obj`)\[\] | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains |
1861+
| key | `keyof Obj` \| `(keyof Obj)[]` | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains |
18621862
| callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
18631863

18641864
The **return value** is a `boolean` indicating whether or not the `value` is an `object` of a generic `Obj` containing the `key`.

packages/type/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1858,7 +1858,7 @@ const guardObjectKey: GuardObjectKey =
18581858
| Parameter | Type | Description |
18591859
| :---------- | :--------------------------------: | :--------------------------------------------------------------------- |
18601860
| value | `Obj` | A generic `Obj` type `value` that contains the `key` to guard |
1861-
| key | keyof O`bj` \| (keyof `Obj`)\[\] | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains |
1861+
| key | `keyof Obj` \| `(keyof Obj)[]` | A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains |
18621862
| callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
18631863

18641864
The **return value** is a `boolean` indicating whether or not the `value` is an `object` of a generic `Obj` containing the `key`.

0 commit comments

Comments
 (0)