クラス: Server

Server()

HTTP を介して仕様とサポートファイルを配信します。

コンストラクタ

new Server()

メソッド

hostname() → {string}

サーバーがリッスンしているホスト名を取得します。このメソッドはサーバーが起動されていなければなりません。

戻り値

ホスト名(指定されていなければ localhost)

タイプ
文字列

port() → {number}

サーバーがリッスンしているポートを取得します。このメソッドはサーバーが起動されていなければなりません。

戻り値

ポート番号

タイプ
数値

scheme() → {string}

サーバーがリッスンしている URL スキームを取得します。このメソッドはサーバーが起動されていなければなりません。

戻り値

URL スキーム(http または https)

タイプ
文字列

start() → {Promise.<undefined>}

サーバーを起動します。

戻り値

正常に起動したときに解決されるプロミス。

タイプ
Promise.<undefined>

stop() → {Promise.<undefined>}

サーバーを停止します。

戻り値
タイプ
Promise.<undefined>

Server(options)

new Server(options)

パラメーター
名前 タイプ 説明
options ServerCtorOptions

メソッド

hostname() → {string}

サーバーがリッスンしているホスト名を取得します。このメソッドはサーバーが起動されていなければなりません。

戻り値

ホスト名(指定されていなければ localhost)

タイプ
文字列

port() → {number}

サーバーがリッスンしているポートを取得します。このメソッドはサーバーが起動されていなければなりません。

戻り値

ポート番号

タイプ
数値

scheme() → {string}

サーバーがリッスンしている URL スキームを取得します。このメソッドはサーバーが起動されていなければなりません。

戻り値

URL スキーム(http または https)

タイプ
文字列

start() → {Promise.<undefined>}

サーバーを起動します。

戻り値

正常に起動したときに解決されるプロミス。

タイプ
Promise.<undefined>

stop() → {Promise.<undefined>}

サーバーを停止します。

戻り値
タイプ
Promise.<undefined>