@reykjavik/webtools 0.2.2 → 0.2.3

package/CHANGELOG.md

@@ -4,6 +4,15 @@
 
 - ... <!-- Add new lines here. -->
 
+## 0.2.3
+
+_2025-03-31_
+
+- `@reykjavik/webtools/errorhandling`:
+  - feat: Add a `.mapTo(fn)` method to `ResultTupleObj`s
+  - fix: `Result.map` does not catch errors thrown by the mapping function
+  - docs: Fix minor error in README code example
+
 ## 0.2.2
 
 _2024-12-19_

package/README.md

@@ -34,6 +34,7 @@ bun add @reykjavik/webtools
   - [`Result` Singleton](#result-singleton)
   - [Type `ResultTuple`](#type-resulttuple)
   - [Type `ResultTupleObj`](#type-resulttupleobj)
+    - [Type `ResultTupleObj.mapTo`](#type-resulttupleobjmapto)
   - [`Result.catch`](#resultcatch)
   - [`Result.map`](#resultmap)
   - [`Result.Success`](#resultsuccess)
@@ -456,10 +457,12 @@ if (error) {
 Discriminated tuple type for a `[error, result]` pair (same as `ResultTuple`)
 but with named properties `error` and `result` attached for dev convenience.
 
+It also has a `.mapTo` method ([see below](#type-resulttupleobjmapto)).
+
 ```ts
-import { type ResultTuple } from '@reykjavik/webtools/errorhandling';
+import { type ResultTupleObj } from '@reykjavik/webtools/errorhandling';
 
-declare const myResult: ResultTuple<string, Error>;
+declare const myResult: ResultTupleObj<string, Error>;
 
 const [error, result] = myResult;
 // (One of these two is always `undefined`)
@@ -482,6 +485,39 @@ if (myResult.error) {
 }
 ```
 
+#### Type `ResultTupleObj.mapTo`
+
+**Syntax:**
+`ResultTupleObj.mapTo<T2, E>(mapResult: (resultValue: T) => T2): ResultTuple<T2, E>`
+
+This convenience method allows quick mapping of the `ResultTubleOBj`'s result
+value to a new type. The returned value is also a `ResultTubleOBj`.
+
+(Internally this method calls [`Result.map`](#resultmap).)
+
+```ts
+import { type ResultTuple } from '@reykjavik/webtools/errorhandling';
+
+declare const myResult: ResultTuple<string, Error>;
+
+const mappedResult: ResultTupleObj<number, Error> = myResult.mapTo(
+  (result: string) => result.length
+);
+
+if (mappedRes.error) {
+  console.error(myResult.error.message);
+} else {
+  // Here `myResult.result` is a number
+  console.log(myResult.result);
+}
+```
+
+If the original `ResultTupleObj` is in a failed state, the mapping function is
+not called.
+
+If the mapping function throws an error it gets caught and turned into a
+failed `ResultTupleObj`.
+
 ### `Result.catch`
 
 **Syntax:**

package/errorhandling.d.ts

@@ -23,10 +23,12 @@ export declare const asError: (maybeError: unknown) => ErrorFromPayload;
 type SuccessResult<T> = [error: undefined, result: T] & {
     error?: undefined;
     result: T;
+    mapTo: <T2, E extends Error = Error>(fn: (result: T) => T2) => ResultTupleObj<T2, E>;
 };
 type FailResult<E extends Error> = [error: E, result?: undefined] & {
     error: E;
     result?: undefined;
+    mapTo: () => FailResult<E>;
 };
 /**
  * Simple bare-bones discriminated tuple type for a [error, result] pair.

package/errorhandling.js

@@ -39,11 +39,15 @@ exports.asError = asError;
 const Success = (result) => {
     const tuple = [undefined, result];
     tuple.result = result;
+    tuple.mapTo = (fn) => 
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    map(tuple, fn);
     return tuple;
 };
 const Fail = (e) => {
     const tuple = [(0, exports.asError)(e)];
     tuple.error = tuple[0];
+    tuple.mapTo = () => tuple;
     return tuple;
 };
 function catch_(something) {
@@ -57,6 +61,13 @@ function catch_(something) {
         return Fail(e);
     }
 }
+const map = (result, mapFn) => {
+    const [error, resultValue] = result;
+    if (error) {
+        return Fail(error);
+    }
+    return catch_(() => mapFn(resultValue));
+};
 /**
  * Singleton object with small methods for creating, mapping or handling
  * `ResultTupleObj` instances.
@@ -90,7 +101,7 @@ exports.Result = {
         if (error) {
             return Fail(error);
         }
-        return Success(mapFn(resultValue));
+        return catch_(() => mapFn(resultValue));
     },
     /**
      * Unwraps a discriminated [error, result] `Result.Tuple`-like object

package/esm/errorhandling.d.ts

@@ -23,10 +23,12 @@ export declare const asError: (maybeError: unknown) => ErrorFromPayload;
 type SuccessResult<T> = [error: undefined, result: T] & {
     error?: undefined;
     result: T;
+    mapTo: <T2, E extends Error = Error>(fn: (result: T) => T2) => ResultTupleObj<T2, E>;
 };
 type FailResult<E extends Error> = [error: E, result?: undefined] & {
     error: E;
     result?: undefined;
+    mapTo: () => FailResult<E>;
 };
 /**
  * Simple bare-bones discriminated tuple type for a [error, result] pair.

package/esm/errorhandling.js

@@ -34,11 +34,15 @@ export const asError = (maybeError) => {
 const Success = (result) => {
     const tuple = [undefined, result];
     tuple.result = result;
+    tuple.mapTo = (fn) => 
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    map(tuple, fn);
     return tuple;
 };
 const Fail = (e) => {
     const tuple = [asError(e)];
     tuple.error = tuple[0];
+    tuple.mapTo = () => tuple;
     return tuple;
 };
 function catch_(something) {
@@ -52,6 +56,13 @@ function catch_(something) {
         return Fail(e);
     }
 }
+const map = (result, mapFn) => {
+    const [error, resultValue] = result;
+    if (error) {
+        return Fail(error);
+    }
+    return catch_(() => mapFn(resultValue));
+};
 /**
  * Singleton object with small methods for creating, mapping or handling
  * `ResultTupleObj` instances.
@@ -85,7 +96,7 @@ export const Result = {
         if (error) {
             return Fail(error);
         }
-        return Success(mapFn(resultValue));
+        return catch_(() => mapFn(resultValue));
     },
     /**
      * Unwraps a discriminated [error, result] `Result.Tuple`-like object

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@reykjavik/webtools",
-	"version": "0.2.2",
+	"version": "0.2.3",
 	"description": "Misc. JS/TS helpers used by Reykjavík City's web dev teams.",
 	"main": "index.js",
 	"repository": "ssh://git@github.com:reykjavikcity/webtools.git",