@ersbeth/picoflow 0.2.4 → 1.0.0

package/api/doc/picoflow.stream.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [stream](./picoflow.stream.md)
-
-## stream() function
-
-Creates a new reactive stream.
-
-**Signature:**
-
-```typescript
-export declare function stream<T>(updater: (set: (value: T) => void) => () => void): FlowStream<T>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-updater
-
-
-</td><td>
-
-(set: (value: T) =&gt; void) =&gt; () =&gt; void
-
-
-</td><td>
-
-A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowStream](./picoflow.flowstream.md)<!-- -->&lt;T&gt;
-
-A new instance of [FlowStream](./picoflow.flowstream.md)<!-- -->.
-

package/api/doc/picoflow.streamasync.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [streamAsync](./picoflow.streamasync.md)
-
-## streamAsync() function
-
-Creates a new reactive asynchronous stream.
-
-**Signature:**
-
-```typescript
-export declare function streamAsync<T>(updater: (set: (value: T) => void) => () => void): FlowStreamAsync<T>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-updater
-
-
-</td><td>
-
-(set: (value: T) =&gt; void) =&gt; () =&gt; void
-
-
-</td><td>
-
-A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowStreamAsync](./picoflow.flowstreamasync.md)<!-- -->&lt;T&gt;
-
-A new instance of [FlowStreamAsync](./picoflow.flowstreamasync.md)<!-- -->.
-

package/api/picoflow.public.api.md

@@ -1,244 +0,0 @@
-## 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
-
-import { ResourceFetcher } from 'solid-js';
-
-// @public
-export function array<T>(initial?: T[]): FlowArray<T>;
-
-// @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 FlowArray<T> extends FlowObservable<T[]> {
-    $lastAction: FlowState<FlowArrayAction<T>>;
-    constructor(value?: T[]);
-    clear(): void;
-    dispose(options?: {
-        self: boolean;
-    }): void;
-    get(): T[];
-    get length(): number;
-    pop(): void;
-    push(item: T): void;
-    set(items: T[]): void;
-    setItem(index: number, item: T): void;
-    shift(): void;
-    splice(start: number, deleteCount: number, ...newItems: T[]): void;
-    unshift(item: T): void;
-}
-
-// @public
-export type FlowArrayAction<T> = {
-    type: "set";
-    items: T[];
-} | {
-    type: "setItem";
-    index: number;
-    item: T;
-} | {
-    type: "push";
-    item: T;
-} | {
-    type: "pop";
-} | {
-    type: "unshift";
-    item: T;
-} | {
-    type: "shift";
-} | {
-    type: "splice";
-    start: number;
-    deleteCount: number;
-    items: T[];
-} | {
-    type: "clear";
-};
-
-// @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 interface FlowDisposable {
-    dispose(options?: {
-        self: boolean;
-    }): void;
-}
-
-// @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 implements FlowDisposable {
-    dispose(options?: {
-        self: boolean;
-    }): 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;
-
-// Warning: (ae-forgotten-export) The symbol "NotPromise" needs to be exported by the entry point index.d.ts
-//
-// @public
-export function from<T>(flow: FlowObservable<Promise<NotPromise<T>>>): SolidResource<NotPromise<T>>;
-
-// @public
-export function from<T>(flow: FlowObservable<NotPromise<T>>): SolidDerivation<NotPromise<T>>;
-
-// @public
-export function from<T>(flow: FlowObservable<Promise<NotPromise<T>>> | FlowObservable<NotPromise<T>>): SolidDerivation<NotPromise<T>> | SolidResource<NotPromise<T>>;
-
-// @public
-export function from<T>(flow: (get: FlowGetter) => NotPromise<T>): SolidDerivation<NotPromise<T>>;
-
-// @public
-export function from<T>(flow: (get: FlowGetter) => Promise<NotPromise<T>>): SolidResource<NotPromise<T>>;
-
-// @public
-export function from<T>(flow: ((get: FlowGetter) => NotPromise<T>) | ((get: FlowGetter) => Promise<NotPromise<T>>)): SolidDerivation<T> | SolidResource<T>;
-
-// @public
-export function isDisposable(obj: unknown): obj is FlowDisposable;
-
-// @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 class SolidDerivation<T> implements SolidObservable<T> {
-    constructor(calculator: SolidGetter<T>);
-    readonly get: () => T;
-}
-
-// @public
-export type SolidGetter<T> = ((previous: T) => T) | T;
-
-// @public
-export interface SolidObservable<T> {
-    get: () => T;
-}
-
-// @public
-export class SolidResource<T> implements SolidObservable<T | undefined> {
-    constructor(fetcher: ResourceFetcher<true, T, unknown>);
-    readonly get: () => T | undefined;
-    readonly latest: () => T | undefined;
-    readonly refetch: () => void;
-    readonly state: () => 'unresolved' | 'pending' | 'errored' | 'ready' | 'refreshing';
-}
-
-// @public
-export class SolidState<T> implements SolidObservable<T> {
-    constructor(initialValue: T);
-    readonly get: () => T;
-    readonly set: (param: SolidGetter<T>) => void;
-}
-
-// @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

@@ -1,61 +0,0 @@
-{
-    "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-    "mainEntryPointFilePath": "<projectFolder>/dist/types/index.d.ts",
-    "newlineKind": "lf",
-
-    "apiReport": {
-        "enabled": true,
-        "reportFolder": "<projectFolder>/api/",
-        "reportTempFolder": "<projectFolder>/api/temp/",
-        "reportVariants": ["public"]
-    },
-
-    "docModel": {
-        "enabled": true,
-        "apiJsonFilePath": "<projectFolder>/api/temp/<unscopedPackageName>.api.json",
-
-        /**
-         * The base URL where the project's source code can be viewed on a website such as GitHub or
-         * Azure DevOps. This URL path corresponds to the `<projectFolder>` path on disk.
-         *
-         * This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items.
-         * For example, if the `projectFolderUrl` is "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor" and an API
-         * item's file path is "api/ExtractorConfig.ts", the full URL file path would be
-         * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js".
-         *
-         * This setting can be omitted if you don't need source code links in your API documentation reference.
-         *
-         * SUPPORTED TOKENS: none
-         * DEFAULT VALUE: ""
-         */
-        "projectFolderUrl": "https://gitlab.com/ersbeth-web/picomachine"
-    },
-
-    "dtsRollup": {
-        "enabled": false
-    },
-
-    "tsdocMetadata": {
-        "enabled": false
-    },
-
-    "messages": {
-        "compilerMessageReporting": {
-            "default": {
-                "logLevel": "warning"
-            }
-        },
-
-        "extractorMessageReporting": {
-            "default": {
-                "logLevel": "warning"
-            }
-        },
-
-        "tsdocMessageReporting": {
-            "default": {
-                "logLevel": "warning"
-            }
-        }
-    }
-}