separates result creation into own factory class

Author: everweij

biome.json

@@ -15,7 +15,8 @@
 				"noExplicitAny": "off"
 			},
 			"complexity": {
-				"noBannedTypes": "off"
+				"noBannedTypes": "off",
+				"noStaticOnlyClass": "off"
 			},
 			"correctness": {
 				"useYield": "off"

package.json

@@ -1,8 +1,8 @@
 {
 	"private": false,
 	"name": "typescript-result",
-	"version": "3.4.0-beta.1",
-	"description": "A Result type inspired by Rust and Kotlin that leverages TypeScript's powerful type system to simplify error handling and make your code more readable and maintainable.",
+	"version": "3.4.0-beta.2",
+	"description": "Supercharge your TypeScript error handling with a powerful Result type that transforms chaotic try-catch blocks into elegant, type-safe code.",
 	"keywords": [
 		"result",
 		"type",
@@ -13,7 +13,9 @@
 		"exception",
 		"ok",
 		"success",
-		"failure"
+		"failure",
+		"Rust",
+		"functional programming"
 	],
 	"author": {
 		"name": "Erik Verweij",

readme.md

@@ -1421,7 +1421,7 @@ Creates a new result instance that represents a successful outcome.
 
 #### Example
 ```ts
-const result = Result.ok(42); // Result<number, never>
+const result = Result.ok(42); // Result.Ok<number>
 ```
 
 ### Result.error(error)
@@ -1436,7 +1436,7 @@ Creates a new result instance that represents a failed outcome.
 
 #### Example
 ```ts
-const result = Result.error(new NotFoundError()); // Result<never, NotFoundError>
+const result = Result.error(new NotFoundError()); // Result.Error<NotFoundError>
 ```
 
 ### Result.isResult(possibleResult)

src/index.ts

@@ -5,7 +5,8 @@ import {
 	type IfGeneratorAsync,
 	type InferGeneratorError,
 	type InferGeneratorReturn,
-	Result as ResultBase,
+	type Result as ResultBase,
+	ResultFactory,
 } from "./result.js";
 
 export { AsyncResult } from "./result.js";
@@ -36,38 +37,4 @@ export type Result<Value, Err> =
 	| ([Value] extends [never] ? never : Result.Ok<Value>)
 	| ([Err] extends [never] ? never : Result.Error<Err>);
 
-export const Result: {
-	ok: typeof ResultBase.ok;
-	error: typeof ResultBase.error;
-	assertOk: typeof ResultBase.assertOk;
-	assertError: typeof ResultBase.assertError;
-	isResult: typeof ResultBase.isResult;
-	isAsyncResult: typeof ResultBase.isAsyncResult;
-	all: typeof ResultBase.all;
-	allCatching: typeof ResultBase.allCatching;
-	wrap: typeof ResultBase.wrap;
-	try: typeof ResultBase.try;
-	fromAsync: typeof ResultBase.fromAsync;
-	fromAsyncCatching: typeof ResultBase.fromAsyncCatching;
-	gen: typeof ResultBase.gen;
-	genCatching: typeof ResultBase.genCatching;
-	[Symbol.hasInstance]: (instance: unknown) => boolean;
-} = {
-	ok: ResultBase.ok,
-	error: ResultBase.error,
-	isResult: ResultBase.isResult,
-	isAsyncResult: ResultBase.isAsyncResult,
-	all: ResultBase.all,
-	allCatching: ResultBase.allCatching,
-	wrap: ResultBase.wrap,
-	try: ResultBase.try,
-	fromAsync: ResultBase.fromAsync,
-	fromAsyncCatching: ResultBase.fromAsyncCatching,
-	gen: ResultBase.gen,
-	genCatching: ResultBase.genCatching,
-	assertOk: ResultBase.assertOk,
-	assertError: ResultBase.assertError,
-	[Symbol.hasInstance](instance: unknown) {
-		return instance instanceof ResultBase;
-	},
-};
+export const Result: typeof ResultFactory = ResultFactory;

src/integration.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from "vitest";
 import { assertUnreachable } from "./helpers.js";
-import { Result } from "./result.js";
+import { Result } from "./index.js";
 
 describe("User management app", () => {
 	let count = 0;