@koerismo/result 0.9.1 → 0.9.2

package/README.md

@@ -1,35 +1,35 @@
-# Result
-A minimal Result interface for TypeScript in a 300-byte package.
-
-## Example
-
-```ts
-import { Ok, Err } from '@koerismo/result';
-
-// Or, use the globals:
-// import '@koerismo/result/global';
-
-
-// Define a sketchy function...
-function errorProneFunc(i: number) {
-	if (i <= 0.1)  return Err(-1);
-	else           return Ok(Math.round(i * 100));
-}
-
-// Throw a random number at it...
-const result = errorProneFunc(Math.random());
-
-
-// The result can be checked by accessing the "ok" property:
-if (result.ok)  console.log('Result is okay!');
-else            console.log('Result is error!');
-
-// But maybe the result is usable even with an error:
-console.log('Either Value:', result.value);
-
-// The value can be unwrapped with a fallback via .unwrapOr(...):
-console.log('Value or Fallback:', result.unwrapOr('john fallback'));
-
-// .unwrap() Throws (-1) if the function returned Err(-1).
-console.log('Correct Value:', result.unwrap());
-```
+# Result
+A minimal Result interface for TypeScript in a 300-byte package.
+
+## Example
+
+```ts
+import { Ok, Err } from '@koerismo/result';
+
+// Or, use the globals:
+// import '@koerismo/result/global';
+
+
+// Define a sketchy function...
+function errorProneFunc(i: number) {
+	if (i <= 0.1)  return Err(-1);
+	else           return Ok(Math.round(i * 100));
+}
+
+// Throw a random number at it...
+const result = errorProneFunc(Math.random());
+
+
+// The result can be checked by accessing the "ok" property:
+if (result.ok)  console.log('Result is okay!');
+else            console.log('Result is error!');
+
+// But maybe the result is usable even with an error:
+console.log('Either Value:', result.value);
+
+// The value can be unwrapped with a fallback via .unwrapOr(...):
+console.log('Value or Fallback:', result.unwrapOr('john fallback'));
+
+// .unwrap() Throws (-1) if the function returned Err(-1).
+console.log('Correct Value:', result.unwrap());
+```

package/package.json

@@ -1,27 +1,32 @@
 {
-  "name": "@koerismo/result",
-  "description": "A miniscule Result interface for TypeScript.",
-  "version": "0.9.1",
-  "author": "Koerismo",
-  "license": "MPL-2.0",
-  "type": "module",
-  "main": "dist/index.js",
-  "exports": {
-    ".": "./dist/index.js",
-    "./global": "./dist/global.js"
-  },
-  "keywords": [
-    "result",
-    "rust",
-    "maybe"
-  ],
-  "devDependencies": {
-    "esbuild": "^0.27.2",
-    "typescript": "^5.9.3"
-  },
-  "scripts": {
-    "build": "pnpm run build-code && pnpm run build-types",
-    "build-code": "esbuild ./src/* --minify --platform=neutral --sourcemap --sources-content=false --outdir=./dist/",
-    "build-types": "tsc"
-  }
-}
+	"name": "@koerismo/result",
+	"description": "A miniscule Result interface for TypeScript.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/koerismo/result-js.git"
+	},
+	"version": "0.9.2",
+	"author": "Koerismo",
+	"license": "MPL-2.0",
+	"type": "module",
+	"main": "dist/index.js",
+	"exports": {
+		".": "./dist/index.js",
+		"./global": "./dist/global.js"
+	},
+	"scripts": {
+		"build": "pnpm run build-code && pnpm run build-types",
+		"build-npm": "npm run build-code && npm run build-types",
+		"build-code": "esbuild ./src/* --minify --platform=neutral --sourcemap --sources-content=false --outdir=./dist/",
+		"build-types": "tsc"
+	},
+	"keywords": [
+		"result",
+		"rust",
+		"maybe"
+	],
+	"devDependencies": {
+		"esbuild": "^0.27.2",
+		"typescript": "^5.9.3"
+	}
+}

package/src/global.ts

@@ -1,9 +1,9 @@
-import { Ok as _Ok, Err as _Err } from './index.js';
-
-declare global {
-	var Ok: typeof _Ok;
-	var Err: typeof _Err;
-}
-
-globalThis.Ok = _Ok;
-globalThis.Err = _Err;
+import { Ok as _Ok, Err as _Err } from './index.js';
+
+declare global {
+	var Ok: typeof _Ok;
+	var Err: typeof _Err;
+}
+
+globalThis.Ok = _Ok;
+globalThis.Err = _Err;

package/src/index.ts

@@ -1,55 +1,55 @@
-/** Shorthand: Represents an ok {@link Result} result. */
-export type OkResult<T> = Result<T, any, true>;
-
-/** Shorthand: Represents an error {@link Result} result. */
-export type ErrResult<T> = Result<any, T, false>;
-
-/** Used to declare separate ok/error {@link Result} types. */
-export type ResultType<V, E = V> = Result<V, E, true> | Result<V, E, false>;
-
-/** Creates a new ok {@link Result} with the provided value. */
-export const Ok = <V>(value: V): OkResult<V> => {
-	return new Result(true, value);
-}
-
-/** Creates a new error {@link Result} with the provided value. */
-export const Err = <E>(error: E): ErrResult<E> => {
-	return new Result(false, error); 
-}
-
-/**
- * Represents a value and an associated `ok` value.
- * 
- * Use {@link ResultType} instead of this class when writing type annotations!
- */
-export class Result<V, E = V, O extends boolean = boolean> {
-	constructor(
-		public readonly ok: O,
-		public readonly value: O extends true ? V : E
-		) { }
-
-	/**
-	 * Returns this Result's value if `ok`. If not, the value of this Result is thrown.
-	 */
-	unwrap(): V | never {
-		if (this.ok) return this.value as V;
-		throw this.value;
-	}
-
-	/**
-	 * Returns this Result's value if `ok`. If not, `value` is returned.
-	*/
-	unwrapOr(): V | undefined;
-	unwrapOr<T>(value: T): V | T;
-	unwrapOr<T>(value?: T): V | T {
-		return this.ok ? this.value as V : value!;
-	}
-
-	/**
-	 * Returns this Result's value if `ok`. If not, `onError` is evaluated
-	 * with this Result's value as a parameter, and the result is returned.
-	 */
-	unwrapOrElse<T>(onError: (err: E) => T): V | T {
-		return this.ok ? this.value as V : onError(this.value as E);
-	}
-}
+/** Shorthand: Represents an ok {@link Result} result. */
+export type OkResult<T> = Result<T, any, true>;
+
+/** Shorthand: Represents an error {@link Result} result. */
+export type ErrResult<T> = Result<any, T, false>;
+
+/** Used to declare separate ok/error {@link Result} types. */
+export type ResultType<V, E = V> = Result<V, E, true> | Result<V, E, false>;
+
+/** Creates a new ok {@link Result} with the provided value. */
+export const Ok = <V>(value: V): OkResult<V> => {
+	return new Result(true, value);
+}
+
+/** Creates a new error {@link Result} with the provided value. */
+export const Err = <E>(error: E): ErrResult<E> => {
+	return new Result(false, error); 
+}
+
+/**
+ * Represents a value and an associated `ok` value.
+ * 
+ * Use {@link ResultType} instead of this class when writing type annotations!
+ */
+export class Result<V, E = V, O extends boolean = boolean> {
+	constructor(
+		public readonly ok: O,
+		public readonly value: O extends true ? V : E
+		) { }
+
+	/**
+	 * Returns this Result's value if `ok`. If not, the value of this Result is thrown.
+	 */
+	unwrap(): V | never {
+		if (this.ok) return this.value as V;
+		throw this.value;
+	}
+
+	/**
+	 * Returns this Result's value if `ok`. If not, `value` is returned.
+	*/
+	unwrapOr(): V | undefined;
+	unwrapOr<T>(value: T): V | T;
+	unwrapOr<T>(value?: T): V | T {
+		return this.ok ? this.value as V : value!;
+	}
+
+	/**
+	 * Returns this Result's value if `ok`. If not, `onError` is evaluated
+	 * with this Result's value as a parameter, and the result is returned.
+	 */
+	unwrapOrElse<T>(onError: (err: E) => T): V | T {
+		return this.ok ? this.value as V : onError(this.value as E);
+	}
+}