neverthrow と fetch と zod を組み合わせた非同期処理

import { Result, ok, err } from "neverthrow";

/**
 * 引数の target を numbers 配列のいずれかの値で除算する関数です。
 * もし 0 で除算しようとした場合は err() を返します。
 * 0 以外で除算する場合は ok() を返します。
 */
const divide = (target: number): Result<number, string> => {
  const numbers = [0, 1, 2];
  const index = Math.floor(Math.random() * numbers.length);

  if (numbers[index] === 0) return err("0で割ることはできません。");
  return ok(target / numbers[index]);
};

/**
 * isOk() は処理が成功したか（okを返したか）を判定します。
 */
const result = divide(10);
if (result.isOk()) {
  console.log(result.value); // 10 or 5
} else {
  console.log(result.error); // 0で割ることはできません。
}

import { Result, ok, err } from "neverthrow";

/**
 * neverthrow と fetch を組み合わせた関数です。
 * ジェネリクスの R は API のレスポンスの型。P はリクエストパラメータの型です。
 */
export const handleFetch = <R, P = unknown>({
  path,
  method = "GET",
  requestParams,
}: {
  path: string;
  method?: "GET" | "POST" | "PUT" | "DELETE";
  requestParams?: P;
}): Promise<Result<R, Error>> => {
  // リクエストパラメータの整備
  const params: RequestInit = {
    method,
  };
  if ((method === "POST" || method === "PUT") && requestParams) {
    params.body = JSON.stringify(requestParams);
  }

  // fetch の実行
  return fetch(path, params)
    .then((res) => {
      if (!res.ok) {
        // 通信に失敗した場合は例外を投げます
        // 最終的に、例外は catch 句にて err() でラップして返します
        throw new Error("サーバーとの通信に失敗しました");
      }

      return res.json();
    })
    .then((data: R) => {
      return ok(data);
    })
    .catch((error: Error) => {
      return err(error);
    });
};

import { handleFetch } from "./neverthrow_fetch";

type Todo = {
  id: number;
  userId: number;
  title: string;
  completed: boolean;
};

const run = async () => {
  const result = await handleFetch<Todo>({
    path: "https://jsonplaceholder.typicode.com/todos/1",
  });

  if (result.isOk()) {
    console.log(result.value); // { "userId": 1, "id": 1, "title": "title text", "completed": false }
  } else {
    console.log(result.error);
  }
};

run();

import { err, ok, fromPromise } from "neverthrow";
import { z, ZodError } from "zod";
import { handleFetch } from "./neverthrow_fetch";

type Todo = {
  id: number;
  userId: number;
  title: string;
  completed: boolean;
};

const run = (id: number) => {
  ok(z.number().min(1).max(100).safeParse(id))
    .andThen((id) => {
      // URL 末尾に入る id を zod で検証して、その結果を ok() か err() に振り分ける … (1)
      if (!id.success) return err(id.error);
      return ok(id.data);
    })
    .asyncAndThen((id) => {
      // 検証後の id を利用して API を実行する … (2)
      // fromPromise は Promise<Result<Todo, Error>> を ResultAsync として扱うため
      return fromPromise(
        handleFetch<Todo>({
          path: `https://jsonplaceholder.typicode.com/todos/${id}`,
        }),
        (error) => error
      );
    })
    .map((result) => {
      // 一連の処理が成功した場合 … (3)
      if (result.isOk()) {
        console.log(result.value);
      }
    })
    .mapErr((error) => {
      // エラーが発生した場合 … (4)
      if (error instanceof ZodError) {
        console.log("zod エラー", error);
      } else {
        console.log("API エラー", error);
      }
    });
};

run(1);