squiggle/packages/website/docs/Api/Duration.mdx

77 lines
824 B
Plaintext
Raw Normal View History

2022-06-05 20:59:45 +00:00
---
2022-06-11 00:35:48 +00:00
sidebar_position: 6
2022-06-05 20:59:45 +00:00
title: Duration
---
import TOCInline from "@theme/TOCInline";
<TOCInline toc={toc} />
2022-06-05 20:59:45 +00:00
### toString
2022-06-06 05:16:29 +00:00
```
toString: (duration) => string
2022-06-05 20:59:45 +00:00
```
## Units
2022-06-06 05:16:29 +00:00
### minutes
```
minutes: (number) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### hours
```
hours: (number) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### days
```
days: (number) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### years
```
years: (number) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### toHours
```
2022-06-11 00:35:48 +00:00
toHours: (duration) => number
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### toMinutes
```
2022-06-11 00:35:48 +00:00
toMinutes: (duration) => number
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### toDays
```
2022-06-11 00:35:48 +00:00
toDays: (duration) => number
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### toYears
```
2022-06-11 00:35:48 +00:00
toYears: (duration) => number
2022-06-05 20:59:45 +00:00
```
## Algebra
2022-06-06 05:16:29 +00:00
### add
```
add: (duration, duration) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### subtract
```
subtract: (duration, duration) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### multiply
```
2022-06-11 00:35:48 +00:00
multiply: (duration, number) => duration
2022-06-05 20:59:45 +00:00
```
2022-06-06 05:16:29 +00:00
### divide
```
2022-06-11 00:35:48 +00:00
divide: (duration, number) => duration
```