@kaumlaut/pure 0.5.0 → 0.5.1

package/docs/runtime/persistence/none.md

@@ -0,0 +1,29 @@
+[**@kaumlaut/pure v0.5.1**](../../README.md)
+
+***
+
+[@kaumlaut/pure](../../README.md) / runtime/persistence/none
+
+# runtime/persistence/none
+
+## Functions
+
+### noPersistence()
+
+> **noPersistence**\<`Model`, `CustomMessage`\>(): [`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>
+
+Defined in: [runtime/persistence/none/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/persistence/none/index.ts#L8)
+
+#### Type Parameters
+
+##### Model
+
+`Model` *extends* [`Cloneable`](../../clone.md#cloneable)
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](../../runtime.md#message)
+
+#### Returns
+
+[`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>

package/docs/runtime/persistence/storage.md

@@ -0,0 +1,39 @@
+[**@kaumlaut/pure v0.5.1**](../../README.md)
+
+***
+
+[@kaumlaut/pure](../../README.md) / runtime/persistence/storage
+
+# runtime/persistence/storage
+
+## Functions
+
+### storagePersistence()
+
+> **storagePersistence**\<`Model`, `CustomMessage`\>(`name`, `storage`): [`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>
+
+Defined in: [runtime/persistence/storage/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/persistence/storage/index.ts#L8)
+
+#### Type Parameters
+
+##### Model
+
+`Model` *extends* [`Cloneable`](../../clone.md#cloneable)
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](../../runtime.md#message)
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### storage
+
+`Storage`
+
+#### Returns
+
+[`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>

package/docs/runtime/persistence.md

@@ -0,0 +1,63 @@
+[**@kaumlaut/pure v0.5.1**](../README.md)
+
+***
+
+[@kaumlaut/pure](../README.md) / runtime/persistence
+
+# runtime/persistence
+
+## Type Aliases
+
+### Persistence\<Model, CustomMessage\>
+
+> **Persistence**\<`Model`, `CustomMessage`\> = `object`
+
+Defined in: [runtime/persistence/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/persistence/index.ts#L6)
+
+#### Type Parameters
+
+##### Model
+
+`Model` *extends* [`Cloneable`](../clone.md#cloneable)
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](../runtime.md#message)
+
+#### Methods
+
+##### persist()
+
+> **persist**(`model`): `void`
+
+Defined in: [runtime/persistence/index.ts:10](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/persistence/index.ts#L10)
+
+###### Parameters
+
+###### model
+
+`Model`
+
+###### Returns
+
+`void`
+
+##### read()
+
+> **read**(`guard`, `init`): [`Result`](../result.md#result)\<`Model`, `string`\>
+
+Defined in: [runtime/persistence/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/persistence/index.ts#L11)
+
+###### Parameters
+
+###### guard
+
+[`Guard`](../guard.md#guard)\<`Model`\>
+
+###### init
+
+[`Init`](../runtime.md#init)\<`Model`, `CustomMessage`\>
+
+###### Returns
+
+[`Result`](../result.md#result)\<`Model`, `string`\>

package/docs/runtime.md

@@ -0,0 +1,167 @@
+[**@kaumlaut/pure v0.5.1**](README.md)
+
+***
+
+[@kaumlaut/pure](README.md) / runtime
+
+# runtime
+
+## Type Aliases
+
+### Change\<CustomMessage, Model\>
+
+> **Change**\<`CustomMessage`, `Model`\> = \[`CustomMessage` \| `null`, `Model`, \{ `meta`: `object` \| `null`; `name`: `string`; \} \| `null`\]
+
+Defined in: [runtime/index.ts:20](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L20)
+
+#### Type Parameters
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](#message)
+
+##### Model
+
+`Model`
+
+***
+
+### Changes\<CustomMessage, Model\>
+
+> **Changes**\<`CustomMessage`, `Model`\> = [`Change`](#change)\<`CustomMessage`, `Model`\>[]
+
+Defined in: [runtime/index.ts:29](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L29)
+
+#### Type Parameters
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](#message)
+
+##### Model
+
+`Model` *extends* [`Cloneable`](clone.md#cloneable)
+
+***
+
+### Init()\<Model, CustomMessage\>
+
+> **Init**\<`Model`, `CustomMessage`\> = (`persistedModel`) => \[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
+
+Defined in: [runtime/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L16)
+
+#### Type Parameters
+
+##### Model
+
+`Model` *extends* [`Cloneable`](clone.md#cloneable)
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](#message)
+
+#### Parameters
+
+##### persistedModel
+
+[`Maybe`](maybe.md#maybe)\<`Model`\>
+
+#### Returns
+
+\[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
+
+***
+
+### Message\<N, T\>
+
+> **Message**\<`N`, `T`\> = `object`
+
+Defined in: [runtime/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L6)
+
+#### Type Parameters
+
+##### N
+
+`N` *extends* `string` = `string`
+
+##### T
+
+`T` = `any`
+
+#### Properties
+
+##### name
+
+> **name**: `N`
+
+Defined in: [runtime/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L8)
+
+##### value
+
+> **value**: `T`
+
+Defined in: [runtime/index.ts:7](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L7)
+
+***
+
+### Update()\<Model, CustomMessage\>
+
+> **Update**\<`Model`, `CustomMessage`\> = (`model`, `msg`) => \[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
+
+Defined in: [runtime/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L11)
+
+#### Type Parameters
+
+##### Model
+
+`Model` *extends* [`Cloneable`](clone.md#cloneable)
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](#message)
+
+#### Parameters
+
+##### model
+
+`Readonly`\<`Model`\>
+
+##### msg
+
+`CustomMessage`
+
+#### Returns
+
+\[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
+
+## Functions
+
+### is()
+
+> **is**\<`CustomMessage`, `A`\>(`name`, `message`): `message is CustomMessage`
+
+Defined in: [runtime/index.ts:34](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/index.ts#L34)
+
+#### Type Parameters
+
+##### CustomMessage
+
+`CustomMessage` *extends* [`Message`](#message)\<`A`, `any`\>
+
+##### A
+
+`A` *extends* `string`
+
+#### Parameters
+
+##### name
+
+`A`
+
+##### message
+
+[`Message`](#message)
+
+#### Returns
+
+`message is CustomMessage`

package/docs/util.md

@@ -0,0 +1,33 @@
+[**@kaumlaut/pure v0.5.1**](README.md)
+
+***
+
+[@kaumlaut/pure](README.md) / util
+
+# util
+
+## Functions
+
+### id()
+
+> **id**\<`T`\>(`value`): `T`
+
+Defined in: [util/index.ts:4](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/util/index.ts#L4)
+
+Returns the given value.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### value
+
+`T`
+
+#### Returns
+
+`T`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaumlaut/pure",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Types and functions for a state runtime inspired by Elm and functional programming",
   "author": "Max Kaemmerer",
   "license": "MIT",
@@ -15,7 +15,9 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "docs",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc",
@@ -37,4 +39,4 @@
     "typescript-eslint": "^8.26.1",
     "vitest": "^3.0.8"
   }
-}
+}