@k8ordo/router

パスの型検査

リンクのパターンやparamの書き間違いを、型エラーにできるようになります。ルート表から作った型は、自分のコードでも使えます。

このページの内容

paramの検査

ts
href('/products/:id', { id: '42' });
href('/products/:id');
idが無いので型エラーになる
href('/products/:id', { productId: '42' });
productIdはパターンに無いので型エラーになる

hrefとnavigateTo、useParamsは、渡したパターンの文字列からparamの型を作ります。何も設定しなくても、paramの渡し忘れや名前の書き間違いは型エラーになります。

ルート表の登録

src/k8ordo-router.d.ts
import type { routes } from './routes';

declare module '@k8ordo/router' {
  interface Register {
    routes: typeof routes;
  }
}
ts
href('/products/:id', { id: '42' });
href('/prodcuts/:id', { id: '42' });
表に無いパターンなので型エラーになる

何も設定しないと、/で始まる文字列ならどのパターンも通ります。ルート表をRegisterに登録すると、表に無いパターンも型エラーになります。

登録したあとに受け付けるパターンは、次のとおりです。

  • href、navigateTo:リンク先にできるパターン
  • useParams:表のパターン
  • useMatch、matchPath:表のパターンと、その後ろに/*を付けたもの

登録はアプリの中で1度だけ行います。ライブラリで登録すると、そのライブラリを使うすべてのアプリがその表で検査されてしまいます。

@k8ordo/stateのRegisterにも同じroutes: typeof routesを書くと、そのhrefに渡すパスがこのルート表で検査されます。書き方は@k8ordo/stateのリンクを見てください。

情報

メモ

@k8ordo/frameworkでは、この登録が.k8ordo/register.gen.tsに生成されます。自分では書きません。生成されるファイルはルーティングを見てください。

ルート表から作る型

src/links.ts
import type { RegisteredNavigablePattern } from '@k8ordo/router';

export type SitePath = Exclude<
  Extract<RegisteredNavigablePattern, `/:locale${string}`>,
  `/:locale${string}:${string}`
>;

上のSitePathは、このサイトで使っている型です。リンク先にできるパターンのうち、/:localeで始まり、ロケールのほかにparamを持たないものに絞っています。ナビゲーションのデータに書いたページが表に無ければ、型エラーになります。

登録した表から作られる型は、次の4つです。

  • RegisteredPattern:表のすべてのページのパターン(/*のパターンも含む)
  • RegisteredNavigablePattern:リンク先にできるパターン(/*を含むものを除く)
  • RegisteredParams<P>:パターンPへのリンクが受け取るparamの型
  • RegisteredPageParams<P>:パターンPのページが受け取るparamの型

登録の前は、はじめの2つは/で始まる任意の文字列になります。

情報

メモ

@k8ordo/frameworkでは、paramsSchemaを書いたページへのリンクとそのページは、paramをスキーマが作った型で扱います。詳しくはパラメータを見てください。

ts
import type { NavigablePath } from '@k8ordo/router';

type A = NavigablePath<typeof routes, '/products/42'>;
// '/products/42'
type B = NavigablePath<typeof routes, '/products/42/reviews'>;
// never
type C = NavigablePath<typeof routes, '/products/'>;
// never

NavigablePath<typeof routes, Path>は、パスがリンク先にできるパターンのどれかに合えばそのパスを返し、どれにも合わなければneverを返します。:idのようなparamの位置には、空でない1区間ならどれでも入ります。

末尾にスラッシュのあるパスは受け付けません。照合では/products/も/productsと同じページになりますが、リンクに書くパスは1通りの書き方にそろえます。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。