@madkarma/result 2.0.2 → 3.0.1

package/README.md

@@ -1,10 +1,10 @@
 # @madkarma/result
 
-Rust's Result type, for TypeScript.
+Rust's `Result` and `Option` types, for TypeScript.
 
-Inspired by [this video](https://www.youtube.com/watch?v=ovnyeq-Xxrc) by Web Dev Simplified and [vultix/ts-results](https://github.com/vultix/ts-results).
+This library mimics the Rust `Result` and `Option` enums and includes some of their chainable methods adapted for TypeScript, with full type safety. For full documentation on the usage of the available methods, please refer to the official Rust docs (or read the JSDocs directly in your editor).
 
-This library mimics the Rust `Result` enum and includes its chainable methods adapted for TypeScript. For full documentation on the available methods, please refer to the [official Rust Result documentation](https://doc.rust-lang.org/std/result/enum.Result.html) (or read the JSDocs directly in your editor).
+> Inspired by [this video](https://www.youtube.com/watch?v=ovnyeq-Xxrc) by **Web Dev Simplified** and [vultix/ts-results](https://github.com/vultix/ts-results).
 
 ## Installation
 
@@ -20,6 +20,10 @@ yarn add @madkarma/result
 
 ## Usage
 
+### Result
+
+[Official Rust Result documentation](https://doc.rust-lang.org/std/result/enum.Result.html)
+
 ```typescript
 import { Ok, Err } from '@madkarma/result';
 
@@ -39,14 +43,12 @@ const parseUserId = (id: string) => {
 
 const fetchUser = (id: number) => {
     if (id === 13) return Err({ code: 'NOT_FOUND', message: 'User not found' });
-
     return Ok({ id, name: 'Alice', role: 'admin' });
 };
 
-// Processing an input by chaining methods
 const { value: user, error } = parseUserId('10')
-    .map((id) => id + 3) // Transform the Ok value (10 -> 13)
-    .andThen(fetchUser); // Chain operations that return another Result
+    .map((id) => id + 3)
+    .andThen(fetchUser);
 
 if (error) {
     switch (error.code) {
@@ -63,9 +65,30 @@ if (error) {
 }
 ```
 
+### Option
+
+[Official Rust Option documentation](https://doc.rust-lang.org/std/option/enum.Option.html)
+
+```typescript
+import { Some, None } from '@madkarma/result';
+
+const parseNickname = (nickname?: string) => {
+    if (!nickname) return None();
+
+    const trimmed = nickname.trim();
+    return trimmed.length > 0 ? Some(trimmed) : None();
+};
+
+const displayName = parseNickname('  Ada  ')
+    .map((name) => name.toUpperCase())
+    .unwrapOr('ANONYMOUS');
+
+console.log(displayName);
+```
+
 ## How this differs from Rust
 
-Instead of Rust's `match` expressions, check `{ value, error }` directly and use a `switch` on `error.code` to emulate pattern matching.
+Instead of Rust's `match` expressions, check `Result` values as `{ value, error }` directly and use a `switch` on `error.code` to emulate pattern matching. `Option` values are handled directly with `isSome()` / `isNone()` checks.
 
 ## Contributing
 

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './result';
+export * from './option';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -1,2 +1,3 @@
 export * from './result';
+export * from './option';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

package/dist/option.d.ts

@@ -0,0 +1,148 @@
+import { type Result, type ResultError } from './result';
+/**
+ * Represents some value of type `T`.
+ */
+export type SomeOption<T> = {
+    readonly value: T;
+} & OptionMethods<T>;
+/**
+ * Represents the absence of a value of type `T`.
+ */
+export type NoneOption<T> = {
+    readonly value: null;
+} & OptionMethods<T>;
+export type Option<T> = SomeOption<T> | NoneOption<T>;
+interface OptionMethods<T> {
+    /**
+     * Returns `true` if the option is a `Some` value.
+     */
+    isSome(): this is SomeOption<T>;
+    /**
+     * Returns `true` if the option is a `Some` and the value inside of it matches a predicate.
+     */
+    isSomeAnd(f: (val: T) => boolean): boolean;
+    /**
+     * Returns `true` if the option is a `None` value.
+     */
+    isNone(): this is NoneOption<T>;
+    /**
+     * Returns `true` if the option is a `None` or the value inside of it matches a predicate.
+     */
+    isNoneOr(f: (val: T) => boolean): boolean;
+    /**
+     * Returns the contained `Some` value.
+     *
+     * @throws Error if the value is a `None` with a custom error message provided by `msg`.
+     */
+    expect(msg: string): T;
+    /**
+     * Returns the contained `Some` value.
+     *
+     * @throws Error if the value is a `None`.
+     */
+    unwrap(): T;
+    /**
+     * Returns the contained `Some` value or a provided default.
+     */
+    unwrapOr(defaultVal: T): T;
+    /**
+     * Returns the contained `Some` value or computes it from a closure.
+     */
+    unwrapOrElse(f: () => T): T;
+    /**
+     * Maps an `Option<T>` to `Option<U>` by applying a function to a contained value.
+     */
+    map<U>(f: (val: T) => U): Option<U>;
+    /**
+     * Calls the provided closure with a reference to the contained value (if `Some`).
+     */
+    inspect(f: (val: T) => void): Option<T>;
+    /**
+     * Returns the provided default result (if none), or applies a function to the contained value (if any).
+     */
+    mapOr<U>(defaultVal: U, f: (val: T) => U): U;
+    /**
+     * Computes a default function result (if none), or applies a different function to the contained value (if any).
+     */
+    mapOrElse<U>(defaultF: () => U, f: (val: T) => U): U;
+    /**
+     * Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to `Ok(v)` and `None` to `Err(err)`.
+     */
+    okOr<E extends ResultError>(err: E): Result<T, E>;
+    /**
+     * Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to `Ok(v)` and `None` to `Err(err())`.
+     */
+    okOrElse<E extends ResultError>(errF: () => E): Result<T, E>;
+    /**
+     * Returns an iterator over the possibly contained value.
+     */
+    iter(): IterableIterator<T>;
+    /**
+     * Returns `None` if the option is `None`, otherwise returns `optb`.
+     */
+    and<U>(optb: Option<U>): Option<U>;
+    /**
+     * Returns `None` if the option is `None`, otherwise calls `f` with the wrapped value and returns the result.
+     */
+    andThen<U>(f: (val: T) => Option<U>): Option<U>;
+    /**
+     * Returns `None` if the option is `None`, otherwise calls `predicate` with the wrapped value and returns:
+     * - `Some(t)` if `predicate` returns `true` (where `t` is the wrapped value), and
+     * - `None` if `predicate` returns `false`.
+     */
+    filter(predicate: (val: T) => boolean): Option<T>;
+    /**
+     * Returns the option if it contains a value, otherwise returns `optb`.
+     */
+    or<T2>(optb: Option<T2>): Option<T | T2>;
+    /**
+     * Returns the option if it contains a value, otherwise calls `f` and returns the result.
+     */
+    orElse<T2>(f: () => Option<T2>): Option<T | T2>;
+    /**
+     * Returns `Some` if exactly one of `this`, `optb` is `Some`, otherwise returns `None`.
+     */
+    xor<T2>(optb: Option<T2>): Option<T | T2>;
+    /**
+     * Inserts `value` into the option, then returns a reference to it.
+     */
+    insert(value: T): T;
+    /**
+     * Inserts `value` into the option if it is `None`, then returns a reference to the contained value.
+     */
+    getOrInsert(value: T): T;
+    /**
+     * Inserts a value computed from `f` into the option if it is `None`, then returns a reference to the contained value.
+     */
+    getOrInsertWith(f: () => T): T;
+    /**
+     * Takes the value out of the option, leaving a `None` in its place.
+     */
+    take(): Option<T>;
+    /**
+     * Takes the value out of the option, but only if the predicate evaluates to `true` on the value.
+     */
+    takeIf(predicate: (val: T) => boolean): Option<T>;
+    /**
+     * Replaces the actual value in the option by the value given in parameter, returning the old value if present,
+     * leaving a `Some` in its place.
+     */
+    replace(value: T): Option<T>;
+    /**
+     * Converts from `Option<Option<T>>` to `Option<T>`.
+     */
+    flatten<U>(this: Option<Option<U>>): Option<U>;
+}
+/**
+ * Some value of type `T`.
+ * @param value The value to be wrapped in a `Some`.
+ * @returns An `Option` representing the presence of a value.
+ */
+export declare const Some: <T>(value: T) => Option<T>;
+/**
+ * No value.
+ * @returns An `Option` representing the absence of a value.
+ */
+export declare const None: <T = never>() => Option<T>;
+export {};
+//# sourceMappingURL=option.d.ts.map

package/dist/option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"option.d.ts","sourceRoot":"","sources":["../src/option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,WAAW,EAAW,MAAM,UAAU,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IACxB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;CACrB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAErB;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IACxB,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;CACxB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAErB,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;AAEtD,UAAU,aAAa,CAAC,CAAC;IACrB;;OAEG;IACH,MAAM,IAAI,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,MAAM,IAAI,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,OAAO,CAAC;IAE1C;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IAEvB;;;;OAIG;IACH,MAAM,IAAI,CAAC,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAE5B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAErD;;OAEG;IACH,IAAI,CAAC,CAAC,SAAS,WAAW,EAAE,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE7D;;OAEG;IACH,IAAI,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAE5B;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEhD;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAElD;;OAEG;IACH,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAEhD;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAElD;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;CAClD;AAiKD;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,CAE1C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,GAAG,KAAK,OAAK,MAAM,CAAC,CAAC,CAE1C,CAAC"}

package/dist/option.js

@@ -0,0 +1,160 @@
+import { Ok, Err } from './result';
+class OptionImpl {
+    #value;
+    constructor(value) {
+        this.#value = value;
+    }
+    get value() {
+        return this.#value;
+    }
+    isSome() {
+        return this.value !== null;
+    }
+    isSomeAnd(f) {
+        return this.isSome() && f(this.value);
+    }
+    isNone() {
+        return this.value === null;
+    }
+    isNoneOr(f) {
+        return this.value === null || f(this.value);
+    }
+    expect(msg) {
+        if (this.isNone())
+            throw new Error(msg);
+        return this.value;
+    }
+    unwrap() {
+        if (this.isNone())
+            throw new Error('called `Option.unwrap()` on a `None` value');
+        return this.value;
+    }
+    unwrapOr(defaultVal) {
+        return this.isSome() ? this.value : defaultVal;
+    }
+    unwrapOrElse(f) {
+        return this.isSome() ? this.value : f();
+    }
+    map(f) {
+        if (this.isSome())
+            return Some(f(this.value));
+        return None();
+    }
+    inspect(f) {
+        if (this.isSome())
+            f(this.value);
+        return this;
+    }
+    mapOr(defaultVal, f) {
+        return this.isSome() ? f(this.value) : defaultVal;
+    }
+    mapOrElse(defaultF, f) {
+        return this.isSome() ? f(this.value) : defaultF();
+    }
+    okOr(err) {
+        if (this.isSome())
+            return Ok(this.value);
+        return Err(err);
+    }
+    okOrElse(errF) {
+        if (this.isSome())
+            return Ok(this.value);
+        return Err(errF());
+    }
+    *iter() {
+        if (this.isSome())
+            yield this.value;
+    }
+    and(optb) {
+        if (this.isSome())
+            return optb;
+        return None();
+    }
+    andThen(f) {
+        if (this.isSome())
+            return f(this.value);
+        return None();
+    }
+    filter(predicate) {
+        if (this.isSome() && predicate(this.value))
+            return this;
+        return None();
+    }
+    or(optb) {
+        if (this.isSome())
+            return this;
+        return optb;
+    }
+    orElse(f) {
+        if (this.isSome())
+            return this;
+        return f();
+    }
+    xor(optb) {
+        const thisIsSome = this.isSome();
+        const optbIsSome = optb.isSome();
+        if (thisIsSome && !optbIsSome)
+            return this;
+        if (!thisIsSome && optbIsSome)
+            return optb;
+        return None();
+    }
+    insert(value) {
+        this.#value = value;
+        return this.#value;
+    }
+    getOrInsert(value) {
+        if (this.isNone())
+            this.#value = value;
+        return this.#value;
+    }
+    getOrInsertWith(f) {
+        if (this.isNone())
+            this.#value = f();
+        return this.#value;
+    }
+    take() {
+        if (this.isSome()) {
+            const val = this.value;
+            this.#value = null;
+            return Some(val);
+        }
+        return None();
+    }
+    takeIf(predicate) {
+        if (this.isSome() && predicate(this.value)) {
+            const val = this.value;
+            this.#value = null;
+            return Some(val);
+        }
+        return None();
+    }
+    replace(value) {
+        const old = this.#value;
+        this.#value = value;
+        if (old !== null)
+            return Some(old);
+        return None();
+    }
+    flatten() {
+        if (this.isSome())
+            return this.value;
+        return None();
+    }
+}
+/**
+ * Some value of type `T`.
+ * @param value The value to be wrapped in a `Some`.
+ * @returns An `Option` representing the presence of a value.
+ */
+export const Some = (value) => {
+    return new OptionImpl(value);
+};
+/**
+ * No value.
+ * @returns An `Option` representing the absence of a value.
+ */
+export const None = () => {
+    return new OptionImpl(null);
+};
+//# sourceMappingURL=option.js.map

package/dist/option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"option.js","sourceRoot":"","sources":["../src/option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,EAAE,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAuKlE,MAAM,UAAU;IACZ,MAAM,CAAW;IAEjB,YAAY,KAAe;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED,SAAS,CAAC,CAAsB;QAC5B,OAAO,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED,QAAQ,CAAC,CAAsB;QAC3B,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,MAAM;QACF,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,QAAQ,CAAC,UAAa;QAClB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;IACnD,CAAC;IAED,YAAY,CAAC,CAAU;QACnB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC;IAED,GAAG,CAAI,CAAgB;QACnB,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,OAAO,CAAC,CAAmB;QACvB,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,IAAiB,CAAC;IAC7B,CAAC;IAED,KAAK,CAAI,UAAa,EAAE,CAAgB;QACpC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;IACtD,CAAC;IAED,SAAS,CAAI,QAAiB,EAAE,CAAgB;QAC5C,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtD,CAAC;IAED,IAAI,CAAwB,GAAM;QAC9B,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IAED,QAAQ,CAAwB,IAAa;QACzC,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IACvB,CAAC;IAED,CAAC,IAAI;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC;IACxC,CAAC;IAED,GAAG,CAAI,IAAe;QAClB,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,IAAI,CAAC;QAC/B,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,OAAO,CAAI,CAAwB;QAC/B,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,SAA8B;QACjC,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,IAAiB,CAAC;QACrE,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,EAAE,CAAK,IAAgB;QACnB,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,IAAiB,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,CAAK,CAAmB;QAC1B,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,IAAiB,CAAC;QAC5C,OAAO,CAAC,EAAE,CAAC;IACf,CAAC;IAED,GAAG,CAAK,IAAgB;QACpB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAEjC,IAAI,UAAU,IAAI,CAAC,UAAU;YAAE,OAAO,IAAiB,CAAC;QACxD,IAAI,CAAC,UAAU,IAAI,UAAU;YAAE,OAAO,IAAI,CAAC;QAE3C,OAAO,IAAI,EAAU,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,KAAQ;QACX,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,WAAW,CAAC,KAAQ;QAChB,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACvC,OAAO,IAAI,CAAC,MAAW,CAAC;IAC5B,CAAC;IAED,eAAe,CAAC,CAAU;QACtB,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC,MAAW,CAAC;IAC5B,CAAC;IAED,IAAI;QACA,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAChB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,SAA8B;QACjC,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,OAAO,CAAC,KAAQ;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;IAED,OAAO;QACH,IAAI,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,IAAI,CAAC,KAAkB,CAAC;QAClD,OAAO,IAAI,EAAK,CAAC;IACrB,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAI,KAAQ,EAAa,EAAE;IAC3C,OAAO,IAAI,UAAU,CAAI,KAAK,CAAc,CAAC;AACjD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,GAAyB,EAAE;IAC3C,OAAO,IAAI,UAAU,CAAI,IAAI,CAAc,CAAC;AAChD,CAAC,CAAC"}

package/dist/result.d.ts

@@ -1,3 +1,4 @@
+import { type Option } from './option';
 /**
  * The base interface for all errors returned by a `Result`.
  * It requires a `code` property which can be used to identify the error type.
@@ -53,7 +54,7 @@ interface ResultMethods<T, E extends ResultError> {
     /**
      * Returns `true` if the result is `Ok` and the value inside of it matches a predicate.
      */
-    isOkAnd(fn: (val: T) => boolean): this is OkResult<T, E>;
+    isOkAnd(f: (val: T) => boolean): this is OkResult<T, E>;
     /**
      * Returns `true` if the result is `Err`.
      */
@@ -61,47 +62,59 @@ interface ResultMethods<T, E extends ResultError> {
     /**
      * Returns `true` if the result is `Err` and the value inside of it matches a predicate.
      */
-    isErrAnd(fn: (err: E) => boolean): this is ErrResult<T, E>;
+    isErrAnd(f: (err: E) => boolean): this is ErrResult<T, E>;
+    /**
+     * Converts from `Result<T, E>` to `Option<T>`.
+     *
+     * Converts self into an `Option<T>`, consuming self, and converting the error to `None`, if any.
+     */
+    ok(): Option<T>;
+    /**
+     * Converts from `Result<T, E>` to `Option<E>`.
+     *
+     * Converts self into an `Option<E>`, consuming self, and discarding the success value, if any.
+     */
+    err(): Option<E>;
     /**
      * Maps a `Result<T, E>` to `Result<U, E>` by applying a function to a contained `Ok` value, leaving an `Err` value untouched.
      *
      * This function can be used to compose the results of two functions.
      */
-    map<U>(fn: (val: T) => U): Result<U, E>;
+    map<U>(f: (val: T) => U): Result<U, E>;
     /**
      * Returns the provided default (if `Err`), or applies a function to the contained value (if `Ok`).
      *
      * Arguments passed to `mapOr` are eagerly evaluated; if you are passing the result of a function call, it is recommended to use `mapOrElse`, which is lazily evaluated.
      */
-    mapOr<U>(fallback: U, fn: (val: T) => U): U;
+    mapOr<U>(fallback: U, f: (val: T) => U): U;
     /**
-     * Maps a `Result<T, E>` to `U` by applying fallback function `fallbackFn` to a contained `Err` value, or function `fn` to a contained `Ok` value.
+     * Maps a `Result<T, E>` to `U` by applying fallback function `fallbackFn` to a contained `Err` value, or function `f` to a contained `Ok` value.
      *
      * This function can be used to unpack a successful result while handling an error.
      */
-    mapOrElse<U>(fallbackFn: (err: E) => U, fn: (val: T) => U): U;
+    mapOrElse<U>(fallbackFn: (err: E) => U, f: (val: T) => U): U;
     /**
      * Maps a `Result<T, E>` to `Result<T, F>` by applying a function to a contained `Err` value, leaving an `Ok` value untouched.
      *
      * This function can be used to pass through a successful result while handling an error.
      */
-    mapErr<F extends ResultError>(fn: (err: E) => F): Result<T, F>;
+    mapErr<F extends ResultError>(f: (err: E) => F): Result<T, F>;
     /**
      * Calls a function with a reference to the contained value if `Ok`.
      *
      * Returns the original result.
      */
-    inspect(fn: (val: T) => void): Result<T, E>;
+    inspect(f: (val: T) => void): Result<T, E>;
     /**
      * Calls a function with a reference to the contained value if `Err`.
      *
      * Returns the original result.
      */
-    inspectErr(fn: (err: E) => void): Result<T, E>;
+    inspectErr(f: (err: E) => void): Result<T, E>;
     /**
      * Returns an iterator over the possibly contained value.
      *
-     * The iterator yields one value if the result is `Result::Ok`, otherwise none.
+     * The iterator yields one value if the result is `Ok`, otherwise none.
      */
     iter(): Iterable<T>;
     /**
@@ -135,11 +148,11 @@ interface ResultMethods<T, E extends ResultError> {
      */
     and<U, E2 extends ResultError>(res: Result<U, E2>): Result<U, E | E2>;
     /**
-     * Calls `fn` if the result is `Ok`, otherwise returns the `Err` value of `self`.
+     * Calls `f` if the result is `Ok`, otherwise returns the `Err` value of `self`.
      *
      * This function can be used for control flow based on `Result` values.
      */
-    andThen<U, F extends ResultError>(fn: (val: T) => Result<U, F>): Result<U, E | F>;
+    andThen<U, F extends ResultError>(f: (val: T) => Result<U, F>): Result<U, E | F>;
     /**
      * Returns `res` if the result is `Err`, otherwise returns the `Ok` value of `self`.
      *
@@ -147,11 +160,11 @@ interface ResultMethods<T, E extends ResultError> {
      */
     or<T2, F extends ResultError>(res: Result<T2, F>): Result<T | T2, F>;
     /**
-     * Calls `fn` if the result is `Err`, otherwise returns the `Ok` value of `self`.
+     * Calls `f` if the result is `Err`, otherwise returns the `Ok` value of `self`.
      *
      * This function can be used for control flow based on result values.
      */
-    orElse<T2, F extends ResultError>(fn: (err: E) => Result<T2, F>): Result<T | T2, F>;
+    orElse<T2, F extends ResultError>(f: (err: E) => Result<T2, F>): Result<T | T2, F>;
     /**
      * Returns the contained `Ok` value or a provided default.
      *
@@ -161,7 +174,8 @@ interface ResultMethods<T, E extends ResultError> {
     /**
      * Returns the contained `Ok` value or computes it from a closure.
      */
-    unwrapOrElse<T2>(fn: (err: E) => T2): T | T2;
+    unwrapOrElse<T2>(f: (err: E) => T2): T | T2;
+    flatten<U, F extends ResultError>(this: Result<Result<U, F>, E>): Result<U, E | F>;
 }
 /**
  * Contains the success value.

package/dist/result.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI;IAC7C,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;CACxB,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI;IAC9C,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;CACrB,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEhF,UAAU,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW;IAC5C;;OAEG;IACH,IAAI,IAAI,IAAI,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD;;OAEG;IACH,KAAK,IAAI,IAAI,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAG3D;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxC;;;;OAIG;IACH,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5C;;;;OAIG;IACH,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9D;;;;OAIG;IACH,MAAM,CAAC,CAAC,SAAS,WAAW,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/D;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5C;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C;;;;OAIG;IACH,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IACvB;;;;OAIG;IACH,MAAM,IAAI,CAAC,CAAC;IAEZ;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IAC1B;;;;OAIG;IACH,SAAS,IAAI,CAAC,CAAC;IACf;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,EAAE,SAAS,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IACtE;;;;OAIG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,EAC5B,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACpB;;;;OAIG;IACH,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;IACrE;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC,SAAS,WAAW,EAC5B,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,GAC9B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC;CAChD;AAqID;;;;;;;;;;GAUG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,KAAK,EAC/C,OAAO,CAAC,KACT,MAAM,CAAC,CAAC,EAAE,CAAC,CAEb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,GAAG,GACZ,KAAK,CAAC,CAAC,SAAS,MAAM,EACtB,CAAC,SAAS,WAAW,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,EAEnC,OAAO,CAAC,KACT,MAAM,CAAC,KAAK,EAAE,CAAC,CAEjB,CAAC"}
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAc,MAAM,UAAU,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI;IAC7C,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;CACxB,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI;IAC9C,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;CACrB,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEhF,UAAU,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW;IAC5C;;OAEG;IACH,IAAI,IAAI,IAAI,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxD;;OAEG;IACH,KAAK,IAAI,IAAI,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D;;;;OAIG;IACH,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;IAChB;;;;OAIG;IACH,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;IACjB;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC;;;;OAIG;IACH,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3C;;;;OAIG;IACH,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7D;;;;OAIG;IACH,MAAM,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9D;;;;OAIG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C;;;;OAIG;IACH,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C;;;;OAIG;IACH,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IACvB;;;;OAIG;IACH,MAAM,IAAI,CAAC,CAAC;IACZ;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;IAC1B;;;;OAIG;IACH,SAAS,IAAI,CAAC,CAAC;IACf;;;;OAIG;IACH,GAAG,CAAC,CAAC,EAAE,EAAE,SAAS,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IACtE;;;;OAIG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,EAC5B,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACpB;;;;OAIG;IACH,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;IACrE;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC,SAAS,WAAW,EAC5B,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,GAC7B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC;IAE5C,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,EAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAC9B,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACvB;AAqJD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,KAAK,EAC/C,OAAO,CAAC,KACT,MAAM,CAAC,CAAC,EAAE,CAAC,CAEb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,GAAG,GACZ,KAAK,CAAC,CAAC,SAAS,MAAM,EACtB,CAAC,SAAS,WAAW,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,EAEnC,OAAO,CAAC,KACT,MAAM,CAAC,KAAK,EAAE,CAAC,CAEjB,CAAC"}

package/dist/result.js

@@ -1,3 +1,4 @@
+import { Some, None } from './option';
 class ResultImpl {
     // will error at runtime if trying to access # fields
     #value;
@@ -17,44 +18,53 @@ class ResultImpl {
     isOk() {
         return this.error === null;
     }
-    isOkAnd(fn) {
-        return this.isOk() && fn(this.value);
+    isOkAnd(f) {
+        return this.isOk() && f(this.value);
     }
     isErr() {
         return this.value === null;
     }
-    isErrAnd(fn) {
-        return this.isErr() && fn(this.error);
+    isErrAnd(f) {
+        return this.isErr() && f(this.error);
     }
-    map(fn) {
-        if (this.isErr()) {
+    ok() {
+        if (this.isOk())
+            return Some(this.value);
+        return None();
+    }
+    err() {
+        if (this.isErr())
+            return Some(this.error);
+        return None();
+    }
+    map(f) {
+        if (this.isErr())
             return new ResultImpl(null, this.error);
-        }
-        return new ResultImpl(fn(this.value), null);
+        return new ResultImpl(f(this.value), null);
     }
-    mapOr(fallback, fn) {
+    mapOr(fallback, f) {
         if (this.isErr())
             return fallback;
-        return fn(this.value);
+        return f(this.value);
     }
-    mapOrElse(fallbackFn, fn) {
+    mapOrElse(fallbackFn, f) {
         if (this.isErr())
             return fallbackFn(this.error);
-        return fn(this.value);
+        return f(this.value);
     }
-    mapErr(fn) {
+    mapErr(f) {
         if (this.isErr())
-            return new ResultImpl(null, fn(this.error));
+            return new ResultImpl(null, f(this.error));
         return new ResultImpl(this.value, null);
     }
-    inspect(fn) {
+    inspect(f) {
         if (this.isOk())
-            fn(this.value);
+            f(this.value);
         return this;
     }
-    inspectErr(fn) {
+    inspectErr(f) {
         if (this.isErr())
-            fn(this.error);
+            f(this.error);
         return this;
     }
     *iter() {
@@ -86,9 +96,9 @@ class ResultImpl {
             return res;
         return new ResultImpl(null, this.error);
     }
-    andThen(fn) {
+    andThen(f) {
         if (this.isOk())
-            return fn(this.value);
+            return f(this.value);
         return new ResultImpl(null, this.error);
     }
     or(res) {
@@ -96,9 +106,9 @@ class ResultImpl {
             return res;
         return new ResultImpl(this.value, null);
     }
-    orElse(fn) {
+    orElse(f) {
         if (this.isErr())
-            return fn(this.error);
+            return f(this.error);
         return new ResultImpl(this.value, null);
     }
     unwrapOr(fallback) {
@@ -106,11 +116,19 @@ class ResultImpl {
             return fallback;
         return this.value;
     }
-    unwrapOrElse(fn) {
+    unwrapOrElse(f) {
         if (this.isErr())
-            return fn(this.error);
+            return f(this.error);
         return this.value;
     }
+    /**
+     * Converts from `Result<Result<T, E>, E>` to `Result<T, E>`.
+     */
+    flatten() {
+        if (this.isOk())
+            return this.value;
+        return new ResultImpl(null, this.error);
+    }
 }
 /**
  * Contains the success value.

package/dist/result.js.map

@@ -1 +1 @@
-{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAiLA,MAAM,UAAU;IACZ,qDAAqD;IACrD,MAAM,CAAW;IACjB,MAAM,CAAW;IAEjB,YAAY,KAAe,EAAE,KAAe;QACxC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,EAAuB;QAC3B,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED,QAAQ,CAAC,EAAuB;QAC5B,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;IAC/C,CAAC;IAED,GAAG,CAAI,EAAiB;QACpB,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YACf,OAAO,IAAI,UAAU,CAAO,IAAI,EAAE,IAAI,CAAC,KAAK,CAAiB,CAAC;QAClE,CAAC;QACD,OAAO,IAAI,UAAU,CAAO,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,EAAE,IAAI,CAAiB,CAAC;IAC3E,CAAC;IAED,KAAK,CAAI,QAAW,EAAE,EAAiB;QACnC,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,QAAQ,CAAC;QAClC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;IAC/B,CAAC;IAED,SAAS,CAAI,UAAyB,EAAE,EAAiB;QACrD,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,UAAU,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;QACrD,OAAO,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAwB,EAAiB;QAC3C,IAAI,IAAI,CAAC,KAAK,EAAE;YACZ,OAAO,IAAI,UAAU,CAAO,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAGpD,CAAC;QACN,OAAO,IAAI,UAAU,CAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAiB,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,EAAoB;QACxB,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;QACrC,OAAO,IAA+B,CAAC;IAC3C,CAAC;IAED,UAAU,CAAC,EAAoB;QAC3B,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;QACtC,OAAO,IAA+B,CAAC;IAC3C,CAAC;IAED,CAAC,IAAI;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,CAAC,KAAU,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,MAAM;QACF,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC;QAC1C,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,GAAW;QACjB,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,SAAS;QACL,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,GAAG,CAA4B,GAAkB;QAC7C,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,GAAG,CAAC;QAC5B,OAAO,IAAI,UAAU,CAAY,IAAI,EAAE,IAAI,CAAC,KAAK,CAAsB,CAAC;IAC5E,CAAC;IAED,OAAO,CACH,EAA4B;QAE5B,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;QAC5C,OAAO,IAAI,UAAU,CAAW,IAAI,EAAE,IAAI,CAAC,KAAK,CAAqB,CAAC;IAC1E,CAAC;IAED,EAAE,CAA4B,GAAkB;QAC5C,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC;QAC7B,OAAO,IAAI,UAAU,CAAY,IAAI,CAAC,KAAK,EAAE,IAAI,CAAsB,CAAC;IAC5E,CAAC;IAED,MAAM,CACF,EAA6B;QAE7B,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;QAC7C,OAAO,IAAI,UAAU,CAAY,IAAI,CAAC,KAAK,EAAE,IAAI,CAAsB,CAAC;IAC5E,CAAC;IAED,QAAQ,CAAK,QAAY;QACrB,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,QAAQ,CAAC;QAClC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,YAAY,CAAK,EAAkB;QAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,EAAE,GAAG,CACd,KAAQ,EACI,EAAE;IACd,OAAO,IAAI,UAAU,CAAO,KAAK,EAAE,IAAI,CAAiB,CAAC;AAC7D,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAIf,KAAQ,EACQ,EAAE;IAClB,OAAO,IAAI,UAAU,CAAW,IAAI,EAAE,KAAK,CAAqB,CAAC;AACrE,CAAC,CAAC"}
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,IAAI,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAgMnD,MAAM,UAAU;IACZ,qDAAqD;IACrD,MAAM,CAAW;IACjB,MAAM,CAAW;IAEjB,YAAY,KAAe,EAAE,KAAe;QACxC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,CAAsB;QAC1B,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED,QAAQ,CAAC,CAAsB;QAC3B,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,EAAE;QACE,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,IAAI,EAAE,CAAC;IAClB,CAAC;IAED,GAAG;QACC,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,OAAO,IAAI,EAAE,CAAC;IAClB,CAAC;IAED,GAAG,CAAI,CAAgB;QACnB,IAAI,IAAI,CAAC,KAAK,EAAE;YACZ,OAAO,IAAI,UAAU,CAAO,IAAI,EAAE,IAAI,CAAC,KAAK,CAAiB,CAAC;QAClE,OAAO,IAAI,UAAU,CAAO,CAAC,CAAC,IAAI,CAAC,KAAU,CAAC,EAAE,IAAI,CAAiB,CAAC;IAC1E,CAAC;IAED,KAAK,CAAI,QAAW,EAAE,CAAgB;QAClC,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,QAAQ,CAAC;QAClC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;IAC9B,CAAC;IAED,SAAS,CAAI,UAAyB,EAAE,CAAgB;QACpD,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChD,OAAO,CAAC,CAAC,IAAI,CAAC,KAAU,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,CAAwB,CAAgB;QAC1C,IAAI,IAAI,CAAC,KAAK,EAAE;YACZ,OAAO,IAAI,UAAU,CAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAiB,CAAC;QACrE,OAAO,IAAI,UAAU,CAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAiB,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,CAAmB;QACvB,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,OAAO,IAAoB,CAAC;IAChC,CAAC;IAED,UAAU,CAAC,CAAmB;QAC1B,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,OAAO,IAAoB,CAAC;IAChC,CAAC;IAED,CAAC,IAAI;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,MAAM;QACF,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC;QAC1C,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,GAAW;QACjB,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,SAAS;QACL,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,GAAG,CAA4B,GAAkB;QAC7C,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,GAAG,CAAC;QAC5B,OAAO,IAAI,UAAU,CAAY,IAAI,EAAE,IAAI,CAAC,KAAK,CAAsB,CAAC;IAC5E,CAAC;IAED,OAAO,CACH,CAA2B;QAE3B,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,OAAO,IAAI,UAAU,CAAW,IAAI,EAAE,IAAI,CAAC,KAAK,CAAqB,CAAC;IAC1E,CAAC;IAED,EAAE,CAA4B,GAAkB;QAC5C,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC;QAC7B,OAAO,IAAI,UAAU,CAAY,IAAI,CAAC,KAAK,EAAE,IAAI,CAAsB,CAAC;IAC5E,CAAC;IAED,MAAM,CACF,CAA4B;QAE5B,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,UAAU,CAAY,IAAI,CAAC,KAAK,EAAE,IAAI,CAAsB,CAAC;IAC5E,CAAC;IAED,QAAQ,CAAK,QAAY;QACrB,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,QAAQ,CAAC;QAClC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED,YAAY,CAAK,CAAiB;QAC9B,IAAI,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,OAAO;QAGH,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,IAAI,CAAC,KAAyB,CAAC;QACvD,OAAO,IAAI,UAAU,CAAW,IAAI,EAAE,IAAI,CAAC,KAAK,CAAqB,CAAC;IAC1E,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,EAAE,GAAG,CACd,KAAQ,EACI,EAAE;IACd,OAAO,IAAI,UAAU,CAAO,KAAK,EAAE,IAAI,CAAiB,CAAC;AAC7D,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAIf,KAAQ,EACQ,EAAE;IAClB,OAAO,IAAI,UAAU,CAAW,IAAI,EAAE,KAAK,CAAqB,CAAC;AACrE,CAAC,CAAC"}

package/package.json

@@ -1,8 +1,9 @@
 {
     "name": "@madkarma/result",
-    "version": "2.0.2",
-    "description": "Rust's Result type, for TypeScript",
+    "version": "3.0.1",
+    "description": "Rust's Result and Option types, for TypeScript",
     "devDependencies": {
+        "@types/bun": "^1.3.14",
         "prettier": "3.8.3",
         "typescript": "^6.0.3",
         "vitest": "^4.1.6"