@consolidados/results 0.1.2 → 0.1.4

package/README.md

@@ -309,12 +309,13 @@ The `Result` type currently implements the following methods:
 - [x] `map(fn)`: Maps a successful value using a function.
 - [x] `flatMap(fn)`: Applies a function that returns a `Result`.
 - [x] `mapErr(fn)`: Maps an error value using a function.
+- [x] `ok()`: Converts `Result<T, E>` into `Option<T>`.
+
 
 #### Methods to be Developed
 
 The following methods are planned for future development:
 
-- [ ] `expect(message)`: Extracts the successful value or throws an error with a custom message.
 - [ ] `ok()`: Converts `Result<T, E>` into `Option<T>`.
 - [ ] `err()`: Converts `Result<T, E>` into `Option<E>`.
 - [ ] `and(res)`: Returns `Err` if `self` is `Err`, otherwise returns `res`.

package/dist/helpers/match.cjs

@@ -0,0 +1,27 @@
+'use strict';
+
+// src/helpers/match.ts
+function match(matcher, cases) {
+  if ("isOk" in matcher && matcher.isOk()) {
+    if (!cases.Ok) throw new Error("Missing case for Ok");
+    return cases.Ok(matcher.unwrap());
+  }
+  if ("isErr" in matcher && matcher.isErr()) {
+    if (!cases.Err) throw new Error("Missing case for Err");
+    return cases.Err(matcher.unwrapErr());
+  }
+  if ("isSome" in matcher && matcher.isSome()) {
+    if (!cases.Some) throw new Error("Missing case for Some");
+    return cases.Some(matcher.unwrap());
+  }
+  if ("isNone" in matcher && matcher.isNone()) {
+    if (!cases.None) throw new Error("Missing case for None");
+    return cases.None();
+  }
+  throw new Error("Invalid matcher or missing case");
+}
+global.match = match;
+
+exports.match = match;
+//# sourceMappingURL=match.cjs.map
+//# sourceMappingURL=match.cjs.map

package/dist/helpers/match.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/helpers/match.ts"],"names":[],"mappings":";;;AAiBO,SAAS,KAAA,CACd,SACA,KAMG,EAAA;AACH,EAAA,IAAI,MAAU,IAAA,OAAA,IAAW,OAAQ,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,IAAI,CAAC,KAAM,CAAA,EAAA,EAAU,MAAA,IAAI,MAAM,qBAAqB,CAAA;AACpD,IAAA,OAAO,KAAM,CAAA,EAAA,CAAG,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGlC,EAAA,IAAI,OAAW,IAAA,OAAA,IAAW,OAAQ,CAAA,KAAA,EAAS,EAAA;AACzC,IAAA,IAAI,CAAC,KAAM,CAAA,GAAA,EAAW,MAAA,IAAI,MAAM,sBAAsB,CAAA;AACtD,IAAA,OAAO,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,SAAA,EAAgB,CAAA;AAAA;AAG3C,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC3C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,KAAM,CAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGpC,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC3C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,MAAM,IAAK,EAAA;AAAA;AAGpB,EAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AACnD;AAGC,MAAA,CAAe,KAAQ,GAAA,KAAA","file":"match.cjs","sourcesContent":["import type { Option } from \"../option\";\nimport type { Result } from \"../result\";\n\nexport function match<T, E extends Error, R>(\n  matcher: Result<T, E>,\n  cases: {\n    Ok: (value: T) => R;\n    Err: (error: E) => R;\n  },\n): R;\nexport function match<T, R>(\n  matcher: Option<T>,\n  cases: {\n    Some: (value: T) => R;\n    None: () => R;\n  },\n): R;\nexport function match<T, E extends Error, R>(\n  matcher: Result<T, E> | Option<T>,\n  cases: {\n    Ok?: (value: T) => R;\n    Err?: (error: E) => R;\n    Some?: (value: T) => R;\n    None?: () => R;\n  },\n): R {\n  if (\"isOk\" in matcher && matcher.isOk()) {\n    if (!cases.Ok) throw new Error(\"Missing case for Ok\");\n    return cases.Ok(matcher.unwrap());\n  }\n\n  if (\"isErr\" in matcher && matcher.isErr()) {\n    if (!cases.Err) throw new Error(\"Missing case for Err\");\n    return cases.Err(matcher.unwrapErr() as E);\n  }\n\n  if (\"isSome\" in matcher && matcher.isSome()) {\n    if (!cases.Some) throw new Error(\"Missing case for Some\");\n    return cases.Some(matcher.unwrap());\n  }\n\n  if (\"isNone\" in matcher && matcher.isNone()) {\n    if (!cases.None) throw new Error(\"Missing case for None\");\n    return cases.None();\n  }\n\n  throw new Error(\"Invalid matcher or missing case\");\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: <explanation>\n(global as any).match = match;\n"]}

package/dist/helpers/match.d.cts

@@ -0,0 +1,13 @@
+import { O as Option } from '../option-DpT8KCGE.cjs';
+import { R as Result } from '../types/globals.cjs';
+
+declare function match<T, E extends Error, R>(matcher: Result<T, E>, cases: {
+    Ok: (value: T) => R;
+    Err: (error: E) => R;
+}): R;
+declare function match<T, R>(matcher: Option<T>, cases: {
+    Some: (value: T) => R;
+    None: () => R;
+}): R;
+
+export { match };

package/dist/helpers/match.d.ts

@@ -0,0 +1,13 @@
+import { O as Option } from '../option-DpT8KCGE.js';
+import { R as Result } from '../types/globals.js';
+
+declare function match<T, E extends Error, R>(matcher: Result<T, E>, cases: {
+    Ok: (value: T) => R;
+    Err: (error: E) => R;
+}): R;
+declare function match<T, R>(matcher: Option<T>, cases: {
+    Some: (value: T) => R;
+    None: () => R;
+}): R;
+
+export { match };

package/dist/helpers/match.js

@@ -0,0 +1,25 @@
+// src/helpers/match.ts
+function match(matcher, cases) {
+  if ("isOk" in matcher && matcher.isOk()) {
+    if (!cases.Ok) throw new Error("Missing case for Ok");
+    return cases.Ok(matcher.unwrap());
+  }
+  if ("isErr" in matcher && matcher.isErr()) {
+    if (!cases.Err) throw new Error("Missing case for Err");
+    return cases.Err(matcher.unwrapErr());
+  }
+  if ("isSome" in matcher && matcher.isSome()) {
+    if (!cases.Some) throw new Error("Missing case for Some");
+    return cases.Some(matcher.unwrap());
+  }
+  if ("isNone" in matcher && matcher.isNone()) {
+    if (!cases.None) throw new Error("Missing case for None");
+    return cases.None();
+  }
+  throw new Error("Invalid matcher or missing case");
+}
+global.match = match;
+
+export { match };
+//# sourceMappingURL=match.js.map
+//# sourceMappingURL=match.js.map

package/dist/helpers/match.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/helpers/match.ts"],"names":[],"mappings":";AAiBO,SAAS,KAAA,CACd,SACA,KAMG,EAAA;AACH,EAAA,IAAI,MAAU,IAAA,OAAA,IAAW,OAAQ,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,IAAI,CAAC,KAAM,CAAA,EAAA,EAAU,MAAA,IAAI,MAAM,qBAAqB,CAAA;AACpD,IAAA,OAAO,KAAM,CAAA,EAAA,CAAG,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGlC,EAAA,IAAI,OAAW,IAAA,OAAA,IAAW,OAAQ,CAAA,KAAA,EAAS,EAAA;AACzC,IAAA,IAAI,CAAC,KAAM,CAAA,GAAA,EAAW,MAAA,IAAI,MAAM,sBAAsB,CAAA;AACtD,IAAA,OAAO,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,SAAA,EAAgB,CAAA;AAAA;AAG3C,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC3C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,KAAM,CAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGpC,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC3C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,MAAM,IAAK,EAAA;AAAA;AAGpB,EAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AACnD;AAGC,MAAA,CAAe,KAAQ,GAAA,KAAA","file":"match.js","sourcesContent":["import type { Option } from \"../option\";\nimport type { Result } from \"../result\";\n\nexport function match<T, E extends Error, R>(\n  matcher: Result<T, E>,\n  cases: {\n    Ok: (value: T) => R;\n    Err: (error: E) => R;\n  },\n): R;\nexport function match<T, R>(\n  matcher: Option<T>,\n  cases: {\n    Some: (value: T) => R;\n    None: () => R;\n  },\n): R;\nexport function match<T, E extends Error, R>(\n  matcher: Result<T, E> | Option<T>,\n  cases: {\n    Ok?: (value: T) => R;\n    Err?: (error: E) => R;\n    Some?: (value: T) => R;\n    None?: () => R;\n  },\n): R {\n  if (\"isOk\" in matcher && matcher.isOk()) {\n    if (!cases.Ok) throw new Error(\"Missing case for Ok\");\n    return cases.Ok(matcher.unwrap());\n  }\n\n  if (\"isErr\" in matcher && matcher.isErr()) {\n    if (!cases.Err) throw new Error(\"Missing case for Err\");\n    return cases.Err(matcher.unwrapErr() as E);\n  }\n\n  if (\"isSome\" in matcher && matcher.isSome()) {\n    if (!cases.Some) throw new Error(\"Missing case for Some\");\n    return cases.Some(matcher.unwrap());\n  }\n\n  if (\"isNone\" in matcher && matcher.isNone()) {\n    if (!cases.None) throw new Error(\"Missing case for None\");\n    return cases.None();\n  }\n\n  throw new Error(\"Invalid matcher or missing case\");\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: <explanation>\n(global as any).match = match;\n"]}

package/dist/index.cjs

@@ -0,0 +1,316 @@
+'use strict';
+
+// src/helpers/match.ts
+function match2(matcher, cases) {
+  if ("isOk" in matcher && matcher.isOk()) {
+    if (!cases.Ok) throw new Error("Missing case for Ok");
+    return cases.Ok(matcher.unwrap());
+  }
+  if ("isErr" in matcher && matcher.isErr()) {
+    if (!cases.Err) throw new Error("Missing case for Err");
+    return cases.Err(matcher.unwrapErr());
+  }
+  if ("isSome" in matcher && matcher.isSome()) {
+    if (!cases.Some) throw new Error("Missing case for Some");
+    return cases.Some(matcher.unwrap());
+  }
+  if ("isNone" in matcher && matcher.isNone()) {
+    if (!cases.None) throw new Error("Missing case for None");
+    return cases.None();
+  }
+  throw new Error("Invalid matcher or missing case");
+}
+global.match = match2;
+
+// src/option/__internal__/return-types/some.ts
+var Some2 = class _Some {
+  /**
+   * Creates a new `Some` option with the given value.
+   * @param value The value to be wrapped in the `Some` option.
+   */
+  constructor(value) {
+    this.value = value;
+  }
+  /**
+   * Checks if this option is a `Some`.
+   * @returns `true` if this option is a `Some`, otherwise `false`.
+   */
+  isSome() {
+    return true;
+  }
+  /**
+   * Checks if this option is a `None`.
+   * @returns `false` because this is a `Some`.
+   */
+  isNone() {
+    return false;
+  }
+  /**
+   * Unwraps the value held by this `Some` option.
+   * @returns The value held by this `Some` option.
+   */
+  unwrap() {
+    return this.value;
+  }
+  /**
+   * Applies a transformation function to the value held by this `Some` option and returns a new `Option` 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 `Some` option containing the transformed value.
+   */
+  map(fn) {
+    return new _Some(fn(this.value));
+  }
+  /**
+   * Applies a transformation function that returns an `Option` to the value held by this `Some` option.
+   * @template U The type of the value in the resulting `Option`.
+   * @param fn The transformation function to apply to the value.
+   * @returns The result of applying the transformation function.
+   */
+  flatMap(fn) {
+    return fn(this.value);
+  }
+  /**
+   * Returns the value held by this `Some` option, ignoring the default value provided.
+   * @param _ A default value (ignored in this implementation).
+   * @returns The value held by this `Some` option.
+   */
+  unwrapOr(_) {
+    return this.value;
+  }
+};
+
+// src/option/__internal__/return-types/none.ts
+var None2 = class _None {
+  /**
+   * Checks if this option is a `Some`.
+   * @returns `false` because this is a `None`.
+   */
+  isSome() {
+    return false;
+  }
+  /**
+   * Checks if this option is a `None`.
+   * @returns `true` because this is a `None`.
+   */
+  isNone() {
+    return true;
+  }
+  /**
+   * Attempts to unwrap the value from this `None` option.
+   * @throws An error because `None` has no value.
+   */
+  unwrap() {
+    throw new Error("Called unwrap on a None value");
+  }
+  /**
+   * Applies a transformation function to the value (which does not exist) of this `None` option.
+   * @template U The type of the value that would have been returned.
+   * @param _fn The transformation function (ignored in this implementation).
+   * @returns A new `None` option.
+   */
+  map(_fn) {
+    return new _None();
+  }
+  /**
+   * Applies a transformation function that returns an `Option` to the value (which does not exist) of this `None` option.
+   * @template U The type of the value in the resulting `Option`.
+   * @param _fn The transformation function (ignored in this implementation).
+   * @returns A new `None` option.
+   */
+  flatMap(_fn) {
+    return new _None();
+  }
+  /**
+   * Returns the default value provided, since `None` has no value.
+   * @template T The type of the default value.
+   * @param defaultValue The value to return.
+   * @returns The default value provided.
+   */
+  unwrapOr(defaultValue) {
+    return defaultValue;
+  }
+};
+
+// src/option/option.ts
+function Some3(value) {
+  return new Some2(value);
+}
+function None3() {
+  return new None2();
+}
+global.Some = Some3;
+global.None = None3;
+
+// 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;
+  }
+  /**
+   * Converts `Result` type to `Option` type.
+   * @returns `Some` if the result is `Ok`, `None` if the result is `Err`.
+   */
+  ok() {
+    return None();
+  }
+};
+
+// 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");
+  }
+  /**
+   * Converts `Result` type to `Option` type.
+   * @returns `Some` if the result is `Ok`, `None` if the result is `Err`.
+   */
+  ok() {
+    return match(this, {
+      Ok: (v) => Some(v),
+      Err: (_) => None()
+    });
+  }
+};
+
+// 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.None = None3;
+exports.Some = Some3;
+exports.match = match2;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/helpers/match.ts","../src/option/__internal__/return-types/some.ts","../src/option/__internal__/return-types/none.ts","../src/option/option.ts","../src/result/__internal__/return-types/err.ts","../src/result/__internal__/return-types/ok.ts","../src/result/result.ts"],"names":["match","Some","None","Ok","Err"],"mappings":";;;AAiBO,SAASA,MAAAA,CACd,SACA,KAMG,EAAA;AACH,EAAA,IAAI,MAAU,IAAA,OAAA,IAAW,OAAQ,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,IAAI,CAAC,KAAM,CAAA,EAAA,EAAU,MAAA,IAAI,MAAM,qBAAqB,CAAA;AACpD,IAAA,OAAO,KAAM,CAAA,EAAA,CAAG,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGlC,EAAA,IAAI,OAAW,IAAA,OAAA,IAAW,OAAQ,CAAA,KAAA,EAAS,EAAA;AACzC,IAAA,IAAI,CAAC,KAAM,CAAA,GAAA,EAAW,MAAA,IAAI,MAAM,sBAAsB,CAAA;AACtD,IAAA,OAAO,KAAM,CAAA,GAAA,CAAI,OAAQ,CAAA,SAAA,EAAgB,CAAA;AAAA;AAG3C,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC3C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,KAAM,CAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,EAAQ,CAAA;AAAA;AAGpC,EAAA,IAAI,QAAY,IAAA,OAAA,IAAW,OAAQ,CAAA,MAAA,EAAU,EAAA;AAC3C,IAAA,IAAI,CAAC,KAAM,CAAA,IAAA,EAAY,MAAA,IAAI,MAAM,uBAAuB,CAAA;AACxD,IAAA,OAAO,MAAM,IAAK,EAAA;AAAA;AAGpB,EAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AACnD;AAGC,MAAA,CAAe,KAAQA,GAAAA,MAAAA;;;AC3CjB,IAAMC,KAAAA,GAAN,MAAM,KAAQ,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnB,YAAoB,KAAU,EAAA;AAAV,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAY;AAAA;AAAA;AAAA;AAAA,EAMhC,MAA0B,GAAA;AACxB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,MAAuB,GAAA;AACrB,IAAO,OAAA,KAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,MAAY,GAAA;AACV,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,EAAgC,EAAA;AACrC,IAAA,OAAO,IAAI,KAAA,CAAK,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAChC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QAAW,EAAwC,EAAA;AACjD,IAAO,OAAA,EAAA,CAAG,KAAK,KAAK,CAAA;AAAA;AACtB;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,CAAS,EAAA;AAChB,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AAEhB,CAAA;;;AC5DO,IAAMC,KAAAA,GAAN,MAAM,KAAK,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKhB,MAA8B,GAAA;AAC5B,IAAO,OAAA,KAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,MAAuB,GAAA;AACrB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,GAAA;AACd,IAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA;AAAA;AACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,GAAqC,EAAA;AAC1C,IAAA,OAAO,IAAI,KAAK,EAAA;AAAA;AAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QAAW,GAA6C,EAAA;AACtD,IAAA,OAAO,IAAI,KAAK,EAAA;AAAA;AAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAY,YAAoB,EAAA;AAC9B,IAAO,OAAA,YAAA;AAAA;AAEX,CAAA;;;AC5CA,SAASD,MAAQ,KAAuB,EAAA;AACvC,EAAO,OAAA,IAAIA,MAAS,KAAK,CAAA;AAC1B;AAUA,SAASC,KAAiB,GAAA;AACzB,EAAA,OAAO,IAAIA,KAAS,EAAA;AACrB;AAEC,MAAA,CAAe,IAAOD,GAAAA,KAAAA;AACtB,MAAA,CAAe,IAAOC,GAAAA,KAAAA;;;AC1BhB,IAAM,GAAA,GAAN,MAAM,IAAA,SACH,KAEV,CAAA;AAAA,EACU,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,YAAY,KAAmB,EAAA;AAC7B,IAAA,KAAA,CAAM,OAAO,KAAA,KAAU,QAAW,GAAA,KAAA,GAAQ,MAAM,OAAO,CAAA;AACvD,IAAA,IAAA,CAAK,QACH,OAAO,KAAA,KAAU,WAAY,IAAI,KAAA,CAAM,KAAK,CAAW,GAAA,KAAA;AACzD,IAAO,MAAA,CAAA,cAAA,CAAe,IAAM,EAAA,IAAA,CAAI,SAAS,CAAA;AAEzC,IAAA,IAAI,MAAM,iBAAmB,EAAA;AAC3B,MAAM,KAAA,CAAA,iBAAA,CAAkB,MAAM,IAAG,CAAA;AAAA;AACnC;AACF;AAAA;AAAA;AAAA;AAAA,EAMA,IAA0B,GAAA;AACxB,IAAO,OAAA,KAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,KAAkD,GAAA;AAChD,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,MAAgB,GAAA;AACd,IAAM,MAAA,IAAI,MAAM,+BAA+B,CAAA;AAAA;AACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,GAAsD,EAAA;AAC3D,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAwB,EAA+C,EAAA;AACrE,IAAA,OAAO,IAAI,IAAA,CAAO,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACE,GAC4B,EAAA;AAC5B,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,SAAe,GAAA;AACb,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACd;AAAA;AAAA;AAAA;AAAA,EAMA,EAAK,GAAA;AACH,IAAA,OAAO,IAAK,EAAA;AAAA;AAEhB,CAAA;;;AC3FO,IAAM,EAAA,GAAN,MAAM,GAA4C,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKvD,YAAoB,KAAU,EAAA;AAAV,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA;AAAA;AAAW;AAAA;AAAA;AAAA;AAAA,EAK/B,IAAsB,GAAA;AACpB,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,KAA4B,GAAA;AAC1B,IAAO,OAAA,KAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,MAAY,GAAA;AACV,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAO,EAAiD,EAAA;AACtD,IAAA,OAAO,IAAI,GAAA,CAAG,EAAG,CAAA,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA;AAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,QACE,EAC4B,EAAA;AAC5B,IAAO,OAAA,EAAA,CAAG,KAAK,KAAK,CAAA;AAAA;AACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAwB,GAAgD,EAAA;AACtE,IAAO,OAAA,IAAA;AAAA;AACT;AAAA;AAAA;AAAA;AAAA,EAMA,SAAmB,GAAA;AACjB,IAAM,MAAA,IAAI,MAAM,iCAAiC,CAAA;AAAA;AACnD;AAAA;AAAA;AAAA;AAAA,EAMA,EAAK,GAAA;AACH,IAAA,OAAO,MAAM,IAAM,EAAA;AAAA,MACjB,EAAI,EAAA,CAAC,CAAM,KAAA,IAAA,CAAK,CAAC,CAAA;AAAA,MACjB,GAAA,EAAK,CAAC,CAAA,KAAM,IAAK;AAAA,KAClB,CAAA;AAAA;AAEL,CAAA;;;ACzEA,SAASC,IAAM,KAAqB,EAAA;AAClC,EAAO,OAAA,IAAI,GAAO,KAAK,CAAA;AACzB;AAYA,SAASC,KAAqB,KAA+B,EAAA;AAC3D,EAAO,OAAA,IAAI,IAAQ,KAAK,CAAA;AAC1B;AAGC,MAAA,CAAe,EAAKD,GAAAA,GAAAA;AAEpB,MAAA,CAAe,GAAMC,GAAAA,IAAAA","file":"index.cjs","sourcesContent":["import type { Option } from \"../option\";\nimport type { Result } from \"../result\";\n\nexport function match<T, E extends Error, R>(\n  matcher: Result<T, E>,\n  cases: {\n    Ok: (value: T) => R;\n    Err: (error: E) => R;\n  },\n): R;\nexport function match<T, R>(\n  matcher: Option<T>,\n  cases: {\n    Some: (value: T) => R;\n    None: () => R;\n  },\n): R;\nexport function match<T, E extends Error, R>(\n  matcher: Result<T, E> | Option<T>,\n  cases: {\n    Ok?: (value: T) => R;\n    Err?: (error: E) => R;\n    Some?: (value: T) => R;\n    None?: () => R;\n  },\n): R {\n  if (\"isOk\" in matcher && matcher.isOk()) {\n    if (!cases.Ok) throw new Error(\"Missing case for Ok\");\n    return cases.Ok(matcher.unwrap());\n  }\n\n  if (\"isErr\" in matcher && matcher.isErr()) {\n    if (!cases.Err) throw new Error(\"Missing case for Err\");\n    return cases.Err(matcher.unwrapErr() as E);\n  }\n\n  if (\"isSome\" in matcher && matcher.isSome()) {\n    if (!cases.Some) throw new Error(\"Missing case for Some\");\n    return cases.Some(matcher.unwrap());\n  }\n\n  if (\"isNone\" in matcher && matcher.isNone()) {\n    if (!cases.None) throw new Error(\"Missing case for None\");\n    return cases.None();\n  }\n\n  throw new Error(\"Invalid matcher or missing case\");\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: <explanation>\n(global as any).match = match;\n","import type { None } from \"./none\";\nimport type { Option } from \"./option\";\n\n/**\n * Represents a `Some` option, which holds a value.\n * @template T The type of the value held by this `Some` instance.\n */\nexport class Some<T> {\n  /**\n   * Creates a new `Some` option with the given value.\n   * @param value The value to be wrapped in the `Some` option.\n   */\n  constructor(private value: T) { }\n\n  /**\n   * Checks if this option is a `Some`.\n   * @returns `true` if this option is a `Some`, otherwise `false`.\n   */\n  isSome(): this is Some<T> {\n    return true;\n  }\n\n  /**\n   * Checks if this option is a `None`.\n   * @returns `false` because this is a `Some`.\n   */\n  isNone(): this is None {\n    return false;\n  }\n\n  /**\n   * Unwraps the value held by this `Some` option.\n   * @returns The value held by this `Some` option.\n   */\n  unwrap(): T {\n    return this.value;\n  }\n\n  /**\n   * Applies a transformation function to the value held by this `Some` option and returns a new `Option` with the transformed value.\n   * @template U The type of the transformed value.\n   * @param fn The transformation function to apply to the value.\n   * @returns A new `Some` option containing the transformed value.\n   */\n  map<U>(fn: (value: T) => U): Option<U> {\n    return new Some(fn(this.value));\n  }\n\n  /**\n   * Applies a transformation function that returns an `Option` to the value held by this `Some` option.\n   * @template U The type of the value in the resulting `Option`.\n   * @param fn The transformation function to apply to the value.\n   * @returns The result of applying the transformation function.\n   */\n  flatMap<U>(fn: (value: T) => Option<U>): Option<U> {\n    return fn(this.value);\n  }\n\n  /**\n   * Returns the value held by this `Some` option, ignoring the default value provided.\n   * @param _ A default value (ignored in this implementation).\n   * @returns The value held by this `Some` option.\n   */\n  unwrapOr(_: T): T {\n    return this.value;\n  }\n}\n","import type { Some } from \"./some\";\nimport type { Option } from \"./option\";\n\n/**\n * Represents a `None` option, which holds no value.\n */\nexport class None {\n  /**\n   * Checks if this option is a `Some`.\n   * @returns `false` because this is a `None`.\n   */\n  isSome(): this is Some<never> {\n    return false;\n  }\n\n  /**\n   * Checks if this option is a `None`.\n   * @returns `true` because this is a `None`.\n   */\n  isNone(): this is None {\n    return true;\n  }\n\n  /**\n   * Attempts to unwrap the value from this `None` option.\n   * @throws An error because `None` has no value.\n   */\n  unwrap(): never {\n    throw new Error(\"Called unwrap on a None value\");\n  }\n\n  /**\n   * Applies a transformation function to the value (which does not exist) of this `None` option.\n   * @template U The type of the value that would have been returned.\n   * @param _fn The transformation function (ignored in this implementation).\n   * @returns A new `None` option.\n   */\n  map<U>(_fn: (value: never) => U): Option<U> {\n    return new None();\n  }\n\n  /**\n   * Applies a transformation function that returns an `Option` to the value (which does not exist) of this `None` option.\n   * @template U The type of the value in the resulting `Option`.\n   * @param _fn The transformation function (ignored in this implementation).\n   * @returns A new `None` option.\n   */\n  flatMap<U>(_fn: (value: never) => Option<U>): Option<U> {\n    return new None();\n  }\n\n  /**\n   * Returns the default value provided, since `None` has no value.\n   * @template T The type of the default value.\n   * @param defaultValue The value to return.\n   * @returns The default value provided.\n   */\n  unwrapOr<T>(defaultValue: T): T {\n    return defaultValue;\n  }\n}\n","import {\n\tSome as SomeType,\n\tNone as NoneType,\n\ttype Option,\n} from \"./__internal__/return-types\";\n\n/**\n * Creates a new `Some` instance, representing an `Option` with a value.\n * @template T The type of the value contained in the `Some`.\n * @param value The value to wrap in the `Some` instance.\n * @returns A `Some` instance containing the given value.\n * @example\n * const option = Some(42);\n * console.log(option.isSome()); // true\n * console.log(option.unwrap()); // 42\n */\nfunction Some<T>(value: T): SomeType<T> {\n\treturn new SomeType(value);\n}\n\n/**\n * Creates a new `None` instance, representing an `Option` with no value.\n * @returns A `None` instance.\n * @example\n * const option = None();\n * console.log(option.isNone()); // true\n * console.log(option.unwrap()); // throws Error: \"Called unwrap on a None value\"\n */\nfunction None(): NoneType {\n\treturn new NoneType();\n}\n\n(global as any).Some = Some;\n(global as any).None = None;\n\nexport { None, Some, Option };\n","import type { Ok } from \"./ok\";\nimport type { ResultDefinition } from \"./result\";\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  extends Error\n  implements ResultDefinition<never, E>\n{\n  private error: E;\n  /**\n   * Creates a new `Err` instance with the given error value.\n   * @param error The error to wrap in the `Err` instance.\n   */\n  constructor(error: E | string) {\n    super(typeof error === \"string\" ? error : error.message);\n    this.error =\n      typeof error === \"string\" ? (new Error(error) as E) : (error as E);\n    Object.setPrototypeOf(this, Err.prototype);\n\n    if (Error.captureStackTrace) {\n      Error.captureStackTrace(this, Err);\n    }\n  }\n\n  /**\n   * Checks if this result is an `Ok`.\n   * @returns `false` because this is an `Err`.\n   */\n  isOk(): this is Ok<never> {\n    return false;\n  }\n\n  /**\n   * Checks if this result is an `Err`.\n   * @returns `true` because this is an `Err`.\n   */\n  isErr(): this is Err<E extends Error ? E : Error> {\n    return true;\n  }\n\n  /**\n   * Retrieves the value contained in this result. Since this is an `Err`, an error is thrown.\n   * @throws An error because `unwrap` is called on an `Err`.\n   */\n  unwrap(): never {\n    throw new Error(\"Called unwrap on an Err value\");\n  }\n\n  /**\n   * Maps the value (if any). Since this is an `Err`, the mapping function is ignored, and the original `Err` is returned.\n   * @template U The type of the value (ignored for `Err`).\n   * @param _fn The mapping function for values (not used).\n   * @returns The original `Err` instance.\n   */\n  map<U>(_fn: (value: never) => U): ResultDefinition<never, E> {\n    return this as unknown as ResultDefinition<never, E>;\n  }\n\n  /**\n   * Maps the error value using a transformation function and returns a new `Result` with the transformed error.\n   * @template U The type of the transformed error.\n   * @param fn The transformation function to apply to the error value.\n   * @returns A new `Err` containing the transformed error.\n   */\n  mapErr<U extends Error>(fn: (err: E) => U): ResultDefinition<never, U> {\n    return new Err<U>(fn(this.error)) as unknown as ResultDefinition<never, U>;\n  }\n\n  /**\n   * Applies a transformation function that returns a `Result` to the value (which does not exist) of this `Err`.\n   * @template U The type of the value in the resulting `Result`.\n   * @param _fn The transformation function (ignored in this implementation).\n   * @returns The original `Err` instance.\n   */\n  flatMap<U>(\n    _fn: (value: never) => ResultDefinition<U, never>,\n  ): ResultDefinition<never, E> {\n    return this as unknown as ResultDefinition<never, E>;\n  }\n\n  /**\n   * Retrieves the error value contained in this `Err`.\n   * @returns The error value contained in this `Err`.\n   */\n  unwrapErr(): E {\n    return this.error;\n  }\n\n  /**\n   * Converts `Result` type to `Option` type.\n   * @returns `Some` if the result is `Ok`, `None` if the result is `Err`.\n   */\n  ok() {\n    return None();\n  }\n}\n","import type { ResultDefinition } from \"./result\";\nimport type { 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  /**\n   * Creates a new `Ok` instance with the given value.\n   * @param value The value to wrap in the `Ok` instance.\n   */\n  constructor(private value: T) {}\n  /**\n   * Checks if this result is an `Ok`.\n   * @returns `true` because this is an `Ok`.\n   */\n  isOk(): this is Ok<T> {\n    return true;\n  }\n\n  /**\n   * Checks if this result is an `Err`.\n   * @returns `false` because this is an `Ok`.\n   */\n  isErr(): this is Err<never> {\n    return false;\n  }\n\n  /**\n   * Retrieves the value contained in this `Ok`.\n   * @returns The value contained in this `Ok`.\n   */\n  unwrap(): T {\n    return this.value;\n  }\n\n  /**\n   * Applies a transformation function to the value contained in this `Ok` and returns a new `Result` with the transformed value.\n   * @template U The type of the transformed value.\n   * @param fn The transformation function to apply to the value.\n   * @returns A new `Ok` containing the transformed value.\n   */\n  map<U>(fn: (value: T) => U): ResultDefinition<U, never> {\n    return new Ok(fn(this.value)) as ResultDefinition<U, never>;\n  }\n\n  /**\n   * Applies a transformation function that returns a `Result` to the value contained in this `Ok`.\n   * @template U The type of the value in the resulting `Result`.\n   * @param fn The transformation function to apply to the value.\n   * @returns The result of applying the transformation function.\n   */\n  flatMap<U>(\n    fn: (value: T) => ResultDefinition<U, never>,\n  ): ResultDefinition<U, never> {\n    return fn(this.value);\n  }\n\n  /**\n   * Maps the error value (if any). Since this is an `Ok`, the error mapping function is ignored, and the original `Ok` is returned.\n   * @template U The type of the error (ignored for `Ok`).\n   * @param _fn The mapping function for errors (not used).\n   * @returns The original `Ok` instance.\n   */\n  // mapErr<U extends Error | string>(fn: (err: U) => U): Result<T, never> {\n  // \treturn this;\n  mapErr<U extends Error>(_fn: (err: never) => U): ResultDefinition<T, U> {\n    return this as unknown as ResultDefinition<T, U>;\n  }\n\n  /**\n   * Retrieves the error contained in this result. Since this is an `Ok`, an error is thrown.\n   * @throws An error because `unwrapErr` is called on an `Ok`.\n   */\n  unwrapErr(): never {\n    throw new Error(\"Called unwrapErr on an Ok value\");\n  }\n\n  /**\n   * Converts `Result` type to `Option` type.\n   * @returns `Some` if the result is `Ok`, `None` if the result is `Err`.\n   */\n  ok() {\n    return match(this, {\n      Ok: (v) => Some(v),\n      Err: (_) => None(),\n    });\n  }\n}\n","import {\n  Err as ErrType,\n  Ok as OkType,\n  type 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  return 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  return new ErrType(error);\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: <explanation>\n(global as any).Ok = Ok;\n// biome-ignore lint/suspicious/noExplicitAny: <explanation>\n(global as any).Err = Err;\n\nexport type { Err, Ok, Result, ErrType, OkType };\n"]}

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+export { R as Result } from './types/globals.cjs';
+export { match } from './helpers/match.cjs';
+export { None, Some } from './option/option.cjs';
+export { Err, Ok } from './result/result.cjs';
+export { O as Option } from './option-DpT8KCGE.cjs';

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { R as Result } from './types/globals.js';
+export { match } from './helpers/match.js';
+export { None, Some } from './option/option.js';
+export { Err, Ok } from './result/result.js';
+export { O as Option } from './option-DpT8KCGE.js';