@kaumlaut/pure 0.4.0 → 0.5.1

package/dist/maybe/index.js

@@ -1,25 +1,47 @@
+/**
+ * Provides types representing the Maybe concept as well as functions to work with it.
+ * @module maybe
+ */
 import { err, ok } from "@kaumlaut/pure/result";
+/**
+ * Creates a maybe not containing a value. (Nothing)
+ */
 export function nothing() {
     return {
         type: "maybe-nothing",
     };
 }
+/**
+ * Creates a maybe containing a value. (Just)
+ */
 export function just(value) {
     return {
         type: "maybe-just",
         value,
     };
 }
+/**
+ * A Guard confirming that the given maybe value is a Nothing.
+ */
 export function isNothing(maybe) {
     return maybe.type === "maybe-nothing";
 }
+/**
+ * A Guard confirming that the given maybe value is a Just.
+ */
 export function isJust(maybe) {
     return maybe.type === "maybe-just";
 }
+/**
+ * A Guard confirming that the given value is a Maybe.
+ */
 export function isMaybe(value) {
     //@ts-expect-error is validated
     return value.type === "maybe-just" || value.type === "maybe-nothing";
 }
+/**
+ * Applies the func function to the value if the given Maybe is a Just and returns it wrapped in a Just. Otherwise returns the given Maybe.
+ */
 export function map(func) {
     return (maybe) => {
         if (isJust(maybe)) {
@@ -28,6 +50,9 @@ export function map(func) {
         return maybe;
     };
 }
+/**
+ * Converts the given Maybe into a Nothing if it is Just but does not pass the given function.
+ */
 export function filter(func) {
     return (maybe) => {
         if (!isJust(maybe)) {
@@ -39,6 +64,9 @@ export function filter(func) {
         return nothing();
     };
 }
+/**
+ * Unwraps a Maybe, returning the value if it is a Just or the default value if it is a Nothing.
+ */
 export function withDefault(defaultValue) {
     return (maybe) => {
         if (isJust(maybe)) {
@@ -47,6 +75,49 @@ export function withDefault(defaultValue) {
         return defaultValue;
     };
 }
+/**
+ * Converts the given Maybe to a Result.
+ * A Nothing becomes an Err with the given error.
+ * A Just becomes an Ok with the contained value.
+ */
 export function toResult(error) {
     return (maybe) => (isJust(maybe) ? ok(maybe.value) : err(error));
 }
+/**
+ * Creates a Just if the Guard passes for the given value. Otherwise Creates a Nothing.
+ */
+export function maybeByGuard(guard) {
+    return (value) => {
+        return guard(value) ? just(value) : nothing();
+    };
+}
+/**
+ * Maps the a value contained within a Just using the given function without wrapping it in another Just.
+ * Returns the given Maybe if it is a Nothing.
+ */
+export function mapToMaybe(func) {
+    return (maybe) => {
+        if (isJust(maybe)) {
+            return func(maybe.value);
+        }
+        return maybe;
+    };
+}
+/**
+ * Maps the a value contained within a Just using the given function without wrapping it in another Just.
+ * Returns the given Maybe if it is a Nothing.
+ */
+export function tryMap(func) {
+    return (maybe) => {
+        if (isJust(maybe)) {
+            try {
+                return just(func(maybe.value));
+            }
+            catch (e) {
+                console.error(e);
+                return nothing();
+            }
+        }
+        return maybe;
+    };
+}

package/dist/parse/index.d.ts

@@ -1,4 +1,10 @@
 import { type Result } from "@kaumlaut/pure/result";
+/**
+ * Attempts to parse a string as an interger. Returning ok if successful or err if not.
+ */
 export declare function asInt(value: string): Result<number, string>;
+/**
+ * Attempts to parse a string as an float. Returning ok if successful or err if not.
+ */
 export declare function asFloat(value: string): Result<number, string>;
 //# sourceMappingURL=index.d.ts.map

package/dist/parse/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parse/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE7D,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ3D;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ7D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parse/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ3D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ7D"}

package/dist/parse/index.js

@@ -1,4 +1,7 @@
 import { err, ok } from "@kaumlaut/pure/result";
+/**
+ * Attempts to parse a string as an interger. Returning ok if successful or err if not.
+ */
 export function asInt(value) {
     const parsed = parseInt(value, 10);
     if (Number.isNaN(parsed)) {
@@ -6,6 +9,9 @@ export function asInt(value) {
     }
     return ok(parsed);
 }
+/**
+ * Attempts to parse a string as an float. Returning ok if successful or err if not.
+ */
 export function asFloat(value) {
     const parsed = parseFloat(value);
     if (Number.isNaN(parsed)) {

package/dist/pipe/index.d.ts

@@ -1,7 +1,20 @@
-type Pipe<IT> = {
+/**
+ * Represents a function pipeline
+ */
+export type Pipe<IT> = {
     into: <RT>(func: (input: IT) => RT) => Pipe<RT>;
     out: () => IT;
 };
+/**
+ * Creates a Pipe that allows you to chain multiple functions using into.
+ * Is meant to make larger functions more readable.
+ * @example
+*   const output = put("3")
+      .into(asInt)
+      .into(toMaybe)
+      .into(withDefault(0))
+      .into((input) => input * 3.14)
+      .into((input) => input.toPrecision());
+ */
 export declare function put<IT>(data: IT): Pipe<IT>;
-export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/pipe/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pipe/index.ts"],"names":[],"mappings":"AAAA,KAAK,IAAI,CAAC,EAAE,IAAI;IACd,IAAI,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;IAChD,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF,wBAAgB,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAO1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pipe/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,EAAE,IAAI;IACrB,IAAI,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;IAChD,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAO1C"}

package/dist/pipe/index.js

@@ -1,3 +1,14 @@
+/**
+ * Creates a Pipe that allows you to chain multiple functions using into.
+ * Is meant to make larger functions more readable.
+ * @example
+*   const output = put("3")
+      .into(asInt)
+      .into(toMaybe)
+      .into(withDefault(0))
+      .into((input) => input * 3.14)
+      .into((input) => input.toPrecision());
+ */
 export function put(data) {
     return {
         into: (func) => {

package/dist/result/index.d.ts

@@ -1,19 +1,58 @@
 import { Maybe } from "@kaumlaut/pure/maybe";
+/**
+ * Represents the Result of an action that succeeded and contains a corresponding value.
+ */
 export type Ok<T> = {
     type: "ok-result";
     value: T;
 };
+/**
+ * Represents the Result of an action that failed and contains a corresponding error.
+ */
 export type Err<T> = {
     type: "error-result";
     error: T;
 };
+/**
+ * Represents the Result of an action that can fail.
+ */
+export type Result<T, E> = Ok<T> | Err<E>;
+/**
+ * A Guard conforming that the given Result is of type Ok.
+ */
 export declare function isOk<T, E>(result: Result<T, E>): result is Ok<T>;
+/**
+ * A Guard conforming that the given Result is of type Err.
+ */
 export declare function isErr<T, E>(result: Result<T, E>): result is Err<E>;
+/**
+ * Creates a Result of type Ok containg the given value.
+ */
 export declare function ok<T>(value: T): Ok<T>;
+/**
+ * Creates a Result of type Err containg the given error.
+ */
 export declare function err<E>(error: E): Err<E>;
-export type Result<T, E> = Ok<T> | Err<E>;
+/**
+ * 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.
+ */
 export declare function map<T, E, R>(func: (value: T) => R): (result: Result<T, E>) => Result<R, E>;
+/**
+ * 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.
+ */
 export declare function mapErr<T, E, R>(func: (value: E) => R): (result: Result<T, E>) => Result<T, R>;
+/**
+ * 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.
+ */
 export declare function withDefault<T, E>(defaultValue: T): (result: Result<T, E>) => T;
+/**
+ * Converts the given Result to a Maybe
+ * When Result is Ok: Returns a Just containing the value.
+ * When Result is Err: Returns a Nothing.
+ */
 export declare function toMaybe<T, E>(result: Result<T, E>): Maybe<T>;
 //# sourceMappingURL=index.d.ts.map

package/dist/result/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/result/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAW,MAAM,sBAAsB,CAAC;AAE5D,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI;IACnB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAEhE;AAED,wBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAElE;AAED,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAKrC;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAKvC;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AAE1C,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACzB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAQxC;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAC5B,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAQxC;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAC9B,YAAY,EAAE,CAAC,GACd,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAQ7B;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAE5D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/result/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,EAAW,MAAM,sBAAsB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI;IACnB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AAE1C;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAEhE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAElE;AAED;;GAEG;AACH,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAKrC;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAKvC;AAED;;;GAGG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACzB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAQxC;AAGD;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAC5B,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAQxC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAC9B,YAAY,EAAE,CAAC,GACd,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAQ7B;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAE5D"}

package/dist/result/index.js

@@ -1,22 +1,38 @@
 import { just, nothing } from "@kaumlaut/pure/maybe";
+/**
+ * A Guard conforming that the given Result is of type Ok.
+ */
 export function isOk(result) {
     return result.type === "ok-result";
 }
+/**
+ * A Guard conforming that the given Result is of type Err.
+ */
 export function isErr(result) {
     return result.type === "error-result";
 }
+/**
+ * Creates a Result of type Ok containg the given value.
+ */
 export function ok(value) {
     return {
         type: "ok-result",
         value,
     };
 }
+/**
+ * Creates a Result of type Err containg the given error.
+ */
 export function err(error) {
     return {
         type: "error-result",
         error,
     };
 }
+/**
+ * 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.
+ */
 export function map(func) {
     return (result) => {
         if (isOk(result)) {
@@ -25,6 +41,10 @@ export function map(func) {
         return result;
     };
 }
+/**
+ * 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.
+ */
 export function mapErr(func) {
     return (result) => {
         if (isErr(result)) {
@@ -33,6 +53,11 @@ export function mapErr(func) {
         return result;
     };
 }
+/**
+ * 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.
+ */
 export function withDefault(defaultValue) {
     return (result) => {
         if (isErr(result)) {
@@ -41,6 +66,11 @@ export function withDefault(defaultValue) {
         return result.value;
     };
 }
+/**
+ * Converts the given Result to a Maybe
+ * When Result is Ok: Returns a Just containing the value.
+ * When Result is Err: Returns a Nothing.
+ */
 export function toMaybe(result) {
     return isOk(result) ? just(result.value) : nothing();
 }

package/dist/runtime/effect/fetch/index.d.ts

@@ -1,18 +1,17 @@
 import { Guard } from "@kaumlaut/pure/guard";
 import { ReceiveEffectResult, Effect } from "@kaumlaut/pure/runtime/effect";
 import { Message } from "@kaumlaut/pure/runtime";
-type HttpError = {
+export type HttpError = {
     code: number;
     message: string;
 };
-type MalformedPayloadError = {
+export type MalformedPayloadError = {
     message: string;
 };
-type FetchError = HttpError | MalformedPayloadError;
+export type FetchError = HttpError | MalformedPayloadError;
 export declare function isNotFound(error: FetchError): boolean;
 export declare function isHttp(error: FetchError): error is HttpError;
 export declare function isClient(error: FetchError): boolean;
 export declare function isServer(error: FetchError): boolean;
 export declare function fetchJson<T, M extends Message>(url: string, headers: [string, string][], method: string, guard: Guard<T>, receiver: ReceiveEffectResult<T, FetchError, M>): Effect<M>;
-export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/effect/fetch/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/runtime/effect/fetch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,OAAO,EACL,mBAAmB,EACnB,MAAM,EAEP,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,KAAK,SAAS,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,UAAU,GAAG,SAAS,GAAG,qBAAqB,CAAC;AAEpD,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAErD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,IAAI,SAAS,CAK5D;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAEnD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAEnD;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAC5C,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAC3B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,QAAQ,EAAE,mBAAmB,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,GAC9C,MAAM,CAAC,CAAC,CAAC,CA4CX"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/runtime/effect/fetch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,OAAO,EACL,mBAAmB,EACnB,MAAM,EAEP,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,qBAAqB,CAAC;AAE3D,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAErD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,IAAI,SAAS,CAK5D;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAEnD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAEnD;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAC5C,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAC3B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,QAAQ,EAAE,mBAAmB,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,GAC9C,MAAM,CAAC,CAAC,CAAC,CA4CX"}

package/dist/util/index.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Returns the given value.
+ */
 export declare function id<T>(value: T): T;
 //# sourceMappingURL=index.d.ts.map

package/dist/util/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAEjC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAEjC"}

package/dist/util/index.js

@@ -1,3 +1,6 @@
+/**
+ * Returns the given value.
+ */
 export function id(value) {
     return value;
 }

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`