feat: Renamed "effectSync()" to "syncEffect()"

benchmarks/index.ts

@@ -11,20 +11,20 @@ main();
 async function main() {
   const bench = new Bench();
 
-  bench.add('DEV: compute + effectSync', () => {
-    return createComputeTest(DEV_CORE, true);
+  bench.add('DEV: compute + syncEffect', () => {
+    return createComputeTest(DEV_CORE, DEV_CORE.syncEffect);
   });
 
   bench.add('DEV: compute + effect    ', () => {
-    return createComputeTest(DEV_CORE, false);
+    return createComputeTest(DEV_CORE, DEV_CORE.effect);
   });
 
-  bench.add('REF: compute + effectSync', () => {
-    return createComputeTest(REF_CORE, true);
+  bench.add('REF: compute + syncEffect', () => {
+    return createComputeTest(REF_CORE, REF_CORE.effectSync);
   });
 
   bench.add('REF: compute + effect    ', () => {
-    return createComputeTest(REF_CORE, false);
+    return createComputeTest(REF_CORE, REF_CORE.effect);
   });
 
   await bench.run();
@@ -36,10 +36,9 @@ async function main() {
 
 function createComputeTest(
   core: typeof DEV_CORE | typeof REF_CORE,
-  sync: boolean,
+  effectFactory: DEV_CORE.EffectFn,
 ) {
   const { signal, compute } = core;
-  const effectFactory = sync ? core.effectSync : core.effect;
 
   const entry = signal(0);
 

src/core/_public.ts

@@ -13,7 +13,7 @@ export type {
   EffectCleanupFn,
   EffectCleanupRegisterFn,
 } from './effect';
-export { effect, effectSync } from './effect';
+export { effect, syncEffect } from './effect';
 
 export { runEffects } from './runtime';
 

src/core/compute.test.ts

@@ -7,7 +7,7 @@ import {
 
 import { defaultEquals, Signal } from './common';
 import { compute, ComputedImpl } from './compute';
-import { effect, effectSync } from './effect';
+import { effect, syncEffect } from './effect';
 import { SIGNAL_RUNTIME } from './runtime';
 import { signal } from './signal';
 import { createSignalSubject } from './signalSubject';
@@ -53,7 +53,7 @@ describe('compute()', () => {
 
     const results: number[] = [];
 
-    effectSync(() => results.push(h()));
+    syncEffect(() => results.push(h()));
 
     entry.set(1);
     entry.set(2);
@@ -160,7 +160,7 @@ describe('compute()', () => {
     const b = compute(() => a() + 1);
 
     const results: number[] = [];
-    const fx = effectSync(() => results.push(b()));
+    const fx = syncEffect(() => results.push(b()));
     source.set(1);
     source.set(2);
     fx.destroy();

src/core/effect.test.ts

@@ -2,7 +2,7 @@ import { flushMicrotasks } from '../test/testUtils';
 
 import { action } from './action';
 import { compute } from './compute';
-import { effect, effectSync } from './effect';
+import { effect, syncEffect } from './effect';
 import { signal } from './signal';
 
 describe('effect()', () => {
@@ -89,12 +89,12 @@ describe('effect()', () => {
   });
 });
 
-describe('effectSync()', () => {
+describe('syncEffect()', () => {
   it('should subscribe to an action', () => {
     const emitter = action<number>();
 
     let result = 0;
-    const fx = effectSync(emitter, (value) => (result = value));
+    const fx = syncEffect(emitter, (value) => (result = value));
     expect(result).toBe(0);
 
     emitter(1);
@@ -110,7 +110,7 @@ describe('effectSync()', () => {
     const b = signal(2);
 
     let result = 0;
-    const fx = effectSync(
+    const fx = syncEffect(
       compute(() => a() + b()),
       (value) => (result = value),
     );
@@ -129,7 +129,7 @@ describe('effectSync()', () => {
     const b = signal(2);
 
     let result = 0;
-    const fx = effectSync(() => (result = a() + b()));
+    const fx = syncEffect(() => (result = a() + b()));
     expect(result).toBe(3);
 
     a.set(2);

src/core/effect.ts

@@ -73,7 +73,7 @@ export const effect: EffectFn = <
   );
 };
 
-export const effectSync: EffectFn = <
+export const syncEffect: EffectFn = <
   T,
   Source extends Action<T> | Signal<T> | SideEffectFn,
   Callback extends Source extends Action<T>

src/core/scope.test.ts

@@ -24,7 +24,7 @@ describe('Scope', () => {
       const source = signal<number>(1);
       const results: number[] = [];
 
-      scope.effectSync(() => results.push(source() * 3));
+      scope.syncEffect(() => results.push(source() * 3));
       source.set(2);
       scope.destroy();
       source.set(3);

src/core/scope.ts

@@ -1,5 +1,5 @@
 import { action } from './action';
-import { effect, EffectFn, effectSync } from './effect';
+import { effect, EffectFn, syncEffect } from './effect';
 import { signal } from './signal';
 
 export interface Unsubscribable {
@@ -27,7 +27,7 @@ export type Scope = Readonly<
     action: typeof action;
     signal: typeof signal;
     effect: EffectFn;
-    effectSync: EffectFn;
+    syncEffect: EffectFn;
   }
 >;
 
@@ -120,8 +120,8 @@ class ScopeImpl implements Scope {
     return result;
   }
 
-  effectSync(...args: Parameters<EffectFn>) {
-    const result = effectSync(...args);
+  syncEffect(...args: Parameters<EffectFn>) {
+    const result = syncEffect(...args);
     this.add(result);
     return result;
   }
@@ -142,6 +142,6 @@ export function createScope(): Scope {
     action: scope.action.bind(scope),
     signal: scope.signal.bind(scope),
     effect: scope.effect.bind(scope),
-    effectSync: scope.effectSync.bind(scope),
+    syncEffect: scope.syncEffect.bind(scope),
   };
 }

src/rxjs/toObservable.ts

@@ -1,7 +1,7 @@
 import { Observable, share, shareReplay, skip } from 'rxjs';
 
 import { Signal } from '../core/common';
-import { effect, effectSync } from '../core/effect';
+import { effect, syncEffect } from '../core/effect';
 import { SIGNAL_RUNTIME } from '../core/runtime';
 
 export type ToObservableOptions = {
@@ -19,7 +19,7 @@ export function toObservable<T>(
   options?: ToObservableOptions,
 ): Observable<T> {
   const observable = new Observable<T>((subscriber) => {
-    const effectFn = options?.sync ? effectSync : effect;
+    const effectFn = options?.sync ? syncEffect : effect;
     const scheduler = options?.sync
       ? SIGNAL_RUNTIME.syncScheduler
       : SIGNAL_RUNTIME.asyncScheduler;