Skip to content

Commit 3b98456

Browse files
committed
docs: explain usage on conversion to primitive number
1 parent 0473a89 commit 3b98456

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import Time from 'time-chainer';
2929
setTimeout(() => {
3030
doSomething();
3131

32-
}, Time.seconds(5));
32+
}, +Time.seconds(5));
3333

3434
// 3 Days and 12 hours later from now
3535
new Date(
@@ -50,3 +50,19 @@ Time
5050
.weeks(1)
5151
; // 1,945,830,500
5252
```
53+
54+
## `TimeChainer` extends `Number`
55+
56+
Time Chainer extends `Number` object. In cases where a primitive number is strictly required, you will need to explicitly convert it to a primitive `number` by appending a `+` operator like this:
57+
58+
```js
59+
jest.advanceTimersByTime(+Time.days(30));
60+
```
61+
62+
See details:
63+
64+
```js
65+
Time.seconds(5) instanceof Number // true
66+
typeof Time.seconds(5) // "object"
67+
typeof +Time.seconds(5) // "number"
68+
```

0 commit comments

Comments
 (0)