クラス: Server

Server()

HTTP 経由で仕様とサポートファイルを配信します。

コンストラクタ

new Server()

メソッド

hostname() → {string}

サーバーがリッスンしているホスト名を取得します。このメソッドはサーバーが起動してから呼び出す必要があります。

返却値

ホスト名 (指定されていない場合、localhost)

文字列

port() → {number}

サーバーがリッスンしているポートを取得します。このメソッドはサーバーが起動してから呼び出す必要があります。

返却値

ポート番号

数字

scheme() → {string}

サーバーがリッスンしている URL スキームを取得します。このメソッドはサーバーが起動してから呼び出す必要があります。

返却値

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

文字列

start(options) → {Promise.<undefined>}

サーバーを起動します。

パラメータ
名前 説明文
options ServerStartOptions
返却値

起動に成功したら解決するプロミス

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(options) → {Promise.<undefined>}

サーバーを起動します。

パラメータ
名前 説明文
options ServerStartOptions
返却値

起動に成功したら解決するプロミス

Promise.<undefined>

stop() → {Promise.<undefined>}

サーバーを停止します。

返却値
Promise.<undefined>