@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/result.md DELETED
@@ -1,363 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](README.md) / result
6
-
7
- # result
8
-
9
- ## Type Aliases
10
-
11
- ### Err\<T\>
12
-
13
- > **Err**\<`T`\> = `object`
14
-
15
- Defined in: [result/index.ts:14](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L14)
16
-
17
- Represents the Result of an action that failed and contains a corresponding error.
18
-
19
- #### Type Parameters
20
-
21
- ##### T
22
-
23
- `T`
24
-
25
- #### Properties
26
-
27
- ##### error
28
-
29
- > **error**: `T`
30
-
31
- Defined in: [result/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L16)
32
-
33
- ##### type
34
-
35
- > **type**: `"error-result"`
36
-
37
- Defined in: [result/index.ts:15](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L15)
38
-
39
- ***
40
-
41
- ### Ok\<T\>
42
-
43
- > **Ok**\<`T`\> = `object`
44
-
45
- Defined in: [result/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L6)
46
-
47
- Represents the Result of an action that succeeded and contains a corresponding value.
48
-
49
- #### Type Parameters
50
-
51
- ##### T
52
-
53
- `T`
54
-
55
- #### Properties
56
-
57
- ##### type
58
-
59
- > **type**: `"ok-result"`
60
-
61
- Defined in: [result/index.ts:7](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L7)
62
-
63
- ##### value
64
-
65
- > **value**: `T`
66
-
67
- Defined in: [result/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L8)
68
-
69
- ***
70
-
71
- ### Result\<T, E\>
72
-
73
- > **Result**\<`T`, `E`\> = [`Ok`](#ok)\<`T`\> \| [`Err`](#err)\<`E`\>
74
-
75
- Defined in: [result/index.ts:22](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L22)
76
-
77
- Represents the Result of an action that can fail.
78
-
79
- #### Type Parameters
80
-
81
- ##### T
82
-
83
- `T`
84
-
85
- ##### E
86
-
87
- `E`
88
-
89
- ## Functions
90
-
91
- ### err()
92
-
93
- > **err**\<`E`\>(`error`): [`Err`](#err)\<`E`\>
94
-
95
- Defined in: [result/index.ts:51](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L51)
96
-
97
- Creates a Result of type Err containg the given error.
98
-
99
- #### Type Parameters
100
-
101
- ##### E
102
-
103
- `E`
104
-
105
- #### Parameters
106
-
107
- ##### error
108
-
109
- `E`
110
-
111
- #### Returns
112
-
113
- [`Err`](#err)\<`E`\>
114
-
115
- ***
116
-
117
- ### isErr()
118
-
119
- > **isErr**\<`T`, `E`\>(`result`): `result is Err<E>`
120
-
121
- Defined in: [result/index.ts:34](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L34)
122
-
123
- A Guard conforming that the given Result is of type Err.
124
-
125
- #### Type Parameters
126
-
127
- ##### T
128
-
129
- `T`
130
-
131
- ##### E
132
-
133
- `E`
134
-
135
- #### Parameters
136
-
137
- ##### result
138
-
139
- [`Result`](#result)\<`T`, `E`\>
140
-
141
- #### Returns
142
-
143
- `result is Err<E>`
144
-
145
- ***
146
-
147
- ### isOk()
148
-
149
- > **isOk**\<`T`, `E`\>(`result`): `result is Ok<T>`
150
-
151
- Defined in: [result/index.ts:27](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L27)
152
-
153
- A Guard conforming that the given Result is of type Ok.
154
-
155
- #### Type Parameters
156
-
157
- ##### T
158
-
159
- `T`
160
-
161
- ##### E
162
-
163
- `E`
164
-
165
- #### Parameters
166
-
167
- ##### result
168
-
169
- [`Result`](#result)\<`T`, `E`\>
170
-
171
- #### Returns
172
-
173
- `result is Ok<T>`
174
-
175
- ***
176
-
177
- ### map()
178
-
179
- > **map**\<`T`, `E`, `R`\>(`func`): (`result`) => [`Result`](#result)\<`R`, `E`\>
180
-
181
- Defined in: [result/index.ts:62](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L62)
182
-
183
- When Result is Ok: Applies the func function to the contained value and wraps it in Ok again.
184
- When Result is Err: Returns the given Result.
185
-
186
- #### Type Parameters
187
-
188
- ##### T
189
-
190
- `T`
191
-
192
- ##### E
193
-
194
- `E`
195
-
196
- ##### R
197
-
198
- `R`
199
-
200
- #### Parameters
201
-
202
- ##### func
203
-
204
- (`value`) => `R`
205
-
206
- #### Returns
207
-
208
- > (`result`): [`Result`](#result)\<`R`, `E`\>
209
-
210
- ##### Parameters
211
-
212
- ###### result
213
-
214
- [`Result`](#result)\<`T`, `E`\>
215
-
216
- ##### Returns
217
-
218
- [`Result`](#result)\<`R`, `E`\>
219
-
220
- ***
221
-
222
- ### mapErr()
223
-
224
- > **mapErr**\<`T`, `E`, `R`\>(`func`): (`result`) => [`Result`](#result)\<`T`, `R`\>
225
-
226
- Defined in: [result/index.ts:78](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L78)
227
-
228
- When Result is Ok: Returns the given Result.
229
- When Result is Err: Applies the func function to the contained error and wraps it in Err again.
230
-
231
- #### Type Parameters
232
-
233
- ##### T
234
-
235
- `T`
236
-
237
- ##### E
238
-
239
- `E`
240
-
241
- ##### R
242
-
243
- `R`
244
-
245
- #### Parameters
246
-
247
- ##### func
248
-
249
- (`value`) => `R`
250
-
251
- #### Returns
252
-
253
- > (`result`): [`Result`](#result)\<`T`, `R`\>
254
-
255
- ##### Parameters
256
-
257
- ###### result
258
-
259
- [`Result`](#result)\<`T`, `E`\>
260
-
261
- ##### Returns
262
-
263
- [`Result`](#result)\<`T`, `R`\>
264
-
265
- ***
266
-
267
- ### ok()
268
-
269
- > **ok**\<`T`\>(`value`): [`Ok`](#ok)\<`T`\>
270
-
271
- Defined in: [result/index.ts:41](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L41)
272
-
273
- Creates a Result of type Ok containg the given value.
274
-
275
- #### Type Parameters
276
-
277
- ##### T
278
-
279
- `T`
280
-
281
- #### Parameters
282
-
283
- ##### value
284
-
285
- `T`
286
-
287
- #### Returns
288
-
289
- [`Ok`](#ok)\<`T`\>
290
-
291
- ***
292
-
293
- ### toMaybe()
294
-
295
- > **toMaybe**\<`T`, `E`\>(`result`): [`Maybe`](maybe.md#maybe)\<`T`\>
296
-
297
- Defined in: [result/index.ts:112](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L112)
298
-
299
- Converts the given Result to a Maybe
300
- When Result is Ok: Returns a Just containing the value.
301
- When Result is Err: Returns a Nothing.
302
-
303
- #### Type Parameters
304
-
305
- ##### T
306
-
307
- `T`
308
-
309
- ##### E
310
-
311
- `E`
312
-
313
- #### Parameters
314
-
315
- ##### result
316
-
317
- [`Result`](#result)\<`T`, `E`\>
318
-
319
- #### Returns
320
-
321
- [`Maybe`](maybe.md#maybe)\<`T`\>
322
-
323
- ***
324
-
325
- ### withDefault()
326
-
327
- > **withDefault**\<`T`, `E`\>(`defaultValue`): (`result`) => `T`
328
-
329
- Defined in: [result/index.ts:95](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/result/index.ts#L95)
330
-
331
- Unwrap a result to either its contained value or the default value.
332
- When Result is Ok: Returns the nested value.
333
- When Result is Err: Returns the given default value.
334
-
335
- #### Type Parameters
336
-
337
- ##### T
338
-
339
- `T`
340
-
341
- ##### E
342
-
343
- `E`
344
-
345
- #### Parameters
346
-
347
- ##### defaultValue
348
-
349
- `T`
350
-
351
- #### Returns
352
-
353
- > (`result`): `T`
354
-
355
- ##### Parameters
356
-
357
- ###### result
358
-
359
- [`Result`](#result)\<`T`, `E`\>
360
-
361
- ##### Returns
362
-
363
- `T`
package/docs/runtime/effect/fetch.md DELETED
@@ -1,169 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](../../README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](../../README.md) / runtime/effect/fetch
6
-
7
- # runtime/effect/fetch
8
-
9
- ## Type Aliases
10
-
11
- ### FetchError
12
-
13
- > **FetchError** = [`HttpError`](#httperror) \| [`MalformedPayloadError`](#malformedpayloaderror)
14
-
15
- Defined in: [runtime/effect/fetch/index.ts:19](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L19)
16
-
17
- ***
18
-
19
- ### HttpError
20
-
21
- > **HttpError** = `object`
22
-
23
- Defined in: [runtime/effect/fetch/index.ts:10](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L10)
24
-
25
- #### Properties
26
-
27
- ##### code
28
-
29
- > **code**: `number`
30
-
31
- Defined in: [runtime/effect/fetch/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L11)
32
-
33
- ##### message
34
-
35
- > **message**: `string`
36
-
37
- Defined in: [runtime/effect/fetch/index.ts:12](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L12)
38
-
39
- ***
40
-
41
- ### MalformedPayloadError
42
-
43
- > **MalformedPayloadError** = `object`
44
-
45
- Defined in: [runtime/effect/fetch/index.ts:15](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L15)
46
-
47
- #### Properties
48
-
49
- ##### message
50
-
51
- > **message**: `string`
52
-
53
- Defined in: [runtime/effect/fetch/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L16)
54
-
55
- ## Functions
56
-
57
- ### fetchJson()
58
-
59
- > **fetchJson**\<`T`, `M`\>(`url`, `headers`, `method`, `guard`, `receiver`): [`Effect`](../effect.md#effect)\<`M`\>
60
-
61
- Defined in: [runtime/effect/fetch/index.ts:40](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L40)
62
-
63
- #### Type Parameters
64
-
65
- ##### T
66
-
67
- `T`
68
-
69
- ##### M
70
-
71
- `M` *extends* [`Message`](../../runtime.md#message)
72
-
73
- #### Parameters
74
-
75
- ##### url
76
-
77
- `string`
78
-
79
- ##### headers
80
-
81
- \[`string`, `string`\][]
82
-
83
- ##### method
84
-
85
- `string`
86
-
87
- ##### guard
88
-
89
- [`Guard`](../../guard.md#guard)\<`T`\>
90
-
91
- ##### receiver
92
-
93
- [`ReceiveEffectResult`](../effect.md#receiveeffectresult)\<`T`, [`FetchError`](#fetcherror), `M`\>
94
-
95
- #### Returns
96
-
97
- [`Effect`](../effect.md#effect)\<`M`\>
98
-
99
- ***
100
-
101
- ### isClient()
102
-
103
- > **isClient**(`error`): `boolean`
104
-
105
- Defined in: [runtime/effect/fetch/index.ts:32](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L32)
106
-
107
- #### Parameters
108
-
109
- ##### error
110
-
111
- [`FetchError`](#fetcherror)
112
-
113
- #### Returns
114
-
115
- `boolean`
116
-
117
- ***
118
-
119
- ### isHttp()
120
-
121
- > **isHttp**(`error`): `error is HttpError`
122
-
123
- Defined in: [runtime/effect/fetch/index.ts:25](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L25)
124
-
125
- #### Parameters
126
-
127
- ##### error
128
-
129
- [`FetchError`](#fetcherror)
130
-
131
- #### Returns
132
-
133
- `error is HttpError`
134
-
135
- ***
136
-
137
- ### isNotFound()
138
-
139
- > **isNotFound**(`error`): `boolean`
140
-
141
- Defined in: [runtime/effect/fetch/index.ts:21](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L21)
142
-
143
- #### Parameters
144
-
145
- ##### error
146
-
147
- [`FetchError`](#fetcherror)
148
-
149
- #### Returns
150
-
151
- `boolean`
152
-
153
- ***
154
-
155
- ### isServer()
156
-
157
- > **isServer**(`error`): `boolean`
158
-
159
- Defined in: [runtime/effect/fetch/index.ts:36](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/fetch/index.ts#L36)
160
-
161
- #### Parameters
162
-
163
- ##### error
164
-
165
- [`FetchError`](#fetcherror)
166
-
167
- #### Returns
168
-
169
- `boolean`
package/docs/runtime/effect/none.md DELETED
@@ -1,19 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](../../README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](../../README.md) / runtime/effect/none
6
-
7
- # runtime/effect/none
8
-
9
- ## Functions
10
-
11
- ### none()
12
-
13
- > **none**(): [`Effect`](../effect.md#effect)\<`any`\>
14
-
15
- Defined in: [runtime/effect/none/index.ts:4](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/none/index.ts#L4)
16
-
17
- #### Returns
18
-
19
- [`Effect`](../effect.md#effect)\<`any`\>
package/docs/runtime/effect.md DELETED
@@ -1,179 +0,0 @@
1
- [**@kaumlaut/pure v0.5.2**](../README.md)
2
-
3
- ***
4
-
5
- [@kaumlaut/pure](../README.md) / runtime/effect
6
-
7
- # runtime/effect
8
-
9
- ## Type Aliases
10
-
11
- ### AsyncEffect()\<T\>
12
-
13
- > **AsyncEffect**\<`T`\> = () => `Promise`\<`T`\>
14
-
15
- Defined in: [runtime/effect/index.ts:4](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L4)
16
-
17
- #### Type Parameters
18
-
19
- ##### T
20
-
21
- `T` *extends* [`Message`](../runtime.md#message)
22
-
23
- #### Returns
24
-
25
- `Promise`\<`T`\>
26
-
27
- ***
28
-
29
- ### AsyncNullEffect()
30
-
31
- > **AsyncNullEffect** = () => `Promise`\<`null`\>
32
-
33
- Defined in: [runtime/effect/index.ts:7](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L7)
34
-
35
- #### Returns
36
-
37
- `Promise`\<`null`\>
38
-
39
- ***
40
-
41
- ### Effect\<T\>
42
-
43
- > **Effect**\<`T`\> = `object`
44
-
45
- Defined in: [runtime/effect/index.ts:13](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L13)
46
-
47
- #### Type Parameters
48
-
49
- ##### T
50
-
51
- `T` *extends* [`Message`](../runtime.md#message)
52
-
53
- #### Properties
54
-
55
- ##### effectType
56
-
57
- > **effectType**: [`EffectType`](#effecttype-1)\<`T`\>
58
-
59
- Defined in: [runtime/effect/index.ts:14](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L14)
60
-
61
- ##### meta
62
-
63
- > **meta**: `object` \| `null`
64
-
65
- Defined in: [runtime/effect/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L16)
66
-
67
- ##### name
68
-
69
- > **name**: `string`
70
-
71
- Defined in: [runtime/effect/index.ts:15](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L15)
72
-
73
- ***
74
-
75
- ### EffectType\<T\>
76
-
77
- > **EffectType**\<`T`\> = [`AsyncEffect`](#asynceffect)\<`T`\> \| [`SyncEffect`](#synceffect)\<`T`\> \| [`NullEffect`](#nulleffect) \| [`AsyncNullEffect`](#asyncnulleffect)
78
-
79
- Defined in: [runtime/effect/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L8)
80
-
81
- #### Type Parameters
82
-
83
- ##### T
84
-
85
- `T` *extends* [`Message`](../runtime.md#message)
86
-
87
- ***
88
-
89
- ### NullEffect()
90
-
91
- > **NullEffect** = () => `null`
92
-
93
- Defined in: [runtime/effect/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L6)
94
-
95
- #### Returns
96
-
97
- `null`
98
-
99
- ***
100
-
101
- ### ReceiveEffectResult()\<T, E, R\>
102
-
103
- > **ReceiveEffectResult**\<`T`, `E`, `R`\> = (`result`) => `R`
104
-
105
- Defined in: [runtime/effect/index.ts:31](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L31)
106
-
107
- #### Type Parameters
108
-
109
- ##### T
110
-
111
- `T`
112
-
113
- ##### E
114
-
115
- `E`
116
-
117
- ##### R
118
-
119
- `R`
120
-
121
- #### Parameters
122
-
123
- ##### result
124
-
125
- [`Result`](../result.md#result)\<`T`, `E`\>
126
-
127
- #### Returns
128
-
129
- `R`
130
-
131
- ***
132
-
133
- ### SyncEffect()\<T\>
134
-
135
- > **SyncEffect**\<`T`\> = () => `T`
136
-
137
- Defined in: [runtime/effect/index.ts:5](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L5)
138
-
139
- #### Type Parameters
140
-
141
- ##### T
142
-
143
- `T` *extends* [`Message`](../runtime.md#message)
144
-
145
- #### Returns
146
-
147
- `T`
148
-
149
- ## Functions
150
-
151
- ### withName()
152
-
153
- > **withName**\<`T`\>(`name`, `effect`, `meta`): [`Effect`](#effect)\<`T`\>
154
-
155
- Defined in: [runtime/effect/index.ts:19](https://github.com/maxkaemmerer/pure-vue-poc/blob/1f00f47d2f3c329e3dda9a01eb5ed8ebf93253d3/pure/src/runtime/effect/index.ts#L19)
156
-
157
- #### Type Parameters
158
-
159
- ##### T
160
-
161
- `T` *extends* [`Message`](../runtime.md#message)
162
-
163
- #### Parameters
164
-
165
- ##### name
166
-
167
- `string`
168
-
169
- ##### effect
170
-
171
- [`EffectType`](#effecttype-1)\<`T`\>
172
-
173
- ##### meta
174
-
175
- `object` = `null`
176
-
177
- #### Returns
178
-
179
- [`Effect`](#effect)\<`T`\>