Skip to content

Commit a105ef0

Browse files
docs(README.md): add description to experimental
1 parent 10c4330 commit a105ef0

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -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 handles creating and getting the [`BigInt`][bigint] with `BigInt()`.
1504+
The object handles creating and getting the [`BigInt`][bigint] with [`BigInt()`][bigintconstructor].
15051505

15061506
```typescript
15071507
class BigIntObject {
@@ -1514,11 +1514,23 @@ class BigIntObject {
15141514
}
15151515
```
15161516

1517+
Create a new [`BigInt`][bigint] by assign value to the `set` property.
1518+
1519+
```typescript
1520+
BigIntObject.set = 1n;
1521+
```
1522+
1523+
Get created [`BigInt`][bigint] with the `get` property.
1524+
1525+
```typescript
1526+
const bigint: BigIntObject = BigIntObject.get;
1527+
```
1528+
15171529
----
15181530

15191531
### BooleanObject
15201532

1521-
The object handles creating and getting the [`Boolean`][boolean] object instance with `Boolean()`.
1533+
The object handles creating and getting the [`Boolean`][boolean] object instance with [`Boolean()`][booleanconstructor].
15221534

15231535
```typescript
15241536
class BooleanObject {
@@ -1544,14 +1556,14 @@ BooleanObject.set = false;
15441556
Get created [`Boolean`][boolean] instance with the `get` property.
15451557

15461558
```typescript
1547-
const instance: Boolean = BooleanObject.get;
1559+
const booleanInstance: Boolean = BooleanObject.get;
15481560
```
15491561

15501562
----
15511563

15521564
### NumberObject
15531565

1554-
The object handles creating and getting the [`Number`][number] object instance with `Number()`.
1566+
The object handles creating and getting the [`Number`][number] object instance with [`Number()`][numberconstructor].
15551567

15561568
```typescript
15571569
class NumberObject {
@@ -1573,7 +1585,7 @@ NumberObject.set = 'my number instance';
15731585
Get created [`Number`][number] instance with the `get` property.
15741586

15751587
```typescript
1576-
const instance: Number = NumberObject.get;
1588+
const numberInstance: Number = NumberObject.get;
15771589
```
15781590

15791591
----
@@ -1596,7 +1608,7 @@ class PrimitiveObject {
15961608

15971609
### StringObject
15981610

1599-
The object handles creating and getting the [`String`][string] object instance with `String()`.
1611+
The object handles creating and getting the [`String`][string] object instance with [`String()`][stringconstructor].
16001612

16011613
```typescript
16021614
class StringObject {
@@ -1618,7 +1630,7 @@ StringObject.set = 'my string instance';
16181630
Get created [`String`][string] instance with the `get` property.
16191631

16201632
```typescript
1621-
const instance: String = StringObject.get;
1633+
const stringInstance: String = StringObject.get;
16221634
```
16231635

16241636
----
@@ -1833,12 +1845,24 @@ MIT © angular-package ([license](https://github.com/angular-package/type/blob/m
18331845
[resultcallback]: #resultcallback
18341846

18351847
[array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
1848+
1849+
[bigint]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt
1850+
[bigintconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt/BigInt
1851+
18361852
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
1853+
[booleanconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean/Boolean
1854+
18371855
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Functions
18381856
[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number
1857+
[numberconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/Number
1858+
18391859
[object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
18401860
[primitive]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive
1861+
18411862
[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
1863+
[stringconstructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/String
1864+
1865+
[symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
18421866

18431867
[new]: https://img.shields.io/badge/-new-red
18441868

0 commit comments

Comments
 (0)