@iahuang/result-ts 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ian Huang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+# `result-ts`
+
+A Typescript implementation of Rust's [`std::result::Result`](https://doc.rust-lang.org/std/result/enum.Result.html) enum type. Make errors in fallible subroutines predictable and impossible to ignore.
+
+## Example Usage
+
+```ts
+type ParseErrors = {
+    invalid_number: string; // the string that failed to parse as a number
+    negative: number; // the number that was negative
+};
+
+const parseResult = resultType<number, ParseErrors>();
+
+type ParseError = Err<ParseErrors>; // { ok: false, error: "invalid_number", detail: string } | { ok: false, error: "negative", detail: number }
+type ParseOk = Ok<number>; // { ok: true, value: number }
+
+type ParseResult = ResultType<typeof parseResult>; // ParseError | ParseOk
+
+function parseIntStrict(s: string): ParseResult {
+    const n = Number.parseInt(s, 10);
+    if (Number.isNaN(n)) return parseResult.err("invalid_number", s);
+    if (n < 0) return parseResult.err("negative", n);
+    return parseResult.ok(n);
+}
+
+const timesTwo = resultMap(parseIntStrict("123"), (n) => n * 2);
+
+// construct plain results manually
+const okResult = parseResult.ok(123); // { ok: true, value: 123 }
+const errResult = parseResult.err("invalid_number", "123"); // { ok: false, error: "invalid_number", detail: "123" }
+```
+
+The equivalent Rust code is:
+
+```rust
+enum ParseError {
+    InvalidNumber(String),
+    Negative(i32),
+}
+
+fn parse_int_strict(s: &str) -> Result<i32, ParseError> {
+    match s.parse::<i32>() {
+        Ok(n) => {
+            if n < 0 {
+                Err(ParseError::Negative(n))
+            } else {
+                Ok(n)
+            }
+        },
+        Err(_) => Err(ParseError::InvalidNumber(s.to_string())),
+    }
+}
+
+let times_two = parse_int_strict("123").map(|n| n * 2);
+
+let ok_result = Ok(123);
+let err_result = Err(ParseError::InvalidNumber("123".to_string()));
+```
+
+### Chain API
+
+For readability, this library also provides a method chaining API.
+
+```ts
+const timesTwo = chain(parseIntStrict("123"))
+    .map((n) => n * 2)
+    .unwrapOr(0);
+```
+
+This more closely resembles the equivalent Rust code:
+
+```rust
+let times_two = parse_int_strict("123")
+    .map(|n| n * 2)
+    .unwrap_or(0);
+```
+
+## Comparison with Other Libraries
+
+### `neverthrow`
+
+Unlike `neverthrow`, the canonical representation of a result is a plain object with type information
+rather than a class instance. This allows for result types to be safely serialized and deserialized,
+as `Result` types contain neither methods nor class information!
+
+`neverthrow` provides a perfectly valid solution to this problem statement; this library aims to
+act more as lighter, type-safe wrapper around plain Javascript constructs rather than creating new types
+entirely.

package/dist/index.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Usage
+ *
+ * ```ts
+ * type ParseErrors = {
+ *   invalid_number: string;
+ *   negative: number;
+ * };
+ *
+ * const parseResult = resultType<number, ParseErrors>();
+ * type ParseResult = ResultType<typeof parseResult>;
+ * type ParseError = Err<ParseErrors>;
+ * type ParseOk = Ok<number>;
+ *
+ * function parseIntStrict(s: string): ParseResult {
+ *   if (!/^-?\d+$/.test(s)) return parseResult.err("invalid_number", s);
+ *   return parseResult.ok(Number.parseInt(s, 10));
+ * }
+ * ```
+ */
+export type Err<E> = {
+    [K in keyof E]: {
+        ok: false;
+        error: K;
+        detail: E[K];
+    };
+}[keyof E];
+export type Ok<T> = {
+    ok: true;
+    error?: never;
+    value: T;
+};
+export type Result<T, E> = Err<E> | Ok<T>;
+export type Undetailed<E extends string> = {
+    [K in E]: undefined;
+};
+export declare function ok<T>(value: T): Ok<T>;
+export type OkConstructor<T> = (value: T) => Ok<T>;
+export type ErrConstructor<E> = <K extends keyof E>(error: K, ...args: E[K] extends undefined ? [] : [detail: E[K]]) => Err<E>;
+export declare function okConstructor<T>(): OkConstructor<T>;
+export declare function errConstructor<E>(): <K extends keyof E>(error: K, ...args: E[K] extends undefined ? [] : [detail: E[K]]) => Err<E>;
+type ResultConstructors<T, E> = {
+    ok: OkConstructor<T>;
+    err: ErrConstructor<E>;
+    __result: Result<T, E>;
+};
+export declare function resultType<T, E>(): ResultConstructors<T, E>;
+export type ResultType<T extends ResultConstructors<any, any>> = T["__result"];
+export declare function resultAnd<T, E>(result: Result<T, E>, other: Result<T, E>): Result<T, E>;
+export declare function resultAndThen<T, E, R>(result: Result<T, E>, fn: (value: T) => Result<R, E>): Result<R, E>;
+export declare function resultErr<T, E>(result: Result<T, E>): Err<E> | null;
+export declare function resultExpect<T, E>(result: Result<T, E>, msg: string): T;
+export declare function resultExpectErr<T, E>(result: Result<T, E>, msg: string): Err<E>;
+export declare function resultFlatten<T, E>(result: Result<Result<T, E>, E>): Result<T, E>;
+export declare function resultInspect<T, E>(result: Result<T, E>, fn: (value: T) => void): Result<T, E>;
+export declare function resultInspectErr<T, E>(result: Result<T, E>, fn: (err: Err<E>) => void): Result<T, E>;
+export declare function resultIsErr<T, E>(r: Result<T, E>): r is Err<E>;
+export declare function resultIsErrAnd<T, E>(r: Result<T, E>, fn: (err: Err<E>) => boolean): boolean;
+export declare function resultIsOk<T, E>(r: Result<T, E>): r is Ok<T>;
+export declare function resultIsOkAnd<T, E>(r: Result<T, E>, fn: (value: T) => boolean): boolean;
+export declare function resultMap<T, E, R>(result: Result<T, E>, fn: (value: T) => R): Result<R, E>;
+export declare function resultMapErr<T, E, F>(result: Result<T, E>, fn: (err: Err<E>) => Err<F>): Result<T, F>;
+export declare function resultMapOr<T, E, R>(result: Result<T, E>, defaultValue: R, fn: (value: T) => R): R;
+export declare function resultMapOrElse<T, E, R>(result: Result<T, E>, defaultValue: (err: Err<E>) => R, fn: (value: T) => R): R;
+export declare function resultOk<T, E>(result: Result<T, E>): T | null;
+export declare function resultOr<T, E>(result: Result<T, E>, other: Result<T, E>): Result<T, E>;
+export declare function resultOrElse<T, E>(result: Result<T, E>, fn: (err: Err<E>) => Result<T, E>): Result<T, E>;
+export declare function resultUnwrap<T, E>(result: Result<T, E>): T;
+export declare function resultUnwrapErr<T, E>(result: Result<T, E>): Err<E>;
+export declare function resultUnwrapOr<T, E>(result: Result<T, E>, defaultValue: T): T;
+export declare function resultUnwrapOrElse<T, E>(result: Result<T, E>, fn: (err: Err<E>) => T): T;
+export declare function tryCatchResult<T, E>(fn: () => T, err: (e: unknown) => Err<E>): Result<T, E>;
+export declare function tryCatchResultAsync<T, E>(fn: () => Promise<T>, err: (e: unknown) => Err<E>): Promise<Result<T, E>>;
+type ChainAnd<T, E> = (other: Result<T, E>) => Chain<T, E>;
+type ChainAndThen<I, E> = <O>(fn: (value: I) => Result<O, E>) => Chain<O, E>;
+type ChainMap<I, E> = <O>(fn: (value: I) => O) => Chain<O, E>;
+type ChainMapErr<T, E> = <F>(fn: (err: Err<E>) => Err<F>) => Chain<T, F>;
+type ChainMapOr<I> = <R>(defaultValue: R, fn: (value: I) => R) => R;
+type ChainMapOrElse<I, E> = <R>(defaultValue: (err: Err<E>) => R, fn: (value: I) => R) => R;
+type ChainOr<T, E> = (other: Result<T, E>) => Chain<T, E>;
+type ChainOrElse<T, E> = (fn: (err: Err<E>) => Result<T, E>) => Chain<T, E>;
+type ChainUnwrap<T> = () => T;
+type ChainUnwrapOr<T> = (defaultValue: T) => T;
+type ChainUnwrapOrElse<T, E> = (fn: (err: Err<E>) => T) => T;
+type ChainExpect<T> = (msg: string) => T;
+type ChainExpectErr<E> = (msg: string) => Err<E>;
+type ChainUnwrapErr<E> = () => Err<E>;
+type ChainFlatten<T, E> = () => Chain<T, E>;
+type ChainInspect<T, E> = (fn: (value: T) => void) => Chain<T, E>;
+type ChainInspectErr<T, E> = (fn: (err: Err<E>) => void) => Chain<T, E>;
+type ChainIsOk<T, E> = () => boolean & {
+    __phantom?: [T, E];
+};
+type ChainIsErr<T, E> = () => boolean & {
+    __phantom?: [T, E];
+};
+type ChainIsOkAnd<T> = (fn: (value: T) => boolean) => boolean;
+type ChainIsErrAnd<E> = (fn: (err: Err<E>) => boolean) => boolean;
+type ChainOk<T> = () => T | null;
+type ChainErr<E> = () => Err<E> | null;
+type Chain<T, E> = {
+    result: Result<T, E>;
+    and: ChainAnd<T, E>;
+    andThen: ChainAndThen<T, E>;
+    map: ChainMap<T, E>;
+    mapErr: ChainMapErr<T, E>;
+    mapOr: ChainMapOr<T>;
+    mapOrElse: ChainMapOrElse<T, E>;
+    or: ChainOr<T, E>;
+    orElse: ChainOrElse<T, E>;
+    unwrap: ChainUnwrap<T>;
+    unwrapOr: ChainUnwrapOr<T>;
+    unwrapOrElse: ChainUnwrapOrElse<T, E>;
+    expect: ChainExpect<T>;
+    expectErr: ChainExpectErr<E>;
+    unwrapErr: ChainUnwrapErr<E>;
+    flatten: T extends Result<infer U, E> ? ChainFlatten<U, E> : never;
+    inspect: ChainInspect<T, E>;
+    inspectErr: ChainInspectErr<T, E>;
+    isOk: ChainIsOk<T, E>;
+    isErr: ChainIsErr<T, E>;
+    isOkAnd: ChainIsOkAnd<T>;
+    isErrAnd: ChainIsErrAnd<E>;
+    ok: ChainOk<T>;
+    err: ChainErr<E>;
+};
+export declare function chain<I, E>(initial: Result<I, E>): Chain<I, E>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,GAAG;QACf,EAAE,EAAE,KAAK,CAAC;QACV,KAAK,EAAE,CAAC,CAAC;QACT,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;KACb;CACD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI;IACnB,EAAE,EAAE,IAAI,CAAC;IACT,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;AAE1C,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,IAAI;KACzC,CAAC,IAAI,CAAC,GAAG,SAAS;CACnB,CAAC;AAEF,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAErC;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,EACjD,KAAK,EAAE,CAAC,EACR,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KACjD,GAAG,CAAC,CAAC,CAAC,CAAC;AAEZ,wBAAgB,aAAa,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAEnD;AAED,wBAAgB,cAAc,CAAC,CAAC,MACvB,CAAC,SAAS,MAAM,CAAC,EACxB,OAAO,CAAC,EACR,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KACnD,GAAG,CAAC,CAAC,CAAC,CAOT;AAED,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI;IAC/B,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACrB,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CACvB,CAAC;AAEF,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAM3D;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC;AAE/E,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEvF;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACpC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5B,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEd;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAEnE;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,CAKvE;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAK/E;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEjF;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAK9F;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,CAAC,EACpC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,GACvB,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAKd;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAE9D;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,GAAG,OAAO,CAE3F;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAE5D;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAAG,OAAO,CAEvF;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAE1F;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACnC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GACzB,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEd;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAClC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,YAAY,EAAE,CAAC,EACf,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACjB,CAAC,CAEH;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACtC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAChC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GACjB,CAAC,CAEH;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAE7D;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEtF;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAChC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/B,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEd;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAK1D;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAKlE;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAE7E;AAED,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAExF;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAM3F;AAED,wBAAsB,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAC7C,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAMvB;AAED,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3D,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC7E,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9D,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACzE,KAAK,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACpE,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC5F,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1D,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC5E,KAAK,WAAW,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC;AAC9B,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC;AAC/C,KAAK,iBAAiB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC7D,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,CAAC;AACzC,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;AACjD,KAAK,cAAc,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;AACtC,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC5C,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAClE,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACxE,KAAK,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,MAAM,OAAO,GAAG;IAAE,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAAE,CAAC;AAC9D,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,MAAM,OAAO,GAAG;IAAE,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAAE,CAAC;AAC/D,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,KAAK,OAAO,CAAC;AAC9D,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,KAAK,OAAO,CAAC;AAClE,KAAK,OAAO,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC;AACjC,KAAK,QAAQ,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AAEvC,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI;IAClB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrB,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5B,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1B,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACrB,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClB,MAAM,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1B,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC3B,YAAY,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7B,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7B,OAAO,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;IACnE,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5B,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtB,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACzB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC3B,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjB,CAAC;AAEF,wBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CA4B9D"}

package/dist/index.js

@@ -0,0 +1,226 @@
+/**
+ * Usage
+ *
+ * ```ts
+ * type ParseErrors = {
+ *   invalid_number: string;
+ *   negative: number;
+ * };
+ *
+ * const parseResult = resultType<number, ParseErrors>();
+ * type ParseResult = ResultType<typeof parseResult>;
+ * type ParseError = Err<ParseErrors>;
+ * type ParseOk = Ok<number>;
+ *
+ * function parseIntStrict(s: string): ParseResult {
+ *   if (!/^-?\d+$/.test(s)) return parseResult.err("invalid_number", s);
+ *   return parseResult.ok(Number.parseInt(s, 10));
+ * }
+ * ```
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+export function ok(value) {
+    return { ok: true, value: value };
+}
+export function okConstructor() {
+    return (function (value) { return ({ ok: true, value: value }); });
+}
+export function errConstructor() {
+    return function (error) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        return {
+            ok: false,
+            error: error,
+            detail: args[0],
+        };
+    };
+}
+export function resultType() {
+    return {
+        ok: okConstructor(),
+        err: errConstructor(),
+        __result: undefined,
+    };
+}
+export function resultAnd(result, other) {
+    return result.ok ? other : result;
+}
+export function resultAndThen(result, fn) {
+    return result.ok ? fn(result.value) : result;
+}
+export function resultErr(result) {
+    return !result.ok ? result : null;
+}
+export function resultExpect(result, msg) {
+    if (!result.ok) {
+        throw new Error(msg);
+    }
+    return result.value;
+}
+export function resultExpectErr(result, msg) {
+    if (result.ok) {
+        throw new Error(msg);
+    }
+    return result;
+}
+export function resultFlatten(result) {
+    return result.ok ? result.value : result;
+}
+export function resultInspect(result, fn) {
+    if (result.ok) {
+        fn(result.value);
+    }
+    return result;
+}
+export function resultInspectErr(result, fn) {
+    if (!result.ok) {
+        fn(result);
+    }
+    return result;
+}
+export function resultIsErr(r) {
+    return !r.ok;
+}
+export function resultIsErrAnd(r, fn) {
+    return !r.ok && fn(r);
+}
+export function resultIsOk(r) {
+    return r.ok;
+}
+export function resultIsOkAnd(r, fn) {
+    return r.ok && fn(r.value);
+}
+export function resultMap(result, fn) {
+    return result.ok ? ok(fn(result.value)) : result;
+}
+export function resultMapErr(result, fn) {
+    return result.ok ? result : fn(result);
+}
+export function resultMapOr(result, defaultValue, fn) {
+    return result.ok ? fn(result.value) : defaultValue;
+}
+export function resultMapOrElse(result, defaultValue, fn) {
+    return result.ok ? fn(result.value) : defaultValue(result);
+}
+export function resultOk(result) {
+    return result.ok ? result.value : null;
+}
+export function resultOr(result, other) {
+    return result.ok ? result : other;
+}
+export function resultOrElse(result, fn) {
+    return result.ok ? result : fn(result);
+}
+export function resultUnwrap(result) {
+    if (!result.ok) {
+        throw result;
+    }
+    return result.value;
+}
+export function resultUnwrapErr(result) {
+    if (result.ok) {
+        throw new Error("Result is ok; expected an error");
+    }
+    return result;
+}
+export function resultUnwrapOr(result, defaultValue) {
+    return result.ok ? result.value : defaultValue;
+}
+export function resultUnwrapOrElse(result, fn) {
+    return result.ok ? result.value : fn(result);
+}
+export function tryCatchResult(fn, err) {
+    try {
+        return ok(fn());
+    }
+    catch (e) {
+        return err(e);
+    }
+}
+export function tryCatchResultAsync(fn, err) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _a, e_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 2, , 3]);
+                    _a = ok;
+                    return [4 /*yield*/, fn()];
+                case 1: return [2 /*return*/, _a.apply(void 0, [_b.sent()])];
+                case 2:
+                    e_1 = _b.sent();
+                    return [2 /*return*/, err(e_1)];
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
+}
+export function chain(initial) {
+    return {
+        result: initial,
+        and: function (other) { return chain(resultAnd(initial, other)); },
+        andThen: function (fn) { return chain(resultAndThen(initial, fn)); },
+        map: function (fn) { return chain(resultMap(initial, fn)); },
+        mapErr: function (fn) { return chain(resultMapErr(initial, fn)); },
+        mapOr: function (defaultValue, fn) { return resultMapOr(initial, defaultValue, fn); },
+        mapOrElse: function (defaultValue, fn) {
+            return resultMapOrElse(initial, defaultValue, fn);
+        },
+        or: function (other) { return chain(resultOr(initial, other)); },
+        orElse: function (fn) { return chain(resultOrElse(initial, fn)); },
+        unwrap: function () { return resultUnwrap(initial); },
+        unwrapOr: function (defaultValue) { return resultUnwrapOr(initial, defaultValue); },
+        unwrapOrElse: function (fn) { return resultUnwrapOrElse(initial, fn); },
+        expect: function (msg) { return resultExpect(initial, msg); },
+        expectErr: function (msg) { return resultExpectErr(initial, msg); },
+        unwrapErr: function () { return resultUnwrapErr(initial); },
+        flatten: (function () { return chain(resultFlatten(initial)); }),
+        inspect: function (fn) { return chain(resultInspect(initial, fn)); },
+        inspectErr: function (fn) { return chain(resultInspectErr(initial, fn)); },
+        isOk: function () { return resultIsOk(initial); },
+        isErr: function () { return resultIsErr(initial); },
+        isOkAnd: function (fn) { return resultIsOkAnd(initial, fn); },
+        isErrAnd: function (fn) { return resultIsErrAnd(initial, fn); },
+        ok: function () { return resultOk(initial); },
+        err: function () { return resultErr(initial); },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBH,MAAM,UAAU,EAAE,CAAI,KAAQ;IAC7B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,OAAA,EAAE,CAAC;AAC5B,CAAC;AASD,MAAM,UAAU,aAAa;IAC5B,OAAO,CAAC,UAAC,KAAQ,IAAK,OAAA,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,OAAA,EAAE,CAAC,EAArB,CAAqB,CAAqB,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,cAAc;IAC7B,OAAO,UACN,KAAQ;QACR,cAAqD;aAArD,UAAqD,EAArD,qBAAqD,EAArD,IAAqD;YAArD,6BAAqD;;QAErD,OAAO;YACN,EAAE,EAAE,KAAK;YACT,KAAK,OAAA;YACL,MAAM,EAAE,IAAI,CAAC,CAAC,CAAS;SACvB,CAAC;IACH,CAAC,CAAC;AACH,CAAC;AAQD,MAAM,UAAU,UAAU;IACzB,OAAO;QACN,EAAE,EAAE,aAAa,EAAE;QACnB,GAAG,EAAE,cAAc,EAAE;QACrB,QAAQ,EAAE,SAAoC;KAClB,CAAC;AAC/B,CAAC;AAID,MAAM,UAAU,SAAS,CAAO,MAAoB,EAAE,KAAmB;IACxE,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,aAAa,CAC5B,MAAoB,EACpB,EAA8B;IAE9B,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,SAAS,CAAO,MAAoB;IACnD,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,YAAY,CAAO,MAAoB,EAAE,GAAW;IACnE,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,eAAe,CAAO,MAAoB,EAAE,GAAW;IACtE,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,aAAa,CAAO,MAA+B;IAClE,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,aAAa,CAAO,MAAoB,EAAE,EAAsB;IAC/E,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC/B,MAAoB,EACpB,EAAyB;IAEzB,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QAChB,EAAE,CAAC,MAAM,CAAC,CAAC;IACZ,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,WAAW,CAAO,CAAe;IAChD,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;AACd,CAAC;AAED,MAAM,UAAU,cAAc,CAAO,CAAe,EAAE,EAA4B;IACjF,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,UAAU,CAAO,CAAe;IAC/C,OAAO,CAAC,CAAC,EAAE,CAAC;AACb,CAAC;AAED,MAAM,UAAU,aAAa,CAAO,CAAe,EAAE,EAAyB;IAC7E,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,SAAS,CAAU,MAAoB,EAAE,EAAmB;IAC3E,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,YAAY,CAC3B,MAAoB,EACpB,EAA2B;IAE3B,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAE,MAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,WAAW,CAC1B,MAAoB,EACpB,YAAe,EACf,EAAmB;IAEnB,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,eAAe,CAC9B,MAAoB,EACpB,YAAgC,EAChC,EAAmB;IAEnB,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAO,MAAoB;IAClD,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAO,MAAoB,EAAE,KAAmB;IACvE,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,YAAY,CAC3B,MAAoB,EACpB,EAAiC;IAEjC,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,YAAY,CAAO,MAAoB;IACtD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QAChB,MAAM,MAAM,CAAC;IACd,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,eAAe,CAAO,MAAoB;IACzD,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,cAAc,CAAO,MAAoB,EAAE,YAAe;IACzE,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAO,MAAoB,EAAE,EAAsB;IACpF,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,cAAc,CAAO,EAAW,EAAE,GAA2B;IAC5E,IAAI,CAAC;QACJ,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IACf,CAAC;AACF,CAAC;AAED,MAAM,UAAgB,mBAAmB,CACxC,EAAoB,EACpB,GAA2B;;;;;;;oBAGnB,KAAA,EAAE,CAAA;oBAAC,qBAAM,EAAE,EAAE,EAAA;wBAApB,sBAAO,kBAAG,SAAU,EAAC,EAAC;;;oBAEtB,sBAAO,GAAG,CAAC,GAAC,CAAC,EAAC;;;;;CAEf;AAqDD,MAAM,UAAU,KAAK,CAAO,OAAqB;IAChD,OAAO;QACN,MAAM,EAAE,OAAO;QACf,GAAG,EAAE,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,EAAhC,CAAgC;QAChD,OAAO,EAAE,UAAC,EAAE,IAAK,OAAA,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAjC,CAAiC;QAClD,GAAG,EAAE,UAAI,EAAmB,IAAK,OAAA,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAA7B,CAA6B;QAC9D,MAAM,EAAE,UAAI,EAA2B,IAAK,OAAA,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAhC,CAAgC;QAC5E,KAAK,EAAE,UAAI,YAAe,EAAE,EAAmB,IAAK,OAAA,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,CAAC,EAAtC,CAAsC;QAC1F,SAAS,EAAE,UAAI,YAAgC,EAAE,EAAmB;YACnE,OAAA,eAAe,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,CAAC;QAA1C,CAA0C;QAC3C,EAAE,EAAE,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,EAA/B,CAA+B;QAC9C,MAAM,EAAE,UAAC,EAAE,IAAK,OAAA,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAhC,CAAgC;QAChD,MAAM,EAAE,cAAM,OAAA,YAAY,CAAC,OAAO,CAAC,EAArB,CAAqB;QACnC,QAAQ,EAAE,UAAC,YAAY,IAAK,OAAA,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,EAArC,CAAqC;QACjE,YAAY,EAAE,UAAC,EAAE,IAAK,OAAA,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,EAA/B,CAA+B;QACrD,MAAM,EAAE,UAAC,GAAG,IAAK,OAAA,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,EAA1B,CAA0B;QAC3C,SAAS,EAAE,UAAC,GAAG,IAAK,OAAA,eAAe,CAAC,OAAO,EAAE,GAAG,CAAC,EAA7B,CAA6B;QACjD,SAAS,EAAE,cAAM,OAAA,eAAe,CAAC,OAAO,CAAC,EAAxB,CAAwB;QACzC,OAAO,EAAE,CAAC,cAAM,OAAA,KAAK,CAAC,aAAa,CAAC,OAAc,CAAC,CAAC,EAApC,CAAoC,CAAQ;QAC5D,OAAO,EAAE,UAAC,EAAE,IAAK,OAAA,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAjC,CAAiC;QAClD,UAAU,EAAE,UAAC,EAAE,IAAK,OAAA,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAApC,CAAoC;QACxD,IAAI,EAAE,cAAM,OAAA,UAAU,CAAC,OAAO,CAAC,EAAnB,CAAmB;QAC/B,KAAK,EAAE,cAAM,OAAA,WAAW,CAAC,OAAO,CAAC,EAApB,CAAoB;QACjC,OAAO,EAAE,UAAC,EAAE,IAAK,OAAA,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC,EAA1B,CAA0B;QAC3C,QAAQ,EAAE,UAAC,EAAE,IAAK,OAAA,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC,EAA3B,CAA2B;QAC7C,EAAE,EAAE,cAAM,OAAA,QAAQ,CAAC,OAAO,CAAC,EAAjB,CAAiB;QAC3B,GAAG,EAAE,cAAM,OAAA,SAAS,CAAC,OAAO,CAAC,EAAlB,CAAkB;KAC7B,CAAC;AACH,CAAC"}

package/index.ts

@@ -0,0 +1,314 @@
+/**
+ * Usage
+ *
+ * ```ts
+ * type ParseErrors = {
+ *   invalid_number: string;
+ *   negative: number;
+ * };
+ *
+ * const parseResult = resultType<number, ParseErrors>();
+ * type ParseResult = ResultType<typeof parseResult>;
+ * type ParseError = Err<ParseErrors>;
+ * type ParseOk = Ok<number>;
+ *
+ * function parseIntStrict(s: string): ParseResult {
+ *   if (!/^-?\d+$/.test(s)) return parseResult.err("invalid_number", s);
+ *   return parseResult.ok(Number.parseInt(s, 10));
+ * }
+ * ```
+ */
+
+export type Err<E> = {
+	[K in keyof E]: {
+		ok: false;
+		error: K;
+		detail: E[K];
+	};
+}[keyof E];
+
+export type Ok<T> = {
+	ok: true;
+	error?: never;
+	value: T;
+};
+
+export type Result<T, E> = Err<E> | Ok<T>;
+
+export type Undetailed<E extends string> = {
+	[K in E]: undefined;
+};
+
+export function ok<T>(value: T): Ok<T> {
+	return { ok: true, value };
+}
+
+export type OkConstructor<T> = (value: T) => Ok<T>;
+
+export type ErrConstructor<E> = <K extends keyof E>(
+	error: K,
+	...args: E[K] extends undefined ? [] : [detail: E[K]]
+) => Err<E>;
+
+export function okConstructor<T>(): OkConstructor<T> {
+	return ((value: T) => ({ ok: true, value })) as OkConstructor<T>;
+}
+
+export function errConstructor<E>() {
+	return <K extends keyof E>(
+		error: K,
+		...args: E[K] extends undefined ? [] : [detail: E[K]]
+	): Err<E> => {
+		return {
+			ok: false,
+			error,
+			detail: args[0] as E[K],
+		};
+	};
+}
+
+type ResultConstructors<T, E> = {
+	ok: OkConstructor<T>;
+	err: ErrConstructor<E>;
+	__result: Result<T, E>;
+};
+
+export function resultType<T, E>(): ResultConstructors<T, E> {
+	return {
+		ok: okConstructor(),
+		err: errConstructor(),
+		__result: undefined as unknown as Result<T, E>,
+	} as ResultConstructors<T, E>;
+}
+
+export type ResultType<T extends ResultConstructors<any, any>> = T["__result"];
+
+export function resultAnd<T, E>(result: Result<T, E>, other: Result<T, E>): Result<T, E> {
+	return result.ok ? other : result;
+}
+
+export function resultAndThen<T, E, R>(
+	result: Result<T, E>,
+	fn: (value: T) => Result<R, E>
+): Result<R, E> {
+	return result.ok ? fn(result.value) : result;
+}
+
+export function resultErr<T, E>(result: Result<T, E>): Err<E> | null {
+	return !result.ok ? result : null;
+}
+
+export function resultExpect<T, E>(result: Result<T, E>, msg: string): T {
+	if (!result.ok) {
+		throw new Error(msg);
+	}
+	return result.value;
+}
+
+export function resultExpectErr<T, E>(result: Result<T, E>, msg: string): Err<E> {
+	if (result.ok) {
+		throw new Error(msg);
+	}
+	return result;
+}
+
+export function resultFlatten<T, E>(result: Result<Result<T, E>, E>): Result<T, E> {
+	return result.ok ? result.value : result;
+}
+
+export function resultInspect<T, E>(result: Result<T, E>, fn: (value: T) => void): Result<T, E> {
+	if (result.ok) {
+		fn(result.value);
+	}
+	return result;
+}
+
+export function resultInspectErr<T, E>(
+	result: Result<T, E>,
+	fn: (err: Err<E>) => void
+): Result<T, E> {
+	if (!result.ok) {
+		fn(result);
+	}
+	return result;
+}
+
+export function resultIsErr<T, E>(r: Result<T, E>): r is Err<E> {
+	return !r.ok;
+}
+
+export function resultIsErrAnd<T, E>(r: Result<T, E>, fn: (err: Err<E>) => boolean): boolean {
+	return !r.ok && fn(r);
+}
+
+export function resultIsOk<T, E>(r: Result<T, E>): r is Ok<T> {
+	return r.ok;
+}
+
+export function resultIsOkAnd<T, E>(r: Result<T, E>, fn: (value: T) => boolean): boolean {
+	return r.ok && fn(r.value);
+}
+
+export function resultMap<T, E, R>(result: Result<T, E>, fn: (value: T) => R): Result<R, E> {
+	return result.ok ? ok(fn(result.value)) : result;
+}
+
+export function resultMapErr<T, E, F>(
+	result: Result<T, E>,
+	fn: (err: Err<E>) => Err<F>
+): Result<T, F> {
+	return result.ok ? (result as Ok<T>) : fn(result);
+}
+
+export function resultMapOr<T, E, R>(
+	result: Result<T, E>,
+	defaultValue: R,
+	fn: (value: T) => R
+): R {
+	return result.ok ? fn(result.value) : defaultValue;
+}
+
+export function resultMapOrElse<T, E, R>(
+	result: Result<T, E>,
+	defaultValue: (err: Err<E>) => R,
+	fn: (value: T) => R
+): R {
+	return result.ok ? fn(result.value) : defaultValue(result);
+}
+
+export function resultOk<T, E>(result: Result<T, E>): T | null {
+	return result.ok ? result.value : null;
+}
+
+export function resultOr<T, E>(result: Result<T, E>, other: Result<T, E>): Result<T, E> {
+	return result.ok ? result : other;
+}
+
+export function resultOrElse<T, E>(
+	result: Result<T, E>,
+	fn: (err: Err<E>) => Result<T, E>
+): Result<T, E> {
+	return result.ok ? result : fn(result);
+}
+
+export function resultUnwrap<T, E>(result: Result<T, E>): T {
+	if (!result.ok) {
+		throw result;
+	}
+	return result.value;
+}
+
+export function resultUnwrapErr<T, E>(result: Result<T, E>): Err<E> {
+	if (result.ok) {
+		throw new Error("Result is ok; expected an error");
+	}
+	return result;
+}
+
+export function resultUnwrapOr<T, E>(result: Result<T, E>, defaultValue: T): T {
+	return result.ok ? result.value : defaultValue;
+}
+
+export function resultUnwrapOrElse<T, E>(result: Result<T, E>, fn: (err: Err<E>) => T): T {
+	return result.ok ? result.value : fn(result);
+}
+
+export function tryCatchResult<T, E>(fn: () => T, err: (e: unknown) => Err<E>): Result<T, E> {
+	try {
+		return ok(fn());
+	} catch (e) {
+		return err(e);
+	}
+}
+
+export async function tryCatchResultAsync<T, E>(
+	fn: () => Promise<T>,
+	err: (e: unknown) => Err<E>
+): Promise<Result<T, E>> {
+	try {
+		return ok(await fn());
+	} catch (e) {
+		return err(e);
+	}
+}
+
+type ChainAnd<T, E> = (other: Result<T, E>) => Chain<T, E>;
+type ChainAndThen<I, E> = <O>(fn: (value: I) => Result<O, E>) => Chain<O, E>;
+type ChainMap<I, E> = <O>(fn: (value: I) => O) => Chain<O, E>;
+type ChainMapErr<T, E> = <F>(fn: (err: Err<E>) => Err<F>) => Chain<T, F>;
+type ChainMapOr<I> = <R>(defaultValue: R, fn: (value: I) => R) => R;
+type ChainMapOrElse<I, E> = <R>(defaultValue: (err: Err<E>) => R, fn: (value: I) => R) => R;
+type ChainOr<T, E> = (other: Result<T, E>) => Chain<T, E>;
+type ChainOrElse<T, E> = (fn: (err: Err<E>) => Result<T, E>) => Chain<T, E>;
+type ChainUnwrap<T> = () => T;
+type ChainUnwrapOr<T> = (defaultValue: T) => T;
+type ChainUnwrapOrElse<T, E> = (fn: (err: Err<E>) => T) => T;
+type ChainExpect<T> = (msg: string) => T;
+type ChainExpectErr<E> = (msg: string) => Err<E>;
+type ChainUnwrapErr<E> = () => Err<E>;
+type ChainFlatten<T, E> = () => Chain<T, E>;
+type ChainInspect<T, E> = (fn: (value: T) => void) => Chain<T, E>;
+type ChainInspectErr<T, E> = (fn: (err: Err<E>) => void) => Chain<T, E>;
+type ChainIsOk<T, E> = () => boolean & { __phantom?: [T, E] };
+type ChainIsErr<T, E> = () => boolean & { __phantom?: [T, E] };
+type ChainIsOkAnd<T> = (fn: (value: T) => boolean) => boolean;
+type ChainIsErrAnd<E> = (fn: (err: Err<E>) => boolean) => boolean;
+type ChainOk<T> = () => T | null;
+type ChainErr<E> = () => Err<E> | null;
+
+type Chain<T, E> = {
+	result: Result<T, E>;
+	and: ChainAnd<T, E>;
+	andThen: ChainAndThen<T, E>;
+	map: ChainMap<T, E>;
+	mapErr: ChainMapErr<T, E>;
+	mapOr: ChainMapOr<T>;
+	mapOrElse: ChainMapOrElse<T, E>;
+	or: ChainOr<T, E>;
+	orElse: ChainOrElse<T, E>;
+	unwrap: ChainUnwrap<T>;
+	unwrapOr: ChainUnwrapOr<T>;
+	unwrapOrElse: ChainUnwrapOrElse<T, E>;
+	expect: ChainExpect<T>;
+	expectErr: ChainExpectErr<E>;
+	unwrapErr: ChainUnwrapErr<E>;
+	flatten: T extends Result<infer U, E> ? ChainFlatten<U, E> : never;
+	inspect: ChainInspect<T, E>;
+	inspectErr: ChainInspectErr<T, E>;
+	isOk: ChainIsOk<T, E>;
+	isErr: ChainIsErr<T, E>;
+	isOkAnd: ChainIsOkAnd<T>;
+	isErrAnd: ChainIsErrAnd<E>;
+	ok: ChainOk<T>;
+	err: ChainErr<E>;
+};
+
+export function chain<I, E>(initial: Result<I, E>): Chain<I, E> {
+	return {
+		result: initial,
+		and: (other) => chain(resultAnd(initial, other)),
+		andThen: (fn) => chain(resultAndThen(initial, fn)),
+		map: <O>(fn: (value: I) => O) => chain(resultMap(initial, fn)),
+		mapErr: <F>(fn: (err: Err<E>) => Err<F>) => chain(resultMapErr(initial, fn)),
+		mapOr: <R>(defaultValue: R, fn: (value: I) => R) => resultMapOr(initial, defaultValue, fn),
+		mapOrElse: <R>(defaultValue: (err: Err<E>) => R, fn: (value: I) => R) =>
+			resultMapOrElse(initial, defaultValue, fn),
+		or: (other) => chain(resultOr(initial, other)),
+		orElse: (fn) => chain(resultOrElse(initial, fn)),
+		unwrap: () => resultUnwrap(initial),
+		unwrapOr: (defaultValue) => resultUnwrapOr(initial, defaultValue),
+		unwrapOrElse: (fn) => resultUnwrapOrElse(initial, fn),
+		expect: (msg) => resultExpect(initial, msg),
+		expectErr: (msg) => resultExpectErr(initial, msg),
+		unwrapErr: () => resultUnwrapErr(initial),
+		flatten: (() => chain(resultFlatten(initial as any))) as any,
+		inspect: (fn) => chain(resultInspect(initial, fn)),
+		inspectErr: (fn) => chain(resultInspectErr(initial, fn)),
+		isOk: () => resultIsOk(initial),
+		isErr: () => resultIsErr(initial),
+		isOkAnd: (fn) => resultIsOkAnd(initial, fn),
+		isErrAnd: (fn) => resultIsErrAnd(initial, fn),
+		ok: () => resultOk(initial),
+		err: () => resultErr(initial),
+	};
+}

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@iahuang/result-ts",
+    "version": "1.0.0",
+    "description": "A Typescript implementation of Rust's [`std::result::Result`](https://doc.rust-lang.org/std/result/enum.Result.html) enum type. Make errors in fallible subroutines predictable and impossible to ignore.",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "tsc"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/iahuang/result-ts.git"
+    },
+    "author": "",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/iahuang/result-ts/issues"
+    },
+    "homepage": "https://github.com/iahuang/result-ts#readme"
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "ESNext",
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "lib": ["ESNext"],
+        "outDir": "./dist",
+        "declaration": true,
+        "declarationMap": true,
+        "sourceMap": true,
+        "declarationDir": "./dist"
+    },
+    "$schema": "https://www.schemastore.org/tsconfig",
+    "include": ["index.ts"],
+    "exclude": ["node_modules", "dist"]
+}