@agoric/time 0.3.3-dev-7153535.0 → 0.3.3-dev-813e29e.0

package/index.js

@@ -1,2 +1,4 @@
 export * from './src/timeMath.js';
 export * from './src/typeGuards.js';
+// eslint-disable-next-line import/export -- just types
+export * from './src/types.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/time",
-  "version": "0.3.3-dev-7153535.0+7153535",
+  "version": "0.3.3-dev-813e29e.0+813e29e",
   "description": "Timestamps, time math, timer service API definition",
   "type": "module",
   "main": "index.js",
@@ -30,7 +30,7 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-7153535.0+7153535",
+    "@agoric/assert": "0.6.1-dev-813e29e.0+813e29e",
     "@endo/nat": "^4.1.30",
     "@endo/patterns": "^0.2.5"
   },
@@ -55,5 +55,5 @@
   "typeCoverage": {
     "atLeast": 86.95
   },
-  "gitHead": "7153535c5c10fed309dc60f12f981c81841fdb93"
+  "gitHead": "813e29e088f8fda82916bc9fc2b36502805158ec"
 }

package/src/timeMath.js

@@ -3,23 +3,13 @@ import { mustMatch } from '@endo/patterns';
 import { RelativeTimeRecordShape, TimestampRecordShape } from './typeGuards.js';
 
 const { Fail, quote: q } = assert;
-/**
- * @typedef {import('@endo/marshal').RankComparison} RankComparison
- *
- * @typedef {import('./types').TimerBrand} TimerBrand
- * @typedef {import('./types').Timestamp} Timestamp
- * @typedef {import('./types').RelativeTime} RelativeTime
- * @typedef {import('./types').RelativeTimeValue} RelativeTimeValue
- * @typedef {import('./types').TimestampValue} TimestampValue
- * @typedef {import('./types').TimeMathType} TimeMathType
- */
 
 /**
  * `agreedTimerBrand` is internal to this module.
  *
- * @param {TimerBrand | undefined} leftBrand
- * @param {TimerBrand | undefined} rightBrand
- * @returns {TimerBrand | undefined}
+ * @param {import('./types').TimerBrand | undefined} leftBrand
+ * @param {import('./types').TimerBrand | undefined} rightBrand
+ * @returns {import('./types').TimerBrand | undefined}
  */
 const agreedTimerBrand = (leftBrand, rightBrand) => {
   if (leftBrand === undefined) {
@@ -44,9 +34,9 @@ const agreedTimerBrand = (leftBrand, rightBrand) => {
  * this logic. It does the error checking between the operands, and returns
  * the brand, if any, that should label the resulting time value.
  *
- * @param {Timestamp | RelativeTime} left
- * @param {Timestamp | RelativeTime} right
- * @returns {TimerBrand | undefined}
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} left
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} right
+ * @returns {import('./types').TimerBrand | undefined}
  */
 const sharedTimerBrand = (left, right) => {
   const leftBrand = typeof left === 'bigint' ? undefined : left.timerBrand;
@@ -59,10 +49,10 @@ const sharedTimerBrand = (left, right) => {
  * operators in the case where the returned time should be a `Timestamp`
  * rather than a `RelativeTime`.
  *
- * @param {Timestamp | RelativeTime} left
- * @param {Timestamp | RelativeTime} right
- * @param {TimestampValue} absValue
- * @returns {Timestamp}
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} left
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} right
+ * @param {import('./types').TimestampValue} absValue
+ * @returns {import('./types').Timestamp}
  */
 const absLike = (left, right, absValue) => {
   Nat(absValue);
@@ -82,10 +72,10 @@ const absLike = (left, right, absValue) => {
  * operators in the case where the returned time should be a `RelativeTime`
  * rather than a `Timestamp`.
  *
- * @param {Timestamp | RelativeTime} left
- * @param {Timestamp | RelativeTime} right
- * @param {RelativeTimeValue} relValue
- * @returns {RelativeTime}
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} left
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} right
+ * @param {import('./types').RelativeTimeValue} relValue
+ * @returns {import('./types').RelativeTime}
  */
 const relLike = (left, right, relValue) => {
   Nat(relValue);
@@ -197,11 +187,11 @@ const modRelRel = (rel, step) =>
  * `compareValues` is internal to this module, and used to implement
  * the time comparison operators.
  *
- * @param {Timestamp | RelativeTime} left
- * @param {Timestamp | RelativeTime} right
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} left
+ * @param {import('./types').Timestamp | import('./types').RelativeTime} right
  * @param {bigint} v1
  * @param {bigint} v2
- * @returns {RankComparison}
+ * @returns {import('@endo/marshal').RankComparison}
  */
 const compareValues = (left, right, v1, v2) => {
   sharedTimerBrand(left, right);
@@ -247,7 +237,7 @@ const compareValues = (left, right, v1, v2) => {
  * operand, and return a labeled time object with the brand of the labeled
  * operand.
  *
- * @type {TimeMathType}
+ * @type {import('./types').TimeMathType}
  */
 export const TimeMath = harden({
   absValue,

package/src/types.js

@@ -0,0 +1,2 @@
+// Empty JS file to correspond with types.d.ts
+export {};