@guillaume-docquier/tools-ts 8.1.0 → 8.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/measurements/Angle.d.ts +2 -2
- package/dist/measurements/Angle.js.map +1 -1
- package/dist/measurements/Distance.d.ts +2 -2
- package/dist/measurements/Distance.js.map +1 -1
- package/dist/measurements/Time.d.ts +4 -3
- package/dist/measurements/Time.js +2 -0
- package/dist/measurements/Time.js.map +1 -1
- package/dist/utility-types.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -127,7 +127,7 @@ Use these helpers for quick profiling.
|
|
|
127
127
|
|
|
128
128
|
| Export | What it is | Use it when |
|
|
129
129
|
| ---------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
130
|
-
| `Angle`, `UnitOfAngle` | An angle measurement and its supported
|
|
130
|
+
| `Angle`, `UnitOfAngle` | An angle measurement and its supported units. | You need to represent angles and convert between units. |
|
|
131
131
|
| `Time`, `UnitOfTime` | A time measurement and its supported units, with conversion and arithmetic tools. | You need unit-aware durations or calculations across different time units. |
|
|
132
132
|
| `Distance`, `UnitOfDistance` | A distance measurement and its supported units, with conversion and comparison. | You need unit-aware lengths, spatial comparisons, or distances between points. |
|
|
133
133
|
| `Point2D`, `XY` | A two-dimensional position and its plain coordinate-value shape. | You need 2D positions whose axes can use and convert between distance units. |
|
|
@@ -9,7 +9,7 @@ export declare enum UnitOfAngle {
|
|
|
9
9
|
/**
|
|
10
10
|
* Represents an angle with its unit.
|
|
11
11
|
*/
|
|
12
|
-
export type Angle = Measurement<
|
|
12
|
+
export type Angle<TUnit extends UnitOfAngle = UnitOfAngle> = Measurement<TUnit>;
|
|
13
13
|
/**
|
|
14
14
|
* A set of functions to work with angles.
|
|
15
15
|
*/
|
|
@@ -17,7 +17,7 @@ export declare const Angle: {
|
|
|
17
17
|
/**
|
|
18
18
|
* Creates an angle.
|
|
19
19
|
*/
|
|
20
|
-
create(value: number, unit:
|
|
20
|
+
create<TUnit extends UnitOfAngle>(value: number, unit: TUnit): Angle<TUnit>;
|
|
21
21
|
/**
|
|
22
22
|
* Converts an angle to another unit.
|
|
23
23
|
* The provided angle is left untouched.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Angle.js","sourceRoot":"","sources":["../../src/measurements/Angle.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED,MAAM,iBAAiB,GAAgC;IACrD,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG;IACpC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;CACzB,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;OAEG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"Angle.js","sourceRoot":"","sources":["../../src/measurements/Angle.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED,MAAM,iBAAiB,GAAgC;IACrD,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG;IACpC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;CACzB,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;OAEG;IACH,MAAM,CAA4B,KAAa,EAAE,IAAW;QAC1D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAsB,EAAE,OAAoB;QAClD,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;YAC/B,IAAI,EAAE,OAAO;SACd,CAAA;IACH,CAAC;IAED;;OAEG;IACH,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAmB,EAAE,OAAoB;QACvD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACrB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,CAAC,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAA;IACvE,CAAC;CACF,CAAA"}
|
|
@@ -9,7 +9,7 @@ export declare enum UnitOfDistance {
|
|
|
9
9
|
/**
|
|
10
10
|
* Represents a distance with its unit
|
|
11
11
|
*/
|
|
12
|
-
export type Distance = Measurement<
|
|
12
|
+
export type Distance<TUnit extends UnitOfDistance = UnitOfDistance> = Measurement<TUnit>;
|
|
13
13
|
/**
|
|
14
14
|
* A set of functions to work with Distances.
|
|
15
15
|
*/
|
|
@@ -19,7 +19,7 @@ export declare const Distance: {
|
|
|
19
19
|
* @param value The value for the distance.
|
|
20
20
|
* @param unit The unit for the distance.
|
|
21
21
|
*/
|
|
22
|
-
create(value: number, unit:
|
|
22
|
+
create<TUnit extends UnitOfDistance>(value: number, unit: TUnit): Distance<TUnit>;
|
|
23
23
|
/**
|
|
24
24
|
* Converts a distance to another unit of distance.
|
|
25
25
|
* The provided distance is left untouched.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Distance.js","sourceRoot":"","sources":["../../src/measurements/Distance.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,6CAA2B,CAAA;IAC3B,2DAAyC,CAAA;IACzC,6CAA2B,CAAA;AAC7B,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAED;;;;;GAKG;AACH,MAAM,mBAAmB,GAAmC;IAC1D,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,KAAK;IACnC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1B,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE,eAAe;IACpD,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,qBAAqB;CACpD,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB;;;;OAIG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"Distance.js","sourceRoot":"","sources":["../../src/measurements/Distance.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,6CAA2B,CAAA;IAC3B,2DAAyC,CAAA;IACzC,6CAA2B,CAAA;AAC7B,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAED;;;;;GAKG;AACH,MAAM,mBAAmB,GAAmC;IAC1D,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,KAAK;IACnC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1B,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE,eAAe;IACpD,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,qBAAqB;CACpD,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB;;;;OAIG;IACH,MAAM,CAA+B,KAAa,EAAE,IAAW;QAC7D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAA4B,EAAE,OAAuB;QAC3D,OAAO;YACL,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;YACrC,IAAI,EAAE,OAAO;SACd,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAsB,EAAE,OAAuB;QAC7D,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACrB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,CAAC,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAA;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,SAA6B,EAAE,SAA6B,EAAE,SAA6B;QAClG,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;QAElG,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,KAAK,CAAA;IAChD,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,SAA4B,EAAE,SAA4B,EAAE,eAAgC;QACzG,MAAM,qBAAqB,GAAG,eAAe,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,CAAA;QACjE,MAAM,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;QAEzD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAEhH,OAAO,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,SAA4B,EAAE,SAA4B,EAAE,eAAgC;QAClG,MAAM,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,CAAA;QAC/E,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAE1C,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF,CAAA"}
|
|
@@ -6,17 +6,18 @@ export declare enum UnitOfTime {
|
|
|
6
6
|
MILLISECONDS = "milliseconds",
|
|
7
7
|
SECONDS = "seconds",
|
|
8
8
|
MINUTES = "minutes",
|
|
9
|
-
HOURS = "hours"
|
|
9
|
+
HOURS = "hours",
|
|
10
|
+
DAYS = "days"
|
|
10
11
|
}
|
|
11
12
|
/**
|
|
12
13
|
* Represents a time with its unit
|
|
13
14
|
*/
|
|
14
|
-
export type Time = Measurement<
|
|
15
|
+
export type Time<TUnit extends UnitOfTime = UnitOfTime> = Measurement<TUnit>;
|
|
15
16
|
/**
|
|
16
17
|
* A set of functions to work with Times.
|
|
17
18
|
*/
|
|
18
19
|
export declare const Time: {
|
|
19
|
-
create: (value: number, unit:
|
|
20
|
+
create: <TUnit extends UnitOfTime>(value: number, unit: TUnit) => Time<TUnit>;
|
|
20
21
|
/**
|
|
21
22
|
* Converts a time to another unit of time.
|
|
22
23
|
* The provided time is left untouched.
|
|
@@ -7,6 +7,7 @@ export var UnitOfTime;
|
|
|
7
7
|
UnitOfTime["SECONDS"] = "seconds";
|
|
8
8
|
UnitOfTime["MINUTES"] = "minutes";
|
|
9
9
|
UnitOfTime["HOURS"] = "hours";
|
|
10
|
+
UnitOfTime["DAYS"] = "days";
|
|
10
11
|
})(UnitOfTime || (UnitOfTime = {}));
|
|
11
12
|
/**
|
|
12
13
|
* The definition of factors of time, where the base unit is the second.
|
|
@@ -17,6 +18,7 @@ const TIME_PER_SECONDS = {
|
|
|
17
18
|
[UnitOfTime.SECONDS]: 1,
|
|
18
19
|
[UnitOfTime.MINUTES]: 1 / 60,
|
|
19
20
|
[UnitOfTime.HOURS]: 1 / 60 / 60,
|
|
21
|
+
[UnitOfTime.DAYS]: 1 / 60 / 60 / 24,
|
|
20
22
|
};
|
|
21
23
|
/**
|
|
22
24
|
* A set of functions to work with Times.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Time.js","sourceRoot":"","sources":["../../src/measurements/Time.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,
|
|
1
|
+
{"version":3,"file":"Time.js","sourceRoot":"","sources":["../../src/measurements/Time.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,2CAA6B,CAAA;IAC7B,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,6BAAe,CAAA;IACf,2BAAa,CAAA;AACf,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AAED;;;GAGG;AACH,MAAM,gBAAgB,GAA+B;IACnD,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,IAAI;IAC/B,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;IACvB,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE;IAC5B,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE;IAC/B,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;CACpC,CAAA;AAOD;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,MAAM,EAAE,CAA2B,KAAa,EAAE,IAAW,EAAe,EAAE;QAC5E,OAAO;YACL,KAAK;YACL,IAAI;SACL,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,IAAoB,EAAE,OAAmB;QAC/C,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC;YAC7B,IAAI,EAAE,OAAO;SACd,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,EAAE,CAAC,IAAoB,EAAE,OAAmB;QAC1C,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC/E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,KAAqB,EAAE,KAAqB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC1E,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAqB,EAAE,KAAqB;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC1E,CAAC;CACF,CAAA"}
|
package/dist/utility-types.d.ts
CHANGED