@kaumlaut/pure 0.4.0 → 0.5.1

package/README.md

@@ -2,6 +2,4 @@
 
 Types and functions for a state runtime inspired by Elm and functional programming
 
-## Maybe
-
-A Simple implementation of the Maybe type and associated functions.
+- [API Reference](./docs/README.md)

package/dist/clone/index.d.ts

@@ -1,5 +1,15 @@
+/**
+ * Provides value cloning capabilities
+ * @module clone
+ */
+/**
+ * Defines the Cloneable type
+ */
 export type Cloneable = string | number | boolean | null | Cloneable[] | {
     [key: string]: Cloneable;
 };
+/**
+ * Recursively clones values to prevent changing of the original value.
+ */
 export declare function clone<T extends Cloneable>(value: T): T;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/clone/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjC,wBAAgB,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAkBtD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/clone/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjC;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAkBtD"}

package/dist/clone/index.js

@@ -1,3 +1,10 @@
+/**
+ * Provides value cloning capabilities
+ * @module clone
+ */
+/**
+ * Recursively clones values to prevent changing of the original value.
+ */
 export function clone(value) {
     if (value === null || typeof value !== "object") {
         return value;

package/dist/fetch-state/index.d.ts

@@ -1,26 +1,74 @@
+/**
+ * Provides types and functions to represent fetch request states
+ * @module fetch-state
+ */
 import type { Guard } from "@kaumlaut/pure/guard";
+/**
+ * Represents a failed fetch request
+ */
 export type Failed = {
     error: Readonly<string>;
     type: "Failed";
 };
+/**
+ * Represents a fetch request that has not been executed
+ */
 export type None = {
     type: "None";
 };
+/**
+ * Represents a fetch request that is currently still running
+ */
 export type Loading = {
     type: "Loading";
 };
+/**
+ * Represents a fetch request that succeeded
+ */
 export type Success<T> = {
     data: Readonly<T>;
     type: "Success";
 };
+/**
+ * Represents all possible states of a fetch request
+ */
 export type FetchState<T> = Failed | None | Loading | Success<T>;
+/**
+ * Checks whether or not the fetch state is Loading via a type guard
+ */
 export declare function isLoading<T>(state: FetchState<T>): state is Loading;
+/**
+ * Checks whether or not the fetch state is Failed via a type guard
+ */
 export declare function isFailed<T>(state: FetchState<T>): state is Failed;
+/**
+ * Checks whether or not the fetch state is None via a type guard
+ */
 export declare function isNone<T>(state: FetchState<T>): state is None;
+/**
+ * Checks whether or not the fetch state is Success via a type guard
+ */
 export declare function isSuccess<T>(state: FetchState<T>): state is Success<T>;
+/**
+ * Creates a fetch state of type Failed
+ */
 export declare function fail(error: string): Failed;
+/**
+ * Creates a fetch state of type Loading
+ */
 export declare function load(): Loading;
+/**
+ * Creates a fetch state of type None
+ */
 export declare function none(): None;
+/**
+ * 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.
+ */
 export declare function attempt<T>(guard: Guard<T>, error?: string): (data: unknown) => Success<T> | Failed;
+/**
+ * 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.
+ */
 export declare function mapFailed<T>(mapper: (state: Failed) => FetchState<T>): (state: FetchState<T>) => FetchState<T>;
 //# sourceMappingURL=index.d.ts.map

package/dist/fetch-state/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch-state/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACvB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEjE,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAEnE;AACD,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,MAAM,CAEjE;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAE7D;AACD,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAEtE;AAED,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK1C;AAED,wBAAgB,IAAI,IAAI,OAAO,CAI9B;AAED,wBAAgB,IAAI,IAAI,IAAI,CAI3B;AAED,wBAAgB,OAAO,CAAC,CAAC,EACvB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,KAAK,GAAE,MAA6E,GACnF,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAcxC;AAED,wBAAgB,SAAS,CAAC,CAAC,EACzB,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GACvC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAQzC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fetch-state/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACvB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACjE;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAEnE;AACD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,MAAM,CAEjE;AACD;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAE7D;AACD;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAEtE;AACD;;GAEG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAK1C;AACD;;GAEG;AACH,wBAAgB,IAAI,IAAI,OAAO,CAI9B;AACD;;GAEG;AACH,wBAAgB,IAAI,IAAI,IAAI,CAI3B;AACD;;;GAGG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EACf,KAAK,GAAE,MAA6E,GACnF,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAcxC;AACD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,GACvC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAQzC"}

package/dist/fetch-state/index.js

@@ -1,31 +1,56 @@
+/**
+ * Checks whether or not the fetch state is Loading via a type guard
+ */
 export function isLoading(state) {
     return state.type === "Loading";
 }
+/**
+ * Checks whether or not the fetch state is Failed via a type guard
+ */
 export function isFailed(state) {
     return state.type === "Failed";
 }
+/**
+ * Checks whether or not the fetch state is None via a type guard
+ */
 export function isNone(state) {
     return state.type === "None";
 }
+/**
+ * Checks whether or not the fetch state is Success via a type guard
+ */
 export function isSuccess(state) {
     return state.type === "Success";
 }
+/**
+ * Creates a fetch state of type Failed
+ */
 export function fail(error) {
     return {
         type: "Failed",
         error,
     };
 }
+/**
+ * Creates a fetch state of type Loading
+ */
 export function load() {
     return {
         type: "Loading",
     };
 }
+/**
+ * Creates a fetch state of type None
+ */
 export function none() {
     return {
         type: "None",
     };
 }
+/**
+ * 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.
+ */
 export function attempt(guard, error = "Guard did not pass. Ensure the attempted data has the correct type") {
     return (data) => {
         if (guard(data)) {
@@ -40,6 +65,10 @@ export function attempt(guard, error = "Guard did not pass. Ensure the attempted
         };
     };
 }
+/**
+ * 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.
+ */
 export function mapFailed(mapper) {
     return (state) => {
         if (isFailed(state)) {

package/dist/guard/index.d.ts

@@ -1,26 +1,105 @@
+/**
+ * Represents a type guard
+ */
 export type Guard<T> = (value: unknown) => value is T;
+/**
+ * Confirms that the given value passes all guards.
+ */
 export declare function isAll<T>(guards: Guard<T>[]): (value: unknown) => value is T;
+/**
+ * Confirms that the value is a string.
+ */
 export declare function isString(value: unknown): value is string;
+/**
+ * Confirms that the value is a string with specified length.
+ */
 export declare function isStringOfLength(length: number): (value: unknown) => value is string;
+/**
+ * Confirms that the value is a number.
+ */
 export declare function isNumber(value: unknown): value is number;
+/**
+ * Confirms that the value is an integer.
+ */
 export declare function isInt(value: unknown): value is number;
+/**
+ * Confirms that the value is a floating point number.
+ */
 export declare function isFloat(value: unknown): value is number;
+/**
+ * Confirms that the value is an object containing the specified key.
+ */
 export declare function isObjectWithKey<T extends object>(key: keyof T): (value: unknown) => value is T;
+/**
+ * Confirms that the value is an object containing the specified keys.
+ */
 export declare function isObjectWithKeys<T extends object>(keys: (keyof T)[]): (value: unknown) => value is T;
+/**
+ * Confirms that the value is an object whose key value pairs match the corresponding type guards.
+ * Calls console.debug with an error message to improve debugging when a large type does not match.
+ */
 export declare function isObjectWithKeysMatchingGuard<T extends object>(guards: {
     [K in keyof T]: Guard<T[K]>;
 }): (value: unknown) => value is T;
+/**
+ * Confirms the value exactly matched the given string.
+ */
 export declare function isExactString<T extends string>(expectedString: string): (value: unknown) => value is T;
+/**
+ * Confirms the value is one of the given valid values.
+ */
 export declare function isOneStringOf<T extends string>(validValues: string[]): (value: unknown) => value is T;
+/**
+ * Always passes.
+ */
 export declare function isAlways<T>(value: unknown): value is T;
+/**
+ * Never passes.
+ */
 export declare function isNever<T>(value: unknown): value is T;
+/**
+ * Confirms the value is a boolean.
+ */
 export declare function isBool(value: unknown): value is boolean;
+/**
+ * Confirms the value is null.
+ */
 export declare function isNull(value: unknown): value is null;
+/**
+ * Confirms the value is a list of items that all pass the given guard.
+ * Calls console.debug with an error message to improve debugging when a large type does not match.
+ */
 export declare function isListOf<T>(guard: Guard<T>): (value: unknown) => value is T[];
+/**
+ * Confirms the value passes at least one of the given Guards.
+ */
 export declare function isOneOf<T1, T2>(a: Guard<T1>, b: Guard<T2>): (value: unknown) => value is T1 | T2;
+/**
+ * Confirms the value is either null or passes the given Guard.
+ */
 export declare function isNullOr<T>(guard: Guard<T>): (value: unknown) => value is T | null;
+/**
+ * Confirms the value is an object where every value matches the given guard.
+ * Calls console.debug with an error message to improve debugging when a large type does not match.
+ */
 export declare function isObjectWithAllKeysMatchingGuard<B, T extends {
     [key: string]: B;
 }>(guard: Guard<B>): (value: unknown) => value is T;
+/**
+ * Confirms the value is a string and matches the given regular expression.
+ */
 export declare function isStringWithPattern(pattern: RegExp): Guard<string>;
+/**
+ * Confirms the value is undefined.
+ */
+export declare function isUndefined(value: unknown): value is undefined;
+/**
+ * Confirms the value is a list with atleast one item and all items match the given guard.
+ */
+export declare function isNonEmptyListOf<T>(guard: Guard<T>): (value: unknown) => value is T;
+/**
+ * Confirms the value is number between min and max inclusive.
+ * Meaning if the value equals min or max the guard passes.
+ */
+export declare function isNumberBetweenInclusive<T>(min: number, max: number): (value: unknown) => value is T;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/guard/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AAEtD,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAE3E;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAGrC;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMrD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMvD;AAMD,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,GAAG,EAAE,MAAM,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAChB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,6BAA6B,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE;KACrE,CAAC,IAAI,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5B,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAYjC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,cAAc,EAAE,MAAM,GACrB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,WAAW,EAAE,MAAM,EAAE,GACpB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAEtD;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAErD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAEvD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,EAAE,CAU7E;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,EAAE,EAC5B,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,EACZ,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAEtC;AAED,wBAAgB,QAAQ,CAAC,CAAC,EACxB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GACd,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAEvC;AAED,wBAAgB,gCAAgC,CAC9C,CAAC,EACD,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,EAC9B,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAYjD;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAGlE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/guard/index.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AAEtD;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAE3E;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAGrC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMrD;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAMvD;AAMD;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,GAAG,EAAE,MAAM,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAChB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE;KACrE,CAAC,IAAI,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5B,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAYjC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,cAAc,EAAE,MAAM,GACrB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,WAAW,EAAE,MAAM,EAAE,GACpB,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAEtD;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAErD;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAEvD;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,EAAE,CAU7E;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,EAAE,EAC5B,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,EACZ,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,GACX,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,EAAE,GAAG,EAAE,CAEtC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GACd,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAEvC;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,CAAC,EACD,CAAC,SAAS;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,EAC9B,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAYjD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAGlE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GACd,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EACxC,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAGhC"}

package/dist/guard/index.js

@@ -1,22 +1,44 @@
+/**
+ * Provides easily composable generic type guards
+ * @module guard
+ */
 import { asFloat, asInt } from "@kaumlaut/pure/parse";
 import { isOk } from "@kaumlaut/pure/result";
+/**
+ * Confirms that the given value passes all guards.
+ */
 export function isAll(guards) {
     return (value) => guards.every((guard) => guard(value));
 }
+/**
+ * Confirms that the value is a string.
+ */
 export function isString(value) {
     return typeof value === "string";
 }
+/**
+ * Confirms that the value is a string with specified length.
+ */
 export function isStringOfLength(length) {
     return (value) => isString(value) && value.length === length;
 }
+/**
+ * Confirms that the value is a number.
+ */
 export function isNumber(value) {
     return typeof value === "number";
 }
+/**
+ * Confirms that the value is an integer.
+ */
 export function isInt(value) {
     return (isNumber(value) &&
         !numberIncludesCommaSeparator(value) &&
         isOk(asInt(value.toString())));
 }
+/**
+ * Confirms that the value is a floating point number.
+ */
 export function isFloat(value) {
     return (isNumber(value) &&
         numberIncludesCommaSeparator(value) &&
@@ -25,12 +47,22 @@ export function isFloat(value) {
 function numberIncludesCommaSeparator(value) {
     return `${value}`.includes(".");
 }
+/**
+ * Confirms that the value is an object containing the specified key.
+ */
 export function isObjectWithKey(key) {
     return (value) => typeof value === "object" && key in value;
 }
+/**
+ * Confirms that the value is an object containing the specified keys.
+ */
 export function isObjectWithKeys(keys) {
     return (value) => typeof value === "object" && keys.every((key) => key in value);
 }
+/**
+ * Confirms that the value is an object whose key value pairs match the corresponding type guards.
+ * Calls console.debug with an error message to improve debugging when a large type does not match.
+ */
 export function isObjectWithKeysMatchingGuard(guards) {
     return (value) => typeof value === "object" &&
         Object.keys(guards).filter((key) => {
@@ -41,24 +73,46 @@ export function isObjectWithKeysMatchingGuard(guards) {
             return result;
         }).length === Object.keys(guards).length;
 }
+/**
+ * Confirms the value exactly matched the given string.
+ */
 export function isExactString(expectedString) {
     return (value) => isString(value) && value === expectedString;
 }
+/**
+ * Confirms the value is one of the given valid values.
+ */
 export function isOneStringOf(validValues) {
     return (value) => isString(value) && validValues.includes(value);
 }
+/**
+ * Always passes.
+ */
 export function isAlways(value) {
     return true;
 }
+/**
+ * Never passes.
+ */
 export function isNever(value) {
     return false;
 }
+/**
+ * Confirms the value is a boolean.
+ */
 export function isBool(value) {
     return typeof value === "boolean";
 }
+/**
+ * Confirms the value is null.
+ */
 export function isNull(value) {
     return value === null;
 }
+/**
+ * Confirms the value is a list of items that all pass the given guard.
+ * Calls console.debug with an error message to improve debugging when a large type does not match.
+ */
 export function isListOf(guard) {
     return (value) => Array.isArray(value) &&
         value.filter((item, index) => {
@@ -69,12 +123,22 @@ export function isListOf(guard) {
             return result;
         }).length === value.length;
 }
+/**
+ * Confirms the value passes at least one of the given Guards.
+ */
 export function isOneOf(a, b) {
     return (value) => a(value) || b(value);
 }
+/**
+ * Confirms the value is either null or passes the given Guard.
+ */
 export function isNullOr(guard) {
     return isOneOf(isNull, guard);
 }
+/**
+ * Confirms the value is an object where every value matches the given guard.
+ * Calls console.debug with an error message to improve debugging when a large type does not match.
+ */
 export function isObjectWithAllKeysMatchingGuard(guard) {
     return (value) => typeof value === "object" &&
         Object.keys(value).filter((key) => {
@@ -85,6 +149,28 @@ export function isObjectWithAllKeysMatchingGuard(guard) {
             return result;
         }).length === Object.keys(value).length;
 }
+/**
+ * Confirms the value is a string and matches the given regular expression.
+ */
 export function isStringWithPattern(pattern) {
     return (value) => isString(value) && pattern.test(value);
 }
+/**
+ * Confirms the value is undefined.
+ */
+export function isUndefined(value) {
+    return value === undefined;
+}
+/**
+ * Confirms the value is a list with atleast one item and all items match the given guard.
+ */
+export function isNonEmptyListOf(guard) {
+    return (value) => isListOf(guard)(value) && value.length > 0;
+}
+/**
+ * Confirms the value is number between min and max inclusive.
+ * Meaning if the value equals min or max the guard passes.
+ */
+export function isNumberBetweenInclusive(min, max) {
+    return (value) => isNumber(value) && value >= min && value <= max;
+}

package/dist/maybe/index.d.ts

@@ -1,5 +1,11 @@
+/**
+ * Provides types representing the Maybe concept as well as functions to work with it.
+ * @module maybe
+ */
 import { Result } from "@kaumlaut/pure/result";
+import { Guard } from "../guard";
 /**
+ * Represents a Maybe containing a value.
  * @example
  * ```ts
  * if (isJust(maybe)) {
@@ -13,7 +19,7 @@ export type Just<T> = {
     value: T;
 };
 /**
- * @public
+ * Represents a Maybe not containing a value.
  * @example
   if (isNothing(maybe)) {
       // no value property exists on maybe
@@ -23,14 +29,60 @@ export type Just<T> = {
 export type Nothing = {
     type: "maybe-nothing";
 };
+/**
+ * Represents the Maybe type.
+ */
 export type Maybe<T> = Just<T> | Nothing;
+/**
+ * Creates a maybe not containing a value. (Nothing)
+ */
 export declare function nothing(): Nothing;
+/**
+ * Creates a maybe containing a value. (Just)
+ */
 export declare function just<T>(value: T): Just<T>;
+/**
+ * A Guard confirming that the given maybe value is a Nothing.
+ */
 export declare function isNothing<T>(maybe: Maybe<T>): maybe is Nothing;
+/**
+ * A Guard confirming that the given maybe value is a Just.
+ */
 export declare function isJust<T>(maybe: Maybe<T>): maybe is Just<T>;
+/**
+ * A Guard confirming that the given value is a Maybe.
+ */
 export declare function isMaybe<T>(value: unknown): value is Maybe<T>;
+/**
+ * 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 declare function map<T, R>(func: (value: T) => R): (maybe: Maybe<T>) => Maybe<R>;
+/**
+ * Converts the given Maybe into a Nothing if it is Just but does not pass the given function.
+ */
 export declare function filter<T>(func: (value: T) => boolean): (maybe: Maybe<T>) => Maybe<T>;
+/**
+ * Unwraps a Maybe, returning the value if it is a Just or the default value if it is a Nothing.
+ */
 export declare function withDefault<T>(defaultValue: T): (maybe: Maybe<T>) => T;
+/**
+ * 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 declare function toResult<T, E>(error: E): (maybe: Maybe<T>) => Result<T, E>;
+/**
+ * Creates a Just if the Guard passes for the given value. Otherwise Creates a Nothing.
+ */
+export declare function maybeByGuard<T>(guard: Guard<T>): (value: unknown) => Maybe<T>;
+/**
+ * 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 declare function mapToMaybe<T, R>(func: (value: T) => Maybe<R>): (maybe: Maybe<T>) => Maybe<R>;
+/**
+ * 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 declare function tryMap<T, R>(func: (value: T) => R): (maybe: Maybe<T>) => Maybe<R>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/maybe/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAEzC,wBAAgB,OAAO,IAAI,OAAO,CAIjC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAKzC;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAE9D;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAE3D;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAG5D;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAQ/B;AAED,wBAAgB,MAAM,CAAC,CAAC,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC1B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAY/B;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAQtE;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAE1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/maybe/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAW,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC;;;;;;;;;GASG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAEzC;;GAEG;AACH,wBAAgB,OAAO,IAAI,OAAO,CAIjC;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAKzC;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,OAAO,CAE9D;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAE3D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAG5D;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAQ/B;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAC1B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAY/B;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAQtE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAE1E;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAI7E;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAC7B,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,GAC3B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAQ/B;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EACzB,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACpB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAa/B"}