Skip to content

Commit 7a204cd

Browse files
docs(README.md): update
1 parent 0ac8f7d commit 7a204cd

File tree

2 files changed

+54
-2
lines changed

2 files changed

+54
-2
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,8 @@ const isBooleanObject: IsBooleanObject = (value: any, callback: ResultCallback =
472472
| :------------------- | :---------- |
473473
| `value` is `Boolean` | The **return value** is a `boolean` indicating whether or not the `value` is a [`Boolean`][boolean] instance |
474474

475+
**Usage:**
476+
475477
```typescript
476478
// Example usage
477479
import { isBooleanObject } from '@angular-package/type';
@@ -514,6 +516,8 @@ const isBooleanType: IsBooleanType = (value: any, callback: ResultCallback = res
514516
| :------------------- | :---------- |
515517
| `value` is `boolean` | The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type |
516518

519+
**Usage:**
520+
517521
```typescript
518522
// Example usage
519523
import { isBooleanType } from '@angular-package/type';
@@ -570,6 +574,8 @@ const isClass: IsClass = <Class = Function>(value: any, callback: ResultCallback
570574
| :----------------- | :---------- |
571575
| `value` is `Class` | The **return value** is a `boolean` indicating whether or not the `value` is a [`class`][classes] |
572576

577+
**Usage:**
578+
573579
```typescript
574580
// Example usage
575581
import { isClass } from '@angular-package/type';
@@ -607,6 +613,8 @@ const isDefined: IsDefined = (value: unknown, callback: ResultCallback = resultC
607613
| :----------- | :---------- |
608614
| `boolean` | The **return value** is a `boolean` indicating whether or not the `value` is defined, not `undefined` |
609615

616+
**Usage:**
617+
610618
```typescript
611619
// Example usage
612620
import { isDefined } from '@angular-package/type';
@@ -655,6 +663,8 @@ const isFunction: IsFunction = (value: any, callback: ResultCallback = resultCal
655663
| :---------------- | :---------- |
656664
| `value` is `Func` | The **return value** is a `boolean` indicating whether or not the `value` is a `function` |
657665

666+
**Usage:**
667+
658668
```typescript
659669
// Example usage
660670
import { isFunction } from '@angular-package/type';
@@ -716,6 +726,8 @@ const isInstance: IsInstance =
716726
| :----------------- | :---------- |
717727
| `value` is `Class` | The **return value** is a `boolean` indicating whether or not the `value` is an `instance` of a generic `Class` |
718728

729+
**Usage:**
730+
719731
```typescript
720732
// Example usage
721733
import { isInstance } from '@angular-package/type';
@@ -758,6 +770,8 @@ const isKey: IsKey = (value: any, callback: ResultCallback = resultCallback): va
758770
| :--------------- | :---------- |
759771
| `value` is `Key` | The **return value** is a `boolean` indicating whether or not the `value` is a [`Key`][key] |
760772

773+
**Usage:**
774+
761775
```typescript
762776
// Example usage
763777
import { isKey } from '@angular-package/type';
@@ -803,6 +817,8 @@ const isNull: IsNull = (value: any, callback: ResultCallback = resultCallback):
803817
| :---------------- | :---------- |
804818
| `value` is `null` | The **return value** is a `boolean` indicating whether or not the `value` is `null` |
805819

820+
**Usage:**
821+
806822
```typescript
807823
// Example usage
808824
import { isNull } from '@angular-package/type';
@@ -880,6 +896,8 @@ const isNumberObject: IsNumberObject = (value: any, callback: ResultCallback = r
880896
| :------------------ | :---------- |
881897
| `value` is `Number` | The **return value** is a `boolean` indicating whether or not the `value` is a [`Number`][Number] instance |
882898

899+
**Usage:**
900+
883901
```typescript
884902
// Example usage
885903
import { isNumberObject } from '@angular-package/type';
@@ -938,6 +956,8 @@ const isNumberType: IsNumberType = (value: any, callback: ResultCallback = resul
938956
| :------------------ | :---------- |
939957
| `value` is `number` | The **return value** is a `boolean` indicating whether or not the `value` is a `number` |
940958

959+
**Usage:**
960+
941961
```typescript
942962
// Example usage
943963
import { isNumberType } from '@angular-package/type';
@@ -1003,7 +1023,7 @@ const isObject: IsObject = <Obj = object>(value: any, callback: ResultCallback =
10031023
| :--------------- | :---------- |
10041024
| `value` is `Obj` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` |
10051025

1006-
[Example usage on playground][is-object] | [How to detect an `object` type][detect-object]
1026+
**Usage:**
10071027

10081028
```typescript
10091029
// Example usage
@@ -1062,6 +1082,8 @@ isObject(OBJECT_ONE); // true
10621082

10631083
```
10641084

1085+
[Example usage on playground][is-object] | [How to detect an `object` type][detect-object]
1086+
10651087
----
10661088

10671089
### isObjectKey
@@ -1104,6 +1126,8 @@ const isObjectKey: IsObjectKey =
11041126
| :---------------- | :---------- |
11051127
| `value` is `Type` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` with its own specified keys |
11061128

1129+
**Usage:**
1130+
11071131
```typescript
11081132
// Example usage
11091133
import { isObjectKey } from '@angular-package/type';
@@ -1734,6 +1758,8 @@ const isNotUndefined: IsNotUndefined = (value: unknown, callback: ResultCallback
17341758
| :------------ | :---------- |
17351759
| `boolean` | The **return value** is a `boolean` indicating whether or not the `value` is not `undefined` |
17361760

1761+
**Usage:**
1762+
17371763
```typescript
17381764
// Example usage with the problem
17391765
import { is } from '@angular-package/type';

packages/type/README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,8 @@ const isBooleanObject: IsBooleanObject = (value: any, callback: ResultCallback =
472472
| :------------------- | :---------- |
473473
| `value` is `Boolean` | The **return value** is a `boolean` indicating whether or not the `value` is a [`Boolean`][boolean] instance |
474474

475+
**Usage:**
476+
475477
```typescript
476478
// Example usage
477479
import { isBooleanObject } from '@angular-package/type';
@@ -514,6 +516,8 @@ const isBooleanType: IsBooleanType = (value: any, callback: ResultCallback = res
514516
| :------------------- | :---------- |
515517
| `value` is `boolean` | The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type |
516518

519+
**Usage:**
520+
517521
```typescript
518522
// Example usage
519523
import { isBooleanType } from '@angular-package/type';
@@ -570,6 +574,8 @@ const isClass: IsClass = <Class = Function>(value: any, callback: ResultCallback
570574
| :----------------- | :---------- |
571575
| `value` is `Class` | The **return value** is a `boolean` indicating whether or not the `value` is a [`class`][classes] |
572576

577+
**Usage:**
578+
573579
```typescript
574580
// Example usage
575581
import { isClass } from '@angular-package/type';
@@ -607,6 +613,8 @@ const isDefined: IsDefined = (value: unknown, callback: ResultCallback = resultC
607613
| :----------- | :---------- |
608614
| `boolean` | The **return value** is a `boolean` indicating whether or not the `value` is defined, not `undefined` |
609615

616+
**Usage:**
617+
610618
```typescript
611619
// Example usage
612620
import { isDefined } from '@angular-package/type';
@@ -655,6 +663,8 @@ const isFunction: IsFunction = (value: any, callback: ResultCallback = resultCal
655663
| :---------------- | :---------- |
656664
| `value` is `Func` | The **return value** is a `boolean` indicating whether or not the `value` is a `function` |
657665

666+
**Usage:**
667+
658668
```typescript
659669
// Example usage
660670
import { isFunction } from '@angular-package/type';
@@ -716,6 +726,8 @@ const isInstance: IsInstance =
716726
| :----------------- | :---------- |
717727
| `value` is `Class` | The **return value** is a `boolean` indicating whether or not the `value` is an `instance` of a generic `Class` |
718728

729+
**Usage:**
730+
719731
```typescript
720732
// Example usage
721733
import { isInstance } from '@angular-package/type';
@@ -758,6 +770,8 @@ const isKey: IsKey = (value: any, callback: ResultCallback = resultCallback): va
758770
| :--------------- | :---------- |
759771
| `value` is `Key` | The **return value** is a `boolean` indicating whether or not the `value` is a [`Key`][key] |
760772

773+
**Usage:**
774+
761775
```typescript
762776
// Example usage
763777
import { isKey } from '@angular-package/type';
@@ -803,6 +817,8 @@ const isNull: IsNull = (value: any, callback: ResultCallback = resultCallback):
803817
| :---------------- | :---------- |
804818
| `value` is `null` | The **return value** is a `boolean` indicating whether or not the `value` is `null` |
805819

820+
**Usage:**
821+
806822
```typescript
807823
// Example usage
808824
import { isNull } from '@angular-package/type';
@@ -880,6 +896,8 @@ const isNumberObject: IsNumberObject = (value: any, callback: ResultCallback = r
880896
| :------------------ | :---------- |
881897
| `value` is `Number` | The **return value** is a `boolean` indicating whether or not the `value` is a [`Number`][Number] instance |
882898

899+
**Usage:**
900+
883901
```typescript
884902
// Example usage
885903
import { isNumberObject } from '@angular-package/type';
@@ -938,6 +956,8 @@ const isNumberType: IsNumberType = (value: any, callback: ResultCallback = resul
938956
| :------------------ | :---------- |
939957
| `value` is `number` | The **return value** is a `boolean` indicating whether or not the `value` is a `number` |
940958

959+
**Usage:**
960+
941961
```typescript
942962
// Example usage
943963
import { isNumberType } from '@angular-package/type';
@@ -1003,7 +1023,7 @@ const isObject: IsObject = <Obj = object>(value: any, callback: ResultCallback =
10031023
| :--------------- | :---------- |
10041024
| `value` is `Obj` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` |
10051025

1006-
[Example usage on playground][is-object] | [How to detect an `object` type][detect-object]
1026+
**Usage:**
10071027

10081028
```typescript
10091029
// Example usage
@@ -1062,6 +1082,8 @@ isObject(OBJECT_ONE); // true
10621082

10631083
```
10641084

1085+
[Example usage on playground][is-object] | [How to detect an `object` type][detect-object]
1086+
10651087
----
10661088

10671089
### isObjectKey
@@ -1104,6 +1126,8 @@ const isObjectKey: IsObjectKey =
11041126
| :---------------- | :---------- |
11051127
| `value` is `Type` | The **return value** is a `boolean` indicating whether or not the `value` is an `object` with its own specified keys |
11061128

1129+
**Usage:**
1130+
11071131
```typescript
11081132
// Example usage
11091133
import { isObjectKey } from '@angular-package/type';
@@ -1734,6 +1758,8 @@ const isNotUndefined: IsNotUndefined = (value: unknown, callback: ResultCallback
17341758
| :------------ | :---------- |
17351759
| `boolean` | The **return value** is a `boolean` indicating whether or not the `value` is not `undefined` |
17361760

1761+
**Usage:**
1762+
17371763
```typescript
17381764
// Example usage with the problem
17391765
import { is } from '@angular-package/type';

0 commit comments

Comments
 (0)