Skip to content

Commit 0a05a9e

Browse files
docs(README.md): update
1 parent c70f8c8 commit 0a05a9e

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ const areString = (...value: any): boolean => check('string', ...value);
311311

312312
![update][update]
313313

314-
`4.1.0`: Added `objectKeys` as [`isObjectKeys()`](#isobjectkeys).
314+
`4.1.0`: Adds `objectKeys` as [`isObjectKeys()`](#isobjectkeys).
315315

316316
The object contains prefixed with `is` functions and prefixed with `isNot` functions in property `not`.
317317

@@ -730,11 +730,11 @@ isFunction(() => 5); // true
730730

731731
`4.1.1`:
732732

733-
* Change the `Class` type variable to `Obj`.
734-
* Change the `className` parameter name to `constructor`.
733+
* Changes the `Class` type variable name to `Obj`.
734+
* Changes the `className` parameter name to `constructor` cause it represents [`class`][ts-classes] or [`function`][ts-function] constructor.
735735
* Fixes type variable `Obj` default value is set to [`Function`][function] by removing it cause it's always being picked from the `constructor` parameter.
736-
* Removed unnecessary `Constructor` from the return type.
737-
* Add check `constructor` against the function.
736+
* Removes unnecessary [`Constructor`][constructor] from the return type.
737+
* Adds check `constructor` against the [`function`][ts-function].
738738

739739
Use `isInstance()` or `is.instance()` to check if **any** value is an `object` of a generic `Obj` type and an instance of [`Constructor`][constructor] type.
740740

@@ -753,9 +753,9 @@ const isInstance: IsInstance =
753753

754754
**Generic type variables:**
755755

756-
| Type | Default value | Description |
757-
| :---- | :------------ | :----------------------------------------------------- |
758-
| `Obj` | | A generic variable to the return type `value` is `Obj` |
756+
| Type | Default value | Description |
757+
| :---- | :--------------------- | :----------------------------------------------------- |
758+
| `Obj` | From the `constructor` | A generic variable to the return type `value` is `Obj` |
759759

760760
**Parameters:**
761761

@@ -812,7 +812,7 @@ isInstance(anyInstance, functionConstructor as any); // true
812812

813813
![update][update]
814814

815-
`4.1.0`: Check only for primitive `string` and `number`.
815+
`4.1.0`: Checks only for primitive `string` and `number`.
816816

817817
Use `isKey()` or `is.key()` to check if **any** `value` is one of the `string`, `number`, or `symbol`.
818818

@@ -2029,7 +2029,7 @@ if (!is.undefined(config.a)) {
20292029

20302030
![update][update]
20312031

2032-
`4.1.0`: Added `objectKeys` as [`guardObjectKeys()`](#guardobjectkeys).
2032+
`4.1.0`: Adds `objectKeys` as [`guardObjectKeys()`](#guardobjectkeys).
20332033

20342034
The object contains prefixed with `guard` functions in `is` property.
20352035

@@ -2314,6 +2314,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is a [
23142314
![update][update]
23152315

23162316
`4.1.0`: Fixes the `value` is not guarded by extending generic type `Obj` variable with `object`.
2317+
`4.1.1`: Changes the `instance` parameter name to `constructor` cause it represents [`class`][ts-classes] or [`function`][ts-function] constructor.
23172318

23182319
Use `guardInstance()` or `guard.is.instance()` to guard the `value` to be an `object` of a generic `Obj` type and an `instance` of [`Constructor`][constructor] type.
23192320

0 commit comments

Comments
 (0)