本文へ移動
senri

部品の見本

ドキュメントで使える部品の動作確認用のページ(中身を書く PR で消すか隠す)

型のヒント(Twoslash)

コードブロックに twoslash を付けると、識別子にカーソルを合わせたときに型が出ます。@senrijs/senri の型は、リポジトリの src から読んでいます。

import {  } from "@senrijs/senri";

const  = ();
.("/users/:id", ({ id }) => `user ${}`);
id: string
import {  } from "@senrijs/senri";
import {  } from "@senrijs/senri/multipart";

const  = ();
.("/upload", async (, ) => {
    for await (const  of (, { : 100 * 1024 * 1024 })) {
        .filename;
filename: string | undefined

The file name as the client sent it, or undefined for a field. Browsers send "" (with an empty body) for a file input where no file was chosen. It can be anything, including ../../etc/passwd: do not build a path from it. Choose your own name, such as crypto.randomUUID(), or use safeFileName().

} return "ok"; });

オプションの表(AutoTypeTable)

multipart() の MultipartLimits の型から作った表です。説明は src/multipart.ts の JSDoc(英語)から取っています。

名前

型

インストールのコマンド

npm i @senrijs/senri
npm create senri@latest

図(Mermaid)

ファイルの木

index.ts
package.json
tsconfig.json

ステップ

インストールする

npm i @senrijs/senri

ルートを書く

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

const app = createApp();
app.get("/", () => "こんにちは");

export default app;

起動する

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

await serve(app);

注意書き

ヒント

ふつうの注意書きです。

注意

気をつけてほしいことを書きます。

危険

やってはいけないことを書きます。

タブ

bun run index.ts

このページの内容