tyoi-server

English

日本語

English

日本語

Appearance

@donneko/tyoi-server / Server

Class: Server<RequestNameList, WebSocketNameList> ​

Defined in: server-core/app/server.ts:18

HTTP API、WebSocket、静的ファイル配信を提供するサーバーです。

A server that provides HTTP APIs, WebSocket endpoints, and static file serving.

Type Parameters ​

RequestNameList ​

RequestNameList extends string = string

登録できる HTTP API キー（例: "GET:/health"）。 / HTTP API keys that can be registered, such as "GET:/health".

WebSocketNameList ​

WebSocketNameList extends string = string

登録できる WebSocket パス。 / WebSocket paths that can be registered.

Constructors ​

Constructor ​

new Server<RequestNameList, WebSocketNameList>(options): Server<RequestNameList, WebSocketNameList>

Defined in: server-core/app/server.ts:59

サーバーを作成し、ルーティングと静的ファイル配信を初期化します。

root は必須です。起動は start() で明示的に行います。

Creates the server and initializes routing and static file serving. root is required. Call start() explicitly to start listening.

Parameters ​

options ​

ServerOptions

サーバー設定。 / Server options.

Returns ​

Server<RequestNameList, WebSocketNameList>

Example ​

ts
import { Server } from "@donneko/tyoi-server";

 type RequestNameList = "GET:/test" | "GET:/test/a" | "GET:/a";

 const server = new Server<RequestNameList>({
     root: import.meta.dirname,
     public:"../public/main",
     api:"/api",
     port:3000,
 });

 server.onApi("GET:/test", (data) => {
     return data;
 });
 await server.start();

Properties ​

emitApi ​

emitApi: <Key>(type, arg) => Promise<unknown>

Defined in: server-core/app/server.ts:184

HTTP API ハンドラをリクエストなしで実行します。 / Invokes an HTTP API handler without an HTTP request.

キー名で登録されたハンドラを実行します。 / Invokes the handler registered for a key.

Type Parameters ​

Key ​

Key extends string

Parameters ​

type ​

Key

実行するキー名。 / Key to invoke.

arg ​

RequestEventMap<RequestNameList>[Key]

ハンドラに渡す引数。 / Argument passed to the handler.

Returns ​

Promise<unknown>

Example ​

ts
router.emit("GET:/users/:id", { params: { id: "1" } });

getConfig ​

getConfig: <K>(key) => object[K]

Defined in: server-core/app/server.ts:164

解決済みのサーバー設定を取得します。 / Returns the resolved server configuration.

Type Parameters ​

K ​

K extends "lan" | "port" | "qr" | "browser" | "autoPort" | "root" | "public" | "api" | "middlewares" | "signalClose" | "language" | "gui"

Parameters ​

key ​

K

Returns ​

object[K]

hasApi ​

hasApi: (type) => type is Extract<RequestNameList, string>

Defined in: server-core/app/server.ts:182

指定した HTTP API ハンドラが登録されているかを返します。 / Returns whether the HTTP API has a registered handler.

ハンドラが登録されているかを確認します。 / Checks whether a handler is registered.

Parameters ​

type ​

string

調べるキー名。 / Key to check.

Returns ​

type is Extract<RequestNameList, string>

存在する場合は true。 / true when a handler exists.

Example ​

ts
console.log(router.has("GET:/users/:id"));

hasEvent ​

hasEvent: (type) => type is "server/log:*"

Defined in: server-core/app/server.ts:173

指定したイベントにハンドラが登録されているかを返します。 / Returns whether the event has a registered handler.

ハンドラが登録されているかを確認します。 / Checks whether a handler is registered.

Parameters ​

type ​

string

調べるキー名。 / Key to check.

Returns ​

type is "server/log:*"

存在する場合は true。 / true when a handler exists.

Example ​

ts
console.log(eventBus.has("foo"));

hasWebSocket ​

hasWebSocket: (type) => type is Extract<WebSocketNameList, string>

Defined in: server-core/app/server.ts:195

指定した WebSocket ハンドラが登録されているかを返します。 / Returns whether the WebSocket path has a registered handler.

Parameters ​

type ​

string

Returns ​

type is Extract<WebSocketNameList, string>

offApi ​

offApi: <Key>(type) => void

Defined in: server-core/app/server.ts:180

HTTP API ハンドラを解除します。 / Removes an HTTP API handler.

ハンドラの登録を解除します。 / Unregisters a handler.

Type Parameters ​

Key ​

Key extends string

Parameters ​

type ​

Key

解除するキー名。 / Key to unregister.

Returns ​

void

Example ​

ts
router.off("GET:/users/:id");

offEvent ​

offEvent: <Key>(type, fn) => void

Defined in: server-core/app/server.ts:171

イベントハンドラを解除します。 / Removes an event handler.

ハンドラの登録を解除します。 / Unregisters a handler.

Type Parameters ​

Key ​

Key extends "server/log:*"

Parameters ​

type ​

Key

解除するキー名。 / Key to unregister.

fn ​

EventBusHandler<OutEventBusMap[Key]>

Returns ​

void

Example ​

ts
eventBus.off("foo",handler);

offWebSocket ​

offWebSocket: <Key>(type) => void

Defined in: server-core/app/server.ts:193

WebSocket ハンドラを解除します。 / Removes a WebSocket handler.

Type Parameters ​

Key ​

Key extends string

Parameters ​

type ​

Key

Returns ​

void

onApi ​

onApi: <KEY>(type, fn) => () => void

Defined in: server-core/app/server.ts:176

HTTP API ハンドラを登録します。 / Registers an HTTP API handler.

ハンドラを登録します。 / Registers a handler.

Type Parameters ​

KEY ​

KEY extends string

Parameters ​

type ​

KEY

登録するキー名。 / Key to register.

fn ​

Handler<RequestEventMap<RequestNameList>[KEY]>

実行するハンドラ。 / Handler to invoke.

Returns ​

ハンドラを解除するための関数。 / A function that unregisters the handler.

() => void

Example ​

ts
const unsubscribe = router.on("GET:/users/:id", handler);
unsubscribe();

onceApi ​

onceApi: <Key>(type, fn) => () => void

Defined in: server-core/app/server.ts:178

一度だけ実行する HTTP API ハンドラを登録します。 / Registers a one-time HTTP API handler.

一度だけ実行するハンドラを登録します。 / Registers a handler that runs once.

Type Parameters ​

Key ​

Key extends string

Parameters ​

type ​

Key

登録するキー名。 / Key to register.

fn ​

Handler<RequestEventMap<RequestNameList>[Key]>

実行するハンドラ。 / Handler to invoke.

Returns ​

() => void

Example ​

ts
router.once("GET:/users/:id", handler);

onceEvent ​

onceEvent: <Key>(type, fn) => () => void

Defined in: server-core/app/server.ts:169

一度だけ実行するイベントハンドラを登録します。 / Registers a one-time event handler.

一度だけ実行するハンドラを登録します。 / Registers a handler that runs once.

Type Parameters ​

Key ​

Key extends "server/log:*"

Parameters ​

type ​

Key

登録するキー名。 / Key to register.

fn ​

EventBusHandler<OutEventBusMap[Key]>

実行するハンドラ。 / Handler to invoke.

Returns ​

() => void

Example ​

ts
eventBus.once("foo", handler);

onceWebSocket ​

onceWebSocket: <Key>(type, fn) => () => void

Defined in: server-core/app/server.ts:189

一度だけ実行する WebSocket ハンドラを登録します。 / Registers a one-time WebSocket handler.

Type Parameters ​

Key ​

Key extends string

Parameters ​

type ​

Key

fn ​

Handler<WsHandler>

Returns ​

() => void

onEvent ​

onEvent: <Key>(type, fn) => () => void

Defined in: server-core/app/server.ts:167

イベントハンドラを登録します。 / Registers an event handler.

ハンドラを登録します。 / Registers a handler.

Type Parameters ​

Key ​

Key extends "server/log:*"

Parameters ​

type ​

Key

登録するキー名。 / Key to register.

fn ​

EventBusHandler<OutEventBusMap[Key]>

実行するハンドラ。 / Handler to invoke.

Returns ​

ハンドラを解除するための関数。 / A function that unregisters the handler.

() => void

Example ​

ts
const unsubscribe = eventBus.on("foo", handler);
unsubscribe(); // ハンドラを解除 / Unregister the handler

onWebSocket ​

onWebSocket: <Key>(type, fn) => () => void

Defined in: server-core/app/server.ts:187

WebSocket ハンドラを登録します。 / Registers a WebSocket handler.

Type Parameters ​

Key ​

Key extends string

Parameters ​

type ​

Key

fn ​

Handler<WsHandler>

Returns ​

() => void

Methods ​

close() ​

close(): Promise<void>

Defined in: server-core/app/server.ts:116

stop() の別名です。 / Alias for stop().

Returns ​

Promise<void>

getHttpServer() ​

getHttpServer(): Server<typeof IncomingMessage, typeof ServerResponse> | null

Defined in: server-core/app/server.ts:160

基盤となる Node.js の HTTP サーバーを取得します。 / Returns the underlying Node.js HTTP server.

Returns ​

Server<typeof IncomingMessage, typeof ServerResponse> | null

getPort() ​

getPort(): number

Defined in: server-core/app/server.ts:156

現在設定されているポート番号を返します。 / Returns the currently configured port.

Returns ​

number

isRunning() ​

isRunning(): boolean

Defined in: server-core/app/server.ts:152

サーバーが起動中かを返します。 / Returns whether the server is running.

Returns ​

boolean

listen() ​

listen(options?): Promise<Server<typeof IncomingMessage, typeof ServerResponse> | undefined>

Defined in: server-core/app/server.ts:67

start() の別名です。 / Alias for start().

Parameters ​

options? ​

StartOptions

Returns ​

Promise<Server<typeof IncomingMessage, typeof ServerResponse> | undefined>

start() ​

start(options?): Promise<Server<typeof IncomingMessage, typeof ServerResponse> | undefined>

Defined in: server-core/app/server.ts:92

HTTP サーバーを起動します。

options はコンストラクターで渡した設定を、この起動に限らず 上書きします。すでに起動済み、または起動処理中の場合は undefined を返します。

Starts the HTTP server. options overrides the constructor configuration for this and subsequent starts. Returns undefined if the server is already running or is currently starting.

Parameters ​

options? ​

StartOptions

起動時に上書きする設定。 / Options that override the current configuration when starting.

Returns ​

Promise<Server<typeof IncomingMessage, typeof ServerResponse> | undefined>

起動した HTTP サーバー。すでに起動済みの場合は undefined。 / The started HTTP server, or undefined if already running.

Throws ​

ポートの確保や HTTP サーバーの起動に失敗した場合。 / If the port cannot be acquired or the HTTP server cannot start.

Example ​

ts
await server.start({
  port: 3000,
  qr: false,
});

stop() ​

stop(): Promise<void>

Defined in: server-core/app/server.ts:134

HTTP サーバーを停止し、既存の接続を終了します。

接続が 10 秒以内に閉じない場合は、残った接続を強制的に閉じます。 起動していない場合、または停止処理中の場合は何もしません。

Stops the HTTP server and closes existing connections. Remaining connections are forcibly closed after 10 seconds. Does nothing if the server is not running or is already stopping.

Returns ​

Promise<void>

停止完了時に解決する Promise。 / A promise that resolves when shutdown completes.

Throws ​

HTTP サーバーの停止に失敗した場合。 / If the HTTP server cannot be stopped.