本文へ移動
Senri

型付きクライアント

@senrijs/senri/client で、ルートの表の型からクライアントを作る

ルートの表の型(typeof routes)をクライアントに渡すと、パス・パラメーター・クエリ・本文・レスポンスに型が付きます。サーバーのコードは型だけを読むので、クライアントのバンドルには入りません。

client.ts
import {  } from "@senrijs/senri/client";
import type {  } from "./routes.ts";

const  = <>("https://example.com", {
    : () => ({ : `Bearer ${()}` }),   // 関数なら、呼ぶたびに読む
});

const  = await ("GET /users/:id", { : { : "1" } });
if (.) {
    .data;
data: {
    id: string;
    name: string;
}
} else if (. === 404) { .error;
error: {
    message: string;
}
} await ("POST /users", { : { : "a" } }); // 本文はスキーマの入力の型

送るもの

  • 呼び方は、表のキーと同じ文字列です
  • params はエンコードしてパスに入れます
  • query は文字列にして付けます(配列は同じキーを繰り返します)
  • body は JSON で送ります。FormData・URLSearchParams・Blob・バイト列・ストリームはそのまま送ります

戻り値

{ ok, status, data, error, response } を返します。2xx でなくても例外にしません(ネットワークのエラーと、壊れた JSON だけ例外です)。

  • 本文は Content-Type で読み分けます。JSON は値に、text/* は文字列に、それ以外は Blob にします
  • data の型は、ハンドラーの戻り値を JSON にしたあとの形です(Date は string になります)。endpoint({ response }) のスキーマがあれば、そちらの出力の型です

status ごとの型

ハンドラーが c.json(body, status)・c.text(body, status) で status を書いて返すと、status ごとに型が分かれます。endpoint({ responses: { 404: schema } }) に書いたスキーマも同じです。

  • 2xx(c.json(body, 201) など)は、成功の data に入ります
  • status を書かない c.json(body) は、200 として扱います。c.status() で決めた status は、型には残りません
  • onError・ミドルウェア・notFound の応答は型に入らず、error は unknown です

サーバーを立てずに呼ぶ

fetch を差し替えられます。

import {  } from "@senrijs/senri/client";

const  = <typeof >("http://localhost", { : () => .() });

テストでは、Cookie なども扱える testClient() が便利です。

オプション

名前

型

このページの内容