generic-result-type 1.0.0

package/LICENSE.txt

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 Dave Welsh
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# generic-result-type
+
+A small, dependency free Result type for TypeScript and JavaScript.
+
+It provides a simple way to represent success or failure values without throwing exceptions.
+
+## Installation
+
+```sh
+npm i generic-result-type
+```
+
+## Module support
+
+This package supports *both ESM and CommonJS* out of the box.
+
+ESM:
+
+```ts
+import { Result } from "generic-result-type"
+```
+
+CommonJS:
+
+```js
+const { Result } = require("generic-result-type");
+```
+
+TypeScript typings are included.
+
+## No dependencies
+
+This package has zero runtime dependencies.
+It does not rely on any external libraries.
+
+## License
+
+ISC

package/dist/index.cjs

@@ -0,0 +1,76 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.mts
+var index_exports = {};
+__export(index_exports, {
+  Result: () => Result,
+  isErrorResult: () => isErrorResult,
+  isSuccessResult: () => isSuccessResult
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/errorResult.mts
+var ErrorResult = class {
+  constructor(error) {
+    this.error = error;
+    this.success = false;
+  }
+};
+
+// src/successResult.mts
+var SuccessResult = class {
+  constructor(value) {
+    this.value = value;
+    this.success = true;
+  }
+};
+
+// src/result.mts
+var Result = class _Result {
+  static success(value) {
+    return new SuccessResult(value);
+  }
+  static fail(error) {
+    return new ErrorResult(error);
+  }
+  static combine(results) {
+    for (const result of results) {
+      if (!result.success) {
+        return result;
+      }
+    }
+    return _Result.success(void 0);
+  }
+};
+
+// src/index.mts
+var isSuccessResult = (result) => {
+  return result.success;
+};
+var isErrorResult = (result) => {
+  return !result.success;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Result,
+  isErrorResult,
+  isSuccessResult
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.mts","../src/errorResult.mts","../src/successResult.mts","../src/result.mts"],"sourcesContent":["import type { IErrorResult } from './errorResult.mjs';\nimport type { ISuccessResult } from './successResult.mjs';\n\nexport { Result } from './result.mjs';\nexport type { ISuccessResult };\nexport type { IErrorResult };\n\nexport type ResultType<T> = ISuccessResult<T> | IErrorResult;\n\n// eslint-disable-next-line @stylistic/comma-dangle\nexport const isSuccessResult = <T,>(result: ResultType<T>): result is ISuccessResult<T> => {\n  return result.success;\n};\n\n// eslint-disable-next-line @stylistic/comma-dangle\nexport const isErrorResult = <T,>(result: ResultType<T>): result is IErrorResult => {\n  return !result.success;\n};\n","export interface IErrorResult {\n  readonly success: false;\n  readonly error: Error;\n}\n\nexport class ErrorResult implements IErrorResult {\n  public readonly success = false as const;\n\n  public constructor(public readonly error: Error) { /* empty */ }\n}\n","export interface ISuccessResult<T> {\n  readonly success: true;\n  readonly value: T;\n}\n\nexport class SuccessResult<T> implements ISuccessResult<T> {\n  public readonly success = true as const;\n\n  public constructor(public readonly value: T) { /* empty */ }\n}\n","import type { IErrorResult } from './errorResult.mjs';\nimport { ErrorResult } from './errorResult.mjs';\nimport type { ResultType } from './index.mjs';\nimport type { ISuccessResult } from './successResult.mjs';\nimport { SuccessResult } from './successResult.mjs';\n\n// eslint-disable-next-line @typescript-eslint/no-extraneous-class\nexport abstract class Result {\n\n  public static success<T>(value: T): ISuccessResult<T> {\n    return new SuccessResult(value);\n  }\n\n  public static fail(error: Error): IErrorResult {\n    return new ErrorResult(error);\n  }\n\n  public static combine<T>(results: ResultType<T>[]): ResultType<T | undefined> {\n    for (const result of results) {\n      if (!result.success) {\n        return result;\n      }\n    }\n    return Result.success<undefined>(undefined);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,cAAN,MAA0C;AAAA,EAGxC,YAA4B,OAAc;AAAd;AAFnC,SAAgB,UAAU;AAAA,EAEqC;AACjE;;;ACJO,IAAM,gBAAN,MAAoD;AAAA,EAGlD,YAA4B,OAAU;AAAV;AAFnC,SAAgB,UAAU;AAAA,EAEiC;AAC7D;;;ACFO,IAAe,SAAf,MAAe,QAAO;AAAA,EAE3B,OAAc,QAAW,OAA6B;AACpD,WAAO,IAAI,cAAc,KAAK;AAAA,EAChC;AAAA,EAEA,OAAc,KAAK,OAA4B;AAC7C,WAAO,IAAI,YAAY,KAAK;AAAA,EAC9B;AAAA,EAEA,OAAc,QAAW,SAAqD;AAC5E,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAO,SAAS;AACnB,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO,QAAO,QAAmB,MAAS;AAAA,EAC5C;AACF;;;AHfO,IAAM,kBAAkB,CAAK,WAAuD;AACzF,SAAO,OAAO;AAChB;AAGO,IAAM,gBAAgB,CAAK,WAAkD;AAClF,SAAO,CAAC,OAAO;AACjB;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,21 @@
+interface IErrorResult {
+    readonly success: false;
+    readonly error: Error;
+}
+
+interface ISuccessResult<T> {
+    readonly success: true;
+    readonly value: T;
+}
+
+declare abstract class Result {
+    static success<T>(value: T): ISuccessResult<T>;
+    static fail(error: Error): IErrorResult;
+    static combine<T>(results: ResultType<T>[]): ResultType<T | undefined>;
+}
+
+type ResultType<T> = ISuccessResult<T> | IErrorResult;
+declare const isSuccessResult: <T>(result: ResultType<T>) => result is ISuccessResult<T>;
+declare const isErrorResult: <T>(result: ResultType<T>) => result is IErrorResult;
+
+export { type IErrorResult, type ISuccessResult, Result, type ResultType, isErrorResult, isSuccessResult };

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+interface IErrorResult {
+    readonly success: false;
+    readonly error: Error;
+}
+
+interface ISuccessResult<T> {
+    readonly success: true;
+    readonly value: T;
+}
+
+declare abstract class Result {
+    static success<T>(value: T): ISuccessResult<T>;
+    static fail(error: Error): IErrorResult;
+    static combine<T>(results: ResultType<T>[]): ResultType<T | undefined>;
+}
+
+type ResultType<T> = ISuccessResult<T> | IErrorResult;
+declare const isSuccessResult: <T>(result: ResultType<T>) => result is ISuccessResult<T>;
+declare const isErrorResult: <T>(result: ResultType<T>) => result is IErrorResult;
+
+export { type IErrorResult, type ISuccessResult, Result, type ResultType, isErrorResult, isSuccessResult };

package/dist/index.js

@@ -0,0 +1,47 @@
+// src/errorResult.mts
+var ErrorResult = class {
+  constructor(error) {
+    this.error = error;
+    this.success = false;
+  }
+};
+
+// src/successResult.mts
+var SuccessResult = class {
+  constructor(value) {
+    this.value = value;
+    this.success = true;
+  }
+};
+
+// src/result.mts
+var Result = class _Result {
+  static success(value) {
+    return new SuccessResult(value);
+  }
+  static fail(error) {
+    return new ErrorResult(error);
+  }
+  static combine(results) {
+    for (const result of results) {
+      if (!result.success) {
+        return result;
+      }
+    }
+    return _Result.success(void 0);
+  }
+};
+
+// src/index.mts
+var isSuccessResult = (result) => {
+  return result.success;
+};
+var isErrorResult = (result) => {
+  return !result.success;
+};
+export {
+  Result,
+  isErrorResult,
+  isSuccessResult
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errorResult.mts","../src/successResult.mts","../src/result.mts","../src/index.mts"],"sourcesContent":["export interface IErrorResult {\n  readonly success: false;\n  readonly error: Error;\n}\n\nexport class ErrorResult implements IErrorResult {\n  public readonly success = false as const;\n\n  public constructor(public readonly error: Error) { /* empty */ }\n}\n","export interface ISuccessResult<T> {\n  readonly success: true;\n  readonly value: T;\n}\n\nexport class SuccessResult<T> implements ISuccessResult<T> {\n  public readonly success = true as const;\n\n  public constructor(public readonly value: T) { /* empty */ }\n}\n","import type { IErrorResult } from './errorResult.mjs';\nimport { ErrorResult } from './errorResult.mjs';\nimport type { ResultType } from './index.mjs';\nimport type { ISuccessResult } from './successResult.mjs';\nimport { SuccessResult } from './successResult.mjs';\n\n// eslint-disable-next-line @typescript-eslint/no-extraneous-class\nexport abstract class Result {\n\n  public static success<T>(value: T): ISuccessResult<T> {\n    return new SuccessResult(value);\n  }\n\n  public static fail(error: Error): IErrorResult {\n    return new ErrorResult(error);\n  }\n\n  public static combine<T>(results: ResultType<T>[]): ResultType<T | undefined> {\n    for (const result of results) {\n      if (!result.success) {\n        return result;\n      }\n    }\n    return Result.success<undefined>(undefined);\n  }\n}\n","import type { IErrorResult } from './errorResult.mjs';\nimport type { ISuccessResult } from './successResult.mjs';\n\nexport { Result } from './result.mjs';\nexport type { ISuccessResult };\nexport type { IErrorResult };\n\nexport type ResultType<T> = ISuccessResult<T> | IErrorResult;\n\n// eslint-disable-next-line @stylistic/comma-dangle\nexport const isSuccessResult = <T,>(result: ResultType<T>): result is ISuccessResult<T> => {\n  return result.success;\n};\n\n// eslint-disable-next-line @stylistic/comma-dangle\nexport const isErrorResult = <T,>(result: ResultType<T>): result is IErrorResult => {\n  return !result.success;\n};\n"],"mappings":";AAKO,IAAM,cAAN,MAA0C;AAAA,EAGxC,YAA4B,OAAc;AAAd;AAFnC,SAAgB,UAAU;AAAA,EAEqC;AACjE;;;ACJO,IAAM,gBAAN,MAAoD;AAAA,EAGlD,YAA4B,OAAU;AAAV;AAFnC,SAAgB,UAAU;AAAA,EAEiC;AAC7D;;;ACFO,IAAe,SAAf,MAAe,QAAO;AAAA,EAE3B,OAAc,QAAW,OAA6B;AACpD,WAAO,IAAI,cAAc,KAAK;AAAA,EAChC;AAAA,EAEA,OAAc,KAAK,OAA4B;AAC7C,WAAO,IAAI,YAAY,KAAK;AAAA,EAC9B;AAAA,EAEA,OAAc,QAAW,SAAqD;AAC5E,eAAW,UAAU,SAAS;AAC5B,UAAI,CAAC,OAAO,SAAS;AACnB,eAAO;AAAA,MACT;AAAA,IACF;AACA,WAAO,QAAO,QAAmB,MAAS;AAAA,EAC5C;AACF;;;ACfO,IAAM,kBAAkB,CAAK,WAAuD;AACzF,SAAO,OAAO;AAChB;AAGO,IAAM,gBAAgB,CAAK,WAAkD;AAClF,SAAO,CAAC,OAAO;AACjB;","names":[]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "generic-result-type",
+  "version": "1.0.0",
+  "description": "A generic result wrapper",
+  "license": "ISC",
+  "author": "Dave Welsh",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/move-zig/generic-result-type.git"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit",
+    "test": "jest --verbose",
+    "test:watch": "jest --verbose --watch",
+    "lint": "eslint src"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^2.0.0",
+    "@eslint/js": "^9.39.2",
+    "@faker-js/faker": "^10.2.0",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@swc/core": "^1.15.8",
+    "@swc/jest": "^0.2.39",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.10.4",
+    "eslint": "^9.39.2",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.12.1",
+    "jest": "^30.2.0",
+    "jiti": "^2.6.1",
+    "tsup": "^8.5.1",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.52.0"
+  }
+}