@buenos-nachos/time-sync 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @buenos-nachos/time-sync
 
+## 0.3.0
+
+### Minor Changes
+
+- 122f6c1: Updated `SubscriptionContext.timeSync` type to be readonly and non-nullable, and renamed `SubscriptionContext.isLive` to `SubscriptionContext.isSubscribed`.
+
 ## 0.2.0
 
 ### Breaking Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buenos-nachos/time-sync",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "type": "module",
   "author": "Michael Smith <hello@nachos.dev> (https://www.nachos.dev)",

package/src/TimeSync.test.ts

@@ -131,7 +131,7 @@ describe(TimeSync, () => {
 
 				const expectedCtx: SubscriptionContext = {
 					unsubscribe,
-					isLive: true,
+					isSubscribed: true,
 					timeSync: sync,
 					intervalLastFulfilledAt: dateAfter,
 					registeredAt: dateBefore,
@@ -580,10 +580,10 @@ describe(TimeSync, () => {
 			});
 
 			await vi.advanceTimersByTimeAsync(refreshRates.oneMinute);
-			expect(ejectedContext?.isLive).toBe(true);
+			expect(ejectedContext?.isSubscribed).toBe(true);
 
 			unsub();
-			expect(ejectedContext?.isLive).toBe(false);
+			expect(ejectedContext?.isSubscribed).toBe(false);
 		});
 	});
 
@@ -827,7 +827,7 @@ describe(TimeSync, () => {
 
 			await vi.advanceTimersByTimeAsync(refreshRates.oneSecond);
 			expect(ejectedContext).toEqual<SubscriptionContext>({
-				isLive: true,
+				isSubscribed: true,
 				intervalLastFulfilledAt: null,
 				registeredAt: snapBefore,
 				targetRefreshIntervalMs: refreshRates.oneHour,
@@ -840,7 +840,7 @@ describe(TimeSync, () => {
 
 			const snapAfter = sync.getStateSnapshot().date;
 			expect(ejectedContext).toEqual<SubscriptionContext>({
-				isLive: true,
+				isSubscribed: true,
 				intervalLastFulfilledAt: snapAfter,
 				registeredAt: snapBefore,
 				targetRefreshIntervalMs: refreshRates.oneHour,
@@ -1103,10 +1103,10 @@ describe(TimeSync, () => {
 			});
 
 			await vi.advanceTimersByTimeAsync(refreshRates.oneMinute);
-			expect(ejectedContext?.isLive).toBe(true);
+			expect(ejectedContext?.isSubscribed).toBe(true);
 
 			sync.clearAll();
-			expect(ejectedContext?.isLive).toBe(false);
+			expect(ejectedContext?.isSubscribed).toBe(false);
 		});
 	});
 

package/src/TimeSync.ts

@@ -167,13 +167,13 @@ export interface SubscriptionContext {
 	 * A reference to the TimeSync instance that the subscription was registered
 	 * with.
 	 */
-	timeSync: TimeSync | null;
+	readonly timeSync: TimeSync;
 
 	/**
 	 * Indicates whether the subscription is still live. Will be mutated to be
 	 * false when a subscription is
 	 */
-	isLive: boolean;
+	isSubscribed: boolean;
 
 	/**
 	 * Indicates when the last time the subscription had its explicit interval
@@ -585,7 +585,7 @@ export class TimeSync implements TimeSyncApi {
 		// Have to define this as a writeable to avoid a chicken-and-the-egg
 		// problem for the unsubscribe callback
 		const context: Writeable<SubscriptionContext> = {
-			isLive: true,
+			isSubscribed: true,
 			timeSync: this,
 			unsubscribe: noOp,
 			registeredAt: new ReadonlyDate(),
@@ -603,7 +603,7 @@ export class TimeSync implements TimeSyncApi {
 		const subsOnSetup = this.#subscriptions;
 		const unsubscribe = (): void => {
 			if (!subscribed || this.#subscriptions !== subsOnSetup) {
-				context.isLive = false;
+				context.isSubscribed = false;
 				subscribed = false;
 				return;
 			}
@@ -630,7 +630,7 @@ export class TimeSync implements TimeSyncApi {
 				subscriberCount: Math.max(0, this.#latestSnapshot.subscriberCount - 1),
 			});
 
-			context.isLive = false;
+			context.isSubscribed = false;
 			subscribed = false;
 		};
 		context.unsubscribe = unsubscribe;
@@ -672,7 +672,7 @@ export class TimeSync implements TimeSyncApi {
 		// one actually has much better time complexity
 		for (const subArray of this.#subscriptions.values()) {
 			for (const ctx of subArray) {
-				ctx.isLive = false;
+				ctx.isSubscribed = false;
 			}
 		}