@madkarma/result 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 madkarmaa
+
+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,63 @@
+# @madkarma/result
+
+Rust's Result type, for TypeScript.
+
+## Installation
+
+```bash
+npm install @madkarma/result
+# or
+bun add @madkarma/result
+# or
+pnpm add @madkarma/result
+# or
+yarn add @madkarma/result
+```
+
+## Usage
+
+```typescript
+import { Ok, Err } from '@madkarma/result';
+
+const getUser = (id: number) => {
+    if (typeof id !== 'number')
+        return Err({ code: 'NOT_A_NUMBER', message: 'ID must be a number' });
+
+    if (id < 0)
+        return Err({ code: 'INVALID_ID', message: 'ID must be positive' });
+
+    if (id === 0) return Err({ code: 'NOT_FOUND', message: 'User not found' });
+
+    return Ok({ id, name: 'Alice' });
+};
+
+const [user, error] = getUser(10);
+
+if (error)
+    switch (error.code) {
+        case 'NOT_A_NUMBER':
+            console.error(error.message);
+            break;
+        case 'INVALID_ID':
+            console.error(error.message);
+            break;
+        case 'NOT_FOUND':
+            console.error(error.message);
+            break;
+    }
+else console.log(`Hello, ${user.name}!`);
+```
+
+### How this differs from Rust
+
+Instead of Rust's `match` expressions, check `[value, error]` directly and use a JavaScript `switch` on `error.code` to emulate pattern matching.
+
+This library is essentially a type-safe helper for TypeScript developers. It does **not** include any of the chainable methods found in the actual Rust `Result` type. Its sole purpose is to enforce explicit error handling through control flow.
+
+## Contributing
+
+Contributions are welcome! Feel free to [open an issue](https://github.com/madkarmaa/result-ts/issues/new) or submit a pull request if you'd like to improve the library or fix any bugs.
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,58 @@
+/**
+ * `Result<T, E>` is the type used for returning and propagating errors.
+ *
+ * It is a type with the parameters, `Ok(T)`, representing success and containing a value,
+ * and `Err(E)`, representing error and containing an error value.
+ *
+ * Functions return `Result` whenever errors are expected and recoverable.
+ *
+ * The error type `E` must be an object that contains a `code` property of type `string`.
+ *
+ * @example
+ * ```typescript
+ * const divide = (a: number, b: number) => {
+ *   if (b === 0) return Err({ code: 'DIVIDE_BY_ZERO' });
+ *   return Ok(a / b);
+ * }
+ *
+ * const [value, error] = divide(10, 2);
+ * if (error) console.error(error.code);
+ * else console.log(value);
+ * ```
+ *
+ * @see https://www.youtube.com/watch?v=ovnyeq-Xxrc
+ * @template T - Contains the success value.
+ * @template E - Contains the error value. Must have a `code` property of type `string`.
+ */
+export type Result<T, E extends {
+    code: string;
+}> = [T, null] | [null, E];
+/**
+ * Contains the success value.
+ *
+ * @example
+ * ```typescript
+ * const result = Ok(42);
+ * ```
+ *
+ * @see https://www.youtube.com/watch?v=ovnyeq-Xxrc
+ * @param value - The value to wrap in a successful result.
+ * @returns A `Result` representing a successful outcome.
+ */
+export declare const Ok: <T>(value: T) => Result<T, never>;
+/**
+ * Contains the error value.
+ *
+ * @example
+ * ```typescript
+ * const result = Err({ code: 'NOT_FOUND' });
+ * ```
+ *
+ * @see https://www.youtube.com/watch?v=ovnyeq-Xxrc
+ * @param error - The error to wrap in a failed result. Must have a `code` property of type `string`.
+ * @returns A `Result` representing a failed outcome.
+ */
+export declare const Err: <const C extends string, E extends {
+    code: C;
+}>(error: E) => Result<never, E>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAE1E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,KAAK,CAAkB,CAAC;AAEnE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,GAAG,GAAI,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,EAC7D,OAAO,CAAC,KACT,MAAM,CAAC,KAAK,EAAE,CAAC,CAOjB,CAAC"}

package/dist/index.js

@@ -0,0 +1,31 @@
+/**
+ * Contains the success value.
+ *
+ * @example
+ * ```typescript
+ * const result = Ok(42);
+ * ```
+ *
+ * @see https://www.youtube.com/watch?v=ovnyeq-Xxrc
+ * @param value - The value to wrap in a successful result.
+ * @returns A `Result` representing a successful outcome.
+ */
+export const Ok = (value) => [value, null];
+/**
+ * Contains the error value.
+ *
+ * @example
+ * ```typescript
+ * const result = Err({ code: 'NOT_FOUND' });
+ * ```
+ *
+ * @see https://www.youtube.com/watch?v=ovnyeq-Xxrc
+ * @param error - The error to wrap in a failed result. Must have a `code` property of type `string`.
+ * @returns A `Result` representing a failed outcome.
+ */
+export const Err = (error) => {
+    if (typeof error.code !== 'string')
+        throw new TypeError('Error object must have a code property of type string');
+    return [null, error];
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA4BA;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,EAAE,GAAG,CAAI,KAAQ,EAAoB,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAEnE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CACf,KAAQ,EACQ,EAAE;IAClB,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,MAAM,IAAI,SAAS,CACf,uDAAuD,CAC1D,CAAC;IAEN,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACzB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "@madkarma/result",
+    "version": "0.0.1",
+    "description": "Rust's Result type, for TypeScript",
+    "devDependencies": {
+        "prettier": "3.8.3"
+    },
+    "peerDependencies": {
+        "typescript": "^6.0.3"
+    },
+    "type": "module",
+    "exports": {
+        ".": {
+            "default": "./index.js",
+            "types": "./index.d.ts"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "dev": "tsc --watch",
+        "format": "prettier --write --ignore-unknown .",
+        "tags": "git push origin --tags && git push",
+        "patch": "bun pm version patch && bun run tags",
+        "minor": "bun pm version minor && bun run tags",
+        "major": "bun pm version major && bun run tags",
+        "postinstall": "git config core.hooksPath .githooks"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/madkarmaa/result-ts.git"
+    },
+    "license": "MIT"
+}