@kaumlaut/pure 0.5.0 → 0.5.1

package/docs/README.md

@@ -0,0 +1,23 @@
+**@kaumlaut/pure v0.5.1**
+
+***
+
+# @kaumlaut/pure v0.5.1
+
+## Modules
+
+- [clone](clone.md)
+- [fetch-state](fetch-state.md)
+- [guard](guard.md)
+- [maybe](maybe.md)
+- [parse](parse.md)
+- [pipe](pipe.md)
+- [result](result.md)
+- [runtime](runtime.md)
+- [runtime/effect](runtime/effect.md)
+- [runtime/effect/fetch](runtime/effect/fetch.md)
+- [runtime/effect/none](runtime/effect/none.md)
+- [runtime/persistence](runtime/persistence.md)
+- [runtime/persistence/none](runtime/persistence/none.md)
+- [runtime/persistence/storage](runtime/persistence/storage.md)
+- [util](util.md)

package/docs/clone.md

@@ -0,0 +1,45 @@
+[**@kaumlaut/pure v0.5.1**](README.md)
+
+***
+
+[@kaumlaut/pure](README.md) / clone
+
+# clone
+
+Provides value cloning capabilities
+
+## Type Aliases
+
+### Cloneable
+
+> **Cloneable** = `string` \| `number` \| `boolean` \| `null` \| [`Cloneable`](#cloneable)[] \| \{\[`key`: `string`\]: [`Cloneable`](#cloneable); \}
+
+Defined in: [clone/index.ts:9](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/clone/index.ts#L9)
+
+Defines the Cloneable type
+
+## Functions
+
+### clone()
+
+> **clone**\<`T`\>(`value`): `T`
+
+Defined in: [clone/index.ts:20](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/clone/index.ts#L20)
+
+Recursively clones values to prevent changing of the original value.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Cloneable`](#cloneable)
+
+#### Parameters
+
+##### value
+
+`T`
+
+#### Returns
+
+`T`

package/docs/fetch-state.md

@@ -0,0 +1,345 @@
+[**@kaumlaut/pure v0.5.1**](README.md)
+
+***
+
+[@kaumlaut/pure](README.md) / fetch-state
+
+# fetch-state
+
+Provides types and functions to represent fetch request states
+
+## Type Aliases
+
+### Failed
+
+> **Failed** = `object`
+
+Defined in: [fetch-state/index.ts:10](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L10)
+
+Represents a failed fetch request
+
+#### Properties
+
+##### error
+
+> **error**: `Readonly`\<`string`\>
+
+Defined in: [fetch-state/index.ts:11](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L11)
+
+##### type
+
+> **type**: `"Failed"`
+
+Defined in: [fetch-state/index.ts:12](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L12)
+
+***
+
+### FetchState\<T\>
+
+> **FetchState**\<`T`\> = [`Failed`](#failed) \| [`None`](#none) \| [`Loading`](#loading) \| [`Success`](#success)\<`T`\>
+
+Defined in: [fetch-state/index.ts:39](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L39)
+
+Represents all possible states of a fetch request
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+***
+
+### Loading
+
+> **Loading** = `object`
+
+Defined in: [fetch-state/index.ts:25](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L25)
+
+Represents a fetch request that is currently still running
+
+#### Properties
+
+##### type
+
+> **type**: `"Loading"`
+
+Defined in: [fetch-state/index.ts:26](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L26)
+
+***
+
+### None
+
+> **None** = `object`
+
+Defined in: [fetch-state/index.ts:18](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L18)
+
+Represents a fetch request that has not been executed
+
+#### Properties
+
+##### type
+
+> **type**: `"None"`
+
+Defined in: [fetch-state/index.ts:19](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L19)
+
+***
+
+### Success\<T\>
+
+> **Success**\<`T`\> = `object`
+
+Defined in: [fetch-state/index.ts:32](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L32)
+
+Represents a fetch request that succeeded
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Properties
+
+##### data
+
+> **data**: `Readonly`\<`T`\>
+
+Defined in: [fetch-state/index.ts:33](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L33)
+
+##### type
+
+> **type**: `"Success"`
+
+Defined in: [fetch-state/index.ts:34](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L34)
+
+## Functions
+
+### attempt()
+
+> **attempt**\<`T`\>(`guard`, `error`): (`data`) => [`Failed`](#failed) \| [`Success`](#success)\<`T`\>
+
+Defined in: [fetch-state/index.ts:93](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L93)
+
+Attempts to create a fetch state of type Success if the given guard passes.
+Otherwise creates a fetch state of type Failed with the provided error.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### guard
+
+[`Guard`](guard.md#guard)\<`T`\>
+
+##### error
+
+`string` = `"Guard did not pass. Ensure the attempted data has the correct type"`
+
+#### Returns
+
+> (`data`): [`Failed`](#failed) \| [`Success`](#success)\<`T`\>
+
+##### Parameters
+
+###### data
+
+`unknown`
+
+##### Returns
+
+[`Failed`](#failed) \| [`Success`](#success)\<`T`\>
+
+***
+
+### fail()
+
+> **fail**(`error`): [`Failed`](#failed)
+
+Defined in: [fetch-state/index.ts:67](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L67)
+
+Creates a fetch state of type Failed
+
+#### Parameters
+
+##### error
+
+`string`
+
+#### Returns
+
+[`Failed`](#failed)
+
+***
+
+### isFailed()
+
+> **isFailed**\<`T`\>(`state`): `state is Failed`
+
+Defined in: [fetch-state/index.ts:49](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L49)
+
+Checks whether or not the fetch state is Failed via a type guard
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### state
+
+[`FetchState`](#fetchstate)\<`T`\>
+
+#### Returns
+
+`state is Failed`
+
+***
+
+### isLoading()
+
+> **isLoading**\<`T`\>(`state`): `state is Loading`
+
+Defined in: [fetch-state/index.ts:43](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L43)
+
+Checks whether or not the fetch state is Loading via a type guard
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### state
+
+[`FetchState`](#fetchstate)\<`T`\>
+
+#### Returns
+
+`state is Loading`
+
+***
+
+### isNone()
+
+> **isNone**\<`T`\>(`state`): `state is None`
+
+Defined in: [fetch-state/index.ts:55](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L55)
+
+Checks whether or not the fetch state is None via a type guard
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### state
+
+[`FetchState`](#fetchstate)\<`T`\>
+
+#### Returns
+
+`state is None`
+
+***
+
+### isSuccess()
+
+> **isSuccess**\<`T`\>(`state`): `state is Success<T>`
+
+Defined in: [fetch-state/index.ts:61](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L61)
+
+Checks whether or not the fetch state is Success via a type guard
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### state
+
+[`FetchState`](#fetchstate)\<`T`\>
+
+#### Returns
+
+`state is Success<T>`
+
+***
+
+### load()
+
+> **load**(): [`Loading`](#loading)
+
+Defined in: [fetch-state/index.ts:76](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L76)
+
+Creates a fetch state of type Loading
+
+#### Returns
+
+[`Loading`](#loading)
+
+***
+
+### mapFailed()
+
+> **mapFailed**\<`T`\>(`mapper`): (`state`) => [`FetchState`](#fetchstate)\<`T`\>
+
+Defined in: [fetch-state/index.ts:115](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L115)
+
+A Utility function that allows to map the Failed fetch state to any other fetch state.
+The mapper function is only called if the given fetch state is Failed.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### mapper
+
+(`state`) => [`FetchState`](#fetchstate)\<`T`\>
+
+#### Returns
+
+> (`state`): [`FetchState`](#fetchstate)\<`T`\>
+
+##### Parameters
+
+###### state
+
+[`FetchState`](#fetchstate)\<`T`\>
+
+##### Returns
+
+[`FetchState`](#fetchstate)\<`T`\>
+
+***
+
+### none()
+
+> **none**(): [`None`](#none)
+
+Defined in: [fetch-state/index.ts:84](https://github.com/maxkaemmerer/pure-vue-poc/blob/af231e8df53d90d5cfaa5229a0611bf6aa308ef2/pure/src/fetch-state/index.ts#L84)
+
+Creates a fetch state of type None
+
+#### Returns
+
+[`None`](#none)