Skip to content

Commit 10c4330

Browse files
docs(README.md): update
1 parent 4d5087c commit 10c4330

File tree

1 file changed

+63
-15
lines changed

1 file changed

+63
-15
lines changed

README.md

Lines changed: 63 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ import { Constructor, CycleHook, Func, Key, Primitive, Primitives, ResultCallbac
9898

9999
* Checks if
100100
* **any** value is
101-
* an `Array` of any type with [`isArray()`](#isarray).
102-
* a `bigint` type with [`isBigInt()`](#isbigint).
101+
* an [`Array`][array] of any type with [`isArray()`](#isarray).
102+
* a `bigint` with [`isBigInt()`](#isbigint).
103103
* a `boolean` with [`isBoolean()`](#isboolean).
104104
* an `object`type and instance of [`Boolean`][boolean] and [`Object`][object] with [`isBooleanObject()`](#isbooleanobject).
105105
* a `boolean` type not an instance of [`Boolean`][boolean] and [`Object`][object], and equal to `true` or `false` with [`isBooleanType()`](#isbooleantype).
@@ -118,21 +118,21 @@ import { Constructor, CycleHook, Func, Key, Primitive, Primitives, ResultCallbac
118118
* a `string` type and **not** instance of [`String`][string] and [`Object`][object] with [`isStringType()`](#isstringtype).
119119
* a `symbol` with [`isSymbol()`](#isSymbol).
120120
* a generic type instance, `function`, `object` or primitive type with [`isType()`](#istype).
121-
* a `undefined` type with [`isUndefined()`](#isundefined).
121+
* a `undefined` with [`isUndefined()`](#isundefined).
122122
* an **unknown** value is
123123
* defined with [`isDefined()`](#isdefined).
124124
* an **unknown** value is **not** a
125-
* `boolean` type with [`isNotBoolean()`](#isnotboolean)
126-
* `function` type with [`isNotFunction()`](#isnotfunction)
127-
* `null` type with [`isNotNull()`](#isnotnull)
128-
* `number` type with [`isNotNumber()`](#isnotnumber)
129-
* `string` type with [`isNotString()`](#isnotstring)
130-
* `undefined` type with [`isNotUndefined()`](#isnotundefined)
125+
* `boolean` with [`isNotBoolean()`](#isnotboolean)
126+
* `function` with [`isNotFunction()`](#isnotfunction)
127+
* `null` with [`isNotNull()`](#isnotnull)
128+
* `number` with [`isNotNumber()`](#isnotnumber)
129+
* `string` with [`isNotString()`](#isnotstring)
130+
* `undefined` with [`isNotUndefined()`](#isnotundefined)
131131
* Guard the value to be
132132
* an [`Array`][array] of a generic type with [`guardArray()`](#guardarray).
133133
* a `bigint` with [`guardBigInt()`](#guardbigint).
134134
* a `boolean` with [`guardBoolean()`](#guardboolean).
135-
* a `function` type with [`guardFunction()`](#guardfunction).
135+
* a [`Func`](#func) type with [`guardFunction()`](#guardfunction).
136136
* an instance with [`guardInstance()`](#guardinstance).
137137
* a `null` with [`guardNull()`](#guardnull).
138138
* a [`Key`](#Key) with [`guardKey()`](#guardkey).
@@ -1501,7 +1501,7 @@ The **return value** is a `boolean` indicating whether or not the `value` is `un
15011501

15021502
### BigIntObject
15031503

1504-
The object to create [`BigInt`][bigint] object by assign value to `set` property.
1504+
The object handles creating and getting the [`BigInt`][bigint] with `BigInt()`.
15051505

15061506
```typescript
15071507
class BigIntObject {
@@ -1518,7 +1518,7 @@ class BigIntObject {
15181518

15191519
### BooleanObject
15201520

1521-
The object to create [`Boolean`][boolean] object by assign value to `set` property.
1521+
The object handles creating and getting the [`Boolean`][boolean] object instance with `Boolean()`.
15221522

15231523
```typescript
15241524
class BooleanObject {
@@ -1535,11 +1535,23 @@ class BooleanObject {
15351535
}
15361536
```
15371537

1538+
Create a new [`Boolean`][boolean] instance by assign value to the `set` property.
1539+
1540+
```typescript
1541+
BooleanObject.set = false;
1542+
```
1543+
1544+
Get created [`Boolean`][boolean] instance with the `get` property.
1545+
1546+
```typescript
1547+
const instance: Boolean = BooleanObject.get;
1548+
```
1549+
15381550
----
15391551

15401552
### NumberObject
15411553

1542-
The object to create [`Number`][number] object by assign value to `set` property.
1554+
The object handles creating and getting the [`Number`][number] object instance with `Number()`.
15431555

15441556
```typescript
15451557
class NumberObject {
@@ -1552,6 +1564,18 @@ class NumberObject {
15521564
}
15531565
```
15541566

1567+
Create a new [`Number`][number] instance by assign value to the `set` property.
1568+
1569+
```typescript
1570+
NumberObject.set = 'my number instance';
1571+
```
1572+
1573+
Get created [`Number`][number] instance with the `get` property.
1574+
1575+
```typescript
1576+
const instance: Number = NumberObject.get;
1577+
```
1578+
15551579
----
15561580

15571581
### PrimitiveObject
@@ -1572,7 +1596,7 @@ class PrimitiveObject {
15721596

15731597
### StringObject
15741598

1575-
The object to create [`String`][string] object by assign value to `set` property.
1599+
The object handles creating and getting the [`String`][string] object instance with `String()`.
15761600

15771601
```typescript
15781602
class StringObject {
@@ -1585,11 +1609,23 @@ class StringObject {
15851609
}
15861610
```
15871611

1612+
Create a new [`String`][string] instance by assign value to the `set` property.
1613+
1614+
```typescript
1615+
StringObject.set = 'my string instance';
1616+
```
1617+
1618+
Get created [`String`][string] instance with the `get` property.
1619+
1620+
```typescript
1621+
const instance: String = StringObject.get;
1622+
```
1623+
15881624
----
15891625

15901626
### SymbolObject
15911627

1592-
The object to create [`Symbol`][symbol] object by assign value to `set` property.
1628+
The object handles creating and getting the `symbol` object instance with `Symbol()`.
15931629

15941630
```typescript
15951631
class SymbolObject {
@@ -1602,6 +1638,18 @@ class SymbolObject {
16021638
}
16031639
```
16041640

1641+
Create a new `symbol` by assigning value to the `set` property.
1642+
1643+
```typescript
1644+
SymbolObject.set = 'my symbol';
1645+
```
1646+
1647+
Get created `symbol` with the `get` property.
1648+
1649+
```typescript
1650+
const symbol: Symbol = SymbolObject.get;
1651+
```
1652+
16051653
----
16061654

16071655
### isParam

0 commit comments

Comments
 (0)