v0.3.0

src/async-check.ts

@@ -0,0 +1,8 @@
+import Result from "./result";
+
+export default AsyncCheck;
+
+type AsyncCheck<I, O = I, A extends unknown[] = unknown[]> = (
+  value: I,
+  ...args: A
+) => Promise<Result<O>>;

src/chain-async.ts

@@ -0,0 +1,255 @@
+import AsyncCheck from "./async-check";
+import MaybeAsyncCheck from "./maybe-async-check";
+import ok from "./ok";
+
+export default function chainAsync<V1, A extends unknown[]>(): AsyncCheck<
+  V1,
+  V1,
+  A
+>;
+export default function chainAsync<V1, V2, A extends unknown[]>(
+  ...checks: [MaybeAsyncCheck<V1, V2, A>]
+): AsyncCheck<V1, V2, A>;
+export default function chainAsync<V1, V2, V3, A extends unknown[]>(
+  ...checks: [MaybeAsyncCheck<V1, V2, A>, MaybeAsyncCheck<V2, V3, A>]
+): AsyncCheck<V1, V3, A>;
+export default function chainAsync<V1, V2, V3, V4, A extends unknown[]>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+  ]
+): AsyncCheck<V1, V4, A>;
+export default function chainAsync<V1, V2, V3, V4, V5, A extends unknown[]>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+  ]
+): AsyncCheck<V1, V5, A>;
+export default function chainAsync<V1, V2, V3, V4, V5, V6, A extends unknown[]>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+  ]
+): AsyncCheck<V1, V6, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+  ]
+): AsyncCheck<V1, V7, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  V8,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+    MaybeAsyncCheck<V7, V8, A>,
+  ]
+): AsyncCheck<V1, V8, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  V8,
+  V9,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+    MaybeAsyncCheck<V7, V8, A>,
+    MaybeAsyncCheck<V8, V9, A>,
+  ]
+): AsyncCheck<V1, V9, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  V8,
+  V9,
+  V10,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+    MaybeAsyncCheck<V7, V8, A>,
+    MaybeAsyncCheck<V8, V9, A>,
+    MaybeAsyncCheck<V9, V10, A>,
+  ]
+): AsyncCheck<V1, V10, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  V8,
+  V9,
+  V10,
+  V11,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+    MaybeAsyncCheck<V7, V8, A>,
+    MaybeAsyncCheck<V8, V9, A>,
+    MaybeAsyncCheck<V9, V10, A>,
+    MaybeAsyncCheck<V10, V11, A>,
+  ]
+): AsyncCheck<V1, V11, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  V8,
+  V9,
+  V10,
+  V11,
+  V12,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+    MaybeAsyncCheck<V7, V8, A>,
+    MaybeAsyncCheck<V8, V9, A>,
+    MaybeAsyncCheck<V9, V10, A>,
+    MaybeAsyncCheck<V10, V11, A>,
+    MaybeAsyncCheck<V11, V12, A>,
+  ]
+): AsyncCheck<V1, V12, A>;
+export default function chainAsync<
+  V1,
+  V2,
+  V3,
+  V4,
+  V5,
+  V6,
+  V7,
+  V8,
+  V9,
+  V10,
+  V11,
+  V12,
+  V13,
+  A extends unknown[]
+>(
+  ...checks: [
+    MaybeAsyncCheck<V1, V2, A>,
+    MaybeAsyncCheck<V2, V3, A>,
+    MaybeAsyncCheck<V3, V4, A>,
+    MaybeAsyncCheck<V4, V5, A>,
+    MaybeAsyncCheck<V5, V6, A>,
+    MaybeAsyncCheck<V6, V7, A>,
+    MaybeAsyncCheck<V7, V8, A>,
+    MaybeAsyncCheck<V8, V9, A>,
+    MaybeAsyncCheck<V9, V10, A>,
+    MaybeAsyncCheck<V10, V11, A>,
+    MaybeAsyncCheck<V11, V12, A>,
+    MaybeAsyncCheck<V12, V13, A>,
+  ]
+): AsyncCheck<V1, V13, A>;
+
+/**
+ * Asynchronous version of [[`chain`]].
+ *
+ * ```js
+ * const check = chainAsync(
+ *   string(),
+ *   trim(),
+ *   testAsync(async value => value === "jerome"),
+ * );
+ *
+ * await check("  jerome   ");
+ * // => {
+ * //   isOk: true,
+ * //   value: "jerome",
+ * // }
+ *
+ * await check("john");
+ * // => { isOk: false, ... }
+ * ```
+ *
+ * @param checks The async check functions to chain together.
+ * @returns An async check function.
+ */
+export default function chainAsync<A extends unknown[]>(
+  ...checks: Array<MaybeAsyncCheck<any, any, A>>
+): AsyncCheck<any, any, A> {
+  return async (value, ...args) => {
+    for (const check of checks) {
+      const result = await check(value, ...args);
+
+      if (result.isOk) {
+        value = result.value;
+      } else {
+        return result;
+      }
+    }
+
+    return ok(value);
+  };
+}

src/entries-async.ts

@@ -0,0 +1,73 @@
+import AsyncCheck from "./async-check";
+import MaybeAsyncCheck from "./maybe-async-check";
+import ok from "./ok";
+
+/**
+ * Asynchronous version of [[`entries`]].
+ *
+ * ```js
+ * const check = entriesAsync(
+ *   pattern(/^[0-9]+$/),
+ *   chainAsync(
+ *     string(),
+ *     transformAsync(async value => value.trim()),
+ *   ),
+ * );
+ *
+ * await check({
+ *   1: " one  ",
+ *   2: "   two  "
+ * });
+ * // => {
+ * //   isOk: true,
+ * //   value: {
+ * //      1: "one",
+ * //      2: "two",
+ * //   },
+ * // }
+ *
+ * await check({ 1: 1 });
+ * // => { isOk: false, ... }
+ *
+ * await check({ one: "one" });
+ * // => { isOk: false, ... }
+ * ```
+ *
+ * @param checkKey The async check function to use on the keys.
+ * @param checkValue The async check function to use on the values.
+ * @returns An async check function.
+ */
+export default function entriesAsync<I, O, A extends unknown[]>(
+  checkKey: MaybeAsyncCheck<string, string, A>,
+  checkValue: MaybeAsyncCheck<I, O, A>,
+): AsyncCheck<{ [key: string]: I }, { [key: string]: O }, A> {
+  return async (input, ...args) => {
+    const keys = Object.keys(input);
+    const [keyResults, valueResults] = await Promise.all([
+      Promise.all(keys.map((key) => checkKey(key, ...args))),
+      Promise.all(keys.map((key) => checkValue(input[key], ...args))),
+    ]);
+    const output: { [key: string]: O } = {};
+
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const keyResult = keyResults[i];
+      const valueResult = valueResults[i];
+
+      if (keyResult.isOk) {
+        if (valueResult.isOk) {
+          output[keyResult.value] = valueResult.value;
+        } else {
+          return {
+            ...valueResult,
+            path: [key, ...valueResult.path],
+          };
+        }
+      } else {
+        return keyResult;
+      }
+    }
+
+    return ok(output);
+  };
+}

src/entries.ts

@@ -25,6 +25,10 @@ import ok from "./ok";
  * check({ one: "one" });
  * // => { isOk: false, ... }
  * ```
+ *
+ * @param checkKey The check function to use on the keys.
+ * @param checkValue The check function to use on the values.
+ * @returns A check function.
  */
 export default function entries<I, O, A extends unknown[]>(
   checkKey: Check<string, string, A>,