Getting Started

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous.

bun add @capgo/capacitor-network-diagnostics
bunx cap sync

Importer

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

Exécutez un rapport de diagnostic complet

runDiagnostics est la façon la plus rapide de collecter un rapport de support pour un utilisateur sur un réseau restreint.

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);

Vérifiez l'état réseau actuel

const status = await NetworkDiagnostics.getNetworkStatus();

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

Les drapeaux exacts dépendent de la plateforme. Android peut signaler l'état d'internet validé et de portail captif. iOS signale l'état de chemin, le type d'interface, les chemins coûteux et les chemins contraints à travers Network.framework.

Tester l’API atteignabilité

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);
}

Utilisez un point de terminaison de santé réel de votre backend. Une vérification uniquement en navigateur peut être masquée par WebView, CORS, proxy ou comportement de portail captif, tandis que ce plugin utilise le réseau natif.

Tester un port TCP

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

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

Cela est utile lorsque un point d'accès Wi-Fi bloque les ports non standard, MQTT, des passerelles personnalisées ou un backend privé tout en permettant la navigation normale.

Tester la connectivité WebSocket

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

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

Utilisez cela lorsque les proxies ou les portails captifs autorisent les pages HTTPS mais bloquent les requêtes d'amélioration WebSocket.

Mesurer la vitesse de téléchargement

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

console.log(speed.mbps);

Utilisez votre propre endpoint de fichiers statiques afin que le résultat reflète la voie réseau dont votre application a besoin.

Estimer la perte de paquets

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

console.log(loss.lossPercent);

Les ping ICMP bruts ne sont pas portables dans les applications App Store et Play Store. Cette méthode mesure les pertes de paquets au niveau de l'application en répétant des sondes TCP ou HTTP.

Chute de session web

La mise en œuvre web est destinée au développement. Les navigateurs ne peuvent pas ouvrir des sockets TCP bruts, et les vérifications d'URL peuvent être limitées par CORS. Utilisez les builds iOS ou Android pour des diagnostics de support réels.