型付きクライアント
@senrijs/senri/client で、ルートの表の型からクライアントを作る
ルートの表の型(typeof routes)をクライアントに渡すと、パス・パラメーター・クエリ・本文・レスポンスに型が付きます。サーバーのコードは型だけを読むので、クライアントのバンドルには入りません。
import { } from "@senrijs/senri/client";
import type { } from "./routes.ts";
const = <>("https://example.com", {
: () => ({ : `Bearer ${()}` }), // 関数なら、呼ぶたびに読む
});
const = await ("GET /users/:id", { : { : "1" } });
if (.) {
.data;} else if (. === 404) {
.error;}
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() が便利です。
オプション
名前
型