@valentin30/signal 0.0.7 → 0.0.9

package/dist/index.d.mts

@@ -1,13 +1,13 @@
-type Function = (...args: any[]) => any;
+type Callable = (...args: any[]) => any;
 
 type Maybe<T> = T | null | undefined;
 
-type Factory<Fn extends Function> = Fn & {
+type Factory<Fn extends Callable> = Fn & {
     factory(factory: Maybe<Fn>): void;
     default(factory: Maybe<Fn>): void;
     configured(): boolean;
 };
-declare function factory<Fn extends Function>(name: string): Factory<Fn>;
+declare function factory<Fn extends Callable>(name: string): Factory<Fn>;
 
 type Callback = () => void;
 
@@ -38,27 +38,32 @@ declare class Collector<T> implements Collector$1<T> {
     ignore(callback: Callback): void;
 }
 
-type Equals<T> = (value: T, other: T) => boolean;
 interface Comparable<T> {
     equals(other: T): boolean;
 }
 
-interface Reader<T> {
+interface Readable<T> {
     read(): T;
 }
 
-interface Subscription {
+interface Subscribable {
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
 }
 
-interface Writer<T> {
+interface Writable<T> {
     write(value: T): void;
 }
 
-interface Signal$1<T> extends Reader<T>, Writer<T>, Comparable<T>, Subscription {
+type Equals<T> = (value: T, other: T) => boolean;
+
+interface Peekable<T> {
+    peek(): T;
+}
+
+interface Signal$1<T> extends Readable<T>, Writable<T>, Peekable<T>, Comparable<T>, Subscribable {
 }
-interface ReadonlySignal<T> extends Reader<T>, Comparable<T>, Subscription {
+interface ReadonlySignal<T> extends Readable<T>, Peekable<T>, Comparable<T>, Subscribable {
 }
 type SignalFactory = <T>(value: T, equals?: Equals<T>) => Signal$1<T>;
 declare const signal$1: Factory<SignalFactory>;
@@ -72,6 +77,7 @@ declare class Computed<T> implements ReadonlySignal<T> {
     #private;
     constructor(empty: boolean, value: T | undefined, values: [ReadonlySignal<unknown>, unknown][], dependencies: Set<ReadonlySignal<unknown>>, listeners: Set<Callback>, collector: Collector$1<ReadonlySignal<unknown>>, compute: () => T, equals: Maybe<Equals<T>>);
     read(): T;
+    peek(): T;
     equals(other: T): boolean;
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
@@ -130,6 +136,7 @@ declare class Signal<T> implements Signal$1<T> {
     #private;
     constructor(value: T, equals: Maybe<Equals<T>>, listeners: Set<Callback>, batcher: Collector$1<Callback>, collector: Collector$1<ReadonlySignal<unknown>>);
     read(): T;
+    peek(): T;
     write(value: T): void;
     equals(other: T): boolean;
     subscribe(callback: Callback): Callback;
@@ -191,4 +198,4 @@ interface Config {
 }
 declare function config(config?: Config): void;
 
-export { type Batch, type Callback, type Collector$1 as Collector, type CollectorFactory, type Comparable, type ComposedFactory, type ComputedFactory, type Config, type Effect, type EffectCallback, type EffectCleanup, type Equals, type Factory, type Function, type Ignore, type Maybe, type Reader, type ReadonlySignal, type Signal$1 as Signal, type SignalFactory, type Subscription, type Writer, batch, collector$1 as collector, composed, computed, config, effect$1 as effect, factory, ignore, index as internal, signal$1 as signal };
+export { type Batch, type Callable, type Callback, type Collector$1 as Collector, type CollectorFactory, type Comparable, type ComposedFactory, type ComputedFactory, type Config, type Effect, type EffectCallback, type EffectCleanup, type Equals, type Factory, type Ignore, type Maybe, type Peekable, type Readable, type ReadonlySignal, type Signal$1 as Signal, type SignalFactory, type Subscribable, type Writable, batch, collector$1 as collector, composed, computed, config, effect$1 as effect, factory, ignore, index as internal, signal$1 as signal };

package/dist/index.d.ts

@@ -1,13 +1,13 @@
-type Function = (...args: any[]) => any;
+type Callable = (...args: any[]) => any;
 
 type Maybe<T> = T | null | undefined;
 
-type Factory<Fn extends Function> = Fn & {
+type Factory<Fn extends Callable> = Fn & {
     factory(factory: Maybe<Fn>): void;
     default(factory: Maybe<Fn>): void;
     configured(): boolean;
 };
-declare function factory<Fn extends Function>(name: string): Factory<Fn>;
+declare function factory<Fn extends Callable>(name: string): Factory<Fn>;
 
 type Callback = () => void;
 
@@ -38,27 +38,32 @@ declare class Collector<T> implements Collector$1<T> {
     ignore(callback: Callback): void;
 }
 
-type Equals<T> = (value: T, other: T) => boolean;
 interface Comparable<T> {
     equals(other: T): boolean;
 }
 
-interface Reader<T> {
+interface Readable<T> {
     read(): T;
 }
 
-interface Subscription {
+interface Subscribable {
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
 }
 
-interface Writer<T> {
+interface Writable<T> {
     write(value: T): void;
 }
 
-interface Signal$1<T> extends Reader<T>, Writer<T>, Comparable<T>, Subscription {
+type Equals<T> = (value: T, other: T) => boolean;
+
+interface Peekable<T> {
+    peek(): T;
+}
+
+interface Signal$1<T> extends Readable<T>, Writable<T>, Peekable<T>, Comparable<T>, Subscribable {
 }
-interface ReadonlySignal<T> extends Reader<T>, Comparable<T>, Subscription {
+interface ReadonlySignal<T> extends Readable<T>, Peekable<T>, Comparable<T>, Subscribable {
 }
 type SignalFactory = <T>(value: T, equals?: Equals<T>) => Signal$1<T>;
 declare const signal$1: Factory<SignalFactory>;
@@ -72,6 +77,7 @@ declare class Computed<T> implements ReadonlySignal<T> {
     #private;
     constructor(empty: boolean, value: T | undefined, values: [ReadonlySignal<unknown>, unknown][], dependencies: Set<ReadonlySignal<unknown>>, listeners: Set<Callback>, collector: Collector$1<ReadonlySignal<unknown>>, compute: () => T, equals: Maybe<Equals<T>>);
     read(): T;
+    peek(): T;
     equals(other: T): boolean;
     subscribe(callback: Callback): Callback;
     unsubscribe(callback: Callback): void;
@@ -130,6 +136,7 @@ declare class Signal<T> implements Signal$1<T> {
     #private;
     constructor(value: T, equals: Maybe<Equals<T>>, listeners: Set<Callback>, batcher: Collector$1<Callback>, collector: Collector$1<ReadonlySignal<unknown>>);
     read(): T;
+    peek(): T;
     write(value: T): void;
     equals(other: T): boolean;
     subscribe(callback: Callback): Callback;
@@ -191,4 +198,4 @@ interface Config {
 }
 declare function config(config?: Config): void;
 
-export { type Batch, type Callback, type Collector$1 as Collector, type CollectorFactory, type Comparable, type ComposedFactory, type ComputedFactory, type Config, type Effect, type EffectCallback, type EffectCleanup, type Equals, type Factory, type Function, type Ignore, type Maybe, type Reader, type ReadonlySignal, type Signal$1 as Signal, type SignalFactory, type Subscription, type Writer, batch, collector$1 as collector, composed, computed, config, effect$1 as effect, factory, ignore, index as internal, signal$1 as signal };
+export { type Batch, type Callable, type Callback, type Collector$1 as Collector, type CollectorFactory, type Comparable, type ComposedFactory, type ComputedFactory, type Config, type Effect, type EffectCallback, type EffectCleanup, type Equals, type Factory, type Ignore, type Maybe, type Peekable, type Readable, type ReadonlySignal, type Signal$1 as Signal, type SignalFactory, type Subscribable, type Writable, batch, collector$1 as collector, composed, computed, config, effect$1 as effect, factory, ignore, index as internal, signal$1 as signal };

package/dist/index.js

@@ -42,9 +42,13 @@ function factory(name) {
     if (__default__) return __default__(...args);
     throw new Error(`${name}.factory() not configured!`);
   }
-  object.default = (factory2) => __default__ = factory2;
-  object.factory = (factory2) => __factory__ = factory2;
   object.configured = () => __default__ !== null || __factory__ !== null;
+  object.default = (factory2) => {
+    __default__ = factory2 ?? null;
+  };
+  object.factory = (factory2) => {
+    __factory__ = factory2 ?? null;
+  };
   return object;
 }
 
@@ -160,6 +164,9 @@ var Computed = class {
   }
   read() {
     this.#collector.add(this);
+    return this.peek();
+  }
+  peek() {
     if (!this.#empty && !this.#values.some(([dep, value]) => !dep.equals(value))) return this.#value;
     const current = this.#dependencies;
     const next = this.#collector.collect(() => this.#value = this.#compute());
@@ -282,6 +289,9 @@ var Signal = class {
   }
   read() {
     this.#collector.add(this);
+    return this.peek();
+  }
+  peek() {
     return this.#value;
   }
   write(value) {

package/dist/index.mjs

@@ -13,9 +13,13 @@ function factory(name) {
     if (__default__) return __default__(...args);
     throw new Error(`${name}.factory() not configured!`);
   }
-  object.default = (factory2) => __default__ = factory2;
-  object.factory = (factory2) => __factory__ = factory2;
   object.configured = () => __default__ !== null || __factory__ !== null;
+  object.default = (factory2) => {
+    __default__ = factory2 ?? null;
+  };
+  object.factory = (factory2) => {
+    __factory__ = factory2 ?? null;
+  };
   return object;
 }
 
@@ -131,6 +135,9 @@ var Computed = class {
   }
   read() {
     this.#collector.add(this);
+    return this.peek();
+  }
+  peek() {
     if (!this.#empty && !this.#values.some(([dep, value]) => !dep.equals(value))) return this.#value;
     const current = this.#dependencies;
     const next = this.#collector.collect(() => this.#value = this.#compute());
@@ -253,6 +260,9 @@ var Signal = class {
   }
   read() {
     this.#collector.add(this);
+    return this.peek();
+  }
+  peek() {
     return this.#value;
   }
   write(value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valentin30/signal",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "My take on signals - lightweight reactive primitives inspired by Preact Signals, written in TypeScript.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",