Skip to content

Commit 8aca257

Browse files
docs(README.md): fix
1 parent 9fba1b4 commit 8aca257

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1927,7 +1927,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is a `
19271927

19281928
`4.0.0`: The function has a properly working callback cause of the updated [`isObject`](#isobject).
19291929

1930-
`4.0.3`: Fix type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1930+
`4.0.3`: Fix type variable `Obj` default value is set to cause of it always being picked from the `value`.
19311931

19321932
Use `guardObject()` or `guard.is.object()` to guard the `value` to be an `object` of a generic `Obj` type.
19331933

@@ -1959,7 +1959,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
19591959

19601960
`4.0.1`: Fix guards the `key` by changing its type to `keyof Obj` instead of just a [`Key`][key].
19611961

1962-
`4.0.3`: Fix type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1962+
`4.0.3`: Fix type variable `Obj` default value is set to cause of it always being picked from the `value`.
19631963

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

@@ -1987,22 +1987,22 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
19871987

19881988
### guardPrimitive
19891989

1990-
Use `guardPrimitive()` or `guard.is.primitive()` to guard the `value` to be the [`Primitive`][primitive] from a `type` of the [`Primitives`][primitives].
1990+
Use `guardPrimitive()` or `guard.is.primitive()` to guard the `value` to be the [`Primitive`][primitive] from a `type` of the [`Primitives`](#primitives).
19911991

19921992
```typescript
19931993
const guardPrimitive: GuardPrimitive =
19941994
<Type extends Primitive>(value: Type, type: Primitives, callback?: ResultCallback): value is Type =>
19951995
isPrimitive<Type>(value, type, callback);
19961996
```
19971997

1998-
| Type variable | Default value | Description |
1999-
| :-------------------------------------- | :--------------- | :---------- |
2000-
| `Type` extends [`Primitive`][primitive] | From the `value` | Guarded with [`Primitive`][primitive] type `Type` variable from the `value` to the return type `value` is `Type` |
1998+
| Type variable | Default value | Description |
1999+
| :--------------------------------------- | :--------------- | :---------- |
2000+
| `Type` extends [`Primitive`](#primitive) | From the `value` | Guarded with [`Primitive`](#primitive) type `Type` variable from the `value` to the return type `value` is `Type` |
20012001

20022002
| Parameter | Type | Description |
20032003
| :---------- | :--------------------------------------: | :---------------------------------- |
2004-
| value | `Type` extends [`Primitive`][primitive] | A `Primitive` type `value` to guard |
2005-
| type | [`Primitives`][primitives] | A `string` type from the [`Primitives`][primitives] to check the `value` |
2004+
| value | `Type` extends [`Primitive`](#primitive) | A `Primitive` type `value` to guard |
2005+
| type | [`Primitives`](#primitives) | A `string` type from the [`Primitives`](#primitives) to check the `value` |
20062006
| callback? | [`ResultCallback`][resultcallback] | Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
20072007

20082008
The **return value** is a `boolean` indicating whether or not the `value` is the [`Primitive`][primitive] from the `type`.
@@ -2062,8 +2062,8 @@ const guardType: GuardType = <T extends Type>(value: T, type: Types<T>, callback
20622062
isType<T>(value, type, callback);
20632063
```
20642064

2065-
| Type variable | Default value | Description |
2066-
| :---------------------------- | :--------------- | :---------- |
2065+
| Type variable | Default value | Description |
2066+
| :------------------------- | :--------------- | :---------- |
20672067
| `T` extends [`Type`][type] | From the `value` | Guarded with [`Type`][type] type `T` variable from the `value` to the return type `value` is `T` |
20682068

20692069
| Parameter | Type | Description |

packages/type/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1927,7 +1927,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is a `
19271927

19281928
`4.0.0`: The function has a properly working callback cause of the updated [`isObject`](#isobject).
19291929

1930-
`4.0.3`: Fix type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1930+
`4.0.3`: Fix type variable `Obj` default value is set to cause of it always being picked from the `value`.
19311931

19321932
Use `guardObject()` or `guard.is.object()` to guard the `value` to be an `object` of a generic `Obj` type.
19331933

@@ -1959,7 +1959,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
19591959

19601960
`4.0.1`: Fix guards the `key` by changing its type to `keyof Obj` instead of just a [`Key`][key].
19611961

1962-
`4.0.3`: Fix type variable `Obj` default value is not set to cause of it always being picked from the `value`.
1962+
`4.0.3`: Fix type variable `Obj` default value is set to cause of it always being picked from the `value`.
19631963

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

@@ -1987,22 +1987,22 @@ The **return value** is a `boolean` indicating whether or not the `value` is an
19871987

19881988
### guardPrimitive
19891989

1990-
Use `guardPrimitive()` or `guard.is.primitive()` to guard the `value` to be the [`Primitive`][primitive] from a `type` of the [`Primitives`][primitives].
1990+
Use `guardPrimitive()` or `guard.is.primitive()` to guard the `value` to be the [`Primitive`][primitive] from a `type` of the [`Primitives`](#primitives).
19911991

19921992
```typescript
19931993
const guardPrimitive: GuardPrimitive =
19941994
<Type extends Primitive>(value: Type, type: Primitives, callback?: ResultCallback): value is Type =>
19951995
isPrimitive<Type>(value, type, callback);
19961996
```
19971997

1998-
| Type variable | Default value | Description |
1999-
| :-------------------------------------- | :--------------- | :---------- |
2000-
| `Type` extends [`Primitive`][primitive] | From the `value` | Guarded with [`Primitive`][primitive] type `Type` variable from the `value` to the return type `value` is `Type` |
1998+
| Type variable | Default value | Description |
1999+
| :--------------------------------------- | :--------------- | :---------- |
2000+
| `Type` extends [`Primitive`](#primitive) | From the `value` | Guarded with [`Primitive`](#primitive) type `Type` variable from the `value` to the return type `value` is `Type` |
20012001

20022002
| Parameter | Type | Description |
20032003
| :---------- | :--------------------------------------: | :---------------------------------- |
2004-
| value | `Type` extends [`Primitive`][primitive] | A `Primitive` type `value` to guard |
2005-
| type | [`Primitives`][primitives] | A `string` type from the [`Primitives`][primitives] to check the `value` |
2004+
| value | `Type` extends [`Primitive`](#primitive) | A `Primitive` type `value` to guard |
2005+
| type | [`Primitives`](#primitives) | A `string` type from the [`Primitives`](#primitives) to check the `value` |
20062006
| callback? | [`ResultCallback`][resultcallback] | Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
20072007

20082008
The **return value** is a `boolean` indicating whether or not the `value` is the [`Primitive`][primitive] from the `type`.
@@ -2062,8 +2062,8 @@ const guardType: GuardType = <T extends Type>(value: T, type: Types<T>, callback
20622062
isType<T>(value, type, callback);
20632063
```
20642064

2065-
| Type variable | Default value | Description |
2066-
| :---------------------------- | :--------------- | :---------- |
2065+
| Type variable | Default value | Description |
2066+
| :------------------------- | :--------------- | :---------- |
20672067
| `T` extends [`Type`][type] | From the `value` | Guarded with [`Type`][type] type `T` variable from the `value` to the return type `value` is `T` |
20682068

20692069
| Parameter | Type | Description |

0 commit comments

Comments
 (0)