Skip to content

Commit 139a959

Browse files
docs(README.md): update
1 parent fcec2ae commit 139a959

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1701,20 +1701,22 @@ const guardBoolean: GuardBoolean = <B extends AnyBoolean>(value: B, callback?: R
17011701
isBoolean(value, callback);
17021702
```
17031703

1704+
Type variables:
1705+
17041706
| Type variable | Default value | Description |
17051707
| :-------------------------------------- | :--------------- | :---------- |
17061708
| `B` extends [`AnyBoolean`](#anyboolean) | From the `value` | A `B` variable from the `value` to the return type `value` is `B` |
17071709

1708-
----
1710+
Parameters:
17091711

17101712
| Parameter | Type | Description |
17111713
| :-------- | :-------------------------------------: | :--------------------------------------------------- |
17121714
| value | `B` extends [`AnyBoolean`](#anyboolean) | An [`AnyBoolean`](#anyboolean) type `value` to guard |
17131715
| callback? | [`ResultCallback`][resultcallback] | An Optional [`ResultCallback`][resultcallback] function to handle result before returns eg. to throw an `Error` |
17141716

1715-
----
1717+
Return type:
17161718

1717-
| Return type | Description |
1719+
| Type | Description |
17181720
| :------------- | :---------- |
17191721
| `value` is `B` | The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type or [`Boolean`][boolean] object |
17201722

@@ -1729,11 +1731,13 @@ const guardClass: GuardClass = <Class>(value: Class, callback?: ResultCallback):
17291731
isClass<Class>(value, callback);
17301732
```
17311733

1734+
Type variables:
1735+
17321736
| Type variable | Default value | Description |
17331737
| :------------ | :--------------- | :---------- |
17341738
| `Class` | From the `value` | A `Class` variable from the `value` to the return type `value` is `Class` |
17351739

1736-
----
1740+
Parameters:
17371741

17381742
| Parameter | Type | Description |
17391743
| :-------- | :--------------------------------: | :-------------------------------------- |
@@ -1803,10 +1807,14 @@ const guardDefined: GuardDefined = <Type>(value: Type, callback?: ResultCallback
18031807
isDefined(value, callback);
18041808
```
18051809

1810+
Type variables:
1811+
18061812
| Type variable | Default value | Description |
18071813
| :------------ | :--------------- | :---------- |
18081814
| `Type` | From the `value` | A generic `Type` variable from the `value` to the return type `value` is [`Defined<Type>`][defined] |
18091815

1816+
Parameters:
1817+
18101818
| Parameter | Type | Description |
18111819
| :-------- | :-------------------------------------: | :--------------------------------------------------- |
18121820
| value | `Type` | A generic type `value` to guard |

0 commit comments

Comments
 (0)