@mkvlrn/result 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mike Valeriano <mkvlrn@proton.me>
+
+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,43 @@
+# Result
+
+A lightweight, zero-dependency TypeScript utility for type-safe error handling using the Result pattern.
+
+## Installation
+
+```bash
+# Using yarn
+yarn add @mkvlrn/result
+```
+
+## Usage
+
+```ts
+import { Result } from "@mkvlrn/result";
+
+// Success case
+const success = Result.success(42);
+if (success.ok) {
+  console.log(success.value); // 42
+}
+
+// Error case
+const error = Result.error(new Error("Something went wrong"));
+if (!error.ok) {
+  console.log(error.error.message); // "Something went wrong"
+}
+
+// Custom error type
+type ValidationError = { field: string; message: string };
+const validationError = Result.error<ValidationError>({
+  field: "email",
+  message: "Invalid email format",
+});
+```
+
+## Features
+
+- Type-safe error handling
+- Zero dependencies
+- Simple API
+- Full TypeScript support
+- Tiny bundle size

package/build/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This module exports a Result type and helper functions that represent the outcome of an operation.
+ * @module
+ */
+/**
+ * Result type to represent the outcome of an operation.
+ * It can either be a success with a value or an error with an error message.
+ * This is a generic type that can be used with any type of value and error.
+ */
+export type Result<T, E = Error> = {
+    readonly ok: true;
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly error: E;
+};
+/**
+ * Helper functions to create Result objects.
+ */
+export declare const Result: {
+    success<T>(value: T): Result<T, never>;
+    error<E = Error>(error: E): Result<never, E>;
+};

package/build/index.js

@@ -0,0 +1,27 @@
+/**
+ * This module exports a Result type and helper functions that represent the outcome of an operation.
+ * @module
+ */
+/**
+ * Creates a successful Result with the given value.
+ * @param value The success value
+ * @returns A Result object representing success
+ */
+function success(value) {
+    return { ok: true, value: value };
+}
+/**
+ * Creates a successful Result with the given value.
+ * @param value The success value
+ * @returns A Result object representing success
+ */
+function error(error) {
+    return { ok: false, error: error };
+}
+/**
+ * Helper functions to create Result objects.
+ */
+export const Result = {
+    success: success,
+    error: error,
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@mkvlrn/result",
+  "version": "1.1.0",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "exports": {
+    "types": "./build/index.d.ts",
+    "default": "./build/index.js"
+  },
+  "files": [
+    "build"
+  ],
+  "scripts": {
+    "build": "rm -rf build && tsc"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.0.0-beta.1",
+    "typescript": "^5.8.2"
+  }
+}