@consolidados/results 0.1.0

package/dist/result/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/result/__internal__/return-types/err.ts","../../src/result/__internal__/return-types/ok.ts","../../src/result/result.ts"],"names":["Ok","Err"],"mappings":";;;AAOO,IAAM,GAAA,GAAN,MAAM,IAAA,SACJ,KAET,CAAA;AAAA,EACS,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,YAAY,KAAmB,EAAA;AAC9B,IAAA,KAAA,CAAM,OAAO,KAAA,KAAU,QAAW,GAAA,KAAA,GAAQ,MAAM,OAAO,CAAA;AACvD,IAAA,IAAA,CAAK,QACJ,OAAO,KAAA,KAAU,WAAY,IAAI,KAAA,CAAM,KAAK,CAAW,GAAA,KAAA;AACxD,IAAO,MAAA,CAAA,cAAA,CAAe,IAAM,EAAA,IAAA,CAAI,SAAS,CAAA;AAEzC,IAAA,IAAI,MAAM,iBAAmB,EAAA;AAC5B,MAAM,KAAA,CAAA,iBAAA,CAAkB,MAAM,IAAG,CAAA;AAAA;AAClC;AACD;AAAA;AAAA;AAAA;AAAA,EAMA,IAA0B,GAAA;AACzB,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAAkD,GAAA;AACjD,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,GAAA;AACf,IAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA;AAAA;AAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,GAAsD,EAAA;AAC5D,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAwB,EAA+C,EAAA;AACtE,IAAA,OAAO,IAAI,IAAA,CAAO,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,GAC6B,EAAA;AAC7B,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAe,GAAA;AACd,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AAEd,CAAA;;;ACnFO,IAAM,EAAA,GAAN,MAAM,GAA4C,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxD,YAAoB,KAAU,EAAA;AAAV,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAW;AAAA;AAAA;AAAA;AAAA,EAK/B,IAAsB,GAAA;AACrB,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAA4B,GAAA;AAC3B,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAY,GAAA;AACX,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACb;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,EAAiD,EAAA;AACvD,IAAA,OAAO,IAAI,GAAA,CAAG,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,EAC6B,EAAA;AAC7B,IAAO,OAAA,EAAA,CAAG,KAAK,KAAK,CAAA;AAAA;AACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAwB,GAAgD,EAAA;AACvE,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAmB,GAAA;AAClB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAAA;AAEnD,CAAA;;;AC9DA,SAASA,IAAM,KAAqB,EAAA;AACnC,EAAO,OAAA,IAAI,GAAO,KAAK,CAAA;AACxB;AAYA,SAASC,KAAqB,KAA+B,EAAA;AAC5D,EAAO,OAAA,IAAI,IAAQ,KAAK,CAAA;AACzB;AAEC,MAAA,CAAe,EAAKD,GAAAA,GAAAA;AACpB,MAAA,CAAe,GAAMC,GAAAA,IAAAA","file":"index.cjs","sourcesContent":["import type { ResultDefinition } from \"./result\";\nimport { Ok } from \"./ok\";\n\n/**\n * Represents a failed result (`Err`) that contains an error value.\n * @template E The type of the error contained in this `Err`.\n */\nexport class Err<E extends Error>\n\textends Error\n\timplements ResultDefinition<never, E>\n{\n\tprivate error: E;\n\t/**\n\t * Creates a new `Err` instance with the given error value.\n\t * @param error The error to wrap in the `Err` instance.\n\t */\n\tconstructor(error: E | string) {\n\t\tsuper(typeof error === \"string\" ? error : error.message);\n\t\tthis.error =\n\t\t\ttypeof error === \"string\" ? (new Error(error) as E) : (error as E);\n\t\tObject.setPrototypeOf(this, Err.prototype);\n\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, Err);\n\t\t}\n\t}\n\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `false` because this is an `Err`.\n\t */\n\tisOk(): this is Ok<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `true` because this is an `Err`.\n\t */\n\tisErr(): this is Err<E extends Error ? E : Error> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.\n\t * @throws An error because `unwrap` is called on an `Err`.\n\t */\n\tunwrap(): never {\n\t\tthrow new Error(\"Called unwrap on an Err value\");\n\t}\n\n\t/**\n\t * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.\n\t * @template U The type of the value (ignored for `Err`).\n\t * @param _fn The mapping function for values (not used).\n\t * @returns The original `Err` instance.\n\t */\n\tmap<U>(_fn: (value: never) => U): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Maps the error value using a transformation function and returns a new `Result` with the transformed error.\n\t * @template U The type of the transformed error.\n\t * @param fn The transformation function to apply to the error value.\n\t * @returns A new `Err` containing the transformed error.\n\t */\n\tmapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U> {\n\t\treturn new Err<U>(fn(this.error)) as unknown as ResultDefinition<never, U>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param _fn The transformation function (ignored in this implementation).\n\t * @returns The original `Err` instance.\n\t */\n\tflatMap<U>(\n\t\t_fn: (value: never) => ResultDefinition<U, never>,\n\t): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Retrieves the error value contained in this `Err`.\n\t * @returns The error value contained in this `Err`.\n\t */\n\tunwrapErr(): E {\n\t\treturn this.error;\n\t}\n}\n","import type { ResultDefinition } from \"./result\";\nimport { Err } from \"./err\";\n\n/**\n * Represents a successful result (`Ok`) that contains a value.\n * @template T The type of the value contained in this `Ok`.\n */\nexport class Ok<T> implements ResultDefinition<T, never> {\n\t/**\n\t * Creates a new `Ok` instance with the given value.\n\t * @param value The value to wrap in the `Ok` instance.\n\t */\n\tconstructor(private value: T) {}\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `true` because this is an `Ok`.\n\t */\n\tisOk(): this is Ok<T> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `false` because this is an `Ok`.\n\t */\n\tisErr(): this is Err<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this `Ok`.\n\t * @returns The value contained in this `Ok`.\n\t */\n\tunwrap(): T {\n\t\treturn this.value;\n\t}\n\n\t/**\n\t * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.\n\t * @template U The type of the transformed value.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns A new `Ok` containing the transformed value.\n\t */\n\tmap<U>(fn: (value: T) => U): ResultDefinition<U, never> {\n\t\treturn new Ok(fn(this.value)) as ResultDefinition<U, never>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns The result of applying the transformation function.\n\t */\n\tflatMap<U>(\n\t\tfn: (value: T) => ResultDefinition<U, never>,\n\t): ResultDefinition<U, never> {\n\t\treturn fn(this.value);\n\t}\n\n\t/**\n\t * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.\n\t * @template U The type of the error (ignored for `Ok`).\n\t * @param _fn The mapping function for errors (not used).\n\t * @returns The original `Ok` instance.\n\t */\n\t// mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {\n\t// \treturn this;\n\tmapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U> {\n\t\treturn this as unknown as ResultDefinition<T, U>;\n\t}\n\n\t/**\n\t * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.\n\t * @throws An error because `unwrapErr` is called on an `Ok`.\n\t */\n\tunwrapErr(): never {\n\t\tthrow new Error(\"Called unwrapErr on an Ok value\");\n\t}\n}\n","import {\n\tErr as ErrType,\n\tOk as OkType,\n\ttype Result,\n} from \"./__internal__/return-types\";\n\n/**\n * Creates a new `Ok` instance, representing a successful result.\n * @template T The type of the value contained in the `Ok`.\n * @param value The value to wrap in the `Ok` instance.\n * @returns An `Ok` instance containing the given value.\n * @example\n * const result = Ok(42);\n * console.log(result.isOk()); // true\n * console.log(result.unwrap()); // 42\n */\nfunction Ok<T>(value: T): OkType<T> {\n\treturn new OkType(value);\n}\n\n/**\n * Creates a new `Err` instance, representing a failed result.\n * @template E The type of the error contained in the `Err`.\n * @param error The error to wrap in the `Err` instance.\n * @returns An `Err` instance containing the given error.\n * @example\n * const result = Err(\"Something went wrong\");\n * console.log(result.isErr()); // true\n * console.log(result.unwrapErr()); // \"Something went wrong\"\n */\nfunction Err<E extends Error>(error: E | string): ErrType<E> {\n\treturn new ErrType(error);\n}\n\n(global as any).Ok = Ok;\n(global as any).Err = Err;\n\nexport { Err, Ok, Result, ErrType, OkType };\n"]}

package/dist/result/index.d.cts

@@ -0,0 +1,2 @@
+export { Err, Ok } from './result.cjs';
+export { R as Result } from '../err-B7LUEZ0f.cjs';

package/dist/result/index.d.ts

@@ -0,0 +1,2 @@
+export { Err, Ok } from './result.js';
+export { R as Result } from '../err-B7LUEZ0f.js';

package/dist/result/index.js

@@ -0,0 +1,153 @@
+// src/result/__internal__/return-types/err.ts
+var Err = class _Err extends Error {
+  error;
+  /**
+   * Creates a new `Err` instance with the given error value.
+   * @param error The error to wrap in the `Err` instance.
+   */
+  constructor(error) {
+    super(typeof error === "string" ? error : error.message);
+    this.error = typeof error === "string" ? new Error(error) : error;
+    Object.setPrototypeOf(this, _Err.prototype);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, _Err);
+    }
+  }
+  /**
+   * Checks if this result is an `Ok`.
+   * @returns `false` because this is an `Err`.
+   */
+  isOk() {
+    return false;
+  }
+  /**
+   * Checks if this result is an `Err`.
+   * @returns `true` because this is an `Err`.
+   */
+  isErr() {
+    return true;
+  }
+  /**
+   * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.
+   * @throws An error because `unwrap` is called on an `Err`.
+   */
+  unwrap() {
+    throw new Error("Called unwrap on an Err value");
+  }
+  /**
+   * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.
+   * @template U The type of the value (ignored for `Err`).
+   * @param _fn The mapping function for values (not used).
+   * @returns The original `Err` instance.
+   */
+  map(_fn) {
+    return this;
+  }
+  /**
+   * Maps the error value using a transformation function and returns a new `Result` with the transformed error.
+   * @template U The type of the transformed error.
+   * @param fn The transformation function to apply to the error value.
+   * @returns A new `Err` containing the transformed error.
+   */
+  mapErr(fn) {
+    return new _Err(fn(this.error));
+  }
+  /**
+   * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.
+   * @template U The type of the value in the resulting `Result`.
+   * @param _fn The transformation function (ignored in this implementation).
+   * @returns The original `Err` instance.
+   */
+  flatMap(_fn) {
+    return this;
+  }
+  /**
+   * Retrieves the error value contained in this `Err`.
+   * @returns The error value contained in this `Err`.
+   */
+  unwrapErr() {
+    return this.error;
+  }
+};
+
+// src/result/__internal__/return-types/ok.ts
+var Ok = class _Ok {
+  /**
+   * Creates a new `Ok` instance with the given value.
+   * @param value The value to wrap in the `Ok` instance.
+   */
+  constructor(value) {
+    this.value = value;
+  }
+  /**
+   * Checks if this result is an `Ok`.
+   * @returns `true` because this is an `Ok`.
+   */
+  isOk() {
+    return true;
+  }
+  /**
+   * Checks if this result is an `Err`.
+   * @returns `false` because this is an `Ok`.
+   */
+  isErr() {
+    return false;
+  }
+  /**
+   * Retrieves the value contained in this `Ok`.
+   * @returns The value contained in this `Ok`.
+   */
+  unwrap() {
+    return this.value;
+  }
+  /**
+   * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.
+   * @template U The type of the transformed value.
+   * @param fn The transformation function to apply to the value.
+   * @returns A new `Ok` containing the transformed value.
+   */
+  map(fn) {
+    return new _Ok(fn(this.value));
+  }
+  /**
+   * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.
+   * @template U The type of the value in the resulting `Result`.
+   * @param fn The transformation function to apply to the value.
+   * @returns The result of applying the transformation function.
+   */
+  flatMap(fn) {
+    return fn(this.value);
+  }
+  /**
+   * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.
+   * @template U The type of the error (ignored for `Ok`).
+   * @param _fn The mapping function for errors (not used).
+   * @returns The original `Ok` instance.
+   */
+  // mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {
+  // 	return this;
+  mapErr(_fn) {
+    return this;
+  }
+  /**
+   * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.
+   * @throws An error because `unwrapErr` is called on an `Ok`.
+   */
+  unwrapErr() {
+    throw new Error("Called unwrapErr on an Ok value");
+  }
+};
+
+// src/result/result.ts
+function Ok2(value) {
+  return new Ok(value);
+}
+function Err2(error) {
+  return new Err(error);
+}
+global.Ok = Ok2;
+global.Err = Err2;
+
+export { Err2 as Err, Ok2 as Ok };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/result/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/result/__internal__/return-types/err.ts","../../src/result/__internal__/return-types/ok.ts","../../src/result/result.ts"],"names":["Ok","Err"],"mappings":";AAOO,IAAM,GAAA,GAAN,MAAM,IAAA,SACJ,KAET,CAAA;AAAA,EACS,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,YAAY,KAAmB,EAAA;AAC9B,IAAA,KAAA,CAAM,OAAO,KAAA,KAAU,QAAW,GAAA,KAAA,GAAQ,MAAM,OAAO,CAAA;AACvD,IAAA,IAAA,CAAK,QACJ,OAAO,KAAA,KAAU,WAAY,IAAI,KAAA,CAAM,KAAK,CAAW,GAAA,KAAA;AACxD,IAAO,MAAA,CAAA,cAAA,CAAe,IAAM,EAAA,IAAA,CAAI,SAAS,CAAA;AAEzC,IAAA,IAAI,MAAM,iBAAmB,EAAA;AAC5B,MAAM,KAAA,CAAA,iBAAA,CAAkB,MAAM,IAAG,CAAA;AAAA;AAClC;AACD;AAAA;AAAA;AAAA;AAAA,EAMA,IAA0B,GAAA;AACzB,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAAkD,GAAA;AACjD,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,GAAA;AACf,IAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA;AAAA;AAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,GAAsD,EAAA;AAC5D,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAwB,EAA+C,EAAA;AACtE,IAAA,OAAO,IAAI,IAAA,CAAO,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,GAC6B,EAAA;AAC7B,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAe,GAAA;AACd,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AAEd,CAAA;;;ACnFO,IAAM,EAAA,GAAN,MAAM,GAA4C,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxD,YAAoB,KAAU,EAAA;AAAV,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAW;AAAA;AAAA;AAAA;AAAA,EAK/B,IAAsB,GAAA;AACrB,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAA4B,GAAA;AAC3B,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAY,GAAA;AACX,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACb;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,EAAiD,EAAA;AACvD,IAAA,OAAO,IAAI,GAAA,CAAG,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,EAC6B,EAAA;AAC7B,IAAO,OAAA,EAAA,CAAG,KAAK,KAAK,CAAA;AAAA;AACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAwB,GAAgD,EAAA;AACvE,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAmB,GAAA;AAClB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAAA;AAEnD,CAAA;;;AC9DA,SAASA,IAAM,KAAqB,EAAA;AACnC,EAAO,OAAA,IAAI,GAAO,KAAK,CAAA;AACxB;AAYA,SAASC,KAAqB,KAA+B,EAAA;AAC5D,EAAO,OAAA,IAAI,IAAQ,KAAK,CAAA;AACzB;AAEC,MAAA,CAAe,EAAKD,GAAAA,GAAAA;AACpB,MAAA,CAAe,GAAMC,GAAAA,IAAAA","file":"index.js","sourcesContent":["import type { ResultDefinition } from \"./result\";\nimport { Ok } from \"./ok\";\n\n/**\n * Represents a failed result (`Err`) that contains an error value.\n * @template E The type of the error contained in this `Err`.\n */\nexport class Err<E extends Error>\n\textends Error\n\timplements ResultDefinition<never, E>\n{\n\tprivate error: E;\n\t/**\n\t * Creates a new `Err` instance with the given error value.\n\t * @param error The error to wrap in the `Err` instance.\n\t */\n\tconstructor(error: E | string) {\n\t\tsuper(typeof error === \"string\" ? error : error.message);\n\t\tthis.error =\n\t\t\ttypeof error === \"string\" ? (new Error(error) as E) : (error as E);\n\t\tObject.setPrototypeOf(this, Err.prototype);\n\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, Err);\n\t\t}\n\t}\n\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `false` because this is an `Err`.\n\t */\n\tisOk(): this is Ok<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `true` because this is an `Err`.\n\t */\n\tisErr(): this is Err<E extends Error ? E : Error> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.\n\t * @throws An error because `unwrap` is called on an `Err`.\n\t */\n\tunwrap(): never {\n\t\tthrow new Error(\"Called unwrap on an Err value\");\n\t}\n\n\t/**\n\t * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.\n\t * @template U The type of the value (ignored for `Err`).\n\t * @param _fn The mapping function for values (not used).\n\t * @returns The original `Err` instance.\n\t */\n\tmap<U>(_fn: (value: never) => U): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Maps the error value using a transformation function and returns a new `Result` with the transformed error.\n\t * @template U The type of the transformed error.\n\t * @param fn The transformation function to apply to the error value.\n\t * @returns A new `Err` containing the transformed error.\n\t */\n\tmapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U> {\n\t\treturn new Err<U>(fn(this.error)) as unknown as ResultDefinition<never, U>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param _fn The transformation function (ignored in this implementation).\n\t * @returns The original `Err` instance.\n\t */\n\tflatMap<U>(\n\t\t_fn: (value: never) => ResultDefinition<U, never>,\n\t): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Retrieves the error value contained in this `Err`.\n\t * @returns The error value contained in this `Err`.\n\t */\n\tunwrapErr(): E {\n\t\treturn this.error;\n\t}\n}\n","import type { ResultDefinition } from \"./result\";\nimport { Err } from \"./err\";\n\n/**\n * Represents a successful result (`Ok`) that contains a value.\n * @template T The type of the value contained in this `Ok`.\n */\nexport class Ok<T> implements ResultDefinition<T, never> {\n\t/**\n\t * Creates a new `Ok` instance with the given value.\n\t * @param value The value to wrap in the `Ok` instance.\n\t */\n\tconstructor(private value: T) {}\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `true` because this is an `Ok`.\n\t */\n\tisOk(): this is Ok<T> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `false` because this is an `Ok`.\n\t */\n\tisErr(): this is Err<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this `Ok`.\n\t * @returns The value contained in this `Ok`.\n\t */\n\tunwrap(): T {\n\t\treturn this.value;\n\t}\n\n\t/**\n\t * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.\n\t * @template U The type of the transformed value.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns A new `Ok` containing the transformed value.\n\t */\n\tmap<U>(fn: (value: T) => U): ResultDefinition<U, never> {\n\t\treturn new Ok(fn(this.value)) as ResultDefinition<U, never>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns The result of applying the transformation function.\n\t */\n\tflatMap<U>(\n\t\tfn: (value: T) => ResultDefinition<U, never>,\n\t): ResultDefinition<U, never> {\n\t\treturn fn(this.value);\n\t}\n\n\t/**\n\t * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.\n\t * @template U The type of the error (ignored for `Ok`).\n\t * @param _fn The mapping function for errors (not used).\n\t * @returns The original `Ok` instance.\n\t */\n\t// mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {\n\t// \treturn this;\n\tmapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U> {\n\t\treturn this as unknown as ResultDefinition<T, U>;\n\t}\n\n\t/**\n\t * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.\n\t * @throws An error because `unwrapErr` is called on an `Ok`.\n\t */\n\tunwrapErr(): never {\n\t\tthrow new Error(\"Called unwrapErr on an Ok value\");\n\t}\n}\n","import {\n\tErr as ErrType,\n\tOk as OkType,\n\ttype Result,\n} from \"./__internal__/return-types\";\n\n/**\n * Creates a new `Ok` instance, representing a successful result.\n * @template T The type of the value contained in the `Ok`.\n * @param value The value to wrap in the `Ok` instance.\n * @returns An `Ok` instance containing the given value.\n * @example\n * const result = Ok(42);\n * console.log(result.isOk()); // true\n * console.log(result.unwrap()); // 42\n */\nfunction Ok<T>(value: T): OkType<T> {\n\treturn new OkType(value);\n}\n\n/**\n * Creates a new `Err` instance, representing a failed result.\n * @template E The type of the error contained in the `Err`.\n * @param error The error to wrap in the `Err` instance.\n * @returns An `Err` instance containing the given error.\n * @example\n * const result = Err(\"Something went wrong\");\n * console.log(result.isErr()); // true\n * console.log(result.unwrapErr()); // \"Something went wrong\"\n */\nfunction Err<E extends Error>(error: E | string): ErrType<E> {\n\treturn new ErrType(error);\n}\n\n(global as any).Ok = Ok;\n(global as any).Err = Err;\n\nexport { Err, Ok, Result, ErrType, OkType };\n"]}

package/dist/result/result.cjs

@@ -0,0 +1,158 @@
+'use strict';
+
+// src/result/__internal__/return-types/err.ts
+var Err = class _Err extends Error {
+  error;
+  /**
+   * Creates a new `Err` instance with the given error value.
+   * @param error The error to wrap in the `Err` instance.
+   */
+  constructor(error) {
+    super(typeof error === "string" ? error : error.message);
+    this.error = typeof error === "string" ? new Error(error) : error;
+    Object.setPrototypeOf(this, _Err.prototype);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, _Err);
+    }
+  }
+  /**
+   * Checks if this result is an `Ok`.
+   * @returns `false` because this is an `Err`.
+   */
+  isOk() {
+    return false;
+  }
+  /**
+   * Checks if this result is an `Err`.
+   * @returns `true` because this is an `Err`.
+   */
+  isErr() {
+    return true;
+  }
+  /**
+   * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.
+   * @throws An error because `unwrap` is called on an `Err`.
+   */
+  unwrap() {
+    throw new Error("Called unwrap on an Err value");
+  }
+  /**
+   * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.
+   * @template U The type of the value (ignored for `Err`).
+   * @param _fn The mapping function for values (not used).
+   * @returns The original `Err` instance.
+   */
+  map(_fn) {
+    return this;
+  }
+  /**
+   * Maps the error value using a transformation function and returns a new `Result` with the transformed error.
+   * @template U The type of the transformed error.
+   * @param fn The transformation function to apply to the error value.
+   * @returns A new `Err` containing the transformed error.
+   */
+  mapErr(fn) {
+    return new _Err(fn(this.error));
+  }
+  /**
+   * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.
+   * @template U The type of the value in the resulting `Result`.
+   * @param _fn The transformation function (ignored in this implementation).
+   * @returns The original `Err` instance.
+   */
+  flatMap(_fn) {
+    return this;
+  }
+  /**
+   * Retrieves the error value contained in this `Err`.
+   * @returns The error value contained in this `Err`.
+   */
+  unwrapErr() {
+    return this.error;
+  }
+};
+
+// src/result/__internal__/return-types/ok.ts
+var Ok = class _Ok {
+  /**
+   * Creates a new `Ok` instance with the given value.
+   * @param value The value to wrap in the `Ok` instance.
+   */
+  constructor(value) {
+    this.value = value;
+  }
+  /**
+   * Checks if this result is an `Ok`.
+   * @returns `true` because this is an `Ok`.
+   */
+  isOk() {
+    return true;
+  }
+  /**
+   * Checks if this result is an `Err`.
+   * @returns `false` because this is an `Ok`.
+   */
+  isErr() {
+    return false;
+  }
+  /**
+   * Retrieves the value contained in this `Ok`.
+   * @returns The value contained in this `Ok`.
+   */
+  unwrap() {
+    return this.value;
+  }
+  /**
+   * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.
+   * @template U The type of the transformed value.
+   * @param fn The transformation function to apply to the value.
+   * @returns A new `Ok` containing the transformed value.
+   */
+  map(fn) {
+    return new _Ok(fn(this.value));
+  }
+  /**
+   * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.
+   * @template U The type of the value in the resulting `Result`.
+   * @param fn The transformation function to apply to the value.
+   * @returns The result of applying the transformation function.
+   */
+  flatMap(fn) {
+    return fn(this.value);
+  }
+  /**
+   * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.
+   * @template U The type of the error (ignored for `Ok`).
+   * @param _fn The mapping function for errors (not used).
+   * @returns The original `Ok` instance.
+   */
+  // mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {
+  // 	return this;
+  mapErr(_fn) {
+    return this;
+  }
+  /**
+   * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.
+   * @throws An error because `unwrapErr` is called on an `Ok`.
+   */
+  unwrapErr() {
+    throw new Error("Called unwrapErr on an Ok value");
+  }
+};
+
+// src/result/result.ts
+function Ok2(value) {
+  return new Ok(value);
+}
+function Err2(error) {
+  return new Err(error);
+}
+global.Ok = Ok2;
+global.Err = Err2;
+
+exports.Err = Err2;
+exports.ErrType = Err;
+exports.Ok = Ok2;
+exports.OkType = Ok;
+//# sourceMappingURL=result.cjs.map
+//# sourceMappingURL=result.cjs.map

package/dist/result/result.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/result/__internal__/return-types/err.ts","../../src/result/__internal__/return-types/ok.ts","../../src/result/result.ts"],"names":["Ok","Err"],"mappings":";;;AAOa,IAAA,GAAA,GAAN,MAAM,IAAA,SACJ,KAET,CAAA;AAAA,EACS,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,YAAY,KAAmB,EAAA;AAC9B,IAAA,KAAA,CAAM,OAAO,KAAA,KAAU,QAAW,GAAA,KAAA,GAAQ,MAAM,OAAO,CAAA;AACvD,IAAA,IAAA,CAAK,QACJ,OAAO,KAAA,KAAU,WAAY,IAAI,KAAA,CAAM,KAAK,CAAW,GAAA,KAAA;AACxD,IAAO,MAAA,CAAA,cAAA,CAAe,IAAM,EAAA,IAAA,CAAI,SAAS,CAAA;AAEzC,IAAA,IAAI,MAAM,iBAAmB,EAAA;AAC5B,MAAM,KAAA,CAAA,iBAAA,CAAkB,MAAM,IAAG,CAAA;AAAA;AAClC;AACD;AAAA;AAAA;AAAA;AAAA,EAMA,IAA0B,GAAA;AACzB,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAAkD,GAAA;AACjD,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,GAAA;AACf,IAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA;AAAA;AAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,GAAsD,EAAA;AAC5D,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAwB,EAA+C,EAAA;AACtE,IAAA,OAAO,IAAI,IAAA,CAAO,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,GAC6B,EAAA;AAC7B,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAe,GAAA;AACd,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AAEd;;;ACnFa,IAAA,EAAA,GAAN,MAAM,GAA4C,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxD,YAAoB,KAAU,EAAA;AAAV,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAW;AAAA;AAAA;AAAA;AAAA,EAK/B,IAAsB,GAAA;AACrB,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAA4B,GAAA;AAC3B,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAY,GAAA;AACX,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACb;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,EAAiD,EAAA;AACvD,IAAA,OAAO,IAAI,GAAA,CAAG,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,EAC6B,EAAA;AAC7B,IAAO,OAAA,EAAA,CAAG,KAAK,KAAK,CAAA;AAAA;AACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAwB,GAAgD,EAAA;AACvE,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAmB,GAAA;AAClB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAAA;AAEnD;;;AC9DA,SAASA,IAAM,KAAqB,EAAA;AACnC,EAAO,OAAA,IAAI,GAAO,KAAK,CAAA;AACxB;AAYA,SAASC,KAAqB,KAA+B,EAAA;AAC5D,EAAO,OAAA,IAAI,IAAQ,KAAK,CAAA;AACzB;AAEC,MAAA,CAAe,EAAKD,GAAAA,GAAAA;AACpB,MAAA,CAAe,GAAMC,GAAAA,IAAAA","file":"result.cjs","sourcesContent":["import type { ResultDefinition } from \"./result\";\nimport { Ok } from \"./ok\";\n\n/**\n * Represents a failed result (`Err`) that contains an error value.\n * @template E The type of the error contained in this `Err`.\n */\nexport class Err<E extends Error>\n\textends Error\n\timplements ResultDefinition<never, E>\n{\n\tprivate error: E;\n\t/**\n\t * Creates a new `Err` instance with the given error value.\n\t * @param error The error to wrap in the `Err` instance.\n\t */\n\tconstructor(error: E | string) {\n\t\tsuper(typeof error === \"string\" ? error : error.message);\n\t\tthis.error =\n\t\t\ttypeof error === \"string\" ? (new Error(error) as E) : (error as E);\n\t\tObject.setPrototypeOf(this, Err.prototype);\n\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, Err);\n\t\t}\n\t}\n\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `false` because this is an `Err`.\n\t */\n\tisOk(): this is Ok<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `true` because this is an `Err`.\n\t */\n\tisErr(): this is Err<E extends Error ? E : Error> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.\n\t * @throws An error because `unwrap` is called on an `Err`.\n\t */\n\tunwrap(): never {\n\t\tthrow new Error(\"Called unwrap on an Err value\");\n\t}\n\n\t/**\n\t * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.\n\t * @template U The type of the value (ignored for `Err`).\n\t * @param _fn The mapping function for values (not used).\n\t * @returns The original `Err` instance.\n\t */\n\tmap<U>(_fn: (value: never) => U): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Maps the error value using a transformation function and returns a new `Result` with the transformed error.\n\t * @template U The type of the transformed error.\n\t * @param fn The transformation function to apply to the error value.\n\t * @returns A new `Err` containing the transformed error.\n\t */\n\tmapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U> {\n\t\treturn new Err<U>(fn(this.error)) as unknown as ResultDefinition<never, U>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param _fn The transformation function (ignored in this implementation).\n\t * @returns The original `Err` instance.\n\t */\n\tflatMap<U>(\n\t\t_fn: (value: never) => ResultDefinition<U, never>,\n\t): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Retrieves the error value contained in this `Err`.\n\t * @returns The error value contained in this `Err`.\n\t */\n\tunwrapErr(): E {\n\t\treturn this.error;\n\t}\n}\n","import type { ResultDefinition } from \"./result\";\nimport { Err } from \"./err\";\n\n/**\n * Represents a successful result (`Ok`) that contains a value.\n * @template T The type of the value contained in this `Ok`.\n */\nexport class Ok<T> implements ResultDefinition<T, never> {\n\t/**\n\t * Creates a new `Ok` instance with the given value.\n\t * @param value The value to wrap in the `Ok` instance.\n\t */\n\tconstructor(private value: T) {}\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `true` because this is an `Ok`.\n\t */\n\tisOk(): this is Ok<T> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `false` because this is an `Ok`.\n\t */\n\tisErr(): this is Err<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this `Ok`.\n\t * @returns The value contained in this `Ok`.\n\t */\n\tunwrap(): T {\n\t\treturn this.value;\n\t}\n\n\t/**\n\t * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.\n\t * @template U The type of the transformed value.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns A new `Ok` containing the transformed value.\n\t */\n\tmap<U>(fn: (value: T) => U): ResultDefinition<U, never> {\n\t\treturn new Ok(fn(this.value)) as ResultDefinition<U, never>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns The result of applying the transformation function.\n\t */\n\tflatMap<U>(\n\t\tfn: (value: T) => ResultDefinition<U, never>,\n\t): ResultDefinition<U, never> {\n\t\treturn fn(this.value);\n\t}\n\n\t/**\n\t * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.\n\t * @template U The type of the error (ignored for `Ok`).\n\t * @param _fn The mapping function for errors (not used).\n\t * @returns The original `Ok` instance.\n\t */\n\t// mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {\n\t// \treturn this;\n\tmapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U> {\n\t\treturn this as unknown as ResultDefinition<T, U>;\n\t}\n\n\t/**\n\t * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.\n\t * @throws An error because `unwrapErr` is called on an `Ok`.\n\t */\n\tunwrapErr(): never {\n\t\tthrow new Error(\"Called unwrapErr on an Ok value\");\n\t}\n}\n","import {\n\tErr as ErrType,\n\tOk as OkType,\n\ttype Result,\n} from \"./__internal__/return-types\";\n\n/**\n * Creates a new `Ok` instance, representing a successful result.\n * @template T The type of the value contained in the `Ok`.\n * @param value The value to wrap in the `Ok` instance.\n * @returns An `Ok` instance containing the given value.\n * @example\n * const result = Ok(42);\n * console.log(result.isOk()); // true\n * console.log(result.unwrap()); // 42\n */\nfunction Ok<T>(value: T): OkType<T> {\n\treturn new OkType(value);\n}\n\n/**\n * Creates a new `Err` instance, representing a failed result.\n * @template E The type of the error contained in the `Err`.\n * @param error The error to wrap in the `Err` instance.\n * @returns An `Err` instance containing the given error.\n * @example\n * const result = Err(\"Something went wrong\");\n * console.log(result.isErr()); // true\n * console.log(result.unwrapErr()); // \"Something went wrong\"\n */\nfunction Err<E extends Error>(error: E | string): ErrType<E> {\n\treturn new ErrType(error);\n}\n\n(global as any).Ok = Ok;\n(global as any).Err = Err;\n\nexport { Err, Ok, Result, ErrType, OkType };\n"]}

package/dist/result/result.d.cts

@@ -0,0 +1,27 @@
+import { E as Err$1, O as Ok$1 } from '../err-B7LUEZ0f.cjs';
+export { R as Result } from '../err-B7LUEZ0f.cjs';
+
+/**
+ * Creates a new `Ok` instance, representing a successful result.
+ * @template T The type of the value contained in the `Ok`.
+ * @param value The value to wrap in the `Ok` instance.
+ * @returns An `Ok` instance containing the given value.
+ * @example
+ * const result = Ok(42);
+ * console.log(result.isOk()); // true
+ * console.log(result.unwrap()); // 42
+ */
+declare function Ok<T>(value: T): Ok$1<T>;
+/**
+ * Creates a new `Err` instance, representing a failed result.
+ * @template E The type of the error contained in the `Err`.
+ * @param error The error to wrap in the `Err` instance.
+ * @returns An `Err` instance containing the given error.
+ * @example
+ * const result = Err("Something went wrong");
+ * console.log(result.isErr()); // true
+ * console.log(result.unwrapErr()); // "Something went wrong"
+ */
+declare function Err<E extends Error>(error: E | string): Err$1<E>;
+
+export { Err, Err$1 as ErrType, Ok, Ok$1 as OkType };

package/dist/result/result.d.ts

@@ -0,0 +1,27 @@
+import { E as Err$1, O as Ok$1 } from '../err-B7LUEZ0f.js';
+export { R as Result } from '../err-B7LUEZ0f.js';
+
+/**
+ * Creates a new `Ok` instance, representing a successful result.
+ * @template T The type of the value contained in the `Ok`.
+ * @param value The value to wrap in the `Ok` instance.
+ * @returns An `Ok` instance containing the given value.
+ * @example
+ * const result = Ok(42);
+ * console.log(result.isOk()); // true
+ * console.log(result.unwrap()); // 42
+ */
+declare function Ok<T>(value: T): Ok$1<T>;
+/**
+ * Creates a new `Err` instance, representing a failed result.
+ * @template E The type of the error contained in the `Err`.
+ * @param error The error to wrap in the `Err` instance.
+ * @returns An `Err` instance containing the given error.
+ * @example
+ * const result = Err("Something went wrong");
+ * console.log(result.isErr()); // true
+ * console.log(result.unwrapErr()); // "Something went wrong"
+ */
+declare function Err<E extends Error>(error: E | string): Err$1<E>;
+
+export { Err, Err$1 as ErrType, Ok, Ok$1 as OkType };

package/dist/result/result.js

@@ -0,0 +1,153 @@
+// src/result/__internal__/return-types/err.ts
+var Err = class _Err extends Error {
+  error;
+  /**
+   * Creates a new `Err` instance with the given error value.
+   * @param error The error to wrap in the `Err` instance.
+   */
+  constructor(error) {
+    super(typeof error === "string" ? error : error.message);
+    this.error = typeof error === "string" ? new Error(error) : error;
+    Object.setPrototypeOf(this, _Err.prototype);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, _Err);
+    }
+  }
+  /**
+   * Checks if this result is an `Ok`.
+   * @returns `false` because this is an `Err`.
+   */
+  isOk() {
+    return false;
+  }
+  /**
+   * Checks if this result is an `Err`.
+   * @returns `true` because this is an `Err`.
+   */
+  isErr() {
+    return true;
+  }
+  /**
+   * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.
+   * @throws An error because `unwrap` is called on an `Err`.
+   */
+  unwrap() {
+    throw new Error("Called unwrap on an Err value");
+  }
+  /**
+   * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.
+   * @template U The type of the value (ignored for `Err`).
+   * @param _fn The mapping function for values (not used).
+   * @returns The original `Err` instance.
+   */
+  map(_fn) {
+    return this;
+  }
+  /**
+   * Maps the error value using a transformation function and returns a new `Result` with the transformed error.
+   * @template U The type of the transformed error.
+   * @param fn The transformation function to apply to the error value.
+   * @returns A new `Err` containing the transformed error.
+   */
+  mapErr(fn) {
+    return new _Err(fn(this.error));
+  }
+  /**
+   * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.
+   * @template U The type of the value in the resulting `Result`.
+   * @param _fn The transformation function (ignored in this implementation).
+   * @returns The original `Err` instance.
+   */
+  flatMap(_fn) {
+    return this;
+  }
+  /**
+   * Retrieves the error value contained in this `Err`.
+   * @returns The error value contained in this `Err`.
+   */
+  unwrapErr() {
+    return this.error;
+  }
+};
+
+// src/result/__internal__/return-types/ok.ts
+var Ok = class _Ok {
+  /**
+   * Creates a new `Ok` instance with the given value.
+   * @param value The value to wrap in the `Ok` instance.
+   */
+  constructor(value) {
+    this.value = value;
+  }
+  /**
+   * Checks if this result is an `Ok`.
+   * @returns `true` because this is an `Ok`.
+   */
+  isOk() {
+    return true;
+  }
+  /**
+   * Checks if this result is an `Err`.
+   * @returns `false` because this is an `Ok`.
+   */
+  isErr() {
+    return false;
+  }
+  /**
+   * Retrieves the value contained in this `Ok`.
+   * @returns The value contained in this `Ok`.
+   */
+  unwrap() {
+    return this.value;
+  }
+  /**
+   * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.
+   * @template U The type of the transformed value.
+   * @param fn The transformation function to apply to the value.
+   * @returns A new `Ok` containing the transformed value.
+   */
+  map(fn) {
+    return new _Ok(fn(this.value));
+  }
+  /**
+   * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.
+   * @template U The type of the value in the resulting `Result`.
+   * @param fn The transformation function to apply to the value.
+   * @returns The result of applying the transformation function.
+   */
+  flatMap(fn) {
+    return fn(this.value);
+  }
+  /**
+   * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.
+   * @template U The type of the error (ignored for `Ok`).
+   * @param _fn The mapping function for errors (not used).
+   * @returns The original `Ok` instance.
+   */
+  // mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {
+  // 	return this;
+  mapErr(_fn) {
+    return this;
+  }
+  /**
+   * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.
+   * @throws An error because `unwrapErr` is called on an `Ok`.
+   */
+  unwrapErr() {
+    throw new Error("Called unwrapErr on an Ok value");
+  }
+};
+
+// src/result/result.ts
+function Ok2(value) {
+  return new Ok(value);
+}
+function Err2(error) {
+  return new Err(error);
+}
+global.Ok = Ok2;
+global.Err = Err2;
+
+export { Err2 as Err, Err as ErrType, Ok2 as Ok, Ok as OkType };
+//# sourceMappingURL=result.js.map
+//# sourceMappingURL=result.js.map

package/dist/result/result.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/result/__internal__/return-types/err.ts","../../src/result/__internal__/return-types/ok.ts","../../src/result/result.ts"],"names":["Ok","Err"],"mappings":";AAOa,IAAA,GAAA,GAAN,MAAM,IAAA,SACJ,KAET,CAAA;AAAA,EACS,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,YAAY,KAAmB,EAAA;AAC9B,IAAA,KAAA,CAAM,OAAO,KAAA,KAAU,QAAW,GAAA,KAAA,GAAQ,MAAM,OAAO,CAAA;AACvD,IAAA,IAAA,CAAK,QACJ,OAAO,KAAA,KAAU,WAAY,IAAI,KAAA,CAAM,KAAK,CAAW,GAAA,KAAA;AACxD,IAAO,MAAA,CAAA,cAAA,CAAe,IAAM,EAAA,IAAA,CAAI,SAAS,CAAA;AAEzC,IAAA,IAAI,MAAM,iBAAmB,EAAA;AAC5B,MAAM,KAAA,CAAA,iBAAA,CAAkB,MAAM,IAAG,CAAA;AAAA;AAClC;AACD;AAAA;AAAA;AAAA;AAAA,EAMA,IAA0B,GAAA;AACzB,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAAkD,GAAA;AACjD,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,GAAA;AACf,IAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA;AAAA;AAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,GAAsD,EAAA;AAC5D,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAwB,EAA+C,EAAA;AACtE,IAAA,OAAO,IAAI,IAAA,CAAO,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,GAC6B,EAAA;AAC7B,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAe,GAAA;AACd,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AAEd;;;ACnFa,IAAA,EAAA,GAAN,MAAM,GAA4C,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxD,YAAoB,KAAU,EAAA;AAAV,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAW;AAAA;AAAA;AAAA;AAAA,EAK/B,IAAsB,GAAA;AACrB,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,KAA4B,GAAA;AAC3B,IAAO,OAAA,KAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,MAAY,GAAA;AACX,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACb;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,EAAiD,EAAA;AACvD,IAAA,OAAO,IAAI,GAAA,CAAG,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACC,EAC6B,EAAA;AAC7B,IAAO,OAAA,EAAA,CAAG,KAAK,KAAK,CAAA;AAAA;AACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAwB,GAAgD,EAAA;AACvE,IAAO,OAAA,IAAA;AAAA;AACR;AAAA;AAAA;AAAA;AAAA,EAMA,SAAmB,GAAA;AAClB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAAA;AAEnD;;;AC9DA,SAASA,IAAM,KAAqB,EAAA;AACnC,EAAO,OAAA,IAAI,GAAO,KAAK,CAAA;AACxB;AAYA,SAASC,KAAqB,KAA+B,EAAA;AAC5D,EAAO,OAAA,IAAI,IAAQ,KAAK,CAAA;AACzB;AAEC,MAAA,CAAe,EAAKD,GAAAA,GAAAA;AACpB,MAAA,CAAe,GAAMC,GAAAA,IAAAA","file":"result.js","sourcesContent":["import type { ResultDefinition } from \"./result\";\nimport { Ok } from \"./ok\";\n\n/**\n * Represents a failed result (`Err`) that contains an error value.\n * @template E The type of the error contained in this `Err`.\n */\nexport class Err<E extends Error>\n\textends Error\n\timplements ResultDefinition<never, E>\n{\n\tprivate error: E;\n\t/**\n\t * Creates a new `Err` instance with the given error value.\n\t * @param error The error to wrap in the `Err` instance.\n\t */\n\tconstructor(error: E | string) {\n\t\tsuper(typeof error === \"string\" ? error : error.message);\n\t\tthis.error =\n\t\t\ttypeof error === \"string\" ? (new Error(error) as E) : (error as E);\n\t\tObject.setPrototypeOf(this, Err.prototype);\n\n\t\tif (Error.captureStackTrace) {\n\t\t\tError.captureStackTrace(this, Err);\n\t\t}\n\t}\n\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `false` because this is an `Err`.\n\t */\n\tisOk(): this is Ok<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `true` because this is an `Err`.\n\t */\n\tisErr(): this is Err<E extends Error ? E : Error> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.\n\t * @throws An error because `unwrap` is called on an `Err`.\n\t */\n\tunwrap(): never {\n\t\tthrow new Error(\"Called unwrap on an Err value\");\n\t}\n\n\t/**\n\t * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.\n\t * @template U The type of the value (ignored for `Err`).\n\t * @param _fn The mapping function for values (not used).\n\t * @returns The original `Err` instance.\n\t */\n\tmap<U>(_fn: (value: never) => U): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Maps the error value using a transformation function and returns a new `Result` with the transformed error.\n\t * @template U The type of the transformed error.\n\t * @param fn The transformation function to apply to the error value.\n\t * @returns A new `Err` containing the transformed error.\n\t */\n\tmapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U> {\n\t\treturn new Err<U>(fn(this.error)) as unknown as ResultDefinition<never, U>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param _fn The transformation function (ignored in this implementation).\n\t * @returns The original `Err` instance.\n\t */\n\tflatMap<U>(\n\t\t_fn: (value: never) => ResultDefinition<U, never>,\n\t): ResultDefinition<never, E> {\n\t\treturn this as unknown as ResultDefinition<never, E>;\n\t}\n\n\t/**\n\t * Retrieves the error value contained in this `Err`.\n\t * @returns The error value contained in this `Err`.\n\t */\n\tunwrapErr(): E {\n\t\treturn this.error;\n\t}\n}\n","import type { ResultDefinition } from \"./result\";\nimport { Err } from \"./err\";\n\n/**\n * Represents a successful result (`Ok`) that contains a value.\n * @template T The type of the value contained in this `Ok`.\n */\nexport class Ok<T> implements ResultDefinition<T, never> {\n\t/**\n\t * Creates a new `Ok` instance with the given value.\n\t * @param value The value to wrap in the `Ok` instance.\n\t */\n\tconstructor(private value: T) {}\n\t/**\n\t * Checks if this result is an `Ok`.\n\t * @returns `true` because this is an `Ok`.\n\t */\n\tisOk(): this is Ok<T> {\n\t\treturn true;\n\t}\n\n\t/**\n\t * Checks if this result is an `Err`.\n\t * @returns `false` because this is an `Ok`.\n\t */\n\tisErr(): this is Err<never> {\n\t\treturn false;\n\t}\n\n\t/**\n\t * Retrieves the value contained in this `Ok`.\n\t * @returns The value contained in this `Ok`.\n\t */\n\tunwrap(): T {\n\t\treturn this.value;\n\t}\n\n\t/**\n\t * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.\n\t * @template U The type of the transformed value.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns A new `Ok` containing the transformed value.\n\t */\n\tmap<U>(fn: (value: T) => U): ResultDefinition<U, never> {\n\t\treturn new Ok(fn(this.value)) as ResultDefinition<U, never>;\n\t}\n\n\t/**\n\t * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.\n\t * @template U The type of the value in the resulting `Result`.\n\t * @param fn The transformation function to apply to the value.\n\t * @returns The result of applying the transformation function.\n\t */\n\tflatMap<U>(\n\t\tfn: (value: T) => ResultDefinition<U, never>,\n\t): ResultDefinition<U, never> {\n\t\treturn fn(this.value);\n\t}\n\n\t/**\n\t * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.\n\t * @template U The type of the error (ignored for `Ok`).\n\t * @param _fn The mapping function for errors (not used).\n\t * @returns The original `Ok` instance.\n\t */\n\t// mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {\n\t// \treturn this;\n\tmapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U> {\n\t\treturn this as unknown as ResultDefinition<T, U>;\n\t}\n\n\t/**\n\t * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.\n\t * @throws An error because `unwrapErr` is called on an `Ok`.\n\t */\n\tunwrapErr(): never {\n\t\tthrow new Error(\"Called unwrapErr on an Ok value\");\n\t}\n}\n","import {\n\tErr as ErrType,\n\tOk as OkType,\n\ttype Result,\n} from \"./__internal__/return-types\";\n\n/**\n * Creates a new `Ok` instance, representing a successful result.\n * @template T The type of the value contained in the `Ok`.\n * @param value The value to wrap in the `Ok` instance.\n * @returns An `Ok` instance containing the given value.\n * @example\n * const result = Ok(42);\n * console.log(result.isOk()); // true\n * console.log(result.unwrap()); // 42\n */\nfunction Ok<T>(value: T): OkType<T> {\n\treturn new OkType(value);\n}\n\n/**\n * Creates a new `Err` instance, representing a failed result.\n * @template E The type of the error contained in the `Err`.\n * @param error The error to wrap in the `Err` instance.\n * @returns An `Err` instance containing the given error.\n * @example\n * const result = Err(\"Something went wrong\");\n * console.log(result.isErr()); // true\n * console.log(result.unwrapErr()); // \"Something went wrong\"\n */\nfunction Err<E extends Error>(error: E | string): ErrType<E> {\n\treturn new ErrType(error);\n}\n\n(global as any).Ok = Ok;\n(global as any).Err = Err;\n\nexport { Err, Ok, Result, ErrType, OkType };\n"]}

package/dist/types/globals.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=globals.cjs.map
+//# sourceMappingURL=globals.cjs.map

package/dist/types/globals.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"globals.cjs"}