refactor: make wait optional

StyleShit · Feb 13, 2025 · b936a37 · b936a37
1 parent 71d0603
commit b936a37
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 10 deletions.
diff --git a/src/__tests__/index.test.ts b/src/__tests__/index.test.ts
@@ -19,7 +19,9 @@ describe('Synctactic', () => {
 		const { unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
+			options: {
+				wait: 100,
+			},
 		});
 
 		// Assert.
@@ -58,7 +60,9 @@ describe('Synctactic', () => {
 		const { unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
+			options: {
+				wait: 100,
+			},
 		});
 
 		// Act - Initiate a first sync.
@@ -88,8 +92,8 @@ describe('Synctactic', () => {
 		const { unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
 			options: {
+				wait: 100,
 				notifyOnLeave: true,
 			},
 		});
@@ -122,8 +126,8 @@ describe('Synctactic', () => {
 		const { unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
 			options: {
+				wait: 100,
 				notifyOnLeave: true,
 			},
 		});
@@ -156,7 +160,9 @@ describe('Synctactic', () => {
 		const { unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
+			options: {
+				wait: 100,
+			},
 		});
 
 		// Act.
@@ -177,7 +183,9 @@ describe('Synctactic', () => {
 		const { unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
+			options: {
+				wait: 100,
+			},
 		});
 
 		// Act - Initiate a sync.
@@ -199,7 +207,9 @@ describe('Synctactic', () => {
 		const { forceSync, unSync } = sync({
 			subscribe: (cb) => eventEmitter.subscribe(cb),
 			syncFn,
-			wait: 100,
+			options: {
+				wait: 100,
+			},
 		});
 
 		// Act.

diff --git a/src/sync.ts b/src/sync.ts
@@ -3,13 +3,15 @@ import { debounce } from './debounce';
 export type SyncArgs = {
 	subscribe: (cb: () => unknown) => () => void;
 	syncFn: (signal: AbortSignal) => unknown;
-	wait: number;
 	options?: {
+		wait?: number;
 		notifyOnLeave?: boolean;
 	};
 };
 
-export function sync({ subscribe, syncFn, wait, options }: SyncArgs) {
+export function sync({ subscribe, syncFn, options = {} }: SyncArgs) {
+	const { notifyOnLeave = false, wait = 0 } = options;
+
 	let isSyncing = false;
 	let abortController: AbortController | null = null;
 
@@ -41,7 +43,7 @@ export function sync({ subscribe, syncFn, wait, options }: SyncArgs) {
 		flushIfNeeded();
 	};
 
-	if (options?.notifyOnLeave) {
+	if (notifyOnLeave) {
 		window.addEventListener('beforeunload', onUnload);
 	}