Configuración inicial

Instalar

Puedes utilizar nuestra configuración asistida por inteligencia artificial para instalar el complemento. Agrega las Capgo habilidades a tu herramienta de inteligencia artificial utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

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

Importar

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

Ejecutar un informe de diagnóstico completo

runDiagnostics es la forma más rápida de recopilar un informe de soporte para un usuario en una red restringida.

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

Ver el estado de la red actual

const status = await NetworkDiagnostics.getNetworkStatus();

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

Las banderas exactas dependen de la plataforma. Android puede informar el estado de la conexión a Internet y el portal captivo. iOS informa el estado del camino, el tipo de interfaz, los caminos caros y los caminos restringidos a través de Network.framework.

Probar la API alcance de alcance

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

Utilice un endpoint de salud real desde su backend. Un control de la salud solo en el navegador puede estar oculto por WebView, CORS, proxy o comportamiento de portal captivo, mientras que este complemento utiliza redes nativas.

Pruebe un puerto TCP

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

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

Esto es útil cuando un punto de acceso Wi-Fi bloquea puertos no estándar, MQTT, puertas de enlace personalizadas o un backend privado mientras aún permite la navegación normal.

Pruebe la conectividad de WebSocket

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

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

Utilice esto cuando los proxies o los portales captivos permiten páginas HTTPS pero bloquean solicitudes de actualización de WebSocket.

Mida la velocidad de descarga

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

console.log(speed.mbps);

Utilice su propio punto de conexión de archivos estáticos para que el resultado refleje la ruta de red que necesita su aplicación.

Estimar pérdida de paquetes

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

console.log(loss.lossPercent);

El ping ICMP bruto no es portátil en aplicaciones de App Store y Play Store. Este método mide la pérdida de paquetes a nivel de aplicación repitiendo sondas TCP o HTTP.

Fallo de red web

La implementación web está destinada al desarrollo. Los navegadores no pueden abrir sockets TCP crudos y las comprobaciones de URL pueden estar limitadas por CORS. Utilice compilaciones de iOS o Android para un diagnóstico de soporte real.