Getting Started

インストール

AI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-network-diagnostics` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

npm install @capgo/capacitor-network-diagnostics
npx cap sync

インポート

import { NetworkDiagnostics } from '@capgo/capacitor-network-diagnostics';

完全な診断レポートを実行

runDiagnostics ユーザーが制限されたネットワーク上にいる場合のサポートレポートを収集する最速の方法はこちらです。

const report = await NetworkDiagnostics.runDiagnostics({
  urls: [{ url: 'https://api.example.com/health', method: 'HEAD' }],
  ports: [{ host: 'api.example.com', port: 443 }],
  websockets: [{ url: 'wss://ws.example.com/socket' }],
  download: {
    url: 'https://speed.example.com/5mb.bin',
    maxBytes: 5 * 1024 * 1024,
  },
  packetLoss: {
    mode: 'tcp',
    host: 'api.example.com',
    port: 443,
    count: 10,
  },
});

console.log(report.status.connectionType);
console.log(report.issues);

現在のネットワーク状態を確認

const status = await NetworkDiagnostics.getNetworkStatus();

console.log(status.connected);
console.log(status.connectionType);
console.log(status.internetReachable);
console.log(status.captivePortal);

プラットフォームによって正確な旗が決まります。Androidは有効化されたインターネットとキャプティブ ポータル状態を報告します。iOSはパス状態、インターフェイスタイプ、コストのかかるパス、制限されたパスを通じて Network.framework.

Test API の接続性をテストする

const result = await NetworkDiagnostics.testUrl({
  url: 'https://api.example.com/health',
  method: 'HEAD',
  timeoutMs: 5000,
  followRedirects: true,
});

if (!result.reachable) {
  console.warn(result.errorCode, result.errorMessage);
}

実際のヘルスエンドポイントからバックエンドを使用します。ブラウザのみのチェックは、WebView、CORS、プロキシ、またはキャプティブ ポータル動作によって隠れます。 これはプラグインがネイティブのネットワーキングを使用するためです。

TCP ポートをテストする

const port = await NetworkDiagnostics.testPort({
  host: 'api.example.com',
  port: 443,
  timeoutMs: 3000,
});

console.log(port.open, port.durationMs);

Wi-Fi アクセス ポイントが標準以外のポート、MQTT、カスタムゲートウェイ、またはプライベートバックエンドをブロックしながら通常のブラウジングを許可している場合に便利です。

WebSocket の接続性をテストする

const socket = await NetworkDiagnostics.testWebSocket({
  url: 'wss://ws.example.com/socket',
  timeoutMs: 5000,
});

console.log(socket.open, socket.statusCode);

プロキシやキャプティブ ポータルがHTTPS ページを許可しているが、WebSocket アップグレード要求をブロックしている場合に使用してください。

ダウンロード速度を測定

const speed = await NetworkDiagnostics.testDownloadSpeed({
  url: 'https://speed.example.com/5mb.bin',
  maxBytes: 5 * 1024 * 1024,
  timeoutMs: 30000,
});

console.log(speed.mbps);

あなた自身の静的ファイルエンドポイントを使用してください。結果はあなたのアプリが必要とするネットワークパスを反映します。

パケット損失を推定

const loss = await NetworkDiagnostics.testPacketLoss({
  mode: 'tcp',
  host: 'api.example.com',
  port: 443,
  count: 10,
  timeoutMs: 3000,
  intervalMs: 250,
});

console.log(loss.lossPercent);

Raw ICMP のパケット損失を測定する方法は、App Store と Play Store アプリで使用できません。この方法は、TCP または HTTP のプローブを繰り返して、実際のアプリケーションレベルのパケット損失を測定します。

Web のフォールバック

Web の実装は開発用に意図されています。ブラウザはRaw TCP ソケットを開くことができず、URL のチェックは CORS の制限によって制限される可能性があります。実際のサポート診断には、iOS または Android のビルドを使用してください。