Skip to content

Commit f3031a7

Browse files
docs(README.md): update
1 parent 8aca257 commit f3031a7

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -625,11 +625,11 @@ isFunction(() => 5); // true
625625

626626
![update][update]
627627

628-
`4.0.0`: The function uses [isClass](#isclass) in check to check the `className` instead of [`isFunction()`](#isfunction).
628+
`4.0.0`: The function uses [`isClass()`](#isclass) in check to check the `className` instead of [`isFunction()`](#isfunction).
629629

630630
`4.0.3`: Type variable name `Obj` changes to `Class` and the type result to `value` is `Constructor<Class>`.
631631

632-
Use `isInstance()` or `is.instance()` to check if **any** value is an `object` of a generic `Obj` type equal to an `instance` of [`Constructor`](#constructor) type.
632+
Use `isInstance()` or `is.instance()` to check if **any** value is an `object` of a generic `Obj` type equal to an `instance` of [`Constructor<Class>`](#constructor) type.
633633

634634
```typescript
635635
const isInstance: IsInstance =
@@ -651,7 +651,7 @@ const isInstance: IsInstance =
651651
| Parameter | Type | Description |
652652
| :-------- | :-------------------------------------------------------------: | :----------------------------------------- |
653653
| value | `any` | Any `value` to compare with the `instance` |
654-
| instance | [`Constructor<Obj>`](#constructor) | A generic `Obj` [`Constructor`](#constructor) type to create an `instance` to compare with the `value` |
654+
| instance | [`Constructor<Obj>`](#constructor) | A generic `Obj` [`Constructor<Obj>`](#constructor) type to create an `instance` to compare with the `value` |
655655
| callback | [`ResultCallback`][resultcallback]=[`resultCallback`][callback] | [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
656656

657657
| Type return | Description |
@@ -1393,7 +1393,7 @@ const isType: IsType = <T extends Type>(value: any, type: Types<T>, callback: Re
13931393
| Parameter | Type | Description |
13941394
| :-------- | :-------------------------------------------------------------: | :-------------------------------------------------- |
13951395
| value | `any` | Any `value` to check if its type is from the `type` |
1396-
| type | [`Types<T>`](#types) | A `string` or generic `Constructor` type from the [`Types`](#types) to check the `value` |
1396+
| type | [`Types<T>`](#types) | A `string` or generic `Constructor<T>` type from the [`Types`](#types) to check the `value` |
13971397
| callback | [`ResultCallback`][resultcallback]=[`resultCallback`][callback] | [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
13981398

13991399
| Type return | Description |
@@ -1840,7 +1840,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is a [
18401840

18411841
`4.0.0`: The function uses an updated [`isInstance()`](#isinstance) function that uses [`isClass()`](#isclass).
18421842

1843-
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.
1843+
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<Obj>`](#constructor) type.
18441844

18451845
```typescript
18461846
const guardInstance: GuardInstance = <Obj>(value: Obj, instance: Constructor<Obj>, callback?: ResultCallback): value is Obj =>
@@ -2069,7 +2069,7 @@ const guardType: GuardType = <T extends Type>(value: T, type: Types<T>, callback
20692069
| Parameter | Type | Description |
20702070
| :-------- | :--------------------------------: | :------------------------------------------------- |
20712071
| value | `T` extends [`Type`][type] | A [`Type`][type] `value` to guard with the `type` |
2072-
| type | [`Types<T>`](#types) | A `string` or generic [`Constructor`](#constructor) type from the [`Types`](#types) to check the `value` |
2072+
| type | [`Types<T>`](#types) | A `string` or generic [`Constructor<T>`](#constructor) type from the [`Types`](#types) to check the `value` |
20732073
| callback? | [`ResultCallback`][resultcallback] | Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
20742074

20752075
The **return value** is a `boolean` indicating whether or not the `value` is a `type` from the [`Types`](#types).

packages/type/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -625,11 +625,11 @@ isFunction(() => 5); // true
625625

626626
![update][update]
627627

628-
`4.0.0`: The function uses [isClass](#isclass) in check to check the `className` instead of [`isFunction()`](#isfunction).
628+
`4.0.0`: The function uses [`isClass()`](#isclass) in check to check the `className` instead of [`isFunction()`](#isfunction).
629629

630630
`4.0.3`: Type variable name `Obj` changes to `Class` and the type result to `value` is `Constructor<Class>`.
631631

632-
Use `isInstance()` or `is.instance()` to check if **any** value is an `object` of a generic `Obj` type equal to an `instance` of [`Constructor`](#constructor) type.
632+
Use `isInstance()` or `is.instance()` to check if **any** value is an `object` of a generic `Obj` type equal to an `instance` of [`Constructor<Class>`](#constructor) type.
633633

634634
```typescript
635635
const isInstance: IsInstance =
@@ -651,7 +651,7 @@ const isInstance: IsInstance =
651651
| Parameter | Type | Description |
652652
| :-------- | :-------------------------------------------------------------: | :----------------------------------------- |
653653
| value | `any` | Any `value` to compare with the `instance` |
654-
| instance | [`Constructor<Obj>`](#constructor) | A generic `Obj` [`Constructor`](#constructor) type to create an `instance` to compare with the `value` |
654+
| instance | [`Constructor<Obj>`](#constructor) | A generic `Obj` [`Constructor<Obj>`](#constructor) type to create an `instance` to compare with the `value` |
655655
| callback | [`ResultCallback`][resultcallback]=[`resultCallback`][callback] | [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
656656

657657
| Type return | Description |
@@ -1393,7 +1393,7 @@ const isType: IsType = <T extends Type>(value: any, type: Types<T>, callback: Re
13931393
| Parameter | Type | Description |
13941394
| :-------- | :-------------------------------------------------------------: | :-------------------------------------------------- |
13951395
| value | `any` | Any `value` to check if its type is from the `type` |
1396-
| type | [`Types<T>`](#types) | A `string` or generic `Constructor` type from the [`Types`](#types) to check the `value` |
1396+
| type | [`Types<T>`](#types) | A `string` or generic `Constructor<T>` type from the [`Types`](#types) to check the `value` |
13971397
| callback | [`ResultCallback`][resultcallback]=[`resultCallback`][callback] | [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
13981398

13991399
| Type return | Description |
@@ -1840,7 +1840,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is a [
18401840

18411841
`4.0.0`: The function uses an updated [`isInstance()`](#isinstance) function that uses [`isClass()`](#isclass).
18421842

1843-
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.
1843+
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<Obj>`](#constructor) type.
18441844

18451845
```typescript
18461846
const guardInstance: GuardInstance = <Obj>(value: Obj, instance: Constructor<Obj>, callback?: ResultCallback): value is Obj =>
@@ -2069,7 +2069,7 @@ const guardType: GuardType = <T extends Type>(value: T, type: Types<T>, callback
20692069
| Parameter | Type | Description |
20702070
| :-------- | :--------------------------------: | :------------------------------------------------- |
20712071
| value | `T` extends [`Type`][type] | A [`Type`][type] `value` to guard with the `type` |
2072-
| type | [`Types<T>`](#types) | A `string` or generic [`Constructor`](#constructor) type from the [`Types`](#types) to check the `value` |
2072+
| type | [`Types<T>`](#types) | A `string` or generic [`Constructor<T>`](#constructor) type from the [`Types`](#types) to check the `value` |
20732073
| callback? | [`ResultCallback`][resultcallback] | Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
20742074

20752075
The **return value** is a `boolean` indicating whether or not the `value` is a `type` from the [`Types`](#types).

0 commit comments

Comments
 (0)