@but212/atom-effect 0.22.1 → 0.23.0

package/dist/index.d.ts

@@ -21,12 +21,6 @@ export declare type AsyncStateType = (typeof AsyncState)[keyof typeof AsyncState
  */
 export declare function atom<T>(initialValue: T, options?: AtomOptions): WritableAtom<T>;
 
-/**
- * Brand symbols for reliable type identification.
- * Prevents false positives from duck-typing with external objects.
- */
-export declare const ATOM_BRAND: unique symbol;
-
 /**
  * Base error class.
  */
@@ -63,8 +57,6 @@ export declare function computed<T>(fn: () => Promise<T>, options: ComputedOptio
     defaultValue: T;
 }): ComputedAtom<T>;
 
-export declare const COMPUTED_BRAND: unique symbol;
-
 /**
  * Computed atom interface.
  */
@@ -120,7 +112,6 @@ export declare interface DebugConfig {
     enabled: boolean;
     warnInfiniteLoop: boolean;
     warn(condition: boolean, message: string): void;
-    checkCircular(dep: Dependency, current: object): void;
     attachDebugInfo(obj: object, type: string, id: number): void;
     getDebugName(obj: object | null | undefined): string | undefined;
     getDebugType(obj: object | null | undefined): string | undefined;
@@ -128,20 +119,22 @@ export declare interface DebugConfig {
 
 /**
  * Dependency interface.
+ *
+ * @remarks
+ * Internal fields (`version`, `flags`, `_lastSeenEpoch`) are part of the
+ * engine contract between reactive nodes and must not be mutated externally.
  */
 export declare interface Dependency {
     readonly id: DependencyId;
-    /** Version counter. */
-    version: number;
-    /** State flags. */
-    flags: number;
-    /** Last validated epoch. */
-    _lastSeenEpoch: number;
+    /* Excluded from this release type: version */
+    /* Excluded from this release type: flags */
+    /* Excluded from this release type: _lastSeenEpoch */
     /**
      * Adds a subscriber to this dependency.
-     * @param listener - The subscriber (function or object with execute method).
+     * The listener may optionally receive the new and previous values.
+     * @param listener - A callback or Subscriber object.
      */
-    subscribe(listener: (() => void) | Subscriber): () => void;
+    subscribe(listener: ((newValue?: unknown, oldValue?: unknown) => void) | Subscriber): () => void;
     /** Peek hook. */
     peek?(): unknown;
     /** Value accessor. */
@@ -162,8 +155,6 @@ export declare type DependencyId = number;
  */
 export declare function effect(fn: EffectFunction, options?: EffectOptions): EffectObject;
 
-export declare const EFFECT_BRAND: unique symbol;
-
 /** Effect error. */
 export declare class EffectError extends AtomError {
     constructor(message: string, cause?: Error | null);
@@ -183,6 +174,7 @@ export declare interface EffectObject extends Disposable {
 }
 
 export declare interface EffectOptions {
+    name?: string;
     sync?: boolean;
     maxExecutionsPerSecond?: number;
     maxExecutionsPerFlush?: number;
@@ -206,15 +198,6 @@ export declare function isComputed(obj: unknown): obj is ComputedAtom;
  */
 export declare function isEffect(obj: unknown): obj is EffectObject;
 
-/**
- * Array pool configuration.
- */
-export declare const POOL_CONFIG: {
-    readonly MAX_SIZE: 1000;
-    readonly WARMUP_SIZE: 100;
-    readonly ENABLE_STATS: false;
-};
-
 export declare interface PoolStats {
     acquired: number;
     released: number;
@@ -317,12 +300,20 @@ export declare class SchedulerError extends AtomError {
     constructor(message: string, cause?: Error | null);
 }
 
-declare interface SchedulerJob {
+declare type SchedulerJob = SchedulerJobFunction | SchedulerJobObject;
+
+declare interface SchedulerJobFunction {
     (): void;
     /** Next scheduled epoch */
     _nextEpoch?: number;
 }
 
+declare interface SchedulerJobObject {
+    execute(): void;
+    /** Next scheduled epoch */
+    _nextEpoch?: number;
+}
+
 declare enum SchedulerPhase {
     IDLE = 0,
     BATCHING = 1,