@ersbeth/picoflow 0.0.1 → 0.1.0

package/api/picoflow.public.api.md

@@ -0,0 +1,131 @@
+## Public API Report File for "@ersbeth/picoflow"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export function constant<T>(value: T | (() => T)): FlowConstant<T>;
+
+// @public
+export function derivation<T>(fn: (get: FlowGetter, watch: FlowWatcher) => T): FlowDerivation<T>;
+
+// @public
+export function effect(fn: (get: FlowGetter, watch: FlowWatcher) => void): FlowEffect;
+
+// @public
+export class FlowConstant<T> extends FlowObservable<T> {
+    constructor(value: T | (() => T));
+    get(): T;
+}
+
+// @public
+export class FlowDerivation<T> extends FlowObservable<T> {
+    constructor(compute: (get: FlowGetter, watch: FlowWatcher) => T);
+    get(): T;
+}
+
+// @public
+export class FlowEffect {
+    constructor(apply: (get: FlowGetter, watch: FlowWatcher) => void);
+    dispose(): void;
+    get disposed(): boolean;
+}
+
+// @public
+export type FlowGetter = <T>(observable: FlowObservable<T>) => T;
+
+// @public
+export class FlowMap<K, V> extends FlowState<Map<K, V>> {
+    $lastDeleted: FlowState<{
+        key?: K;
+        value?: V;
+    }>;
+    $lastSet: FlowState<{
+        key?: K;
+        value?: V;
+    }>;
+    delete(key: K): void;
+    setAt(key: K, value: V): void;
+}
+
+// @public
+export abstract class FlowObservable<T> extends FlowSignal {
+    abstract get(): T;
+    subscribe(listener: (value: T) => void): () => void;
+}
+
+// @public
+export class FlowResource<T> extends FlowObservable<T | undefined> {
+    constructor(fetch: () => Promise<T>);
+    fetch(): Promise<void>;
+    get(): T | undefined;
+}
+
+// @public
+export class FlowResourceAsync<T> extends FlowObservable<Promise<T>> {
+    constructor(fetch: () => Promise<T>);
+    fetch(): Promise<void>;
+    get(): Promise<T>;
+}
+
+// @public
+export class FlowSignal {
+    dispose(): void;
+    get disposed(): boolean;
+    trigger(): void;
+}
+
+// @public
+export class FlowState<T> extends FlowConstant<T> {
+    set(value: T | ((current: T) => T)): void;
+}
+
+// @public
+export class FlowStream<T> extends FlowObservable<T | undefined> {
+    constructor(updater: FlowStreamUpdater<T>);
+    dispose(): void;
+    get(): T | undefined;
+}
+
+// @public
+export class FlowStreamAsync<T> extends FlowObservable<Promise<T>> {
+    constructor(updater: FlowStreamUpdater<T>);
+    dispose(): void;
+    get(): Promise<T>;
+}
+
+// @public
+export type FlowStreamDisposer = () => void;
+
+// @public
+export type FlowStreamSetter<T> = (value: T) => void;
+
+// @public
+export type FlowStreamUpdater<T> = (set: FlowStreamSetter<T>) => FlowStreamDisposer;
+
+// @public
+export type FlowWatcher = (signal: FlowSignal) => void;
+
+// @public
+export function map<K extends string | number | symbol, V>(initial?: Record<K, V>): FlowMap<K, V>;
+
+// @public
+export function resource<T>(fn: () => Promise<T>): FlowResource<T>;
+
+// @public
+export function resourceAsync<T>(fn: () => Promise<T>): FlowResourceAsync<T>;
+
+// @public
+export function signal(): FlowSignal;
+
+// @public
+export function state<T>(value: T | (() => T)): FlowState<T>;
+
+// @public
+export function stream<T>(updater: (set: (value: T) => void) => () => void): FlowStream<T>;
+
+// @public
+export function streamAsync<T>(updater: (set: (value: T) => void) => () => void): FlowStreamAsync<T>;
+
+```

package/api-extractor.json

@@ -6,7 +6,8 @@
     "apiReport": {
         "enabled": true,
         "reportFolder": "<projectFolder>/api/",
-        "reportTempFolder": "<projectFolder>/api/temp/"
+        "reportTempFolder": "<projectFolder>/api/temp/",
+        "reportVariants": ["public"]
     },
 
     "docModel": {