Serial.getPorts()

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

Serial インターフェイスの getPorts() メソッドは、接続されており、かつオリジンにアクセス許可があるシリアルポートを表す SerialPort の配列で解決する Promise を返します。

構文

js
getPorts()

引数

なし。

返値

SerialPort オブジェクトの配列で解決する Promise を返します。

例外

SecurityError DOMException

Feature Policy でこの API の使用が制限されていたり、ユーザーの操作によって API の使用が許可されていないとき、返された Promise がこのエラーで拒否されます。

例

この例では、getPorts() を用いて利用可能なポートのリストを初期化します。

js
navigator.serial.getPorts().then((ports) => {
  // ページの読み込み時、`ports` を用いて利用可能なポートのリストを初期化します。
});

仕様書

Specification
Web Serial API
# dom-serial-getports

ブラウザーの互換性

BCD tables only load in the browser