@ersbeth/picoflow 1.1.1 → 2.0.0

package/docs/api/functions/resource.md

@@ -1,52 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / resource
-
-# Function: resource()
-
-```ts
-function resource<T>(fn): FlowResource<T>;
-```
-
-Defined in: [creators.ts:132](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/creators.ts#L132)
-
-Creates a new reactive resource that asynchronously fetches its value, returning `T | undefined`.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the resource value. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fn` | () => `Promise`\<`T`\> | An asynchronous function that fetches the resource value. |
-
-## Returns
-
-[`FlowResource`](/api/classes/FlowResource.md)\<`T`\>
-
-A new instance of [FlowResource](/api/classes/FlowResource.md).
-
-## Remarks
-
-A resource manages async data fetching with reactive updates. Unlike [resourceAsync](/api/functions/resourceAsync.md),
-this returns the resolved value directly (or `undefined` if not fetched yet), making it
-easier to work with in synchronous contexts. Call `fetch()` to trigger the async operation.
-
-## Example
-
-```typescript
-const $user = resource(() => fetch('/api/user').then(r => r.json()));
-
-// Trigger fetch
-await $user.fetch();
-
-// Use in effect
-effect((t) => {
-  const user = $user.get(t);
-  if (user) {
-    console.log(user.name);
-  }
-});
-```

package/docs/api/functions/resourceAsync.md

@@ -1,50 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / resourceAsync
-
-# Function: resourceAsync()
-
-```ts
-function resourceAsync<T>(fn): FlowResourceAsync<T>;
-```
-
-Defined in: [creators.ts:164](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/creators.ts#L164)
-
-Creates a new reactive asynchronous resource that always returns a Promise.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the resource value. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fn` | () => `Promise`\<`T`\> | An asynchronous function that fetches the resource value. |
-
-## Returns
-
-[`FlowResourceAsync`](/api/classes/FlowResourceAsync.md)\<`T`\>
-
-A new instance of [FlowResourceAsync](/api/classes/FlowResourceAsync.md).
-
-## Remarks
-
-An async resource manages async data fetching and always returns a Promise, making it
-ideal for async/await patterns. Unlike [resource](/api/functions/resource.md), the Promise is created lazily
-on first access and cached. Call `fetch()` to create a new Promise and trigger a refetch.
-
-## Example
-
-```typescript
-const $data = resourceAsync(() => fetch('/api/data').then(r => r.json()));
-
-// Use with async/await
-effect(async (t) => {
-  const data = await $data.get(t);
-  console.log(data);
-});
-
-// Refetch
-await $data.fetch();
-```

package/docs/api/functions/stream.md

@@ -1,53 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / stream
-
-# Function: stream()
-
-```ts
-function stream<T>(updater): FlowStream<T>;
-```
-
-Defined in: [creators.ts:200](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/creators.ts#L200)
-
-Creates a new reactive stream that bridges external event sources with PicoFlow's reactive system.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the stream value. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `updater` | (`set`) => () => `void` | A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources. |
-
-## Returns
-
-[`FlowStream`](/api/classes/FlowStream.md)\<`T`\>
-
-A new instance of [FlowStream](/api/classes/FlowStream.md).
-
-## Remarks
-
-Streams are ideal for integrating push-based data sources like WebSockets, DOM events,
-timers, or any event emitter. The updater sets up subscriptions and calls the setter
-when new data arrives. The returned disposer is called on cleanup.
-
-## Example
-
-```typescript
-// WebSocket stream
-const $messages = stream<string>((set) => {
-  const ws = new WebSocket('ws://example.com');
-  ws.onmessage = (e) => set(e.data);
-  return () => ws.close();
-});
-
-// Timer stream
-const $tick = stream<number>((set) => {
-  let count = 0;
-  const id = setInterval(() => set(count++), 1000);
-  return () => clearInterval(id);
-});
-```

package/docs/api/functions/streamAsync.md

@@ -1,50 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / streamAsync
-
-# Function: streamAsync()
-
-```ts
-function streamAsync<T>(updater): FlowStreamAsync<T>;
-```
-
-Defined in: [creators.ts:235](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/creators.ts#L235)
-
-Creates a new reactive asynchronous stream that always returns a Promise.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the stream value. |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `updater` | (`set`) => () => `void` | A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources. |
-
-## Returns
-
-[`FlowStreamAsync`](/api/classes/FlowStreamAsync.md)\<`T`\>
-
-A new instance of [FlowStreamAsync](/api/classes/FlowStreamAsync.md).
-
-## Remarks
-
-Async streams are ideal for push-based async data sources where you want to use async/await.
-Unlike [stream](/api/functions/stream.md), this always returns a Promise that resolves to the value. The initial
-Promise is created on construction and resolves when the setter is first called.
-
-## Example
-
-```typescript
-const $asyncMessages = streamAsync<string>((set) => {
-  const ws = new WebSocket('ws://example.com');
-  ws.onmessage = (e) => set(e.data);
-  return () => ws.close();
-});
-
-effect(async (t) => {
-  const message = await $asyncMessages.get(t);
-  console.log('Received:', message);
-});
-```

package/docs/api/interfaces/SolidObservable.md

@@ -1,19 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / SolidObservable
-
-# Interface: SolidObservable\<T\>
-
-Defined in: [solid/primitives.ts:22](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/solid/primitives.ts#L22)
-
-Interface for a Solid-style observable value.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The value type. |
-
-## Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| <a id="get"></a> `get` | () => `T` | Returns the current value. | [solid/primitives.ts:26](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/solid/primitives.ts#L26) |

package/docs/api/type-aliases/FlowStreamDisposer.md

@@ -1,15 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / FlowStreamDisposer
-
-# Type Alias: FlowStreamDisposer()
-
-```ts
-type FlowStreamDisposer = () => void;
-```
-
-Defined in: [advanced/stream.ts:14](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/stream.ts#L14)
-
-A function type that disposes of a resource.
-
-## Returns
-
-`void`

package/docs/api/type-aliases/FlowStreamSetter.md

@@ -1,27 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / FlowStreamSetter
-
-# Type Alias: FlowStreamSetter()\<T\>
-
-```ts
-type FlowStreamSetter<T> = (value) => void;
-```
-
-Defined in: [advanced/stream.ts:8](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/stream.ts#L8)
-
-A function type that sets a new value for the reactive stream.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the value. |
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `T` |
-
-## Returns
-
-`void`

package/docs/api/type-aliases/FlowStreamUpdater.md

@@ -1,32 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / FlowStreamUpdater
-
-# Type Alias: FlowStreamUpdater()\<T\>
-
-```ts
-type FlowStreamUpdater<T> = (set) => FlowStreamDisposer;
-```
-
-Defined in: [advanced/stream.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/stream.ts#L24)
-
-A function type that updates a stream and returns a disposer for cleanup.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The type of the stream value. |
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `set` | [`FlowStreamSetter`](/api/type-aliases/FlowStreamSetter.md)\<`T`\> |
-
-## Returns
-
-[`FlowStreamDisposer`](/api/type-aliases/FlowStreamDisposer.md)
-
-## Remarks
-
-The updater receives a setter function to update the stream's value.
-It should return a disposer function to release any resources or subscriptions.

package/docs/api/type-aliases/SolidGetter.md

@@ -1,17 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / SolidGetter
-
-# Type Alias: SolidGetter\<T\>
-
-```ts
-type SolidGetter<T> = (previous) => T | T;
-```
-
-Defined in: [solid/primitives.ts:14](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/solid/primitives.ts#L14)
-
-A getter function or value for Solid state/derivation.
-
-## Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` | The value type. |