@kaumlaut/pure 0.5.2 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1 -1
  3. package/package.json +12 -4
  4. package/docs/README.md +0 -23
  5. package/docs/clone.md +0 -45
  6. package/docs/fetch-state.md +0 -368
  7. package/docs/guard.md +0 -729
  8. package/docs/maybe.md +0 -481
  9. package/docs/parse.md +0 -47
  10. package/docs/pipe.md +0 -95
  11. package/docs/result.md +0 -363
  12. package/docs/runtime/effect/fetch.md +0 -169
  13. package/docs/runtime/effect/none.md +0 -19
  14. package/docs/runtime/effect.md +0 -179
  15. package/docs/runtime/persistence/none.md +0 -29
  16. package/docs/runtime/persistence/storage.md +0 -39
  17. package/docs/runtime/persistence.md +0 -63
  18. package/docs/runtime.md +0 -167
  19. package/docs/util.md +0 -33
package/docs/runtime/persistence/none.md DELETED
@@ -1,29 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](../../README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](../../README.md) / runtime/persistence/none
6
-
7
- # runtime/persistence/none
8
-
9
- ## Functions
10
-
11
- ### noPersistence()
12
-
13
- > **noPersistence**\<`Model`, `CustomMessage`\>(): [`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>
14
-
15
- Defined in: [runtime/persistence/none/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/persistence/none/index.ts#L8)
16
-
17
- #### Type Parameters
18
-
19
- ##### Model
20
-
21
- `Model` *extends* [`Cloneable`](../../clone.md#cloneable)
22
-
23
- ##### CustomMessage
24
-
25
- `CustomMessage` *extends* [`Message`](../../runtime.md#message)
26
-
27
- #### Returns
28
-
29
- [`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>
package/docs/runtime/persistence/storage.md DELETED
@@ -1,39 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](../../README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](../../README.md) / runtime/persistence/storage
6
-
7
- # runtime/persistence/storage
8
-
9
- ## Functions
10
-
11
- ### storagePersistence()
12
-
13
- > **storagePersistence**\<`Model`, `CustomMessage`\>(`name`, `storage`): [`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>
14
-
15
- Defined in: [runtime/persistence/storage/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/persistence/storage/index.ts#L8)
16
-
17
- #### Type Parameters
18
-
19
- ##### Model
20
-
21
- `Model` *extends* [`Cloneable`](../../clone.md#cloneable)
22
-
23
- ##### CustomMessage
24
-
25
- `CustomMessage` *extends* [`Message`](../../runtime.md#message)
26
-
27
- #### Parameters
28
-
29
- ##### name
30
-
31
- `string`
32
-
33
- ##### storage
34
-
35
- `Storage`
36
-
37
- #### Returns
38
-
39
- [`Persistence`](../persistence.md#persistence)\<`Model`, `CustomMessage`\>
package/docs/runtime/persistence.md DELETED
@@ -1,63 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](../README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](../README.md) / runtime/persistence
6
-
7
- # runtime/persistence
8
-
9
- ## Type Aliases
10
-
11
- ### Persistence\<Model, CustomMessage\>
12
-
13
- > **Persistence**\<`Model`, `CustomMessage`\> = `object`
14
-
15
- Defined in: [runtime/persistence/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/persistence/index.ts#L6)
16
-
17
- #### Type Parameters
18
-
19
- ##### Model
20
-
21
- `Model` *extends* [`Cloneable`](../clone.md#cloneable)
22
-
23
- ##### CustomMessage
24
-
25
- `CustomMessage` *extends* [`Message`](../runtime.md#message)
26
-
27
- #### Methods
28
-
29
- ##### persist()
30
-
31
- > **persist**(`model`): `void`
32
-
33
- Defined in: [runtime/persistence/index.ts:10](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/persistence/index.ts#L10)
34
-
35
- ###### Parameters
36
-
37
- ###### model
38
-
39
- `Model`
40
-
41
- ###### Returns
42
-
43
- `void`
44
-
45
- ##### read()
46
-
47
- > **read**(`guard`, `init`): [`Result`](../result.md#result)\<`Model`, `string`\>
48
-
49
- Defined in: [runtime/persistence/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/persistence/index.ts#L11)
50
-
51
- ###### Parameters
52
-
53
- ###### guard
54
-
55
- [`Guard`](../guard.md#guard)\<`Model`\>
56
-
57
- ###### init
58
-
59
- [`Init`](../runtime.md#init)\<`Model`, `CustomMessage`\>
60
-
61
- ###### Returns
62
-
63
- [`Result`](../result.md#result)\<`Model`, `string`\>
package/docs/runtime.md DELETED
@@ -1,167 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](README.md) / runtime
6
-
7
- # runtime
8
-
9
- ## Type Aliases
10
-
11
- ### Change\<CustomMessage, Model\>
12
-
13
- > **Change**\<`CustomMessage`, `Model`\> = \[`CustomMessage` \| `null`, `Model`, \{ `meta`: `object` \| `null`; `name`: `string`; \} \| `null`\]
14
-
15
- Defined in: [runtime/index.ts:20](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L20)
16
-
17
- #### Type Parameters
18
-
19
- ##### CustomMessage
20
-
21
- `CustomMessage` *extends* [`Message`](#message)
22
-
23
- ##### Model
24
-
25
- `Model`
26
-
27
- ***
28
-
29
- ### Changes\<CustomMessage, Model\>
30
-
31
- > **Changes**\<`CustomMessage`, `Model`\> = [`Change`](#change)\<`CustomMessage`, `Model`\>[]
32
-
33
- Defined in: [runtime/index.ts:29](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L29)
34
-
35
- #### Type Parameters
36
-
37
- ##### CustomMessage
38
-
39
- `CustomMessage` *extends* [`Message`](#message)
40
-
41
- ##### Model
42
-
43
- `Model` *extends* [`Cloneable`](clone.md#cloneable)
44
-
45
- ***
46
-
47
- ### Init()\<Model, CustomMessage\>
48
-
49
- > **Init**\<`Model`, `CustomMessage`\> = (`persistedModel`) => \[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
50
-
51
- Defined in: [runtime/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L16)
52
-
53
- #### Type Parameters
54
-
55
- ##### Model
56
-
57
- `Model` *extends* [`Cloneable`](clone.md#cloneable)
58
-
59
- ##### CustomMessage
60
-
61
- `CustomMessage` *extends* [`Message`](#message)
62
-
63
- #### Parameters
64
-
65
- ##### persistedModel
66
-
67
- [`Maybe`](maybe.md#maybe)\<`Model`\>
68
-
69
- #### Returns
70
-
71
- \[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
72
-
73
- ***
74
-
75
- ### Message\<N, T\>
76
-
77
- > **Message**\<`N`, `T`\> = `object`
78
-
79
- Defined in: [runtime/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L6)
80
-
81
- #### Type Parameters
82
-
83
- ##### N
84
-
85
- `N` *extends* `string` = `string`
86
-
87
- ##### T
88
-
89
- `T` = `any`
90
-
91
- #### Properties
92
-
93
- ##### name
94
-
95
- > **name**: `N`
96
-
97
- Defined in: [runtime/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L8)
98
-
99
- ##### value
100
-
101
- > **value**: `T`
102
-
103
- Defined in: [runtime/index.ts:7](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L7)
104
-
105
- ***
106
-
107
- ### Update()\<Model, CustomMessage\>
108
-
109
- > **Update**\<`Model`, `CustomMessage`\> = (`model`, `msg`) => \[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
110
-
111
- Defined in: [runtime/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L11)
112
-
113
- #### Type Parameters
114
-
115
- ##### Model
116
-
117
- `Model` *extends* [`Cloneable`](clone.md#cloneable)
118
-
119
- ##### CustomMessage
120
-
121
- `CustomMessage` *extends* [`Message`](#message)
122
-
123
- #### Parameters
124
-
125
- ##### model
126
-
127
- `Readonly`\<`Model`\>
128
-
129
- ##### msg
130
-
131
- `CustomMessage`
132
-
133
- #### Returns
134
-
135
- \[`Model`, [`Effect`](runtime/effect.md#effect)\<`CustomMessage`\>\]
136
-
137
- ## Functions
138
-
139
- ### is()
140
-
141
- > **is**\<`CustomMessage`, `A`\>(`name`, `message`): `message is CustomMessage`
142
-
143
- Defined in: [runtime/index.ts:34](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/index.ts#L34)
144
-
145
- #### Type Parameters
146
-
147
- ##### CustomMessage
148
-
149
- `CustomMessage` *extends* [`Message`](#message)\<`A`, `any`\>
150
-
151
- ##### A
152
-
153
- `A` *extends* `string`
154
-
155
- #### Parameters
156
-
157
- ##### name
158
-
159
- `A`
160
-
161
- ##### message
162
-
163
- [`Message`](#message)
164
-
165
- #### Returns
166
-
167
- `message is CustomMessage`
package/docs/util.md DELETED
@@ -1,33 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](README.md) / util
6
-
7
- # util
8
-
9
- ## Functions
10
-
11
- ### id()
12
-
13
- > **id**\<`T`\>(`value`): `T`
14
-
15
- Defined in: [util/index.ts:4](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/util/index.ts#L4)
16
-
17
- Returns the given value.
18
-
19
- #### Type Parameters
20
-
21
- ##### T
22
-
23
- `T`
24
-
25
- #### Parameters
26
-
27
- ##### value
28
-
29
- `T`
30
-
31
- #### Returns
32
-
33
- `T`