@kaumlaut/pure 0.4.0 → 0.5.1

package/docs/result.md

@@ -0,0 +1,363 @@
+[**@kaumlaut/pure v0.5.1**](README.md)
+
+***
+
+[@kaumlaut/pure](README.md) / result
+
+# result
+
+## Type Aliases
+
+### Err\<T\>
+
+> **Err**\<`T`\> = `object`
+
+Defined in: [result/index.ts:14](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L14)
+
+Represents the Result of an action that failed and contains a corresponding error.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Properties
+
+##### error
+
+> **error**: `T`
+
+Defined in: [result/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L16)
+
+##### type
+
+> **type**: `"error-result"`
+
+Defined in: [result/index.ts:15](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L15)
+
+***
+
+### Ok\<T\>
+
+> **Ok**\<`T`\> = `object`
+
+Defined in: [result/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L6)
+
+Represents the Result of an action that succeeded and contains a corresponding value.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Properties
+
+##### type
+
+> **type**: `"ok-result"`
+
+Defined in: [result/index.ts:7](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L7)
+
+##### value
+
+> **value**: `T`
+
+Defined in: [result/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L8)
+
+***
+
+### Result\<T, E\>
+
+> **Result**\<`T`, `E`\> = [`Ok`](#ok)\<`T`\> \| [`Err`](#err)\<`E`\>
+
+Defined in: [result/index.ts:22](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L22)
+
+Represents the Result of an action that can fail.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+## Functions
+
+### err()
+
+> **err**\<`E`\>(`error`): [`Err`](#err)\<`E`\>
+
+Defined in: [result/index.ts:51](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L51)
+
+Creates a Result of type Err containg the given error.
+
+#### Type Parameters
+
+##### E
+
+`E`
+
+#### Parameters
+
+##### error
+
+`E`
+
+#### Returns
+
+[`Err`](#err)\<`E`\>
+
+***
+
+### isErr()
+
+> **isErr**\<`T`, `E`\>(`result`): `result is Err<E>`
+
+Defined in: [result/index.ts:34](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L34)
+
+A Guard conforming that the given Result is of type Err.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+#### Parameters
+
+##### result
+
+[`Result`](#result)\<`T`, `E`\>
+
+#### Returns
+
+`result is Err<E>`
+
+***
+
+### isOk()
+
+> **isOk**\<`T`, `E`\>(`result`): `result is Ok<T>`
+
+Defined in: [result/index.ts:27](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L27)
+
+A Guard conforming that the given Result is of type Ok.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+#### Parameters
+
+##### result
+
+[`Result`](#result)\<`T`, `E`\>
+
+#### Returns
+
+`result is Ok<T>`
+
+***
+
+### map()
+
+> **map**\<`T`, `E`, `R`\>(`func`): (`result`) => [`Result`](#result)\<`R`, `E`\>
+
+Defined in: [result/index.ts:62](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L62)
+
+When Result is Ok: Applies the func function to the contained value and wraps it in Ok again.
+When Result is Err: Returns the given Result.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+##### R
+
+`R`
+
+#### Parameters
+
+##### func
+
+(`value`) => `R`
+
+#### Returns
+
+> (`result`): [`Result`](#result)\<`R`, `E`\>
+
+##### Parameters
+
+###### result
+
+[`Result`](#result)\<`T`, `E`\>
+
+##### Returns
+
+[`Result`](#result)\<`R`, `E`\>
+
+***
+
+### mapErr()
+
+> **mapErr**\<`T`, `E`, `R`\>(`func`): (`result`) => [`Result`](#result)\<`T`, `R`\>
+
+Defined in: [result/index.ts:79](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L79)
+
+When Result is Ok: Returns the given Result.
+When Result is Err: Applies the func function to the contained error and wraps it in Err again.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+##### R
+
+`R`
+
+#### Parameters
+
+##### func
+
+(`value`) => `R`
+
+#### Returns
+
+> (`result`): [`Result`](#result)\<`T`, `R`\>
+
+##### Parameters
+
+###### result
+
+[`Result`](#result)\<`T`, `E`\>
+
+##### Returns
+
+[`Result`](#result)\<`T`, `R`\>
+
+***
+
+### ok()
+
+> **ok**\<`T`\>(`value`): [`Ok`](#ok)\<`T`\>
+
+Defined in: [result/index.ts:41](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L41)
+
+Creates a Result of type Ok containg the given value.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### value
+
+`T`
+
+#### Returns
+
+[`Ok`](#ok)\<`T`\>
+
+***
+
+### toMaybe()
+
+> **toMaybe**\<`T`, `E`\>(`result`): [`Maybe`](maybe.md#maybe)\<`T`\>
+
+Defined in: [result/index.ts:113](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L113)
+
+Converts the given Result to a Maybe
+When Result is Ok: Returns a Just containing the value.
+When Result is Err: Returns a Nothing.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+#### Parameters
+
+##### result
+
+[`Result`](#result)\<`T`, `E`\>
+
+#### Returns
+
+[`Maybe`](maybe.md#maybe)\<`T`\>
+
+***
+
+### withDefault()
+
+> **withDefault**\<`T`, `E`\>(`defaultValue`): (`result`) => `T`
+
+Defined in: [result/index.ts:96](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/result/index.ts#L96)
+
+Unwrap a result to either its contained value or the default value.
+When Result is Ok: Returns the nested value.
+When Result is Err: Returns the given default value.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+#### Parameters
+
+##### defaultValue
+
+`T`
+
+#### Returns
+
+> (`result`): `T`
+
+##### Parameters
+
+###### result
+
+[`Result`](#result)\<`T`, `E`\>
+
+##### Returns
+
+`T`

package/docs/runtime/effect/fetch.md

@@ -0,0 +1,169 @@
+[**@kaumlaut/pure v0.5.1**](../../README.md)
+
+***
+
+[@kaumlaut/pure](../../README.md) / runtime/effect/fetch
+
+# runtime/effect/fetch
+
+## Type Aliases
+
+### FetchError
+
+> **FetchError** = [`HttpError`](#httperror) \| [`MalformedPayloadError`](#malformedpayloaderror)
+
+Defined in: [runtime/effect/fetch/index.ts:19](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L19)
+
+***
+
+### HttpError
+
+> **HttpError** = `object`
+
+Defined in: [runtime/effect/fetch/index.ts:10](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L10)
+
+#### Properties
+
+##### code
+
+> **code**: `number`
+
+Defined in: [runtime/effect/fetch/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L11)
+
+##### message
+
+> **message**: `string`
+
+Defined in: [runtime/effect/fetch/index.ts:12](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L12)
+
+***
+
+### MalformedPayloadError
+
+> **MalformedPayloadError** = `object`
+
+Defined in: [runtime/effect/fetch/index.ts:15](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L15)
+
+#### Properties
+
+##### message
+
+> **message**: `string`
+
+Defined in: [runtime/effect/fetch/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L16)
+
+## Functions
+
+### fetchJson()
+
+> **fetchJson**\<`T`, `M`\>(`url`, `headers`, `method`, `guard`, `receiver`): [`Effect`](../effect.md#effect)\<`M`\>
+
+Defined in: [runtime/effect/fetch/index.ts:40](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L40)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### M
+
+`M` *extends* [`Message`](../../runtime.md#message)
+
+#### Parameters
+
+##### url
+
+`string`
+
+##### headers
+
+\[`string`, `string`\][]
+
+##### method
+
+`string`
+
+##### guard
+
+[`Guard`](../../guard.md#guard)\<`T`\>
+
+##### receiver
+
+[`ReceiveEffectResult`](../effect.md#receiveeffectresult)\<`T`, [`FetchError`](#fetcherror), `M`\>
+
+#### Returns
+
+[`Effect`](../effect.md#effect)\<`M`\>
+
+***
+
+### isClient()
+
+> **isClient**(`error`): `boolean`
+
+Defined in: [runtime/effect/fetch/index.ts:32](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L32)
+
+#### Parameters
+
+##### error
+
+[`FetchError`](#fetcherror)
+
+#### Returns
+
+`boolean`
+
+***
+
+### isHttp()
+
+> **isHttp**(`error`): `error is HttpError`
+
+Defined in: [runtime/effect/fetch/index.ts:25](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L25)
+
+#### Parameters
+
+##### error
+
+[`FetchError`](#fetcherror)
+
+#### Returns
+
+`error is HttpError`
+
+***
+
+### isNotFound()
+
+> **isNotFound**(`error`): `boolean`
+
+Defined in: [runtime/effect/fetch/index.ts:21](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L21)
+
+#### Parameters
+
+##### error
+
+[`FetchError`](#fetcherror)
+
+#### Returns
+
+`boolean`
+
+***
+
+### isServer()
+
+> **isServer**(`error`): `boolean`
+
+Defined in: [runtime/effect/fetch/index.ts:36](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/fetch/index.ts#L36)
+
+#### Parameters
+
+##### error
+
+[`FetchError`](#fetcherror)
+
+#### Returns
+
+`boolean`

package/docs/runtime/effect/none.md

@@ -0,0 +1,19 @@
+[**@kaumlaut/pure v0.5.1**](../../README.md)
+
+***
+
+[@kaumlaut/pure](../../README.md) / runtime/effect/none
+
+# runtime/effect/none
+
+## Functions
+
+### none()
+
+> **none**(): [`Effect`](../effect.md#effect)\<`any`\>
+
+Defined in: [runtime/effect/none/index.ts:4](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/none/index.ts#L4)
+
+#### Returns
+
+[`Effect`](../effect.md#effect)\<`any`\>

package/docs/runtime/effect.md

@@ -0,0 +1,179 @@
+[**@kaumlaut/pure v0.5.1**](../README.md)
+
+***
+
+[@kaumlaut/pure](../README.md) / runtime/effect
+
+# runtime/effect
+
+## Type Aliases
+
+### AsyncEffect()\<T\>
+
+> **AsyncEffect**\<`T`\> = () => `Promise`\<`T`\>
+
+Defined in: [runtime/effect/index.ts:4](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L4)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Message`](../runtime.md#message)
+
+#### Returns
+
+`Promise`\<`T`\>
+
+***
+
+### AsyncNullEffect()
+
+> **AsyncNullEffect** = () => `Promise`\<`null`\>
+
+Defined in: [runtime/effect/index.ts:7](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L7)
+
+#### Returns
+
+`Promise`\<`null`\>
+
+***
+
+### Effect\<T\>
+
+> **Effect**\<`T`\> = `object`
+
+Defined in: [runtime/effect/index.ts:13](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L13)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Message`](../runtime.md#message)
+
+#### Properties
+
+##### effectType
+
+> **effectType**: [`EffectType`](#effecttype-1)\<`T`\>
+
+Defined in: [runtime/effect/index.ts:14](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L14)
+
+##### meta
+
+> **meta**: `object` \| `null`
+
+Defined in: [runtime/effect/index.ts:16](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L16)
+
+##### name
+
+> **name**: `string`
+
+Defined in: [runtime/effect/index.ts:15](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L15)
+
+***
+
+### EffectType\<T\>
+
+> **EffectType**\<`T`\> = [`AsyncEffect`](#asynceffect)\<`T`\> \| [`SyncEffect`](#synceffect)\<`T`\> \| [`NullEffect`](#nulleffect) \| [`AsyncNullEffect`](#asyncnulleffect)
+
+Defined in: [runtime/effect/index.ts:8](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L8)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Message`](../runtime.md#message)
+
+***
+
+### NullEffect()
+
+> **NullEffect** = () => `null`
+
+Defined in: [runtime/effect/index.ts:6](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L6)
+
+#### Returns
+
+`null`
+
+***
+
+### ReceiveEffectResult()\<T, E, R\>
+
+> **ReceiveEffectResult**\<`T`, `E`, `R`\> = (`result`) => `R`
+
+Defined in: [runtime/effect/index.ts:31](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L31)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+##### E
+
+`E`
+
+##### R
+
+`R`
+
+#### Parameters
+
+##### result
+
+[`Result`](../result.md#result)\<`T`, `E`\>
+
+#### Returns
+
+`R`
+
+***
+
+### SyncEffect()\<T\>
+
+> **SyncEffect**\<`T`\> = () => `T`
+
+Defined in: [runtime/effect/index.ts:5](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L5)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Message`](../runtime.md#message)
+
+#### Returns
+
+`T`
+
+## Functions
+
+### withName()
+
+> **withName**\<`T`\>(`name`, `effect`, `meta`): [`Effect`](#effect)\<`T`\>
+
+Defined in: [runtime/effect/index.ts:19](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/runtime/effect/index.ts#L19)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Message`](../runtime.md#message)
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### effect
+
+[`EffectType`](#effecttype-1)\<`T`\>
+
+##### meta
+
+`object` = `null`
+
+#### Returns
+
+[`Effect`](#effect)\<`T`\>