本文へ移動
Senri
API リファレンス

@senrijs/senri

@senrijs/senri。アプリ、ルート、Context、エラー、バリデーション、標準のミドルウェア

アプリ、ルート、Context、エラー、バリデーション、標準のミドルウェア。

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

関数とクラス

名前すること
createApp(options?)アプリを作る
createRouter(prefix)前置きの付いたルートのまとまりを作る
defineRoutes(table)型の付いたルートの表を作る
endpoint(options, handler)スキーマやミドルウェアの付いたルートを作る
mergeRoutes(...tables)ルートの表を合わせる
Contextハンドラーとミドルウェアが受け取る c
HttpErrorstatus とメッセージを持つエラー
ValidationErrorスキーマに通らなかったときのエラー
logger()・showRoutes()ログ、ルートの一覧
health()/healthz・/readyz
cors()CORS
csrf()CSRF
secureHeaders()セキュリティヘッダー
basicAuth()・bearerAuth()Basic 認証・Bearer 認証
rateLimit()レート制限
ipRestriction()IP の制限
bodyLimit()本文の大きさの上限
uploadLimit()・safeFileName()アップロードの上限、安全なファイル名
timeout()タイムアウト
compress()圧縮
etag()ETag
cache()Cache-Control
prettyJSON()JSON の整形
requestId()リクエスト ID
trailingSlash()末尾のスラッシュ
methodOverride(app)メソッドの上書き
languageDetector()言語の判定

型

AppOptions

名前

型

主な型: App・Handler・Middleware・HandlerResult・RouteTable・TypedResponse・StandardSchemaV1・InferInput・InferOutput。ミドルウェアのオプションの型は、それぞれのページにあります。

ソース: src/index.ts

このページの内容