@interstellar-tools/constants 0.2.0 → 0.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.
Files changed (13) hide show
  1. package/dist/date.d.ts +10 -10
  2. package/dist/date.js +10 -10
  3. package/dist/distance.d.ts +10 -10
  4. package/dist/distance.js +10 -10
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.js +1 -1
  7. package/dist/math.d.ts +1 -1
  8. package/dist/math.js +1 -1
  9. package/dist/objects.d.ts +10 -10
  10. package/dist/objects.js +10 -10
  11. package/dist/temporal.d.ts +5 -5
  12. package/dist/temporal.js +5 -5
  13. package/package.json +1 -1
package/dist/date.d.ts CHANGED
@@ -8,11 +8,11 @@
8
8
  *
9
9
  * :::
10
10
  *
11
- * @category Date
11
+ * @group Date
12
12
  */
13
13
  export declare const TIME_SCALE_UTC: "UTC";
14
14
  /**
15
- * @category Date
15
+ * @group Date
16
16
  */
17
17
  export declare const TIME_SCALE_TT: "TT";
18
18
  /**
@@ -29,12 +29,12 @@ export declare const TIME_SCALE_TT: "TT";
29
29
  * // If you need the TT-based Julian centuries since J2000:
30
30
  * // T = (JD_TT - J2000_TT) / 36525
31
31
  * // Compute JD_TT from a UTC Date using your UTC→TT→JD pipeline, then use J2000_TT.
32
- * @category Date
32
+ * @group Date
33
33
  */
34
34
  export declare const J2000_UTC: Date;
35
35
  /**
36
36
  * Time scale associated with {@link J2000_UTC}.
37
- * @category Date
37
+ * @group Date
38
38
  */
39
39
  export declare const J2000_UTC_TIME_SCALE: "UTC";
40
40
  /**
@@ -46,12 +46,12 @@ export declare const J2000_UTC_TIME_SCALE: "UTC";
46
46
  *
47
47
  * :::
48
48
  *
49
- * @category Date
49
+ * @group Date
50
50
  */
51
51
  export declare const EPOCH_2000_UTC_MIDNIGHT: Date;
52
52
  /**
53
53
  * Time scale associated with {@link EPOCH_2000_UTC_MIDNIGHT}.
54
- * @category Date
54
+ * @group Date
55
55
  */
56
56
  export declare const EPOCH_2000_UTC_MIDNIGHT_TIME_SCALE: "UTC";
57
57
  /**
@@ -62,7 +62,7 @@ export declare const EPOCH_2000_UTC_MIDNIGHT_TIME_SCALE: "UTC";
62
62
  * @example
63
63
  * // Julian centuries since J2000 in TT:
64
64
  * // const T = (jdTT - J2000_TT) / 36525;
65
- * @category Date
65
+ * @group Date
66
66
  */
67
67
  export declare const J2000_TT: 2451545;
68
68
  /**
@@ -72,7 +72,7 @@ export declare const J2000_TT: 2451545;
72
72
  * @example
73
73
  * // When computing Julian centuries:
74
74
  * // T = (JD_TT - J2000_TT) / 36525
75
- * @category Date
75
+ * @group Date
76
76
  */
77
77
  export declare const J2000_EPOCH_TIME_SCALE: "TT";
78
78
  /**
@@ -87,11 +87,11 @@ export declare const J2000_EPOCH_TIME_SCALE: "TT";
87
87
  * specific to the J2000 epoch.
88
88
  *
89
89
  * :::
90
- * @category Date
90
+ * @group Date
91
91
  */
92
92
  export declare const TT_MINUS_UTC_AT_J2000_SECONDS = 64.184;
93
93
  /**
94
- * @category Date
94
+ * @group Date
95
95
  */
96
96
  export declare const TT_MINUS_UTC_AT_J2000_MS = 64184;
97
97
  //# sourceMappingURL=date.d.ts.map
package/dist/date.js CHANGED
@@ -8,11 +8,11 @@
8
8
  *
9
9
  * :::
10
10
  *
11
- * @category Date
11
+ * @group Date
12
12
  */
13
13
  export const TIME_SCALE_UTC = 'UTC';
14
14
  /**
15
- * @category Date
15
+ * @group Date
16
16
  */
17
17
  export const TIME_SCALE_TT = 'TT';
18
18
  /**
@@ -29,12 +29,12 @@ export const TIME_SCALE_TT = 'TT';
29
29
  * // If you need the TT-based Julian centuries since J2000:
30
30
  * // T = (JD_TT - J2000_TT) / 36525
31
31
  * // Compute JD_TT from a UTC Date using your UTC→TT→JD pipeline, then use J2000_TT.
32
- * @category Date
32
+ * @group Date
33
33
  */
34
34
  export const J2000_UTC = new Date('2000-01-01T11:58:55.816Z');
35
35
  /**
36
36
  * Time scale associated with {@link J2000_UTC}.
37
- * @category Date
37
+ * @group Date
38
38
  */
39
39
  export const J2000_UTC_TIME_SCALE = TIME_SCALE_UTC;
40
40
  /**
@@ -46,12 +46,12 @@ export const J2000_UTC_TIME_SCALE = TIME_SCALE_UTC;
46
46
  *
47
47
  * :::
48
48
  *
49
- * @category Date
49
+ * @group Date
50
50
  */
51
51
  export const EPOCH_2000_UTC_MIDNIGHT = new Date('2000-01-01T00:00:00Z');
52
52
  /**
53
53
  * Time scale associated with {@link EPOCH_2000_UTC_MIDNIGHT}.
54
- * @category Date
54
+ * @group Date
55
55
  */
56
56
  export const EPOCH_2000_UTC_MIDNIGHT_TIME_SCALE = TIME_SCALE_UTC;
57
57
  /**
@@ -62,7 +62,7 @@ export const EPOCH_2000_UTC_MIDNIGHT_TIME_SCALE = TIME_SCALE_UTC;
62
62
  * @example
63
63
  * // Julian centuries since J2000 in TT:
64
64
  * // const T = (jdTT - J2000_TT) / 36525;
65
- * @category Date
65
+ * @group Date
66
66
  */
67
67
  export const J2000_TT = 2451545.0;
68
68
  /**
@@ -72,7 +72,7 @@ export const J2000_TT = 2451545.0;
72
72
  * @example
73
73
  * // When computing Julian centuries:
74
74
  * // T = (JD_TT - J2000_TT) / 36525
75
- * @category Date
75
+ * @group Date
76
76
  */
77
77
  export const J2000_EPOCH_TIME_SCALE = TIME_SCALE_TT;
78
78
  /**
@@ -87,11 +87,11 @@ export const J2000_EPOCH_TIME_SCALE = TIME_SCALE_TT;
87
87
  * specific to the J2000 epoch.
88
88
  *
89
89
  * :::
90
- * @category Date
90
+ * @group Date
91
91
  */
92
92
  export const TT_MINUS_UTC_AT_J2000_SECONDS = 64.184;
93
93
  /**
94
- * @category Date
94
+ * @group Date
95
95
  */
96
96
  export const TT_MINUS_UTC_AT_J2000_MS = 64184;
97
97
  //# sourceMappingURL=date.js.map
package/dist/distance.d.ts CHANGED
@@ -14,12 +14,12 @@
14
14
  */
15
15
  /**
16
16
  * Speed of light in vacuum, **exact** per SI (m·s⁻¹).
17
- * @category Distance
17
+ * @group Distance
18
18
  */
19
19
  export declare const SPEED_OF_LIGHT_M_PER_S: 299792458;
20
20
  /**
21
21
  * Astronomical unit in meters, **exact** (IAU 2012 B2).
22
- * @category Distance
22
+ * @group Distance
23
23
  */
24
24
  export declare const AU_METERS: 149597870700;
25
25
  /**
@@ -31,7 +31,7 @@ export declare const AU_METERS: 149597870700;
31
31
  *
32
32
  * :::
33
33
  *
34
- * @category Distance
34
+ * @group Distance
35
35
  */
36
36
  export declare const METERS_PER_LY: number;
37
37
  /**
@@ -43,7 +43,7 @@ export declare const METERS_PER_LY: number;
43
43
  *
44
44
  * :::
45
45
  *
46
- * @category Distance
46
+ * @group Distance
47
47
  */
48
48
  export declare const RADIANS_PER_ARCSECOND: number;
49
49
  /**
@@ -55,7 +55,7 @@ export declare const RADIANS_PER_ARCSECOND: number;
55
55
  *
56
56
  * :::
57
57
  *
58
- * @category Distance
58
+ * @group Distance
59
59
  */
60
60
  export declare const METERS_PER_PC: number;
61
61
  /**
@@ -67,17 +67,17 @@ export declare const METERS_PER_PC: number;
67
67
  *
68
68
  * :::
69
69
  *
70
- * @category Distance
70
+ * @group Distance
71
71
  */
72
72
  export declare const AU_PER_LY: number;
73
73
  /**
74
74
  * Light-years per astronomical unit (reciprocal of {@link AU_PER_LY}).
75
- * @category Distance
75
+ * @group Distance
76
76
  */
77
77
  export declare const LY_PER_AU: number;
78
78
  /**
79
79
  * Kilometers in one astronomical unit.
80
- * @category Distance
80
+ * @group Distance
81
81
  */
82
82
  export declare const KM_PER_AU: number;
83
83
  /**
@@ -89,12 +89,12 @@ export declare const KM_PER_AU: number;
89
89
  *
90
90
  * :::
91
91
  *
92
- * @category Distance
92
+ * @group Distance
93
93
  */
94
94
  export declare const LY_PER_PC: number;
95
95
  /**
96
96
  * Parsecs per light-year (reciprocal of {@link LY_PER_PC}).
97
- * @category Distance
97
+ * @group Distance
98
98
  */
99
99
  export declare const PC_PER_LY: number;
100
100
  //# sourceMappingURL=distance.d.ts.map
package/dist/distance.js CHANGED
@@ -16,12 +16,12 @@ import { JULIAN_YEAR_SECONDS } from './temporal';
16
16
  // Base physical/constants
17
17
  /**
18
18
  * Speed of light in vacuum, **exact** per SI (m·s⁻¹).
19
- * @category Distance
19
+ * @group Distance
20
20
  */
21
21
  export const SPEED_OF_LIGHT_M_PER_S = 299792458; // exact (SI)
22
22
  /**
23
23
  * Astronomical unit in meters, **exact** (IAU 2012 B2).
24
- * @category Distance
24
+ * @group Distance
25
25
  */
26
26
  export const AU_METERS = 149597870700;
27
27
  /**
@@ -33,7 +33,7 @@ export const AU_METERS = 149597870700;
33
33
  *
34
34
  * :::
35
35
  *
36
- * @category Distance
36
+ * @group Distance
37
37
  */
38
38
  export const METERS_PER_LY = SPEED_OF_LIGHT_M_PER_S * JULIAN_YEAR_SECONDS; // 9_460_730_472_580_800
39
39
  /**
@@ -45,7 +45,7 @@ export const METERS_PER_LY = SPEED_OF_LIGHT_M_PER_S * JULIAN_YEAR_SECONDS; // 9_
45
45
  *
46
46
  * :::
47
47
  *
48
- * @category Distance
48
+ * @group Distance
49
49
  */
50
50
  export const RADIANS_PER_ARCSECOND = Math.PI / 648000;
51
51
  /**
@@ -57,7 +57,7 @@ export const RADIANS_PER_ARCSECOND = Math.PI / 648000;
57
57
  *
58
58
  * :::
59
59
  *
60
- * @category Distance
60
+ * @group Distance
61
61
  */
62
62
  export const METERS_PER_PC = AU_METERS / Math.tan(RADIANS_PER_ARCSECOND); // ≈ 3.08567758149e16
63
63
  // Helpful ratios (derive from the above to avoid drift)
@@ -70,17 +70,17 @@ export const METERS_PER_PC = AU_METERS / Math.tan(RADIANS_PER_ARCSECOND); // ≈
70
70
  *
71
71
  * :::
72
72
  *
73
- * @category Distance
73
+ * @group Distance
74
74
  */
75
75
  export const AU_PER_LY = METERS_PER_LY / AU_METERS; // ≈ 63_241.07708426628
76
76
  /**
77
77
  * Light-years per astronomical unit (reciprocal of {@link AU_PER_LY}).
78
- * @category Distance
78
+ * @group Distance
79
79
  */
80
80
  export const LY_PER_AU = 1 / AU_PER_LY;
81
81
  /**
82
82
  * Kilometers in one astronomical unit.
83
- * @category Distance
83
+ * @group Distance
84
84
  */
85
85
  export const KM_PER_AU = AU_METERS / 1000;
86
86
  /**
@@ -92,12 +92,12 @@ export const KM_PER_AU = AU_METERS / 1000;
92
92
  *
93
93
  * :::
94
94
  *
95
- * @category Distance
95
+ * @group Distance
96
96
  */
97
97
  export const LY_PER_PC = METERS_PER_PC / METERS_PER_LY; // ≈ 3.26156…
98
98
  /**
99
99
  * Parsecs per light-year (reciprocal of {@link LY_PER_PC}).
100
- * @category Distance
100
+ * @group Distance
101
101
  */
102
102
  export const PC_PER_LY = 1 / LY_PER_PC;
103
103
  //# sourceMappingURL=distance.js.map
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  *
3
- * @showCategories
3
+ *
4
4
  * @packageDocumentation
5
5
  */
6
6
  export * from './date';
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  *
3
- * @showCategories
3
+ *
4
4
  * @packageDocumentation
5
5
  */
6
6
  export * from './date';
package/dist/math.d.ts CHANGED
@@ -64,7 +64,7 @@
64
64
  * // Angular frequency from frequency (Hz):
65
65
  * const omega = (f: number) => TWO_PI * f; // ω = τ f
66
66
  * ```
67
- * @category Math
67
+ * @group Math
68
68
  */
69
69
  export declare const TWO_PI: number;
70
70
  //# sourceMappingURL=math.d.ts.map
package/dist/math.js CHANGED
@@ -64,7 +64,7 @@
64
64
  * // Angular frequency from frequency (Hz):
65
65
  * const omega = (f: number) => TWO_PI * f; // ω = τ f
66
66
  * ```
67
- * @category Math
67
+ * @group Math
68
68
  */
69
69
  export const TWO_PI = 2 * Math.PI;
70
70
  //# sourceMappingURL=math.js.map
package/dist/objects.d.ts CHANGED
@@ -12,13 +12,13 @@
12
12
  */
13
13
  /**
14
14
  * Nominal solar radius (IAU 2015 B3), exact.
15
- * @category Objects
15
+ * @group Objects
16
16
  */
17
17
  export declare const SOLAR_RADIUS_NOMINAL_KM: 695700;
18
18
  /**
19
19
  * Photospheric / "standard" solar radius suggested for models (HSK 2008).
20
20
  * Reconciles seismic and photospheric definitions.
21
- * @category Objects
21
+ * @group Objects
22
22
  */
23
23
  export declare const SOLAR_RADIUS_PHOTOSPHERIC_KM = 695660;
24
24
  /**
@@ -30,42 +30,42 @@ export const SOLAR_RADIUS_LIMB_INFLECTION_MINUS_PHOTOSPHERIC_KM = 333;
30
30
  // --- SOHO/MDI Mercury transits (2003, 2006) ---
31
31
  /**
32
32
  * Radius from SOHO/MDI Mercury transits (2003 & 2006).
33
- * @category Objects
33
+ * @group Objects
34
34
  */
35
35
  export declare const SOLAR_RADIUS_SOHO_MDI_MERCURY_TRANSIT_KM = 696342;
36
36
  /**
37
37
  * 1σ uncertainty for SOHO/MDI Mercury-transit radius.
38
- * @category Objects
38
+ * @group Objects
39
39
  */
40
40
  export declare const SOLAR_RADIUS_SOHO_MDI_MERCURY_TRANSIT_UNC_KM = 65;
41
41
  /**
42
42
  * PICARD/SODISM radius at 535.7 nm.
43
- * @category Objects
43
+ * @group Objects
44
44
  */
45
45
  export declare const SOLAR_RADIUS_PICARD_SODISM_535_7_NM_KM = 696134;
46
46
  /**
47
47
  * 1σ uncertainty at 535.7 nm.
48
- * @category Objects
48
+ * @group Objects
49
49
  */
50
50
  export declare const SOLAR_RADIUS_PICARD_SODISM_535_7_NM_UNC_KM = 261;
51
51
  /**
52
52
  * PICARD/SODISM radius at 607.1 nm.
53
- * @category Objects
53
+ * @group Objects
54
54
  */
55
55
  export declare const SOLAR_RADIUS_PICARD_SODISM_607_1_NM_KM = 696156;
56
56
  /**
57
57
  * 1σ uncertainty at 607.1 nm.
58
- * @category Objects
58
+ * @group Objects
59
59
  */
60
60
  export declare const SOLAR_RADIUS_PICARD_SODISM_607_1_NM_UNC_KM = 145;
61
61
  /**
62
62
  * PICARD/SODISM radius at 782.2 nm.
63
- * @category Objects
63
+ * @group Objects
64
64
  */
65
65
  export declare const SOLAR_RADIUS_PICARD_SODISM_782_2_NM_KM = 696192;
66
66
  /**
67
67
  * 1σ uncertainty at 782.2 nm.
68
- * @category Objects
68
+ * @group Objects
69
69
  */
70
70
  export declare const SOLAR_RADIUS_PICARD_SODISM_782_2_NM_UNC_KM = 247;
71
71
  //# sourceMappingURL=objects.d.ts.map
package/dist/objects.js CHANGED
@@ -13,14 +13,14 @@
13
13
  // --- IAU nominal (exact conversion constant) ---
14
14
  /**
15
15
  * Nominal solar radius (IAU 2015 B3), exact.
16
- * @category Objects
16
+ * @group Objects
17
17
  */
18
18
  export const SOLAR_RADIUS_NOMINAL_KM = 695700;
19
19
  // --- Photospheric / seismic convention (HSK 2008) ---
20
20
  /**
21
21
  * Photospheric / "standard" solar radius suggested for models (HSK 2008).
22
22
  * Reconciles seismic and photospheric definitions.
23
- * @category Objects
23
+ * @group Objects
24
24
  */
25
25
  export const SOLAR_RADIUS_PHOTOSPHERIC_KM = 695660;
26
26
  /**
@@ -32,43 +32,43 @@ export const SOLAR_RADIUS_LIMB_INFLECTION_MINUS_PHOTOSPHERIC_KM = 333;
32
32
  // --- SOHO/MDI Mercury transits (2003, 2006) ---
33
33
  /**
34
34
  * Radius from SOHO/MDI Mercury transits (2003 & 2006).
35
- * @category Objects
35
+ * @group Objects
36
36
  */
37
37
  export const SOLAR_RADIUS_SOHO_MDI_MERCURY_TRANSIT_KM = 696342;
38
38
  /**
39
39
  * 1σ uncertainty for SOHO/MDI Mercury-transit radius.
40
- * @category Objects
40
+ * @group Objects
41
41
  */
42
42
  export const SOLAR_RADIUS_SOHO_MDI_MERCURY_TRANSIT_UNC_KM = 65;
43
43
  // --- PICARD/SODISM (Venus transit 2012; bandpass-specific, limb-inflection definition) ---
44
44
  /**
45
45
  * PICARD/SODISM radius at 535.7 nm.
46
- * @category Objects
46
+ * @group Objects
47
47
  */
48
48
  export const SOLAR_RADIUS_PICARD_SODISM_535_7_NM_KM = 696134;
49
49
  /**
50
50
  * 1σ uncertainty at 535.7 nm.
51
- * @category Objects
51
+ * @group Objects
52
52
  */
53
53
  export const SOLAR_RADIUS_PICARD_SODISM_535_7_NM_UNC_KM = 261;
54
54
  /**
55
55
  * PICARD/SODISM radius at 607.1 nm.
56
- * @category Objects
56
+ * @group Objects
57
57
  */
58
58
  export const SOLAR_RADIUS_PICARD_SODISM_607_1_NM_KM = 696156;
59
59
  /**
60
60
  * 1σ uncertainty at 607.1 nm.
61
- * @category Objects
61
+ * @group Objects
62
62
  */
63
63
  export const SOLAR_RADIUS_PICARD_SODISM_607_1_NM_UNC_KM = 145;
64
64
  /**
65
65
  * PICARD/SODISM radius at 782.2 nm.
66
- * @category Objects
66
+ * @group Objects
67
67
  */
68
68
  export const SOLAR_RADIUS_PICARD_SODISM_782_2_NM_KM = 696192;
69
69
  /**
70
70
  * 1σ uncertainty at 782.2 nm.
71
- * @category Objects
71
+ * @group Objects
72
72
  */
73
73
  export const SOLAR_RADIUS_PICARD_SODISM_782_2_NM_UNC_KM = 247;
74
74
  //# sourceMappingURL=objects.js.map
package/dist/temporal.d.ts CHANGED
@@ -18,12 +18,12 @@
18
18
  */
19
19
  /**
20
20
  * Length of the **SI day** in seconds (exact).
21
- * @category Temporal
21
+ * @group Temporal
22
22
  */
23
23
  export declare const SECONDS_PER_DAY: 86400;
24
24
  /**
25
25
  * Milliseconds in one second (exact).
26
- * @category Temporal
26
+ * @group Temporal
27
27
  */
28
28
  export declare const MILLISECONDS_PER_SECOND: 1000;
29
29
  /**
@@ -35,12 +35,12 @@ export declare const MILLISECONDS_PER_SECOND: 1000;
35
35
  *
36
36
  * :::
37
37
  *
38
- * @category Temporal
38
+ * @group Temporal
39
39
  */
40
40
  export declare const MILLISECONDS_PER_DAY: number;
41
41
  /**
42
42
  * Length of the **Julian year** in SI days (exactly 365.25).
43
- * @category Temporal
43
+ * @group Temporal
44
44
  */
45
45
  export declare const JULIAN_YEAR_DAYS: 365.25;
46
46
  /**
@@ -52,7 +52,7 @@ export declare const JULIAN_YEAR_DAYS: 365.25;
52
52
  *
53
53
  * :::
54
54
  *
55
- * @category Temporal
55
+ * @group Temporal
56
56
  */
57
57
  export declare const JULIAN_YEAR_SECONDS: number;
58
58
  //# sourceMappingURL=temporal.d.ts.map
package/dist/temporal.js CHANGED
@@ -18,12 +18,12 @@
18
18
  */
19
19
  /**
20
20
  * Length of the **SI day** in seconds (exact).
21
- * @category Temporal
21
+ * @group Temporal
22
22
  */
23
23
  export const SECONDS_PER_DAY = 86400;
24
24
  /**
25
25
  * Milliseconds in one second (exact).
26
- * @category Temporal
26
+ * @group Temporal
27
27
  */
28
28
  export const MILLISECONDS_PER_SECOND = 1000;
29
29
  /**
@@ -35,13 +35,13 @@ export const MILLISECONDS_PER_SECOND = 1000;
35
35
  *
36
36
  * :::
37
37
  *
38
- * @category Temporal
38
+ * @group Temporal
39
39
  */
40
40
  export const MILLISECONDS_PER_DAY = SECONDS_PER_DAY * MILLISECONDS_PER_SECOND;
41
41
  // Julian year (astronomy) - EXACT 365.25 d
42
42
  /**
43
43
  * Length of the **Julian year** in SI days (exactly 365.25).
44
- * @category Temporal
44
+ * @group Temporal
45
45
  */
46
46
  export const JULIAN_YEAR_DAYS = 365.25;
47
47
  /**
@@ -53,7 +53,7 @@ export const JULIAN_YEAR_DAYS = 365.25;
53
53
  *
54
54
  * :::
55
55
  *
56
- * @category Temporal
56
+ * @group Temporal
57
57
  */
58
58
  export const JULIAN_YEAR_SECONDS = SECONDS_PER_DAY * JULIAN_YEAR_DAYS; // 31_557_600
59
59
  //# sourceMappingURL=temporal.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@interstellar-tools/constants",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "constants",
5
5
  "keywords": [
6
6
  "interstellar",