diff options
| author | Jo-Philipp Wich <jo@mein.io> | 2019-11-05 10:18:51 +0100 |
|---|---|---|
| committer | Jo-Philipp Wich <jo@mein.io> | 2019-11-05 10:18:51 +0100 |
| commit | 355a48866d1a43df9443a3b559c8ec8642343f3a (patch) | |
| tree | f5bea3a7a89baeeaa8ab498821b840f085f6315e /documentation/jsapi/LuCI.html | |
| parent | f3f6bf64b860380cdaa52e3386113d3b7ccd6a24 (diff) | |
documentation: change JS docs template
Use another template for the JS api documentation which provides a better
overview over the classes and methods.
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'documentation/jsapi/LuCI.html')
| -rw-r--r-- | documentation/jsapi/LuCI.html | 5735 |
1 files changed, 3161 insertions, 2574 deletions
diff --git a/documentation/jsapi/LuCI.html b/documentation/jsapi/LuCI.html index 44f899b35..68e2042c5 100644 --- a/documentation/jsapi/LuCI.html +++ b/documentation/jsapi/LuCI.html @@ -1,94 +1,1141 @@ <!DOCTYPE html> -<html lang="en"> +<html> <head> <meta charset="utf-8"> - <title>JSDoc: Class: LuCI</title> - - <script src="scripts/prettify/prettify.js"> </script> - <script src="scripts/prettify/lang-css.js"> </script> + <title>Class: LuCI</title> + + + <script src="scripts/prettify/prettify.js"></script> + <script src="scripts/prettify/lang-css.js"></script> + <script src="scripts/jquery.min.js"></script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> - <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> -</head> + <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> + <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> + + + <script> + var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}}; + </script> + + +</head> <body> - -<div id="main"> - - <h1 class="page-title">Class: LuCI</h1> - +<div id="wrap" class="clearfix"> +<div class="navigation"> + <h3 class="applicationName"><a href="index.html"></a></h3> + <div class="search"> + <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> + </div> + <ul class="list"> + + <li class="item" data-name="LuCI"> + <span class="title"> + <a href="LuCI.html">LuCI</a> + + </span> + <ul class="members itemMembers"> + + <span class="subtitle">Members</span> + + <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li> + + <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li> + + <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li> + + <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li> + + <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li> + + <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li> + + <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li> + + <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li> + + <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li> + + <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li> + + <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li> + + <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li> + + <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li> + + <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li> + + <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li> + + <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li> + + <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li> + + <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li> + + <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Class"> + <span class="title"> + <a href="LuCI.Class.html">LuCI.Class</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li> + + <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li> + + <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li> + + <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li> + + <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li> + + <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.dom"> + <span class="title"> + <a href="LuCI.dom.html">LuCI.dom</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li> + + <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li> + + <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li> + + <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li> + + <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li> + + <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li> + + <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li> + + <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li> + + <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li> + + <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li> + + <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li> + + <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li> + + <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.fs"> + <span class="title"> + <a href="LuCI.fs.html">LuCI.fs</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li> + + <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li> + + <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li> + + <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li> + + <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li> + + <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li> + + <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li> + + <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li> + + <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Headers"> + <span class="title"> + <a href="LuCI.Headers.html">LuCI.Headers</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li> + + <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network"> + <span class="title"> + <a href="LuCI.Network.html">LuCI.Network</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li> + + <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li> + + <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li> + + <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li> + + <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li> + + <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li> + + <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li> + + <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li> + + <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li> + + <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li> + + <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li> + + <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li> + + <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li> + + <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li> + + <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li> + + <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li> + + <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li> + + <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li> + + <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li> + + <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li> + + <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li> + + <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li> + + <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li> + + <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li> + + <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li> + + <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li> + + <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li> + + <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Device"> + <span class="title"> + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li> + + <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li> + + <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li> + + <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li> + + <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li> + + <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li> + + <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li> + + <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li> + + <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li> + + <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li> + + <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li> + + <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li> + + <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li> + + <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li> + + <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li> + + <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li> + + <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li> + + <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Hosts"> + <span class="title"> + <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li> + + <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Protocol"> + <span class="title"> + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li> + + <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li> + + <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li> + + <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li> + + <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li> + + <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li> + + <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li> + + <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li> + + <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li> + + <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li> + + <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li> + + <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li> + + <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li> + + <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li> + + <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li> + + <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li> + + <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li> + + <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li> + + <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li> + + <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li> + + <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li> + + <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li> + + <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li> + + <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li> + + <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li> + + <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li> + + <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li> + + <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li> + + <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li> + + <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li> + + <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li> + + <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.WifiDevice"> + <span class="title"> + <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li> + + <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li> + + <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li> + + <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li> + + <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li> + + <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li> + + <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li> + + <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.WifiNetwork"> + <span class="title"> + <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li> + + <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Poll"> + <span class="title"> + <a href="LuCI.Poll.html">LuCI.Poll</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li> + + <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li> + + <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li> + + <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li> + + <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Request"> + <span class="title"> + <a href="LuCI.Request.html">LuCI.Request</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li> + + <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li> + + <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li> + + <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li> + + <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li> + + <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li> + + <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Request.poll"> + <span class="title"> + <a href="LuCI.Request.poll.html">LuCI.Request.poll</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li> + + <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li> + + <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li> + + <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li> + + <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Response"> + <span class="title"> + <a href="LuCI.Response.html">LuCI.Response</a> + + </span> + <ul class="members itemMembers"> + + <span class="subtitle">Members</span> + + <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li> + + <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li> + + <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li> + + <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li> + + <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li> + + <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li> + + <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li> + + <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.rpc"> + <span class="title"> + <a href="LuCI.rpc.html">LuCI.rpc</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li> + + <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li> + + <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li> + + <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li> + + <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li> + + <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li> + + <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li> + + <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li> + + <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li> + + <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li> + + <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li> + + <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.uci"> + <span class="title"> + <a href="LuCI.uci.html">LuCI.uci</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li> + + <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li> + + <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li> + + <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li> + + <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li> + + <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li> + + <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li> + + <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li> + + <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li> + + <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li> + + <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li> + + <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li> + + <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li> + + <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li> + + <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li> + + <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li> + + <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li> + + <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li> + + <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.view"> + <span class="title"> + <a href="LuCI.view.html">LuCI.view</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li> + + <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li> + + <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li> + + <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li> + + <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li> + + <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.XHR"> + <span class="title"> + <a href="LuCI.XHR.html">LuCI.XHR</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li> + + <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li> + + <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li> + + <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li> + + <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li> + + <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + </ul> +</div> + <div class="main"> + <h1 class="page-title" data-filename="LuCI.html">Class: LuCI</h1> + <section> - + <header> + <h2> + LuCI + </h2> - <h2><span class="attribs"><span class="type-signature"></span></span>LuCI<span class="signature">(env)</span><span class="type-signature"></span></h2> - - <div class="class-description"><p>This is the LuCI base class. It is automatically instantiated and + <div class="class-description"><p>This is the LuCI base class. It is automatically instantiated and accessible using the global <code>L</code> variable.</p></div> - -</header> +</header> <article> <div class="container-overview"> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="LuCI"> + + new LuCI<span class="signature">(env)</span> + </h4> + + <div class="tag-source"> + luci.js, line 1 + </div> + + </div> - <h2>Constructor</h2> +</dt> +<dd> + - <h4 class="name" id="LuCI"><span class="type-signature"></span>new LuCI<span class="signature">(env)</span><span class="type-signature"></span></h4> - - - - - - - - - - - - - <h5>Parameters:</h5> + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>env</code></td> - + <td class="type"> @@ -97,92 +1144,70 @@ accessible using the global <code>L</code> variable.</p></div> </td> - - - - <td class="description last"><p>The environment settings to use for the LuCI runtime.</p></td> + + <td class="description last"> + + <p>The environment settings to use for the LuCI runtime.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1">line 1</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - - - - - - - + + + + + + + +</dd> </div> - - - + + + + + <h3 class="subsection-title">Classes</h3> - + <dl> <dt><a href="LuCI.Class.html">Class</a></dt> <dd></dd> @@ -221,141 +1246,121 @@ accessible using the global <code>L</code> variable.</p></div> <dd></dd> </dl> - - - - <h3 class="subsection-title">Members</h3> - + <dl> -<h4 class="name" id="env"><span class="type-signature"></span>env<span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>The <code>env</code> object holds environment settings used by LuCI, such +<dt> + <div class="nameContainer"> + <h4 class="name" id="env">env</h4> + </div> + + +</dt> +<dd> + + <div class="description"> + <p>The <code>env</code> object holds environment settings used by LuCI, such as request timeouts, base URLs etc.</p> -</div> - - - - - - - + </div> + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1657">line 1657</a> - </li></ul></dd> - - - + + </dl> - - - - - - + +</dd> + </dl> + + <h3 class="subsection-title">Methods</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="bind"> + + bind<span class="signature">(fn, self, <span class="optional">args</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1340 + </div> + + </div> - <h4 class="name" id="bind"><span class="type-signature"></span>bind<span class="signature">(fn, self, …args<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {function}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Return a bound function using the given <code>self</code> as <code>this</code> context + <div class="description"> + <p>Return a bound function using the given <code>self</code> as <code>this</code> context and any further arguments as parameters to the bound function.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>fn</code></td> - + <td class="type"> @@ -364,29 +1369,26 @@ and any further arguments as parameters to the bound function.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The function to bind.</p></td> + <td class="description last"> + + + + + + + <p>The function to bind.</p></td> </tr> - - - + + + <tr> <td class="name"><code>self</code></td> - + <td class="type"> @@ -395,29 +1397,26 @@ and any further arguments as parameters to the bound function.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The value to bind as <code>this</code> context to the specified function.</p></td> + <td class="description last"> + + + + + + + <p>The value to bind as <code>this</code> context to the specified function.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -426,176 +1425,157 @@ and any further arguments as parameters to the bound function.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - - <td class="description last"><p>Zero or more variable arguments which are bound to the function + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Zero or more variable arguments which are bound to the function as parameters.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1340">line 1340</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the bound function.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">function</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="error"><span class="type-signature"></span>error<span class="signature">(type<span class="signature-attributes">opt</span>, fmt<span class="signature-attributes">opt</span>, …args<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>A wrapper around <a href="LuCI.html#raise"><code>raise()</code></a> which also renders -the error either as modal overlay when <code>ui.js</code> is already loaed -or directly into the view body.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + function + + + </td> + <td class="description last">Returns the bound function.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="error"> + + error<span class="signature">(<span class="optional">type</span>, <span class="optional">fmt</span>, <span class="optional">args</span>)</span> + </h4> + + + <div class="tag-source"> + luci.js, line 1300 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>A wrapper around <a href="LuCI.html#raise"><code>raise()</code></a> which also renders +the error either as modal overlay when <code>ui.js</code> is already loaed +or directly into the view body.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>type</code></td> - + <td class="type"> @@ -607,19 +1587,7 @@ or directly into the view body.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -627,18 +1595,27 @@ or directly into the view body.</p> </td> - - <td class="description last"><p>Either a string specifying the type of the error to throw or an + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Either a string specifying the type of the error to throw or an existing <code>Error</code> instance to copy.</p></td> </tr> - - - + + + <tr> <td class="name"><code>fmt</code></td> - + <td class="type"> @@ -647,19 +1624,7 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - <td class="default"> @@ -667,18 +1632,27 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - <td class="description last"><p>A format string which is used to form the error message, together + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>A format string which is used to form the error message, together with all subsequent optional arguments.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -687,94 +1661,68 @@ with all subsequent optional arguments.</p></td> </td> - - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - <td class="default"> </td> - - <td class="description last"><p>Zero or more variable arguments to the supplied format string.</p></td> + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Zero or more variable arguments to the supplied format string.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1300">line 1300</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -784,7 +1732,6 @@ appended to the message and the type set to the given type argument or copied from the given error instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -798,75 +1745,74 @@ argument or copied from the given error instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> + - - - - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1918 + </div> + + </div> - <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(url, args<span class="signature-attributes">opt</span>, cb)</span><span class="type-signature"> → {Promise.<null>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Issues a GET request to the given url and invokes the specified + <div class="description"> + <p>Issues a GET request to the given url and invokes the specified callback function. The function is a wrapper around <a href="LuCI.Request.html#request"><code>Request.request()</code></a>.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -875,29 +1821,26 @@ callback function. The function is a wrapper around </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -906,31 +1849,28 @@ callback function. The function is a wrapper around </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional query string arguments to append to the URL.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional query string arguments to append to the URL.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cb</code></td> - + <td class="type"> @@ -939,286 +1879,257 @@ callback function. The function is a wrapper around </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The callback function to invoke when the request finishes.</p></td> + <td class="description last"> + + + + + + + <p>The callback function to invoke when the request finishes.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1918">line 1918</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to <code>null</code> when concluded.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<null></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<null> + + + </td> + <td class="description last">Returns a promise resolving to <code>null</code> when concluded.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="halt"> + + halt<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2040 + </div> + + </div> - <h4 class="name" id="halt"><span class="type-signature"></span>halt<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Deprecated wrapper around <code>Poll.stop()</code>.</p> + </div> - - -<div class="description"> - <p>Deprecated wrapper around <code>Poll.stop()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2040">line 2040</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the polling loop has been stopped or <code>false</code> -when it didn't run to begin with.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when the polling loop has been stopped or <code>false</code> +when it didn't run to begin with.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="hasSystemFeature"> + + hasSystemFeature<span class="signature">(feature, <span class="optional">subfeature</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean|null}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1574 + </div> + + </div> - <h4 class="name" id="hasSystemFeature"><span class="type-signature"></span>hasSystemFeature<span class="signature">(feature, subfeature<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean|null}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Test whether a particular system feature is available, such as + <div class="description"> + <p>Test whether a particular system feature is available, such as hostapd SAE support or an installed firewall. The features are queried once at the beginning of the LuCI session and cached in <code>SessionStorage</code> throughout the lifetime of the associated tab or browser window.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>feature</code></td> - + <td class="type"> @@ -1227,30 +2138,27 @@ browser window.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The feature to test. For detailed list of known feature flags, + <td class="description last"> + + + + + + + <p>The feature to test. For detailed list of known feature flags, see <code>/modules/luci-base/root/usr/libexec/rpcd/luci</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>subfeature</code></td> - + <td class="type"> @@ -1259,179 +2167,160 @@ see <code>/modules/luci-base/root/usr/libexec/rpcd/luci</code>.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Some feature classes like <code>hostapd</code> provide sub-feature flags, + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Some feature classes like <code>hostapd</code> provide sub-feature flags, such as <code>sae</code> or <code>11w</code> support. The <code>subfeature</code> argument can be used to query these.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1574">line 1574</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Return <code>true</code> if the queried feature (and sub-feature) is available + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + | + + null + + + </td> + <td class="description last">Return <code>true</code> if the queried feature (and sub-feature) is available or <code>false</code> if the requested feature isn't present or known. Return <code>null</code> when a sub-feature was queried for a feature which -has no sub-features.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> -| - -<span class="param-type">null</span> - - - </dd> -</dl> - +has no sub-features.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="isObject"> + + isObject<span class="signature">(<span class="optional">val</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1765 + </div> + + </div> - <h4 class="name" id="isObject"><span class="type-signature"></span>isObject<span class="signature">(val<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Tests whether the passed argument is a JavaScript object. + <div class="description"> + <p>Tests whether the passed argument is a JavaScript object. This function is meant to be an object counterpart to the standard <code>Array.isArray()</code> function.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -1440,283 +2329,254 @@ standard <code>Array.isArray()</code> function.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The value to test</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The value to test</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1765">line 1765</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> if the given value is of type object and -not <code>null</code>, else returns <code>false</code>.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> if the given value is of type object and +not <code>null</code>, else returns <code>false</code>.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="location"> + + location<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1745 + </div> + + </div> - <h4 class="name" id="location"><span class="type-signature"></span>location<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Return the complete URL path to the current view.</p> + </div> - - -<div class="description"> - <p>Return the complete URL path to the current view.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1745">line 1745</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the URL path to the current view.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the URL path to the current view.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="path"> + + path<span class="signature">(<span class="optional">prefix</span>, <span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1679 + </div> + + </div> - <h4 class="name" id="path"><span class="type-signature"></span>path<span class="signature">(prefix<span class="signature-attributes">opt</span>, parts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Construct a relative URL path from the given prefix and parts. + <div class="description"> + <p>Construct a relative URL path from the given prefix and parts. The resulting URL is guaranteed to only contain the characters <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well as <code>/</code> for the path separator.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>prefix</code></td> - + <td class="type"> @@ -1725,32 +2585,29 @@ as <code>/</code> for the path separator.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>The prefix to join the given parts with. If the <code>prefix</code> is + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>The prefix to join the given parts with. If the <code>prefix</code> is omitted, it defaults to an empty string.</p></td> </tr> - - - + + + <tr> <td class="name"><code>parts</code></td> - + <td class="type"> @@ -1759,174 +2616,155 @@ omitted, it defaults to an empty string.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An array of parts to join into an URL path. Parts may contain + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An array of parts to join into an URL path. Parts may contain slashes and any of the other characters mentioned above.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1679">line 1679</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Return the joined URL path.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">string</span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="poll"><span class="type-signature"></span>poll<span class="signature">(interval, url, args<span class="signature-attributes">opt</span>, cb, post<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {function}</span></h4> - - - - -<div class="description"> - <p>Register a polling HTTP request that invokes the specified -callback function. The function is a wrapper around -<a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Return the joined URL path.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="poll"> + + poll<span class="signature">(interval, url, <span class="optional">args</span>, cb, <span class="optional">post</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{function}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 1988 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Register a polling HTTP request that invokes the specified +callback function. The function is a wrapper around +<a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>interval</code></td> - + <td class="type"> @@ -1935,35 +2773,32 @@ callback function. The function is a wrapper around </td> - - - <td class="attributes"> - - - - - - </td> - <td class="default"> </td> - - <td class="description last"><p>The poll interval to use. If set to a value less than or equal + + <td class="description last"> + + + + + + + <p>The poll interval to use. If set to a value less than or equal to <code>0</code>, it will default to the global poll interval configured in <code>LuCI.env.pollinterval</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -1972,33 +2807,30 @@ in <code>LuCI.env.pollinterval</code>.</p></td> </td> - - <td class="attributes"> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>The URL to request.</p></td> + + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -2007,37 +2839,34 @@ in <code>LuCI.env.pollinterval</code>.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> </td> - - <td class="description last"><p>Specifies additional arguments for the request. For GET requests, + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies additional arguments for the request. For GET requests, the arguments are appended to the URL as query string, for POST requests, they'll be added to the request body.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cb</code></td> - + <td class="type"> @@ -2046,33 +2875,30 @@ requests, they'll be added to the request body.</p></td> </td> - - - <td class="attributes"> - - - - - - </td> - <td class="default"> </td> - - <td class="description last"><p>The callback function to invoke whenever a request finishes.</p></td> + + <td class="description last"> + + + + + + + <p>The callback function to invoke whenever a request finishes.</p></td> </tr> - - - + + + <tr> <td class="name"><code>post</code></td> - + <td class="type"> @@ -2081,19 +2907,7 @@ requests, they'll be added to the request body.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -2101,169 +2915,162 @@ requests, they'll be added to the request body.</p></td> </td> - - <td class="description last"><p>When set to <code>false</code> or not specified, poll requests will be made + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>When set to <code>false</code> or not specified, poll requests will be made using the GET method. When set to <code>true</code>, POST requests will be issued. In case of POST requests, the request body will contain an argument <code>token</code> with the current value of <code>LuCI.env.token</code> by default, regardless of the parameters specified with <code>args</code>.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1988">line 1988</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - +<table class="params"> + <thead> + <tr> -<div class="param-desc"> - <p>Returns the internally created function that has been passed to + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + function + + + </td> + <td class="description last">Returns the internally created function that has been passed to <a href="LuCI.Request.poll.html#add"><code>Request.poll.add()</code></a>. This value can be passed to <code>Poll.remove()</code> to remove the -polling request.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">function</span> - - - </dd> -</dl> - +polling request.</td> + </tr> + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="post"> + + post<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1946 + </div> + + </div> - <h4 class="name" id="post"><span class="type-signature"></span>post<span class="signature">(url, args<span class="signature-attributes">opt</span>, cb)</span><span class="type-signature"> → {Promise.<null>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Issues a POST request to the given url and invokes the specified + <div class="description"> + <p>Issues a POST request to the given url and invokes the specified callback function. The function is a wrapper around <a href="LuCI.Request.html#request"><code>Request.request()</code></a>. The request is sent using <code>application/x-www-form-urlencoded</code> encoding and will contain a field <code>token</code> with the current value of <code>LuCI.env.token</code> by default.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>url</code></td> - + <td class="type"> @@ -2272,29 +3079,26 @@ by default.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The URL to request.</p></td> + <td class="description last"> + + + + + + + <p>The URL to request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -2303,31 +3107,28 @@ by default.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Additional post arguments to append to the request body.</p></td> + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Additional post arguments to append to the request body.</p></td> </tr> - - - + + + <tr> <td class="name"><code>cb</code></td> - + <td class="type"> @@ -2336,173 +3137,154 @@ by default.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The callback function to invoke when the request finishes.</p></td> + <td class="description last"> + + + + + + + <p>The callback function to invoke when the request finishes.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1946">line 1946</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a promise resolving to <code>null</code> when concluded.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Promise.<null></span> - - - </dd> </dl> - - - - - - - + - <h4 class="name" id="raise"><span class="type-signature"></span>raise<span class="signature">(type<span class="signature-attributes">opt</span>, fmt<span class="signature-attributes">opt</span>, …args<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> - - - - -<div class="description"> - <p>Captures the current stack trace and throws an error of the -specified type as a new exception. Also logs the exception as -error to the debug console if it is available.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Promise.<null> + + + </td> + <td class="description last">Returns a promise resolving to <code>null</code> when concluded.</td> + </tr> + + </tbody> +</table> - - <th>Attributes</th> - + + + +</dd> - <th>Default</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="raise"> + + raise<span class="signature">(<span class="optional">type</span>, <span class="optional">fmt</span>, <span class="optional">args</span>)</span> + </h4> + + <div class="tag-source"> + luci.js, line 1234 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Captures the current stack trace and throws an error of the +specified type as a new exception. Also logs the exception as +error to the debug console if it is available.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>type</code></td> - + <td class="type"> @@ -2514,19 +3296,7 @@ error to the debug console if it is available.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -2534,18 +3304,27 @@ error to the debug console if it is available.</p> </td> - - <td class="description last"><p>Either a string specifying the type of the error to throw or an + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Either a string specifying the type of the error to throw or an existing <code>Error</code> instance to copy.</p></td> </tr> - - - + + + <tr> <td class="name"><code>fmt</code></td> - + <td class="type"> @@ -2554,19 +3333,7 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> @@ -2574,18 +3341,27 @@ existing <code>Error</code> instance to copy.</p></td> </td> - - <td class="description last"><p>A format string which is used to form the error message, together + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>A format string which is used to form the error message, together with all subsequent optional arguments.</p></td> </tr> - - - + + + <tr> <td class="name"><code>args</code></td> - + <td class="type"> @@ -2594,94 +3370,68 @@ with all subsequent optional arguments.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - <repeatable><br> - - </td> - - <td class="default"> </td> - - <td class="description last"><p>Zero or more variable arguments to the supplied format string.</p></td> + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>Zero or more variable arguments to the supplied format string.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1234">line 1234</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> - - + + + + <h5>Throws:</h5> + + <dl> <dt> @@ -2691,7 +3441,6 @@ appended to the message and the type set to the given type argument or copied from the given error instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2705,74 +3454,75 @@ argument or copied from the given error instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> + - - - - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="require"> + + require<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<LuCI#Class>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1379 + </div> + + </div> - <h4 class="name" id="require"><span class="type-signature"></span>require<span class="signature">(name)</span><span class="type-signature"> → {Promise.<LuCI#Class>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Load an additional LuCI JavaScript class and its dependencies, + <div class="description"> + <p>Load an additional LuCI JavaScript class and its dependencies, instantiate it and return the resulting class instance. Each class is only loaded once. Subsequent attempts to load the same class will return the already instantiated class.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>name</code></td> - + <td class="type"> @@ -2781,81 +3531,58 @@ class will return the already instantiated class.</p> </td> - - - - <td class="description last"><p>The name of the class to load in dotted notation. Dots will + + <td class="description last"> + + <p>The name of the class to load in dotted notation. Dots will be replaced by spaces and joined with the runtime-determined base URL of LuCI.js to form an absolute URL to load the class file from.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1379">line 1379</a> - </li></ul></dd> - - - + + </dl> + + + - - - - - - - - - - -<h5>Throws:</h5> -<ul> - <li> + + + + <h5>Throws:</h5> + <ul> + <li> <dl> <dt> @@ -2864,7 +3591,6 @@ file from.</p></td> circular dependencies.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2878,12 +3604,11 @@ circular dependencies.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - - <li> + + <li> <dl> <dt> @@ -2892,7 +3617,6 @@ circular dependencies.</p> call failed.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2906,12 +3630,11 @@ call failed.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - - <li> + + <li> <dl> <dt> @@ -2920,7 +3643,6 @@ call failed.</p> be interpreted by <code>eval</code>.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2934,12 +3656,11 @@ be interpreted by <code>eval</code>.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - - <li> + + <li> <dl> <dt> @@ -2949,7 +3670,6 @@ interpreted, but when invoking its code did not yield a valid class instance.</p> </div> </dt> - <dd></dd> <dt> <dl> <dt> @@ -2963,94 +3683,102 @@ class instance.</p> </dd> </dl> </dt> - <dd></dd> </dl> </li> - </ul> - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the instantiated class.</p> -</div> - + </ul> + + + <h5>Returns:</h5> + -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<LuCI#Class></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<LuCI#Class> + + + </td> + <td class="description last">Returns the instantiated class.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="resolveDefault"> + + resolveDefault<span class="signature">(value, defvalue)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1873 + </div> + + </div> - <h4 class="name" id="resolveDefault"><span class="type-signature"></span>resolveDefault<span class="signature">(value, defvalue)</span><span class="type-signature"> → {Promise.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Returns a promise resolving with either the given value or or with + <div class="description"> + <p>Returns a promise resolving with either the given value or or with the given default in case the input value is a rejecting promise.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>value</code></td> - + <td class="type"> @@ -3059,21 +3787,21 @@ the given default in case the input value is a rejecting promise.</p> </td> - - - - <td class="description last"><p>The value to resolve the promise with.</p></td> + + <td class="description last"> + + <p>The value to resolve the promise with.</p></td> </tr> - - - + + + <tr> <td class="name"><code>defvalue</code></td> - + <td class="type"> @@ -3082,165 +3810,149 @@ the given default in case the input value is a rejecting promise.</p> </td> - - - - <td class="description last"><p>The default value to resolve the promise with in case the given + + <td class="description last"> + + <p>The default value to resolve the promise with in case the given input value is a rejecting promise.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1873">line 1873</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns a new promise resolving either to the given input value or -to the given default value on error.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Promise.<*></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Promise.<*> + + + </td> + <td class="description last">Returns a new promise resolving either to the given input value or +to the given default value on error.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="resource"> + + resource<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1732 + </div> + + </div> - <h4 class="name" id="resource"><span class="type-signature"></span>resource<span class="signature">(parts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Construct an URL path relative to the global static resource path + <div class="description"> + <p>Construct an URL path relative to the global static resource path of the LuCI ui (usually <code>/luci-static/resources</code>).</p> <p>The resulting URL is guaranteed to only contain the characters <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well as <code>/</code> for the path separator.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>parts</code></td> - + <td class="type"> @@ -3249,284 +3961,255 @@ as <code>/</code> for the path separator.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An array of parts to join into an URL path. Parts may contain + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An array of parts to join into an URL path. Parts may contain slashes and any of the other characters mentioned above.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1732">line 1732</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the resulting URL path.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the resulting URL path.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="run"> + + run<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + <div class="tag-source"> + luci.js, line 2053 + </div> + + </div> - <h4 class="name" id="run"><span class="type-signature"></span>run<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> +</dt> +<dd> - + + <div class="description"> + <p>Deprecated wrapper around <code>Poll.start()</code>.</p> + </div> - - -<div class="description"> - <p>Deprecated wrapper around <code>Poll.start()</code>.</p> -</div> - - - - - - - - - - - - - + + + + + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2053">line 2053</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the polling loop has been started or <code>false</code> -when it was already running.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">boolean</span> - - - </dd> </dl> - - - - - - - + - <h4 class="name" id="sortedKeys"><span class="type-signature"></span>sortedKeys<span class="signature">(obj, key<span class="signature-attributes">opt</span>, sortmode<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<string>}</span></h4> - - - - -<div class="description"> - <p>Return an array of sorted object keys, optionally sorted by -a different key or a different sorting mode.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + <h5>Returns:</h5> + + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when the polling loop has been started or <code>false</code> +when it was already running.</td> + </tr> + + </tbody> +</table> + + + + +</dd> - <th>Attributes</th> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="sortedKeys"> + + sortedKeys<span class="signature">(obj, <span class="optional">key</span>, <span class="optional">sortmode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + - + <div class="tag-source"> + luci.js, line 1794 + </div> + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Return an array of sorted object keys, optionally sorted by +a different key or a different sorting mode.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>obj</code></td> - + <td class="type"> @@ -3535,30 +4218,27 @@ a different key or a different sorting mode.</p> </td> - - <td class="attributes"> - - - - - - </td> - - - <td class="description last"><p>The object to extract the keys from. If the given value is + <td class="description last"> + + + + + + + <p>The object to extract the keys from. If the given value is not an object, the function will return an empty array.</p></td> </tr> - - - + + + <tr> <td class="name"><code>key</code></td> - + <td class="type"> @@ -3567,34 +4247,31 @@ not an object, the function will return an empty array.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>Specifies the key to order by. This is mainly useful for + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>Specifies the key to order by. This is mainly useful for nested objects of objects or objects of arrays when sorting shall not be performed by the primary object keys but by some other key pointing to a value within the nested values.</p></td> </tr> - - - + + + <tr> <td class="name"><code>sortmode</code></td> - + <td class="type"> @@ -3603,169 +4280,152 @@ some other key pointing to a value within the nested values.</p></td> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>May be either <code>addr</code> or <code>num</code> to override the natural + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>May be either <code>addr</code> or <code>num</code> to override the natural lexicographic sorting with a sorting suitable for IP/MAC style addresses or numeric values respectively.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1794">line 1794</a> - </li></ul></dd> - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns an array containing the sorted keys of the given object.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Array.<string></span> - - - </dd> + + </dl> - - - - - - - + - <h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">(entry)</span><span class="type-signature"> → {boolean}</span></h4> - - - - -<div class="description"> - <p>Deprecated wrapper around <code>Poll.remove()</code>.</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> + + + <h5>Returns:</h5> + <table class="params"> <thead> <tr> - <th>Name</th> - - <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array containing the sorted keys of the given object.</td> + </tr> + + </tbody> +</table> - + + + +</dd> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="stop"> + + stop<span class="signature">(entry)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + luci.js, line 2027 + </div> + + </div> - <th class="last">Description</th> - </tr> - </thead> + +</dt> +<dd> + + + <div class="description"> + <p>Deprecated wrapper around <code>Poll.remove()</code>.</p> + </div> + - <tbody> + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>entry</code></td> - + <td class="type"> @@ -3774,165 +4434,151 @@ addresses or numeric values respectively.</p></td> </td> - - - - <td class="description last"><p>The polling function to remove.</p></td> + + <td class="description last"> + + <p>The polling function to remove.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + - - - <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2027">line 2027</a> - </li></ul></dd> - - - </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns <code>true</code> when the function has been removed or <code>false</code> if -it could not be found.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">boolean</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when the function has been removed or <code>false</code> if +it could not be found.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="toArray"> + + toArray<span class="signature">(val)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<*>}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1839 + </div> + + </div> - <h4 class="name" id="toArray"><span class="type-signature"></span>toArray<span class="signature">(val)</span><span class="type-signature"> → {Array.<*>}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Converts the given value to an array. If the given value is of + <div class="description"> + <p>Converts the given value to an array. If the given value is of type array, it is returned as-is, values of type object are returned as one-element array containing the object, empty strings and <code>null</code> values are returned as empty array, all other values are converted using <code>String()</code>, trimmed, split on white space and returned as array.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>val</code></td> - + <td class="type"> @@ -3941,163 +4587,147 @@ space and returned as array.</p> </td> - - - - <td class="description last"><p>The value to convert into an array.</p></td> + + <td class="description last"> + + <p>The value to convert into an array.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1839">line 1839</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the resulting array.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">Array.<*></span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + Array.<*> + + + </td> + <td class="description last">Returns the resulting array.</td> + </tr> + + </tbody> +</table> - - - + + + +</dd> - +<dt> + <div class="nameContainer"> + <h4 class="name" id="url"> + + url<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + <div class="tag-source"> + luci.js, line 1710 + </div> + + </div> - <h4 class="name" id="url"><span class="type-signature"></span>url<span class="signature">(parts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string}</span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>Construct an URL pathrelative to the script path of the server + <div class="description"> + <p>Construct an URL pathrelative to the script path of the server side LuCI application (usually <code>/cgi-bin/luci</code>).</p> <p>The resulting URL is guaranteed to only contain the characters <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well as <code>/</code> for the path separator.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>parts</code></td> - + <td class="type"> @@ -4106,176 +4736,159 @@ as <code>/</code> for the path separator.</p> </td> - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - <td class="description last"><p>An array of parts to join into an URL path. Parts may contain + <td class="description last"> + + + <span class="optional">optional</span> + + + + + + <p>An array of parts to join into an URL path. Parts may contain slashes and any of the other characters mentioned above.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1710">line 1710</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + <h5>Returns:</h5> + - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>Returns the resulting URL path.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> +<table class="params"> + <thead> + <tr> -<span class="param-type">string</span> - - - </dd> -</dl> - + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the resulting URL path.</td> + </tr> + + </tbody> +</table> - - - - - + + +</dd> + </dl> + + <h3 class="subsection-title">Type Definitions</h3> - + <dl> - +<dt> + <div class="nameContainer"> + <h4 class="name" id=".requestCallbackFn"> + + LuCI.requestCallbackFn<span class="signature">(xhr, data, duration)</span> + </h4> + + <div class="tag-source"> + luci.js, line 1877 + </div> + + </div> - <h4 class="name" id=".requestCallbackFn"><span class="type-signature"></span>requestCallbackFn<span class="signature">(xhr, data, duration)</span><span class="type-signature"></span></h4> +</dt> +<dd> - - - - -<div class="description"> - <p>The request callback function is invoked whenever an HTTP + <div class="description"> + <p>The request callback function is invoked whenever an HTTP reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or <code>L.poll()</code> function is timed out or received successfully.</p> -</div> - - - - - - - - + </div> + - <h5>Parameters:</h5> + + + + + <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>xhr</code></td> - + <td class="type"> @@ -4284,21 +4897,21 @@ reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or </td> - - - - <td class="description last"><p>The XMLHTTPRequest instance used to make the request.</p></td> + + <td class="description last"> + + <p>The XMLHTTPRequest instance used to make the request.</p></td> </tr> - - - + + + <tr> <td class="name"><code>data</code></td> - + <td class="type"> @@ -4307,22 +4920,22 @@ reply to a request made using the <code>L.get()</code>, <code>L.post()</code> or </td> - - - - <td class="description last"><p>The response JSON if the response could be parsed as such, + + <td class="description last"> + + <p>The response JSON if the response could be parsed as such, else <code>null</code>.</p></td> </tr> - - - + + + <tr> <td class="name"><code>duration</code></td> - + <td class="type"> @@ -4331,106 +4944,80 @@ else <code>null</code>.</p></td> </td> - - - - <td class="description last"><p>The total duration of the request in milliseconds.</p></td> + + <td class="description last"> + + <p>The total duration of the request in milliseconds.</p></td> </tr> - - - </tbody> + + + </tbody> </table> - - - - - - + + + <dl class="details"> - - + - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line1877">line 1877</a> - </li></ul></dd> - - - + + </dl> + + + + + + + + + + +</dd> - - - - - - - - - - - - - - - - - + </dl> + + </article> -</section> - +</section> -</div> - -<nav> - <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LuCI.html">LuCI</a></li><li><a href="LuCI.Class.html">Class</a></li><li><a href="LuCI.dom.html">dom</a></li><li><a href="LuCI.fs.html">fs</a></li><li><a href="LuCI.Headers.html">Headers</a></li><li><a href="LuCI.Network.html">Network</a></li><li><a href="LuCI.Network.Device.html">Device</a></li><li><a href="LuCI.Network.Hosts.html">Hosts</a></li><li><a href="LuCI.Network.Protocol.html">Protocol</a></li><li><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></li><li><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></li><li><a href="LuCI.Poll.html">Poll</a></li><li><a href="LuCI.Request.html">Request</a></li><li><a href="LuCI.Request.poll.html">poll</a></li><li><a href="LuCI.Response.html">Response</a></li><li><a href="LuCI.rpc.html">rpc</a></li><li><a href="LuCI.uci.html">uci</a></li><li><a href="LuCI.view.html">view</a></li><li><a href="LuCI.XHR.html">XHR</a></li></ul> -</nav> -<br class="clear"> -<footer> - Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -</footer> + -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> </body> </html>
\ No newline at end of file |