Skip to content

Commit 4dfb778

Browse files
docs(README.md): update
1 parent 9026c8c commit 4dfb778

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -140,29 +140,35 @@ Checks if **any** value is
140140
* an [`Array`][js-array] of any type with [`isArray()`](#isarray).
141141
* a `bigint` with [`isBigInt()`](#isbigint).
142142
* a `boolean` with [`isBoolean()`](#isboolean).
143-
* an `object`type and instance of [`Boolean`][boolean] and [`Object`][js-object] with [`isBooleanObject()`](#isbooleanobject).
144-
* a `boolean` type not an instance of [`Boolean`][boolean] and [`Object`][js-object], and equal to `true` or `false` with [`isBooleanType()`](#isbooleantype).
143+
* an `object`type and instance of [`Boolean`][js-boolean] and [`Object`][js-object] with [`isBooleanObject()`](#isbooleanobject).
144+
* a `boolean` type not an instance of [`Boolean`][js-boolean] and [`Object`][js-object], and equal to `true` or `false` with [`isBooleanType()`](#isbooleantype).
145145
* a `class` with [`isClass()`](#isclass).
146+
* a [`Date`][js-date] with [`isDate()`](#isdate).
147+
* defined with [`isDefined()`](#isdefined).
148+
* `false` with [`isFalse()`](#isfalse).
146149
* a `function` with [`isFunction()`](#isfunction).
147150
* a generic type `instance` with [`isInstance()`](#isinstance).
148151
* a [`Key`][key] type with [`isKey()`](#iskey).
149152
* a `null` with [`isNull()`](#isnull).
150153
* a `number` with [`isNumber()`](#isnumber).
154+
* a `number` between the specified range with [`isNumberBetween()`](#isnumberbetween).
151155
* an `object` type and instance of [`Number`][js-number] and [`Object`][js-object] with [`isNumberObject()`](#isnumberobject).
152156
* a `number` type and **not** instance of [`Number`][js-number] and [`Object`][js-object] with [`isNumberType()`](#isnumbertype).
153157
* a generic type `object` with [`isObject()`](#isobject).
154158
* an `object` with its own specified [`Key`][key] with [`isObjectKey()`](#isobjectkey).
155159
* an `object` with the [`Key`][key] by using the [`in`][js-in-operator] operator with [`isObjectKeyIn()`](#isobjectkeyin).
156160
* an `object` with some of its own specified [`Key`][key] with [`isObjectKeys()`](#isobjectkeys).
157-
* a one of the primitive `boolean`, `bigint`, `number`, `string` with [`isPrimitive()`](#isPrimitive).
161+
* a one of the primitive `boolean`, `bigint`, `number`, `string` with [`isPrimitive()`](#isprimitive).
162+
* a regular expression of a `RegExp` type with [`isRegExp()`](#isregexp).
158163
* a `string` with [`isString()`](#isstring).
164+
* a `string` with the specified length with [`isStringLength`](#isstringlength).
159165
* an `object` type and instance of [`String`][js-string] and [`Object`][js-object] with [`isStringObject()`](#isstringobject).
160166
* a `string` type and **not** instance of [`String`][js-string] and [`Object`][js-object] with [`isStringType()`](#isstringtype).
161-
* a `symbol` with [`isSymbol()`](#isSymbol).
167+
* a `symbol` with [`isSymbol()`](#issymbol).
168+
* `true` with [`isTrue()`](#istrue).
162169
* a generic type instance, `function`, `object` or primitive type with [`isType()`](#istype).
163170
* a `undefined` with [`isUndefined()`](#isundefined).
164171
* a generic type value is
165-
* defined with [`isDefined()`](#isdefined).
166172
* **not**
167173
* a `boolean` with [`isNotBoolean()`](#isnotboolean)
168174
* a `function` with [`isNotFunction()`](#isnotfunction)
@@ -209,12 +215,6 @@ Guard
209215
* [Skeleton](#skeleton)
210216
* [Callback](#callback)
211217
* [Check](#check)
212-
* Function
213-
* [`typeOf()`](#typeof)
214-
* Object
215-
* [`are`](#are)
216-
* [`is`](#is)
217-
* [`isNot`](#isnot)
218218
* [Guard](#guard)
219219
* [Common types](#common-types)
220220
* [Experimental](#experimental)
@@ -502,7 +502,7 @@ isBigInt(BIGINT); // true
502502

503503
### `isBoolean()`
504504

505-
Use `isBoolean()` or `is.boolean()` to check if **any** `value` is a `boolean` type not instance of [`Boolean`][boolean] and [`Object`][js-object] or `object` type instance of [`Boolean`][boolean] and [`Object`][js-object].
505+
Use `isBoolean()` or `is.boolean()` to check if **any** `value` is a `boolean` type not instance of [`Boolean`][js-boolean] and [`Object`][js-object] or `object` type instance of [`Boolean`][js-boolean] and [`Object`][js-object].
506506

507507
```typescript
508508
const isBoolean: IsBoolean = (
@@ -529,7 +529,7 @@ const isBoolean: IsBoolean = (
529529
| :----------------- | :-------: | :---------------------------------------------------------------- |
530530
| `value is boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement |
531531

532-
The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type or [`Boolean`][boolean] instance.
532+
The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type or [`Boolean`][js-boolean] instance.
533533

534534
**Usage:**
535535

@@ -551,7 +551,7 @@ isBoolean(BOOLEAN_INSTANCE); // true
551551

552552
### `isBooleanObject()`
553553

554-
Use `isBooleanObject()` or `is.booleanObject()` to check if **any** `value` is an `object` type and instance of [`Boolean`][boolean] and [`Object`][js-object].
554+
Use `isBooleanObject()` or `is.booleanObject()` to check if **any** `value` is an `object` type and instance of [`Boolean`][js-boolean] and [`Object`][js-object].
555555

556556
```typescript
557557
const isBooleanObject: IsBooleanObject = (
@@ -577,9 +577,9 @@ const isBooleanObject: IsBooleanObject = (
577577

578578
| Returns | Type | Description |
579579
| :----------------- | :-------: | :--------------------------------------------------------------------------------------------------------------- |
580-
| `value is Boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement indicating the `value` is [`Boolean`][boolean] |
580+
| `value is Boolean` | `boolean` | The **return type** is a `boolean` as the result of its statement indicating the `value` is [`Boolean`][js-boolean] |
581581

582-
The **return value** is a `boolean` indicating whether or not the `value` is a [`Boolean`][boolean] instance.
582+
The **return value** is a `boolean` indicating whether or not the `value` is a [`Boolean`][js-boolean] instance.
583583

584584
**Usage:**
585585

@@ -598,7 +598,7 @@ isBooleanObject(BOOLEAN_INSTANCE); // true
598598

599599
### `isBooleanType()`
600600

601-
Use `isBooleanType()` or `is.booleanType()` to check if **any** `value` is a `boolean` type not an instance of [`Boolean`][boolean] and [`Object`][js-object], and equal to `true` or `false`.
601+
Use `isBooleanType()` or `is.booleanType()` to check if **any** `value` is a `boolean` type not an instance of [`Boolean`][js-boolean] and [`Object`][js-object], and equal to `true` or `false`.
602602

603603
```typescript
604604
const isBooleanType: IsBooleanType = (
@@ -2290,7 +2290,7 @@ const isNot: IsNot = {
22902290

22912291
### `isNotBoolean()`
22922292

2293-
Use `isNotBoolean()` or `is.not.boolean()` to check if a generic `Type` `value` is **not** a `boolean` type and **not** an instance of a [`Boolean`][boolean].
2293+
Use `isNotBoolean()` or `is.not.boolean()` to check if a generic `Type` `value` is **not** a `boolean` type and **not** an instance of a [`Boolean`][js-boolean].
22942294

22952295
```typescript
22962296
const isNotBoolean: IsNotBoolean = <Type>(
@@ -2322,9 +2322,9 @@ const isNotBoolean: IsNotBoolean = <Type>(
23222322

23232323
| Returns | Type | Description |
23242324
| :--------------------------------- | :-------: | :--------------------------------- |
2325-
| `value is Never<AnyBoolean, Type>` | `boolean` | By default `Type` variable is equal to the type detected from the `value`, but the detected type `boolean` or [`Boolean`][boolean] changes to `never` and the **return type** is a `boolean` as the result of its statement `value` is **never** of [`AnyBoolean`](#anyboolean) type but of type detected from the `value` |
2325+
| `value is Never<AnyBoolean, Type>` | `boolean` | By default `Type` variable is equal to the type detected from the `value`, but the detected type `boolean` or [`Boolean`][js-boolean] changes to `never` and the **return type** is a `boolean` as the result of its statement `value` is **never** of [`AnyBoolean`](#anyboolean) type but of type detected from the `value` |
23262326

2327-
The **return value** is a `boolean` indicating whether or not the `value` is not a `boolean` and [`Boolean`][boolean] instance.
2327+
The **return value** is a `boolean` indicating whether or not the `value` is not a `boolean` and [`Boolean`][js-boolean] instance.
23282328

23292329
**Usage:**
23302330

@@ -2802,7 +2802,7 @@ const guardBoolean: GuardBoolean = <B extends AnyBoolean>(
28022802
| :----------- | :-------: | :---------------------------------------------------------------- |
28032803
| `value is B` | `boolean` | By default `B` variable is equal to the type detected from the `value` and the **return type** is a `boolean` as the result of its statement indicating the `value` is of [`AnyBoolean`](#anyboolean) type detected from the `value` |
28042804

2805-
The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type or [`Boolean`][boolean] instance.
2805+
The **return value** is a `boolean` indicating whether or not the `value` is a `boolean` type or [`Boolean`][js-boolean] instance.
28062806

28072807
----
28082808

@@ -3833,7 +3833,7 @@ const bigint: BigIntObject = BigIntObject.get;
38333833

38343834
### BooleanObject
38353835

3836-
The object handles creating and getting the [`Boolean`][boolean] object instance with [`Boolean()`][booleanconstructor].
3836+
The object handles creating and getting the [`Boolean`][js-boolean] object instance with [`Boolean()`][booleanconstructor].
38373837

38383838
```typescript
38393839
class BooleanObject {
@@ -3850,13 +3850,13 @@ class BooleanObject {
38503850
}
38513851
```
38523852

3853-
Create a new [`Boolean`][boolean] instance by assign value to the `set` property.
3853+
Create a new [`Boolean`][js-boolean] instance by assign value to the `set` property.
38543854

38553855
```typescript
38563856
BooleanObject.set = false;
38573857
```
38583858

3859-
Get created [`Boolean`][boolean] instance with the `get` property.
3859+
Get created [`Boolean`][js-boolean] instance with the `get` property.
38603860

38613861
```typescript
38623862
const booleanInstance: Boolean = BooleanObject.get;
@@ -4159,7 +4159,6 @@ MIT © angular-package ([license][property-badge-license])
41594159
[bigint]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt
41604160
[bigintconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt/BigInt
41614161

4162-
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
41634162
[booleanconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean/Boolean
41644163

41654164
[js-error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error

0 commit comments

Comments
 (0)