deno.land / std@0.224.0 / fmt / duration.ts

duration.ts
View Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
/** * Format milliseconds to time duration. * * ```ts * import { format } from "https://deno.land/std@$STD_VERSION/fmt/duration.ts"; * * // "00:00:01:39:674:000:000" * format(99674, { style: "digital" }); * * // "0d 0h 1m 39s 674ms 0µs 0ns" * format(99674); * * // "1m 39s 674ms" * format(99674, { ignoreZero: true }); * * // "1 minutes, 39 seconds, 674 milliseconds" * format(99674, { style: "full", ignoreZero: true }); * ``` * @module */
function addZero(num: number, digits: number) { return String(num).padStart(digits, "0");}
interface DurationObject { d: number; h: number; m: number; s: number; ms: number; us: number; ns: number;}
const keyList: Record<keyof DurationObject, string> = { d: "days", h: "hours", m: "minutes", s: "seconds", ms: "milliseconds", us: "microseconds", ns: "nanoseconds",};
/** Parse milliseconds into a duration. */function millisecondsToDurationObject(ms: number): DurationObject { // Duration cannot be negative const millis = Math.abs(ms); const millisFraction = millis.toFixed(7).slice(-7, -1); return { d: Math.trunc(millis / 86400000), h: Math.trunc(millis / 3600000) % 24, m: Math.trunc(millis / 60000) % 60, s: Math.trunc(millis / 1000) % 60, ms: Math.trunc(millis) % 1000, us: +millisFraction.slice(0, 3), ns: +millisFraction.slice(3, 6), };}
function durationArray( duration: DurationObject,): { type: keyof DurationObject; value: number }[] { return [ { type: "d", value: duration.d }, { type: "h", value: duration.h }, { type: "m", value: duration.m }, { type: "s", value: duration.s }, { type: "ms", value: duration.ms }, { type: "us", value: duration.us }, { type: "ns", value: duration.ns }, ];}
/** Options for {@linkcode format}. */export interface PrettyDurationOptions { /** * "narrow" for "0d 0h 0m 0s 0ms..." * "digital" for "00:00:00:00:000..." * "full" for "0 days, 0 hours, 0 minutes,..." */ style: "narrow" | "digital" | "full"; /** * Whether to ignore zero values. * With style="narrow" | "full", all zero values are ignored. * With style="digital", only values in the ends are ignored. */ ignoreZero: boolean;}
/** * Format milliseconds to time duration. * * ```ts * import { format } from "https://deno.land/std@$STD_VERSION/fmt/duration.ts"; * * format(99674, { style: "digital" }); // "00:00:01:39:674:000:000" * format(99674); // "0d 0h 1m 39s 674ms 0µs 0ns" * format(99674, { ignoreZero: true }); // "1m 39s 674ms" * format(99674, { style: "full", ignoreZero: true }); // "1 minutes, 39 seconds, 674 milliseconds" * ``` */export function format( ms: number, options: Partial<PrettyDurationOptions> = {},): string { const opt = Object.assign( { style: "narrow", ignoreZero: false }, options, ); const duration = millisecondsToDurationObject(ms); const durationArr = durationArray(duration); switch (opt.style) { case "narrow": { if (opt.ignoreZero) { return `${ durationArr.filter((x) => x.value).map((x) => `${x.value}${x.type === "us" ? "µs" : x.type}` ) .join(" ") }`; } return `${ durationArr.map((x) => `${x.value}${x.type === "us" ? "µs" : x.type}`) .join(" ") }`; } case "full": { if (opt.ignoreZero) { return `${ durationArr.filter((x) => x.value).map((x) => `${x.value} ${keyList[x.type]}` ).join(", ") }`; } return `${ durationArr.map((x) => `${x.value} ${keyList[x.type]}`).join(", ") }`; } case "digital": { const arr = durationArr.map((x) => ["ms", "us", "ns"].includes(x.type) ? addZero(x.value, 3) : addZero(x.value, 2) ); if (opt.ignoreZero) { let cont = true; while (cont) { if (!Number(arr[arr.length - 1])) arr.pop(); else cont = false; } } return arr.join(":"); } default: { throw new TypeError(`style must be "narrow", "full", or "digital"!`); } }}
std

Version Info

Tagged at
6 months ago