@relaybus/testing 0.2.0 → 0.3.1

package/dist/index.d.cts

@@ -1,4 +1,8 @@
-import { EventStore, NewDelivery, EventEnvelope, Clock, Transport, TransportMessageHandler } from '@relaybus/core';
+import { NewDelivery, EventEnvelope, EventStore, Clock, Transport, TransportMessageHandler } from '@relaybus/core';
+
+declare function at(offsetMs: number): Date;
+declare function createEnvelope(overrides?: Partial<EventEnvelope>): EventEnvelope;
+declare function createDelivery(handler: string, availableAt?: Date): NewDelivery;
 
 interface EventStoreContractOptions<TTransaction> {
     /** Creates an empty, set-up store. Called before every test. */
@@ -18,9 +22,6 @@ interface EventStoreContractOptions<TTransaction> {
      */
     readonly keepsCompletedRecords?: boolean;
 }
-declare function at(offsetMs: number): Date;
-declare function createEnvelope(overrides?: Partial<EventEnvelope>): EventEnvelope;
-declare function createDelivery(handler: string, availableAt?: Date): NewDelivery;
 /**
  * Behaviour every {@link EventStore} must have. Call it inside a test file of
  * the store package:
@@ -31,13 +32,25 @@ declare function createDelivery(handler: string, availableAt?: Date): NewDeliver
  */
 declare function eventStoreContract<TTransaction>(name: string, options: EventStoreContractOptions<TTransaction>): void;
 
-/** Clock that only moves when told to. */
+type ScheduledTask = Parameters<NonNullable<Clock['schedule']>>[0];
+/**
+ * Clock that only moves when told to. With `controlTimers: true` it also owns relaybus's timers
+ * (polling, retries, heartbeats, retention, timeouts): they run inside {@link FakeClock.advance}
+ * when their time comes instead of on the platform timers. Without it, timers stay real.
+ */
 declare class FakeClock implements Clock {
     #private;
-    constructor(start?: Date | string | number);
+    /** Present only with `controlTimers: true`; see {@link Clock.schedule}. */
+    readonly schedule?: (task: ScheduledTask) => () => void;
+    constructor(start?: Date | string | number, options?: {
+        readonly controlTimers?: boolean;
+    });
     now(): Date;
+    /** Moves the clock forward, running every controlled timer that falls due on the way, in time order. */
     advance(milliseconds: number): Date;
     set(instant: Date | string | number): Date;
+    /** Controlled timers still waiting to run. */
+    get pendingTimers(): number;
 }
 
 interface PublishedMessage {

package/dist/index.d.ts

@@ -1,4 +1,8 @@
-import { EventStore, NewDelivery, EventEnvelope, Clock, Transport, TransportMessageHandler } from '@relaybus/core';
+import { NewDelivery, EventEnvelope, EventStore, Clock, Transport, TransportMessageHandler } from '@relaybus/core';
+
+declare function at(offsetMs: number): Date;
+declare function createEnvelope(overrides?: Partial<EventEnvelope>): EventEnvelope;
+declare function createDelivery(handler: string, availableAt?: Date): NewDelivery;
 
 interface EventStoreContractOptions<TTransaction> {
     /** Creates an empty, set-up store. Called before every test. */
@@ -18,9 +22,6 @@ interface EventStoreContractOptions<TTransaction> {
      */
     readonly keepsCompletedRecords?: boolean;
 }
-declare function at(offsetMs: number): Date;
-declare function createEnvelope(overrides?: Partial<EventEnvelope>): EventEnvelope;
-declare function createDelivery(handler: string, availableAt?: Date): NewDelivery;
 /**
  * Behaviour every {@link EventStore} must have. Call it inside a test file of
  * the store package:
@@ -31,13 +32,25 @@ declare function createDelivery(handler: string, availableAt?: Date): NewDeliver
  */
 declare function eventStoreContract<TTransaction>(name: string, options: EventStoreContractOptions<TTransaction>): void;
 
-/** Clock that only moves when told to. */
+type ScheduledTask = Parameters<NonNullable<Clock['schedule']>>[0];
+/**
+ * Clock that only moves when told to. With `controlTimers: true` it also owns relaybus's timers
+ * (polling, retries, heartbeats, retention, timeouts): they run inside {@link FakeClock.advance}
+ * when their time comes instead of on the platform timers. Without it, timers stay real.
+ */
 declare class FakeClock implements Clock {
     #private;
-    constructor(start?: Date | string | number);
+    /** Present only with `controlTimers: true`; see {@link Clock.schedule}. */
+    readonly schedule?: (task: ScheduledTask) => () => void;
+    constructor(start?: Date | string | number, options?: {
+        readonly controlTimers?: boolean;
+    });
     now(): Date;
+    /** Moves the clock forward, running every controlled timer that falls due on the way, in time order. */
     advance(milliseconds: number): Date;
     set(instant: Date | string | number): Date;
+    /** Controlled timers still waiting to run. */
+    get pendingTimers(): number;
 }
 
 interface PublishedMessage {