Skip to content

Commit e460761

Browse files
sciborrudnickisciborrudnicki
committed
docs(README.md): update
1 parent 6c46075 commit e460761

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎README.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ const isArray: IsArray = <Type = any>(value: any, callback: ResultCallback = res
372372

373373
| Name | Default value | Description |
374374
| :----- | :------------ | :---------- |
375-
| `Type` | `any` | A generic variable to the return type `value` is `Array<Type>` |
375+
| `Type` | `any` | A generic variable to the return type `value is Array<Type>` |
376376

377377
**Parameters:**
378378

@@ -383,9 +383,9 @@ const isArray: IsArray = <Type = any>(value: any, callback: ResultCallback = res
383383

384384
**Returns:**
385385

386-
| Returns | Type | Description |
387-
| :----------------------- | :-------: | :---------------------------------------------------------------- |
388-
| `value` is `Array<Type>` | `boolean` | By default `Type` variable is equal to `any` and the **return type** is a `boolean` as the result of return statement indicating the `value` is an [`Array`][array] of `any` type |
386+
| Returns | Type | Description |
387+
| :--------------------- | :-------: | :---------------------------------------------------------------- |
388+
| `value is Array<Type>` | `boolean` | By default `Type` variable is equal to `any` and the **return type** is a `boolean` as the result of return statement indicating the `value` is an [`Array`][array] of `any` type |
389389

390390
The **return value** is a `boolean` indicating whether or not the `value` is an [`Array`][array].
391391

@@ -425,9 +425,9 @@ const isBigInt: IsBigInt = (value: any, callback: ResultCallback = resultCallbac
425425

426426
**Returns:**
427427

428-
| Returns | Type | Description |
429-
| :------------------ | :-------: | :---------------------------------------------------------------- |
430-
| `value` is `bigint` | `boolean` | The **return type** is a `boolean` as the result of its statement |
428+
| Returns | Type | Description |
429+
| :---------------- | :-------: | :---------------------------------------------------------------- |
430+
| `value is bigint` | `boolean` | The **return type** is a `boolean` as the result of its statement |
431431

432432
The **return value** is a `boolean` indicating whether or not the `value` is a `bigint`.
433433

@@ -467,9 +467,9 @@ const isBoolean: IsBoolean = (value: any, callback: ResultCallback = resultCallb
467467

468468
**Returns:**
469469

470-
| Returns | Type | Description |
471-
| :------------------- | :-------: | :---------------------------------------------------------------- |
472-
| `value` is `boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement |
470+
| Returns | Type | Description |
471+
| :----------------- | :-------: | :---------------------------------------------------------------- |
472+
| `value is boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement |
473473

474474
The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type or [`Boolean`][boolean] instance.
475475

@@ -509,9 +509,9 @@ const isBooleanObject: IsBooleanObject = (value: any, callback: ResultCallback =
509509

510510
**Returns:**
511511

512-
| Returns | Type | Description |
513-
| :------------------------------ | :-------: | :---------------------------------------------------------------- |
514-
| `value` is [`Boolean`][boolean] | `boolean` | The **return type** is a `boolean` as the result of its statement |
512+
| Returns | Type | Description |
513+
| :----------------- | :-------: | :--------------------------------------------------------------------------------------------------------------- |
514+
| `value is Boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement indicating the `value` is [`Boolean`][boolean] |
515515

516516
The **return value** is a `boolean` indicating whether or not the `value` is a [`Boolean`][boolean] instance.
517517

@@ -555,9 +555,9 @@ const isBooleanType: IsBooleanType = (value: any, callback: ResultCallback = res
555555

556556
**Returns:**
557557

558-
| Returns | Type | Description |
559-
| :------------------- | :-------: | :---------------------------------------------------------------- |
560-
| `value` is `boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement |
558+
| Returns | Type | Description |
559+
| :----------------- | :-------: | :---------------------------------------------------------------- |
560+
| `value is boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement |
561561

562562
The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type.
563563

@@ -600,7 +600,7 @@ const isClass: IsClass = <Class = Function>(value: any, callback: ResultCallback
600600

601601
| Name | Default value | Description |
602602
| :------ | :------------ | :---------- |
603-
| `Class` | `Function` | A generic variable to the return type `value` is `Class` |
603+
| `Class` | `Function` | A generic variable to the return type `value is Class` |
604604

605605
**Parameters:**
606606

@@ -611,9 +611,9 @@ const isClass: IsClass = <Class = Function>(value: any, callback: ResultCallback
611611

612612
**Returns:**
613613

614-
| Returns | Type | Description |
615-
| :----------------- | :-------: | :---------------------------------------------------------------- |
616-
| `value` is `Class` | `boolean` | By default `Class` variable is equal to [`Function`][function] and the **return type** is a `boolean` as the result of its statement indicating the `value` is a [`Function`][function] |
614+
| Returns | Type | Description |
615+
| :--------------- | :-------: | :---------------------------------------------------------------- |
616+
| `value is Class` | `boolean` | By default `Class` variable is equal to [`Function`][function] and the **return type** is a `boolean` as the result of its statement indicating the `value` is a [`Function`][function] |
617617

618618
The **return value** is a `boolean` indicating whether or not the `value` is a [`class`][ts-classes].
619619

@@ -645,8 +645,8 @@ const isDefined: IsDefined = (value: unknown, callback: ResultCallback = resultC
645645

646646
**Parameters:**
647647

648-
| Name: `type` | Description |
649-
| :------------------------------------------- | :---------------------------- |
648+
| Name: `type` | Description |
649+
| :------------------------------------------- | :-------------------------- |
650650
| value: `unknown` | An unknown `value` to check |
651651
| callback: [`ResultCallback`][resultcallback] | A function, which by default is [`resultCallback()`][callback] to handle the result before returns eg. to throw an [`Error`][error] |
652652

@@ -757,9 +757,9 @@ const isInstance: IsInstance =
757757

758758
**Generic type variables:**
759759

760-
| Name | Default value | Description |
761-
| :---- | :--------------------- | :----------------------------------------------------- |
762-
| `Obj` | From the `constructor` | A generic variable to the return type `value` is `Obj` |
760+
| Name | Default value | Description |
761+
| :---- | :--------------------- | :--------------------------------------------------- |
762+
| `Obj` | From the `constructor` | A generic variable to the return type `value is Obj` |
763763

764764
**Parameters:**
765765

@@ -771,9 +771,9 @@ const isInstance: IsInstance =
771771

772772
**Returns:**
773773

774-
| Returns | Type | Description |
775-
| :--------------- | :-------: | :----------------------------------------------------------------------------------------------------------------------- |
776-
| `value` is `Obj` | `boolean` | The **return type** is a `boolean` as the result of its statement indicating the `value` is `Obj` from the `constructor` |
774+
| Returns | Type | Description |
775+
| :------------- | :-------: | :------------------------------------------------------------------------------------------------------------------------------------- |
776+
| `value is Obj` | `boolean` | The **return type** is a `boolean` as the result of its statement indicating the `value` is `Obj` from the detected `constructor` type |
777777

778778
The **return value** is a `boolean` indicating whether or not the `value` is an instance of a generic `Obj`.
779779

0 commit comments

Comments
 (0)