Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace router

Index

Namespaces

Enumerations

Interfaces

Functions

Functions

Const getBriefing

  • getBriefing(instance?: Got): Promise<{ ip: { address: string; isConnected: boolean; isDynamic: boolean }; version: string }>

  • Get briefing metadata from main page

    Parameters

    • instance: Got = defaults.instance

      The got instance to use

    Returns Promise<{ ip: { address: string; isConnected: boolean; isDynamic: boolean }; version: string }>

    Publicated router metadata you can see on main page

Const getStatus

  • getStatus(instance?: Got): Promise<{ connectionTime: number; externalIpAddress: string; ipRange: string[]; isConnected: boolean; isDhcpRunning: boolean; isDynamic: boolean; isRemoteManagementEnabled: boolean; remoteManagementPort: number; routerIpAddress: string; routerUptime: number; version: string; wlans: { 2.4GHz: IWlanStatus; 5GHz: IWlanStatus } }>

  • Get the general status of the router

    Parameters

    • instance: Got = defaults.instance

      The got instance to use

    Returns Promise<{ connectionTime: number; externalIpAddress: string; ipRange: string[]; isConnected: boolean; isDhcpRunning: boolean; isDynamic: boolean; isRemoteManagementEnabled: boolean; remoteManagementPort: number; routerIpAddress: string; routerUptime: number; version: string; wlans: { 2.4GHz: IWlanStatus; 5GHz: IWlanStatus } }>

    The general information of the router

Generated using TypeDoc