`oro:network-status`

Observe native network-path status on Android and Linux. OS connectivity does not prove application-server reachability. Linux does not infer transport details; disabled monitoring and missing backends reject with ENOSYS.

Examples#

Subscribe before reading the initial snapshot:

import networkStatus from 'oro:network-status'

const show = status => console.log(status.connected, status.validated, status.metered)
const unsubscribe = networkStatus.onChange(show)
try {
  show(await networkStatus.getStatus())
} catch (error) {
  unsubscribe()
  throw error
}
// Call unsubscribe() when this view is disposed.

API reference#

Module specifiers#

oro:network-status

TypeScript declarations#

These declarations are generated from the runtime's published TypeScript surface.

`oro:network-status`#

declare module "oro:network-status" {
    /**
     * @typedef {object} NetworkStatus
     * @property {string} [platform] Linux reports its platform explicitly.
     * @property {boolean} available Whether the OS permits reading network state.
     * @property {boolean} connected Whether a default network exists.
     * @property {boolean} validated Whether the OS monitor reports full Internet connectivity.
     * @property {boolean} captivePortal Whether Android detected a captive portal.
     * @property {boolean} metered Whether the current path is metered.
     * @property {string[]} transports Reported wifi, cellular, ethernet, bluetooth, or vpn transports.
     * @property {'online'|'offline'} name Online means the path is validated.
     * @property {boolean} [transportDetailsAvailable] False on Linux; transports is empty rather than inferred.
     * @property {boolean} [serverReachabilityKnown] False on Linux. Application servers require their own probes.
     */
    /**
     * Reads the OS monitor's current default path without making a network request.
     * Other platforms and disabled monitoring reject with `ENOSYS`.
     * @returns {Promise<NetworkStatus>}
     */
    export function getStatus(): Promise<NetworkStatus>;
    /**
     * Observes native network path changes. Subscribe before reading `getStatus()`
     * to obtain an initial snapshot without missing later changes. This function
     * does not start polling or probe any application server.
     * @param {(status: NetworkStatus) => void} callback
     * @returns {() => void} Removes the listener.
     */
    export function onChange(callback: (status: NetworkStatus) => void): () => void;
    namespace _default {
        export { getStatus };
        export { onChange };
    }
    export default _default;
    export type NetworkStatus = {
        /**
         * Linux reports its platform explicitly.
         */
        platform?: string;
        /**
         * Whether the OS permits reading network state.
         */
        available: boolean;
        /**
         * Whether a default network exists.
         */
        connected: boolean;
        /**
         * Whether the OS monitor reports full Internet connectivity.
         */
        validated: boolean;
        /**
         * Whether Android detected a captive portal.
         */
        captivePortal: boolean;
        /**
         * Whether the current path is metered.
         */
        metered: boolean;
        /**
         * Reported wifi, cellular, ethernet, bluetooth, or vpn transports.
         */
        transports: string[];
        /**
         * Online means the path is validated.
         */
        name: "online" | "offline";
        /**
         * False on Linux; transports is empty rather than inferred.
         */
        transportDetailsAvailable?: boolean;
        /**
         * False on Linux. Application servers require their own probes.
         */
        serverReachabilityKnown?: boolean;
    };
}

oro:network-status

Related guides#