@lodestar/utils 1.6.0-dev.b00d84f2a5 → 1.6.0-dev.e98d8e9fad

package/lib/err.d.ts

@@ -0,0 +1,34 @@
+declare const symErr: unique symbol;
+export type Err<T> = {
+    [symErr]: true;
+    error: T;
+};
+export type Result<T, E> = T | Err<E>;
+export declare function Err<T>(error: T): Err<T>;
+/**
+ * Typeguard for Err<T>. Allows the pattern
+ * ```ts
+ * function getNumSquare(): Result<number, Error> {
+ *   const value = getNum();
+ *   if (isErr(value)) {
+ *     return value; // return as error
+ *   }
+ *   return value ** 2;
+ * }
+ * function getNum(): Result<number, Error>
+ * ```
+ * Since the non-error is not wrapped, it uses a symbol to prevent collisions
+ */
+export declare function isErr<T, E>(result: Result<T, E>): result is Err<E>;
+/**
+ * Given an array of results, run a function only on an array of ok results.
+ * Returns a new array of results with same length as `results` where the ok
+ * value may be Err or T2.
+ */
+export declare function mapOkResults<T1, T2, E>(results: Result<T1, E>[], fn: (items: T1[]) => Result<T2, E>[]): Result<T2, E>[];
+/**
+ * See {@link mapOkResults} but `fn` is async
+ */
+export declare function mapOkResultsAsync<T1, T2, E>(results: Result<T1, E>[], fn: (items: T1[]) => Promise<Result<T2, E>[]>): Promise<Result<T2, E>[]>;
+export {};
+//# sourceMappingURL=err.d.ts.map

package/lib/err.js

@@ -0,0 +1,81 @@
+const symErr = Symbol("err");
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export function Err(error) {
+    return { [symErr]: true, error };
+}
+/**
+ * Typeguard for Err<T>. Allows the pattern
+ * ```ts
+ * function getNumSquare(): Result<number, Error> {
+ *   const value = getNum();
+ *   if (isErr(value)) {
+ *     return value; // return as error
+ *   }
+ *   return value ** 2;
+ * }
+ * function getNum(): Result<number, Error>
+ * ```
+ * Since the non-error is not wrapped, it uses a symbol to prevent collisions
+ */
+export function isErr(result) {
+    return result !== null && typeof result === "object" && result[symErr] === true;
+}
+/**
+ * Given an array of results, run a function only on an array of ok results.
+ * Returns a new array of results with same length as `results` where the ok
+ * value may be Err or T2.
+ */
+export function mapOkResults(results, fn) {
+    const oks = [];
+    for (let i = 0; i < results.length; i++) {
+        const result = results[i];
+        if (!isErr(result)) {
+            oks.push(result);
+        }
+    }
+    const outOksResults = fn(oks);
+    if (outOksResults.length !== oks.length) {
+        throw Error("mapOkResults fn must return same length");
+    }
+    const outResults = [];
+    for (let i = 0, j = 0; i < results.length; i++) {
+        const result = results[i];
+        if (isErr(result)) {
+            outResults.push(result);
+        }
+        else {
+            outResults.push(outOksResults[j]);
+            j++;
+        }
+    }
+    return outResults;
+}
+/**
+ * See {@link mapOkResults} but `fn` is async
+ */
+export async function mapOkResultsAsync(results, fn) {
+    const oks = [];
+    for (let i = 0; i < results.length; i++) {
+        const result = results[i];
+        if (!isErr(result)) {
+            oks.push(result);
+        }
+    }
+    const outOksResults = await fn(oks);
+    if (outOksResults.length !== oks.length) {
+        throw Error("mapOkResults fn must return same length");
+    }
+    const outResults = [];
+    for (let i = 0, j = 0; i < results.length; i++) {
+        const result = results[i];
+        if (isErr(result)) {
+            outResults.push(result);
+        }
+        else {
+            outResults.push(outOksResults[j]);
+            j++;
+        }
+    }
+    return outResults;
+}
+//# sourceMappingURL=err.js.map

package/lib/err.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"err.js","sourceRoot":"","sources":["../src/err.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAM7B,gEAAgE;AAChE,MAAM,UAAU,GAAG,CAAI,KAAQ;IAC7B,OAAO,EAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,KAAK,CAAO,MAAoB;IAC9C,OAAO,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAK,MAAiB,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAC9F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAwB,EACxB,EAAoC;IAEpC,MAAM,GAAG,GAAS,EAAE,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YAClB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClB;KACF;IAED,MAAM,aAAa,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,aAAa,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE;QACvC,MAAM,KAAK,CAAC,yCAAyC,CAAC,CAAC;KACxD;IAED,MAAM,UAAU,GAAoB,EAAE,CAAC;IAEvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE;YACjB,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACzB;aAAM;YACL,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC,EAAE,CAAC;SACL;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAwB,EACxB,EAA6C;IAE7C,MAAM,GAAG,GAAS,EAAE,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YAClB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClB;KACF;IAED,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,aAAa,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE;QACvC,MAAM,KAAK,CAAC,yCAAyC,CAAC,CAAC;KACxD;IAED,MAAM,UAAU,GAAoB,EAAE,CAAC;IAEvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE;YACjB,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACzB;aAAM;YACL,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC,EAAE,CAAC;SACL;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export * from "./logger/index.js";
 export * from "./yaml/index.js";
 export * from "./assert.js";
 export * from "./bytes.js";
+export * from "./err.js";
 export * from "./errors.js";
 export * from "./format.js";
 export * from "./map.js";

package/lib/index.js

@@ -2,6 +2,7 @@ export * from "./logger/index.js";
 export * from "./yaml/index.js";
 export * from "./assert.js";
 export * from "./bytes.js";
+export * from "./err.js";
 export * from "./errors.js";
 export * from "./format.js";
 export * from "./map.js";

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAe,MAAM,YAAY,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAmB,OAAO,EAAC,MAAM,YAAY,CAAC;AACrD,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAC,KAAK,EAAe,MAAM,YAAY,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAmB,OAAO,EAAC,MAAM,YAAY,CAAC;AACrD,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC"}

package/package.json

@@ -11,7 +11,7 @@
   "bugs": {
     "url": "https://github.com/ChainSafe/lodestar/issues"
   },
-  "version": "1.6.0-dev.b00d84f2a5",
+  "version": "1.6.0-dev.e98d8e9fad",
   "type": "module",
   "exports": "./lib/index.js",
   "files": [
@@ -57,5 +57,5 @@
     "beacon",
     "blockchain"
   ],
-  "gitHead": "179b142cb8b37681069ea08f6354fc828825fd11"
+  "gitHead": "ec526e04f77f4418f4a90d85639f1ed79ce5b8ea"
 }