@manyducks.co/dolla 3.1.0 → 3.3.0

package/dist/core/index.d.ts

@@ -1,6 +1,6 @@
 export { createRoot } from "./root.js";
 export type { DollaPlugin } from "./root.js";
-export { batch, compose, createAtom, createEffect, peek, subscribe, unwrap } from "./signals.js";
+export { batch, compose, createAtom, createEffect, createSetter, createStream, peek, subscribe, unwrap, } from "./signals.js";
 export type { Getter, Setter } from "./signals.js";
 export { addStore, getNearestViewNode, getRootElement, getStore, onCleanup, onEffect, onMount } from "./context.js";
 export type { Context } from "./context.js";

package/dist/core/signals.d.ts

@@ -1,3 +1,4 @@
+import { Context } from "./index.js";
 /**
  * Returns the currently held value. Registers the state as a dependency when called within a tracking context.
  */
@@ -41,7 +42,25 @@ export declare function createAtom<T>(): AtomAccessors<T | undefined>;
  * getValue("overwritten");
  * getInputValue(); // "overwritten"
  */
-export declare function createAtom<T>(compute: Getter<T>): AtomAccessors<T>;
+export declare function createAtom<T>(initialValue: Getter<T>): AtomAccessors<T>;
+/**
+ * Creates a new atom with a value computed from an existing getter.
+ * This is usually used to create a 'settable' getter, in which you can store
+ * a temporary value until it gets overwritten by a _real_ update.
+ *
+ * @example
+ * const [getValue, setValue] = createAtom("");
+ * const [getInputValue, setInputValue] = createAtom(getValue);
+ *
+ * setInputValue("temporary");
+ * getValue("");
+ * getInputValue(); // "temporary"
+ *
+ * setValue("overwritten");
+ * getValue("overwritten");
+ * getInputValue(); // "overwritten"
+ */
+export declare function createAtom<T>(initialValue: MaybeGetter<T>): AtomAccessors<T>;
 /**
  * Creates a new atom with an initial value.
  * Returns a `[getter, setter]` function tuple.
@@ -50,7 +69,11 @@ export declare function createAtom<T>(compute: Getter<T>): AtomAccessors<T>;
  * const [getCount, setCount] = createAtom(5);
  */
 export declare function createAtom<T>(initialValue: T): AtomAccessors<T>;
-export declare function compose<T>(getter: (previousValue?: T) => Getter<T> | T): Getter<T>;
+/**
+ * Creates a customsetter with a `getter` as its source.
+ */
+export declare function createSetter<T>(getter: Getter<T>, callback: (current: T) => T | void): Setter<T>;
+export declare function compose<T>(getter: T | ((previousValue?: T) => Getter<T> | T)): Getter<T>;
 export declare function createEffect(fn: () => void): () => void;
 /**
  * Unwraps a `MaybeGetter<T>` into a plain `T`.
@@ -68,3 +91,34 @@ export declare function peek<T>(value: T | Getter<T>): T;
  */
 export declare function batch(callback: () => void): void;
 export declare function subscribe<T>(target: Getter<T>, fn: (value: T) => any): () => void;
+export interface StreamOptions<T> {
+    /**
+     * An initial value for non-nullable streams.
+     */
+    initialValue?: T;
+    /**
+     * Cancel pending `next` listeners when this context is unmounted.
+     */
+    context?: Context;
+    /**
+     * Number of emitted values to keep. Defaults to 0 (latest value only).
+     */
+    history?: number;
+}
+export interface StreamOptionsWithValue<T> extends StreamOptions<T> {
+    initialValue: T;
+}
+export interface Stream<T> {
+    readonly latest: T;
+    current: Getter<T>;
+    next(): Promise<T>;
+    map<O>(callback: (value: T, previous?: O) => O): Stream<O>;
+    reduce<O>(callback: (reduced: O, value: T) => O, initialValue: O): Stream<O>;
+    filter(callback: (value: T, previous?: T) => boolean, defaultValue: T): Stream<T>;
+    filter(callback: (value: T, previous?: T) => boolean, defaultValue?: T): Stream<T | undefined>;
+    throttle(milliseconds: number): Stream<T>;
+    debounce(milliseconds: number): Stream<T>;
+    delay(milliseconds: number, initialValue?: T): Stream<T>;
+}
+export declare function createStream<T>(options: StreamOptionsWithValue<T>): [Stream<T>, Setter<T>];
+export declare function createStream<T>(options: StreamOptions<T>): [Stream<T | undefined>, Setter<T | undefined>];