diff options
Diffstat (limited to 'jsapi/network.js.html')
| -rw-r--r-- | jsapi/network.js.html | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/jsapi/network.js.html b/jsapi/network.js.html index 96f8747bfd..481ee1a271 100644 --- a/jsapi/network.js.html +++ b/jsapi/network.js.html @@ -4181,7 +4181,7 @@ var Hosts, Network, Protocol, Device, WifiDevice, WifiNetwork; * @hideconstructor * @classdesc * - * The `LuCI.network` class combines data from multiple `ubus` apis to + * The `LuCI.network` class combines data from multiple `ubus` APIs to * provide an abstraction of the current network configuration state. * * It provides methods to enumerate interfaces and devices, to query @@ -4293,11 +4293,11 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { }, /** - * Instantiates the given {@link LuCI.network.Protocol Protocol} backend, + * Instantiates the given {@link LuCI.network.Protocol Protocol} back-end, * optionally using the given network name. * * @param {string} protoname - * The protocol backend to use, e.g. `static` or `dhcp`. + * The protocol back-end to use, e.g. `static` or `dhcp`. * * @param {string} [netname=__dummy__] * The network name to use for the instantiated protocol. This should be @@ -4306,7 +4306,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * without the need for an existing interface. * * @returns {null|LuCI.network.Protocol} - * Returns the instantiated protocol backend class or `null` if the given + * Returns the instantiated protocol back-end class or `null` if the given * protocol isn't known. */ getProtocol: function(protoname, netname) { @@ -4319,7 +4319,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { /** * Obtains instances of all known {@link LuCI.network.Protocol Protocol} - * backend classes. + * back-end classes. * * @returns {Array<LuCI.network.Protocol>} * Returns an array of protocol class instances. @@ -4879,7 +4879,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * the given wireless radio. * * @param {string} devname - * The configuration name of the wireless radio to lookup, e.g. `radio0` + * The configuration name of the wireless radio to look up, e.g. `radio0` * for the first mac80211 phy on the system. * * @returns {Promise<null|LuCI.network.WifiDevice>} @@ -4926,7 +4926,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * the given wireless network. * * @param {string} netname - * The name of the wireless network to lookup. This may be either an uci + * The name of the wireless network to look up. This may be either an uci * configuration section ID, a network ID in the form `radio#.network#` * or a Linux network device name like `wlan0` which is resolved to the * corresponding configuration section through `ubus` runtime information. @@ -5324,10 +5324,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the hostname associated with the given MAC address. + * Look up the hostname associated with the given MAC address. * * @param {string} mac - * The MAC address to lookup. + * The MAC address to look up. * * @returns {null|string} * Returns the hostname associated with the given MAC or `null` if @@ -5341,10 +5341,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the IPv4 address associated with the given MAC address. + * Look up the IPv4 address associated with the given MAC address. * * @param {string} mac - * The MAC address to lookup. + * The MAC address to look up. * * @returns {null|string} * Returns the IPv4 address associated with the given MAC or `null` if @@ -5358,10 +5358,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the IPv6 address associated with the given MAC address. + * Look up the IPv6 address associated with the given MAC address. * * @param {string} mac - * The MAC address to lookup. + * The MAC address to look up. * * @returns {null|string} * Returns the IPv6 address associated with the given MAC or `null` if @@ -5375,10 +5375,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the hostname associated with the given IPv4 address. + * Look up the hostname associated with the given IPv4 address. * * @param {string} ipaddr - * The IPv4 address to lookup. + * The IPv4 address to look up. * * @returns {null|string} * Returns the hostname associated with the given IPv4 or `null` if @@ -5401,10 +5401,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the MAC address associated with the given IPv4 address. + * Look up the MAC address associated with the given IPv4 address. * * @param {string} ipaddr - * The IPv4 address to lookup. + * The IPv4 address to look up. * * @returns {null|string} * Returns the MAC address associated with the given IPv4 or `null` if @@ -5424,10 +5424,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the hostname associated with the given IPv6 address. + * Look up the hostname associated with the given IPv6 address. * * @param {string} ip6addr - * The IPv6 address to lookup. + * The IPv6 address to look up. * * @returns {null|string} * Returns the hostname associated with the given IPv6 or `null` if @@ -5450,10 +5450,10 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { }, /** - * Lookup the MAC address associated with the given IPv6 address. + * Look up the MAC address associated with the given IPv6 address. * * @param {string} ip6addr - * The IPv6 address to lookup. + * The IPv6 address to look up. * * @returns {null|string} * Returns the MAC address associated with the given IPv6 or `null` if @@ -5788,7 +5788,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * * @returns {string[]} * Returns an array of IPv4 DNS servers registered by the remote - * protocol backend. + * protocol back-end. */ getDNSAddrs: function() { var addrs = this._ubus('dns-server'), @@ -5876,7 +5876,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * * @returns {string[]} * Returns an array of IPv6 DNS servers registered by the remote - * protocol backend. + * protocol back-end. */ getDNS6Addrs: function() { var addrs = this._ubus('dns-server'), @@ -5967,7 +5967,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { }, /** - * Check function for the protocol handler if a new interface is createable. + * Check function for the protocol handler if a new interface is creatable. * * This function should be overwritten by protocol specific subclasses. * @@ -5977,7 +5977,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * The name of the interface to be created. * * @returns {Promise<void>} - * Returns a promise resolving if new interface is createable, else + * Returns a promise resolving if new interface is creatable, else * rejects with an error message string. */ isCreateable: function(ifname) { @@ -6082,7 +6082,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { }, /** - * Checks whether this logical interface is "empty", meaning that ut + * Checks whether this logical interface is "empty", where empty means that it * has no network devices attached. * * @returns {boolean} @@ -6207,7 +6207,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { }, /** - * Returns the layer 2 linux network device currently associated + * Returns the layer 2 Linux network device currently associated * with this logical interface. * * @returns {LuCI.network.Device} @@ -6220,7 +6220,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { }, /** - * Returns the layer 3 linux network device currently associated + * Returns the layer 3 Linux network device currently associated * with this logical interface. * * @returns {LuCI.network.Device} @@ -6405,7 +6405,7 @@ Device = baseclass.extend(/** @lends LuCI.network.Device.prototype */ { * * @returns {null|string} * Returns the MAC address of the device or `null` if not applicable, - * e.g. for non-ethernet tunnel devices. + * e.g. for non-Ethernet tunnel devices. */ getMAC: function() { var mac = this._devstate('macaddr'); @@ -6482,8 +6482,8 @@ Device = baseclass.extend(/** @lends LuCI.network.Device.prototype */ { * Get a short description string for the device. * * @returns {string} - * Returns the device name for non-wifi devices or a string containing - * the operation mode and SSID for wifi devices. + * Returns the device name for non-WiFi devices or a string containing + * the operation mode and SSID for WiFi devices. */ getShortName: function() { if (this.wif != null) @@ -6497,7 +6497,7 @@ Device = baseclass.extend(/** @lends LuCI.network.Device.prototype */ { * * @returns {string} * Returns a string containing the type description and device name - * for non-wifi devices or operation mode and ssid for wifi ones. + * for non-WiFi devices or operation mode and SSID for WiFi ones. */ getI18n: function() { if (this.wif != null) { @@ -6677,7 +6677,7 @@ Device = baseclass.extend(/** @lends LuCI.network.Device.prototype */ { * * @returns {boolean} * Returns true if the device has a carrier, e.g. when a cable is - * inserted into an ethernet port of false if there is none. + * inserted into an Ethernet port of false if there is none. */ getCarrier: function() { var link = this._devstate('link'); @@ -6689,8 +6689,8 @@ Device = baseclass.extend(/** @lends LuCI.network.Device.prototype */ { * * @returns {number|null} * Returns the current speed of the network device in Mbps. If the - * device supports no ethernet speed levels, null is returned. - * If the device supports ethernet speeds but has no carrier, -1 is + * device supports no Ethernet speed levels, null is returned. + * If the device supports Ethernet speeds but has no carrier, -1 is * returned. */ getSpeed: function() { @@ -7005,7 +7005,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { * Get the wifi network of the given name belonging to this radio device * * @param {string} network - * The name of the wireless network to lookup. This may be either an uci + * The name of the wireless network to look up. This may be either an uci * configuration section ID, a network ID in the form `radio#.network#` * or a Linux network device name like `wlan0` which is resolved to the * corresponding configuration section through `ubus` runtime information. @@ -7073,7 +7073,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { * radio device. * * @param {string} network - * The name of the wireless network to lookup. This may be either an uci + * The name of the wireless network to look up. This may be either an uci * configuration section ID, a network ID in the form `radio#.network#` * or a Linux network device name like `wlan0` which is resolved to the * corresponding configuration section through `ubus` runtime information. @@ -7305,7 +7305,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ }, /** - * Get the name of the corresponding wifi radio device. + * Get the name of the corresponding WiFi radio device. * * @returns {null|string} * Returns the name of the radio device this network is configured on @@ -7316,11 +7316,11 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ }, /** - * Get the corresponding wifi radio device. + * Get the corresponding WiFi radio device. * * @returns {null|LuCI.network.WifiDevice} * Returns a `Network.WifiDevice` instance representing the corresponding - * wifi radio device or `null` if the related radio device could not be + * WiFi radio device or `null` if the related radio device could not be * found. */ getWifiDevice: function() { @@ -7659,7 +7659,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ }, /** - * Query the current average bitrate of all peers associated to this + * Query the current average bit-rate of all peers associated to this * wireless network. * * @returns {null|number} @@ -7867,10 +7867,10 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ }, /** - * Check whether this wifi network supports de-authenticating clients. + * Check whether this WiFi network supports de-authenticating clients. * * @returns {boolean} - * Returns `true` when this wifi network instance supports forcibly + * Returns `true` when this WiFi network instance supports forcibly * de-authenticating clients, otherwise `false`. */ isClientDisconnectSupported: function() { @@ -7930,7 +7930,7 @@ return Network; <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Dec 23 2023 07:03:28 GMT+0000 (Coordinated Universal Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sat Dec 23 2023 16:26:46 GMT+0000 (Coordinated Universal Time) </footer> </div> </div> |