From 8571afe11cbc1c7298af08d5b6b05dd28278badc Mon Sep 17 00:00:00 2001 From: jow- Date: Tue, 26 Sep 2023 07:48:16 +0000 Subject: [PATCH] deploy: 957a6313bd6371e5afae20573a43f5440948e66e --- jsapi/LuCI.baseclass.html | 6 +- jsapi/LuCI.dom.html | 18 +++--- jsapi/LuCI.form.AbstractElement.html | 12 ++-- jsapi/LuCI.form.AbstractSection.html | 26 ++++----- jsapi/LuCI.form.AbstractValue.html | 29 +++++----- jsapi/LuCI.form.ButtonValue.html | 33 ++++++----- jsapi/LuCI.form.DummyValue.html | 35 ++++++------ jsapi/LuCI.form.DynamicList.html | 33 ++++++----- jsapi/LuCI.form.FileUpload.html | 33 ++++++----- jsapi/LuCI.form.FlagValue.html | 33 ++++++----- jsapi/LuCI.form.GridSection.html | 30 +++++----- jsapi/LuCI.form.HiddenValue.html | 33 ++++++----- jsapi/LuCI.form.JSONMap.html | 28 +++++----- jsapi/LuCI.form.ListValue.html | 35 ++++++------ jsapi/LuCI.form.Map.html | 30 +++++----- jsapi/LuCI.form.MultiValue.html | 33 ++++++----- jsapi/LuCI.form.NamedSection.html | 26 ++++----- jsapi/LuCI.form.SectionValue.html | 33 ++++++----- jsapi/LuCI.form.TableSection.html | 26 ++++----- jsapi/LuCI.form.TextValue.html | 29 +++++----- jsapi/LuCI.form.TypedSection.html | 26 ++++----- jsapi/LuCI.form.Value.html | 33 ++++++----- jsapi/LuCI.form.html | 4 +- jsapi/LuCI.fs.html | 24 ++++++-- jsapi/LuCI.headers.html | 2 +- jsapi/LuCI.html | 30 ++++++---- jsapi/LuCI.network.Device.html | 2 +- jsapi/LuCI.network.Hosts.html | 2 +- jsapi/LuCI.network.Protocol.html | 14 ++--- jsapi/LuCI.network.WifiDevice.html | 10 ++-- jsapi/LuCI.network.WifiNetwork.html | 20 +++---- jsapi/LuCI.network.html | 18 +++--- jsapi/LuCI.poll.html | 10 ++-- jsapi/LuCI.request.html | 10 ++-- jsapi/LuCI.request.poll.html | 4 +- jsapi/LuCI.response.html | 2 +- jsapi/LuCI.rpc.html | 14 ++--- jsapi/LuCI.session.html | 2 +- jsapi/LuCI.uci.html | 82 ++++++++++++++-------------- jsapi/LuCI.ui.AbstractElement.html | 6 +- jsapi/LuCI.ui.Checkbox.html | 6 +- jsapi/LuCI.ui.ComboButton.html | 8 +-- jsapi/LuCI.ui.Combobox.html | 6 +- jsapi/LuCI.ui.Dropdown.html | 6 +- jsapi/LuCI.ui.DynamicList.html | 8 +-- jsapi/LuCI.ui.FileUpload.html | 10 ++-- jsapi/LuCI.ui.Hiddenfield.html | 6 +- jsapi/LuCI.ui.Select.html | 11 ++-- jsapi/LuCI.ui.Textarea.html | 6 +- jsapi/LuCI.ui.Textfield.html | 6 +- jsapi/LuCI.ui.changes.html | 6 +- jsapi/LuCI.ui.html | 39 +++++++------ jsapi/LuCI.ui.menu.html | 6 +- jsapi/LuCI.ui.tabs.html | 2 +- jsapi/LuCI.view.html | 8 +-- jsapi/LuCI.xhr.html | 2 +- jsapi/form.js.html | 70 ++++++++++++------------ jsapi/fs.js.html | 8 +-- jsapi/index.html | 2 +- jsapi/luci.js.html | 66 +++++++++++----------- jsapi/network.js.html | 56 +++++++++---------- jsapi/rpc.js.html | 12 ++-- jsapi/uci.js.html | 54 +++++++++--------- jsapi/ui.js.html | 66 +++++++++++----------- 64 files changed, 703 insertions(+), 643 deletions(-) diff --git a/jsapi/LuCI.baseclass.html b/jsapi/LuCI.baseclass.html index c428d3f9f8..4c3dfb0e62 100644 --- a/jsapi/LuCI.baseclass.html +++ b/jsapi/LuCI.baseclass.html @@ -3770,7 +3770,7 @@ subclass.

- Returns a new LuCI.baseclass sublassed from this class, extended + Returns a new LuCI.baseclass subclassed from this class, extended by the given properties and with its prototype set to this base class to enable inheritance. The resulting value represents a class constructor and can be instantiated with new. @@ -4677,7 +4677,7 @@ would copy all values till the end.

repeatable -

Extra arguments to add to prepend to the resultung array.

+

Extra arguments to add to prepend to the resulting array.

@@ -4774,7 +4774,7 @@ and the values extracted from the args array beginning with diff --git a/jsapi/LuCI.dom.html b/jsapi/LuCI.dom.html index e51c5ca664..c21a35cd3d 100644 --- a/jsapi/LuCI.dom.html +++ b/jsapi/LuCI.dom.html @@ -3739,7 +3739,7 @@ external JavaScript, use L.require("dom").then(...).

< -

The childrens to append to the given node.

+

The children to append to the given node.

When children is an array, then each item of the array will be either appended as child element or text node, depending on whether the item is a DOM Node instance or @@ -3751,10 +3751,10 @@ the passed node argument as sole parameter and the appendnode argument as first and the return value of the children function as second parameter.

-

When children is is a DOM Node instance, it will be +

When children is a DOM Node instance, it will be appended to the given node.

When children is any other non-null value, it will be -converted to a string and appened to the innerHTML property +converted to a string and appended to the innerHTML property of the given node.

@@ -3987,7 +3987,7 @@ added as attribute to the given node, using the given key

When val is of any other type, it will be added as attribute to the given node as-is, with the underlying setAttribute() -call implicitely turning it into a string.

+call implicitly turning it into a string.

@@ -4475,7 +4475,7 @@ instance didn't have the requested method.

Replaces the content of the given node with the given children.

This function first removes any children of the given DOM -Node and then adds the given given children following the +Node and then adds the given children following the rules outlined below.

@@ -4558,7 +4558,7 @@ rules outlined below.

-

The childrens to replace into the given node.

+

The children to replace into the given node.

When children is an array, then each item of the array will be either appended as child element or text node, depending on whether the item is a DOM Node instance or @@ -4570,10 +4570,10 @@ the passed node argument as sole parameter and the appendnode argument as first and the return value of the children function as second parameter.

-

When children is is a DOM Node instance, it will be +

When children is a DOM Node instance, it will be appended to the given node.

When children is any other non-null value, it will be -converted to a string and appened to the innerHTML property +converted to a string and appended to the innerHTML property of the given node.

@@ -6332,7 +6332,7 @@ ignored, else not.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractElement.html b/jsapi/LuCI.form.AbstractElement.html index db39ba0438..9fa3628130 100644 --- a/jsapi/LuCI.form.AbstractElement.html +++ b/jsapi/LuCI.form.AbstractElement.html @@ -3642,7 +3642,7 @@ properties.

- append(element) + append(obj)

@@ -3689,7 +3689,7 @@ properties.

- element + obj @@ -3777,7 +3777,7 @@ properties.

Parse this elements form input.

The parse() function recursively walks the form element tree and triggers input value reading and validation for each encountered element.

-

Elements which are hidden due to unsatisified dependencies are skipped.

+

Elements which are hidden due to unsatisfied dependencies are skipped.

@@ -3970,7 +3970,7 @@ the form element's markup, including the markup of any child elements.

- stripTags(input){string} + stripTags(s){string}

@@ -4017,7 +4017,7 @@ the form element's markup, including the markup of any child elements. - input + s @@ -4321,7 +4321,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractSection.html b/jsapi/LuCI.form.AbstractSection.html index e1c7615c6f..dcbebee0f7 100644 --- a/jsapi/LuCI.form.AbstractSection.html +++ b/jsapi/LuCI.form.AbstractSection.html @@ -3702,7 +3702,7 @@ this property will hold a reference to the parent option instance.

inherited - append(element) + append(obj) @@ -3749,7 +3749,7 @@ this property will hold a reference to the parent option instance.

- element + obj @@ -5024,7 +5024,7 @@ should be used instead if this form section element uses tabs.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -5055,7 +5055,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -5187,7 +5187,7 @@ descendent of AbstractValue.

The parse() function recursively walks the section element tree and triggers input value reading and validation for each encountered child option element.

-

Options which are hidden due to unsatisified dependencies are skipped.

+

Options which are hidden due to unsatisfied dependencies are skipped.

@@ -5383,7 +5383,7 @@ the form element's markup, including the markup of any child elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -5430,7 +5430,7 @@ the form element's markup, including the markup of any child elements. - input + s @@ -5713,7 +5713,7 @@ contents. If omitted, no description will be rendered.

-

Throws an exeption if a tab with the same name already exists.

+

Throws an exception if a tab with the same name already exists.

@@ -5745,7 +5745,7 @@ contents. If omitted, no description will be rendered.

- taboption(tabname, optionclass, classargs){LuCI.form.AbstractValue} + taboption(tabName, optionclass, classargs){LuCI.form.AbstractValue}

@@ -5792,7 +5792,7 @@ contents. If omitted, no description will be rendered.

- tabname + tabName @@ -5843,7 +5843,7 @@ contents. If omitted, no description will be rendered.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -5874,7 +5874,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -6220,7 +6220,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractValue.html b/jsapi/LuCI.form.AbstractValue.html index 9eefb648e1..81da1890df 100644 --- a/jsapi/LuCI.form.AbstractValue.html +++ b/jsapi/LuCI.form.AbstractValue.html @@ -4017,7 +4017,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4380,7 +4380,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4427,7 +4427,7 @@ table section elements.

- element + obj @@ -4848,7 +4848,7 @@ different way.

- depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value)

@@ -4864,9 +4864,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -4875,7 +4875,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -4966,7 +4966,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -4986,20 +4986,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6417,7 +6420,7 @@ the form element's markup, including the markup of any child elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -6464,7 +6467,7 @@ the form element's markup, including the markup of any child elements. - input + s @@ -7275,7 +7278,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.ButtonValue.html b/jsapi/LuCI.form.ButtonValue.html index 35b01df3c8..e295b09647 100644 --- a/jsapi/LuCI.form.ButtonValue.html +++ b/jsapi/LuCI.form.ButtonValue.html @@ -4450,7 +4450,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4813,7 +4813,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4860,7 +4860,7 @@ table section elements.

- element + obj @@ -5287,7 +5287,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5303,9 +5303,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5314,7 +5314,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5405,7 +5405,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5425,20 +5425,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6764,7 +6767,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6811,7 +6814,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7286,7 +7289,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7359,7 +7362,7 @@ custom value.

- value + val @@ -7598,7 +7601,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.DummyValue.html b/jsapi/LuCI.form.DummyValue.html index edde34134c..92859534da 100644 --- a/jsapi/LuCI.form.DummyValue.html +++ b/jsapi/LuCI.form.DummyValue.html @@ -3873,7 +3873,7 @@ option to the section.

-

Set an URL which is opened when clicking on the dummy value text.

+

Set a URL which is opened when clicking on the dummy value text.

By setting this property, the dummy value text is wrapped in an <a> element with the property value used as href attribute.

@@ -4436,7 +4436,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4799,7 +4799,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4846,7 +4846,7 @@ table section elements.

- element + obj @@ -5273,7 +5273,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5289,9 +5289,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5300,7 +5300,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5391,7 +5391,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5411,20 +5411,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6750,7 +6753,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6797,7 +6800,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7272,7 +7275,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7345,7 +7348,7 @@ custom value.

- value + val @@ -7584,7 +7587,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.DynamicList.html b/jsapi/LuCI.form.DynamicList.html index 955de736aa..2db847c418 100644 --- a/jsapi/LuCI.form.DynamicList.html +++ b/jsapi/LuCI.form.DynamicList.html @@ -4287,7 +4287,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4650,7 +4650,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4697,7 +4697,7 @@ table section elements.

- element + obj @@ -5124,7 +5124,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5140,9 +5140,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5151,7 +5151,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5242,7 +5242,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5262,20 +5262,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6601,7 +6604,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6648,7 +6651,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7123,7 +7126,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7196,7 +7199,7 @@ custom value.

- value + val @@ -7435,7 +7438,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.FileUpload.html b/jsapi/LuCI.form.FileUpload.html index 4f2f386227..31291c9ca9 100644 --- a/jsapi/LuCI.form.FileUpload.html +++ b/jsapi/LuCI.form.FileUpload.html @@ -4498,7 +4498,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4861,7 +4861,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4908,7 +4908,7 @@ table section elements.

- element + obj @@ -5335,7 +5335,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5351,9 +5351,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5362,7 +5362,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5453,7 +5453,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5473,20 +5473,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6812,7 +6815,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6859,7 +6862,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7334,7 +7337,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7407,7 +7410,7 @@ custom value.

- value + val @@ -7646,7 +7649,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.FlagValue.html b/jsapi/LuCI.form.FlagValue.html index 4d4ba3a42f..4b45e17c9b 100644 --- a/jsapi/LuCI.form.FlagValue.html +++ b/jsapi/LuCI.form.FlagValue.html @@ -4382,7 +4382,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4745,7 +4745,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4792,7 +4792,7 @@ table section elements.

- element + obj @@ -5219,7 +5219,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5235,9 +5235,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5246,7 +5246,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5337,7 +5337,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5357,20 +5357,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6695,7 +6698,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6742,7 +6745,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7212,7 +7215,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7285,7 +7288,7 @@ custom value.

- value + val @@ -7524,7 +7527,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.GridSection.html b/jsapi/LuCI.form.GridSection.html index c9b29a5fa3..f96c17bf84 100644 --- a/jsapi/LuCI.form.GridSection.html +++ b/jsapi/LuCI.form.GridSection.html @@ -3548,7 +3548,7 @@ elements added with tabopti are displayed in the modal popup.

Another important difference is that the table cells show a readonly text preview of the corresponding option elements by default, unless the child -option element is explicitely made writable by setting the editable +option element is explicitly made writable by setting the editable property to true.

Additionally, the grid section honours a modalonly property of child option elements. Refer to the AbstractValue @@ -4763,7 +4763,7 @@ e.g. query additional data or to inject further option elements.

Return values of this function are ignored but if a promise is returned, it is run to completion before the rendering is continued, allowing -custom logic to perform asynchroneous work before the modal dialog +custom logic to perform asynchronous work before the modal dialog is shown. @@ -4783,7 +4783,7 @@ is shown. inherited - append(element) + append(obj) @@ -4830,7 +4830,7 @@ is shown. - element + obj @@ -5991,7 +5991,7 @@ should be used instead if this form section element uses tabs.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -6022,7 +6022,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -6156,7 +6156,7 @@ descendent of AbstractValue.

The parse() function recursively walks the section element tree and triggers input value reading and validation for each encountered child option element.

-

Options which are hidden due to unsatisified dependencies are skipped.

+

Options which are hidden due to unsatisfied dependencies are skipped.

@@ -6244,7 +6244,7 @@ not meeting the validation constraints of their respective elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -6291,7 +6291,7 @@ not meeting the validation constraints of their respective elements. - input + s @@ -6573,7 +6573,7 @@ contents. If omitted, no description will be rendered.

-

Throws an exeption if a tab with the same name already exists.

+

Throws an exception if a tab with the same name already exists.

@@ -6607,7 +6607,7 @@ contents. If omitted, no description will be rendered.

inherited - taboption(tabname, optionclass, classargs){LuCI.form.AbstractValue} + taboption(tabName, optionclass, classargs){LuCI.form.AbstractValue} @@ -6654,7 +6654,7 @@ contents. If omitted, no description will be rendered.

- tabname + tabName @@ -6705,7 +6705,7 @@ contents. If omitted, no description will be rendered.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -6736,7 +6736,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -7082,7 +7082,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.HiddenValue.html b/jsapi/LuCI.form.HiddenValue.html index 79efc8dbcf..304d167a74 100644 --- a/jsapi/LuCI.form.HiddenValue.html +++ b/jsapi/LuCI.form.HiddenValue.html @@ -4291,7 +4291,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4654,7 +4654,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4701,7 +4701,7 @@ table section elements.

- element + obj @@ -5128,7 +5128,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5144,9 +5144,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5155,7 +5155,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5246,7 +5246,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5266,20 +5266,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6605,7 +6608,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6652,7 +6655,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7127,7 +7130,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7200,7 +7203,7 @@ custom value.

- value + val @@ -7439,7 +7442,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.JSONMap.html b/jsapi/LuCI.form.JSONMap.html index 33d95a9f20..d42297c6e7 100644 --- a/jsapi/LuCI.form.JSONMap.html +++ b/jsapi/LuCI.form.JSONMap.html @@ -3685,7 +3685,7 @@ corresponding headline element will not be rendered.

The description text of the form which is usually rendered as text -paragraph below the form title and before the actual form conents. +paragraph below the form title and before the actual form contents. If omitted, the corresponding paragraph element will not be rendered.

@@ -3819,7 +3819,7 @@ permissions are granted.

inherited - append(element) + append(obj) @@ -3866,7 +3866,7 @@ permissions are granted.

- element + obj @@ -4616,7 +4616,7 @@ an error. inherited - lookupOption(name_or_id, section_id, config){Array.<LuCI.form.AbstractValue, string>|null} + lookupOption(name, section_id, config_name){Array.<LuCI.form.AbstractValue, string>|null} @@ -4663,7 +4663,7 @@ an error. - name_or_id + name @@ -4722,7 +4722,7 @@ omitted if a full ID is passed as first argument.

- config + config_name @@ -4745,7 +4745,7 @@ omitted if a full ID is passed as first argument.

-

The name of the UCI configuration the option instance is belonging to. +

The name of the UCI configuration the option instance belongs to. Defaults to the main UCI configuration of the map if omitted.

@@ -4854,7 +4854,7 @@ Returns null if the option could not be found.

Parse the form input values.

The parse() function recursively walks the form element tree and triggers input value reading and validation for each child element.

-

Elements which are hidden due to unsatisified dependencies are skipped.

+

Elements which are hidden due to unsatisfied dependencies are skipped.

@@ -5266,7 +5266,7 @@ additional data manipulation steps before saving the changes.

If set to true, trigger an alert message to the user in case saving -the form data failes. Otherwise fail silently.

+the form data failures. Otherwise fail silently.

@@ -5430,7 +5430,7 @@ documentation of the different section classes for details.

The section class to use for rendering the configuration section. Note that this value must be the class itself, not a class instance -obtained from calling new. It must also be a class dervied from +obtained from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -5461,7 +5461,7 @@ obtained from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given section class. Refer to the class specific constructor documentation for details.

@@ -5547,7 +5547,7 @@ documentation for details.

inherited - stripTags(input){string} + stripTags(s){string} @@ -5594,7 +5594,7 @@ documentation for details.

- input + s @@ -5900,7 +5900,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.ListValue.html b/jsapi/LuCI.form.ListValue.html index 83c2359c59..84d860b4bf 100644 --- a/jsapi/LuCI.form.ListValue.html +++ b/jsapi/LuCI.form.ListValue.html @@ -3540,7 +3540,7 @@

The ListValue class implements a simple static HTML select element -allowing the user to chose a single value from a set of predefined choices. +allowing the user chose a single value from a set of predefined choices. It builds upon the LuCI.ui.Select widget.

@@ -4436,7 +4436,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4799,7 +4799,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4846,7 +4846,7 @@ table section elements.

- element + obj @@ -5273,7 +5273,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5289,9 +5289,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5300,7 +5300,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5391,7 +5391,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5411,20 +5411,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6750,7 +6753,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6797,7 +6800,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7272,7 +7275,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7345,7 +7348,7 @@ custom value.

- value + val @@ -7584,7 +7587,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.Map.html b/jsapi/LuCI.form.Map.html index 63250aabef..64ff3c052a 100644 --- a/jsapi/LuCI.form.Map.html +++ b/jsapi/LuCI.form.Map.html @@ -3540,7 +3540,7 @@

The Map class represents one complete form. A form usually maps one UCI -configuraton file and is divided into multiple sections containing multiple +configuration file and is divided into multiple sections containing multiple fields each.

It serves as main entry point into the LuCI.form for typical view code.

@@ -3684,7 +3684,7 @@ corresponding headline element will not be rendered.

The description text of the form which is usually rendered as text -paragraph below the form title and before the actual form conents. +paragraph below the form title and before the actual form contents. If omitted, the corresponding paragraph element will not be rendered.

@@ -3818,7 +3818,7 @@ permissions are granted.

inherited - append(element) + append(obj) @@ -3865,7 +3865,7 @@ permissions are granted.

- element + obj @@ -4605,7 +4605,7 @@ an error.

- lookupOption(name_or_id, section_id, config){Array.<LuCI.form.AbstractValue, string>|null} + lookupOption(name, section_id, config_name){Array.<LuCI.form.AbstractValue, string>|null}

@@ -4652,7 +4652,7 @@ an error. - name_or_id + name @@ -4711,7 +4711,7 @@ omitted if a full ID is passed as first argument.

- config + config_name @@ -4734,7 +4734,7 @@ omitted if a full ID is passed as first argument.

-

The name of the UCI configuration the option instance is belonging to. +

The name of the UCI configuration the option instance belongs to. Defaults to the main UCI configuration of the map if omitted.

@@ -4841,7 +4841,7 @@ Returns null if the option could not be found.

Parse the form input values.

The parse() function recursively walks the form element tree and triggers input value reading and validation for each child element.

-

Elements which are hidden due to unsatisified dependencies are skipped.

+

Elements which are hidden due to unsatisfied dependencies are skipped.

@@ -5247,7 +5247,7 @@ additional data manipulation steps before saving the changes.

If set to true, trigger an alert message to the user in case saving -the form data failes. Otherwise fail silently.

+the form data failures. Otherwise fail silently.

@@ -5409,7 +5409,7 @@ documentation of the different section classes for details.

The section class to use for rendering the configuration section. Note that this value must be the class itself, not a class instance -obtained from calling new. It must also be a class dervied from +obtained from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -5440,7 +5440,7 @@ obtained from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given section class. Refer to the class specific constructor documentation for details.

@@ -5526,7 +5526,7 @@ documentation for details.

inherited - stripTags(input){string} + stripTags(s){string} @@ -5573,7 +5573,7 @@ documentation for details.

- input + s @@ -5879,7 +5879,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.MultiValue.html b/jsapi/LuCI.form.MultiValue.html index 2d9799ee09..bb7414c8fc 100644 --- a/jsapi/LuCI.form.MultiValue.html +++ b/jsapi/LuCI.form.MultiValue.html @@ -4387,7 +4387,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4750,7 +4750,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4797,7 +4797,7 @@ table section elements.

- element + obj @@ -5224,7 +5224,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5240,9 +5240,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5251,7 +5251,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5342,7 +5342,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5362,20 +5362,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6701,7 +6704,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6748,7 +6751,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7223,7 +7226,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7296,7 +7299,7 @@ custom value.

- value + val @@ -7535,7 +7538,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.NamedSection.html b/jsapi/LuCI.form.NamedSection.html index 9ec0231643..d886b2aacc 100644 --- a/jsapi/LuCI.form.NamedSection.html +++ b/jsapi/LuCI.form.NamedSection.html @@ -3972,7 +3972,7 @@ this property will hold a reference to the parent option instance.

inherited - append(element) + append(obj) @@ -4019,7 +4019,7 @@ this property will hold a reference to the parent option instance.

- element + obj @@ -5282,7 +5282,7 @@ should be used instead if this form section element uses tabs.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -5313,7 +5313,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -5447,7 +5447,7 @@ descendent of AbstractValue.

The parse() function recursively walks the section element tree and triggers input value reading and validation for each encountered child option element.

-

Options which are hidden due to unsatisified dependencies are skipped.

+

Options which are hidden due to unsatisfied dependencies are skipped.

@@ -5643,7 +5643,7 @@ the form element's markup, including the markup of any child elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -5690,7 +5690,7 @@ the form element's markup, including the markup of any child elements. - input + s @@ -5975,7 +5975,7 @@ contents. If omitted, no description will be rendered.

-

Throws an exeption if a tab with the same name already exists.

+

Throws an exception if a tab with the same name already exists.

@@ -6009,7 +6009,7 @@ contents. If omitted, no description will be rendered.

inherited - taboption(tabname, optionclass, classargs){LuCI.form.AbstractValue} + taboption(tabName, optionclass, classargs){LuCI.form.AbstractValue} @@ -6056,7 +6056,7 @@ contents. If omitted, no description will be rendered.

- tabname + tabName @@ -6107,7 +6107,7 @@ contents. If omitted, no description will be rendered.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -6138,7 +6138,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -6484,7 +6484,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.SectionValue.html b/jsapi/LuCI.form.SectionValue.html index 0cccc36725..7173dde952 100644 --- a/jsapi/LuCI.form.SectionValue.html +++ b/jsapi/LuCI.form.SectionValue.html @@ -4339,7 +4339,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4702,7 +4702,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4749,7 +4749,7 @@ table section elements.

- element + obj @@ -5173,7 +5173,7 @@ its cfgvalue() implementation will always return null. inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5189,9 +5189,9 @@ its cfgvalue() implementation will always return null.
-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5200,7 +5200,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5291,7 +5291,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5311,20 +5311,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6642,7 +6645,7 @@ its remove() implementation is a no-op.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6689,7 +6692,7 @@ its remove() implementation is a no-op.

- input + s @@ -7164,7 +7167,7 @@ was neither a string nor a function. inherited - value(key, value) + value(key, val) @@ -7235,7 +7238,7 @@ its value() implementation is a no-op.

- value + val @@ -7466,7 +7469,7 @@ its write() implementation is a no-op.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TableSection.html b/jsapi/LuCI.form.TableSection.html index d2594d932f..a8c2bcc486 100644 --- a/jsapi/LuCI.form.TableSection.html +++ b/jsapi/LuCI.form.TableSection.html @@ -4957,7 +4957,7 @@ e.g. query additional data or to inject further option elements.

Return values of this function are ignored but if a promise is returned, it is run to completion before the rendering is continued, allowing -custom logic to perform asynchroneous work before the modal dialog +custom logic to perform asynchronous work before the modal dialog is shown. @@ -4977,7 +4977,7 @@ is shown. inherited - append(element) + append(obj) @@ -5024,7 +5024,7 @@ is shown. - element + obj @@ -6185,7 +6185,7 @@ should be used instead if this form section element uses tabs.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -6216,7 +6216,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -6350,7 +6350,7 @@ descendent of AbstractValue.

The parse() function recursively walks the section element tree and triggers input value reading and validation for each encountered child option element.

-

Options which are hidden due to unsatisified dependencies are skipped.

+

Options which are hidden due to unsatisfied dependencies are skipped.

@@ -6438,7 +6438,7 @@ not meeting the validation constraints of their respective elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -6485,7 +6485,7 @@ not meeting the validation constraints of their respective elements. - input + s @@ -6783,7 +6783,7 @@ contents. If omitted, no description will be rendered.

inherited - taboption(tabname, optionclass, classargs){LuCI.form.AbstractValue} + taboption(tabName, optionclass, classargs){LuCI.form.AbstractValue} @@ -6830,7 +6830,7 @@ contents. If omitted, no description will be rendered.

- tabname + tabName @@ -6881,7 +6881,7 @@ contents. If omitted, no description will be rendered.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -6912,7 +6912,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -7258,7 +7258,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TextValue.html b/jsapi/LuCI.form.TextValue.html index 92111c0d2b..f0019b626b 100644 --- a/jsapi/LuCI.form.TextValue.html +++ b/jsapi/LuCI.form.TextValue.html @@ -4482,7 +4482,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4845,7 +4845,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4892,7 +4892,7 @@ table section elements.

- element + obj @@ -5319,7 +5319,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5335,9 +5335,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5346,7 +5346,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5437,7 +5437,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5457,20 +5457,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6796,7 +6799,7 @@ implement alternative removal logic, e.g. to retain the original value.

inherited - stripTags(input){string} + stripTags(s){string} @@ -6843,7 +6846,7 @@ implement alternative removal logic, e.g. to retain the original value.

- input + s @@ -7482,7 +7485,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TypedSection.html b/jsapi/LuCI.form.TypedSection.html index 6973653f34..2cf58bdfd6 100644 --- a/jsapi/LuCI.form.TypedSection.html +++ b/jsapi/LuCI.form.TypedSection.html @@ -4203,7 +4203,7 @@ this property will hold a reference to the parent option instance.

inherited - append(element) + append(obj) @@ -4250,7 +4250,7 @@ this property will hold a reference to the parent option instance.

- element + obj @@ -5541,7 +5541,7 @@ should be used instead if this form section element uses tabs.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -5572,7 +5572,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -5706,7 +5706,7 @@ descendent of AbstractValue.

The parse() function recursively walks the section element tree and triggers input value reading and validation for each encountered child option element.

-

Options which are hidden due to unsatisified dependencies are skipped.

+

Options which are hidden due to unsatisfied dependencies are skipped.

@@ -5902,7 +5902,7 @@ the form element's markup, including the markup of any child elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -5949,7 +5949,7 @@ the form element's markup, including the markup of any child elements. - input + s @@ -6234,7 +6234,7 @@ contents. If omitted, no description will be rendered.

-

Throws an exeption if a tab with the same name already exists.

+

Throws an exception if a tab with the same name already exists.

@@ -6268,7 +6268,7 @@ contents. If omitted, no description will be rendered.

inherited - taboption(tabname, optionclass, classargs){LuCI.form.AbstractValue} + taboption(tabName, optionclass, classargs){LuCI.form.AbstractValue} @@ -6315,7 +6315,7 @@ contents. If omitted, no description will be rendered.

- tabname + tabName @@ -6366,7 +6366,7 @@ contents. If omitted, no description will be rendered.

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained -from calling new. It must also be a class dervied from +from calling new. It must also be a class derived from LuCI.form.AbstractSection.

@@ -6397,7 +6397,7 @@ from calling new. It must also be a class dervied from repeatable -

Additional arguments which are passed as-is to the contructor of the +

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.

@@ -6743,7 +6743,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.Value.html b/jsapi/LuCI.form.Value.html index 295186b2e8..80ad7281aa 100644 --- a/jsapi/LuCI.form.Value.html +++ b/jsapi/LuCI.form.Value.html @@ -4287,7 +4287,7 @@ with.

If set to true, the underlying ui input widget value is not cleared -from the configuration on unsatisfied depedencies. The default behavior +from the configuration on unsatisfied dependencies. The default behavior is to remove the values of all options whose dependencies are not fulfilled.

@@ -4650,7 +4650,7 @@ table section elements.

inherited - append(element) + append(obj) @@ -4697,7 +4697,7 @@ table section elements.

- element + obj @@ -5124,7 +5124,7 @@ different way.

inherited - depends(optionname_or_depends, optionvalue|RegExp) + depends(field, value) @@ -5140,9 +5140,9 @@ different way.

-

Add a dependency contraint to the option.

+

Add a dependency constraint to the option.

Dependency constraints allow making the presence of option elements -dependant on the current values of certain other options within the +dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be hidden from the view and its current value is omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are @@ -5151,7 +5151,7 @@ treated as alternatives, forming a logical "or" expression.

possible to depend on multiple options simultaneously, allowing to form a logical "and" expression.

Option names may be given in "dot notation" which allows to reference -option elements outside of the current form section. If a name without +option elements outside the current form section. If a name without dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

@@ -5242,7 +5242,7 @@ is ignored. The recognized tags are:

- optionname_or_depends + field @@ -5262,20 +5262,23 @@ is ignored. The recognized tags are:

The name of the option to depend on or an object describing multiple -dependencies which must be satified (a logical "and" expression).

+dependencies which must be satisfied (a logical "and" expression).

- optionvalue|RegExp + value string +| + +RegExp @@ -6709,7 +6712,7 @@ the form element's markup, including the markup of any child elements. inherited - stripTags(input){string} + stripTags(s){string} @@ -6756,7 +6759,7 @@ the form element's markup, including the markup of any child elements. - input + s @@ -7229,7 +7232,7 @@ was neither a string nor a function.

- value(key, value) + value(key, val)

@@ -7302,7 +7305,7 @@ custom value.

- value + val @@ -7541,7 +7544,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.html b/jsapi/LuCI.form.html index 8142882817..98a757374a 100644 --- a/jsapi/LuCI.form.html +++ b/jsapi/LuCI.form.html @@ -3539,7 +3539,7 @@ form -

The LuCI form class provides high level abstractions for creating creating +

The LuCI form class provides high level abstractions for creating UCI- or JSON backed configurations forms.

To import the class in views, use 'require form', to import it in external JavaScript, use L.require("form").then(...).

@@ -3742,7 +3742,7 @@ m.render().then(function(node) {
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.fs.html b/jsapi/LuCI.fs.html index 351f1c5e23..25e8750fd0 100644 --- a/jsapi/LuCI.fs.html +++ b/jsapi/LuCI.fs.html @@ -3989,7 +3989,13 @@ the ubus based exec call.

-string +"blob" +| + +"text" +| + +"blob" @@ -4672,7 +4678,13 @@ the ubus based read call.

-string +"blob" +| + +"text" +| + +"blob" @@ -4781,7 +4793,7 @@ reason.

- remove(The){Promise.<number>} + remove(path){Promise.<number>}

@@ -4828,7 +4840,7 @@ reason. - The + path @@ -4844,7 +4856,7 @@ reason. -

file path to remove.

+

The file path to remove.

@@ -5919,7 +5931,7 @@ the failure reason.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.headers.html b/jsapi/LuCI.headers.html index 701c381c7a..2f6f24e33a 100644 --- a/jsapi/LuCI.headers.html +++ b/jsapi/LuCI.headers.html @@ -3947,7 +3947,7 @@ Note: Header-Names are case-insensitive.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.html b/jsapi/LuCI.html index dd24b43ebc..aa47667e6c 100644 --- a/jsapi/LuCI.html +++ b/jsapi/LuCI.html @@ -4299,7 +4299,7 @@ as parameters.

A wrapper around raise() which also renders -the error either as modal overlay when ui.js is already loaed +the error either as modal overlay when ui.js is already loaded or directly into the view body.

@@ -5561,7 +5561,7 @@ not null, else returns false.
-

Construct an URL path relative to the media resource path of the +

Construct a URL path relative to the media resource path of the LuCI ui (usually /luci-static/$theme_name).

The resulting URL is guaranteed to only contain the characters a-z, A-Z, 0-9, _, ., %, ,, ;, and - as well @@ -5619,7 +5619,7 @@ as / for the path separator.

-

An array of parts to join into an URL path. Parts may contain +

An array of parts to join into a URL path. Parts may contain slashes and any of the other characters mentioned above.

@@ -5806,7 +5806,7 @@ omitted, it defaults to an empty string.

-

An array of parts to join into an URL path. Parts may contain +

An array of parts to join into a URL path. Parts may contain slashes and any of the other characters mentioned above.

@@ -6922,7 +6922,7 @@ class instance.

-

Returns a promise resolving with either the given value or or with +

Returns a promise resolving with either the given value or with the given default in case the input value is a rejecting promise.

@@ -7093,7 +7093,7 @@ to the given default value on error.
-

Construct an URL path relative to the global static resource path +

Construct a URL path relative to the global static resource path of the LuCI ui (usually /luci-static/resources).

The resulting URL is guaranteed to only contain the characters a-z, A-Z, 0-9, _, ., %, ,, ;, and - as well @@ -7151,7 +7151,7 @@ as / for the path separator.

-

An array of parts to join into an URL path. Parts may contain +

An array of parts to join into a URL path. Parts may contain slashes and any of the other characters mentioned above.

@@ -7578,6 +7578,9 @@ not an object, the function will return an empty array.

string +| + +null @@ -7610,7 +7613,10 @@ some other key pointing to a value within the nested values.

-string +"addr" +| + +"num" @@ -7627,7 +7633,7 @@ some other key pointing to a value within the nested values.

-

May be either addr or num to override the natural +

Can be either addr or num to override the natural lexicographic sorting with a sorting suitable for IP/MAC style addresses or numeric values respectively.

@@ -8025,7 +8031,7 @@ space and returned as array.

-

Construct an URL pathrelative to the script path of the server +

Construct a URL with path relative to the script path of the server side LuCI application (usually /cgi-bin/luci).

The resulting URL is guaranteed to only contain the characters a-z, A-Z, 0-9, _, ., %, ,, ;, and - as well @@ -8083,7 +8089,7 @@ as / for the path separator.

-

An array of parts to join into an URL path. Parts may contain +

An array of parts to join into a URL path. Parts may contain slashes and any of the other characters mentioned above.

@@ -8348,7 +8354,7 @@ else null.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Device.html b/jsapi/LuCI.network.Device.html index da65fcbd02..ae804f6e88 100644 --- a/jsapi/LuCI.network.Device.html +++ b/jsapi/LuCI.network.Device.html @@ -6312,7 +6312,7 @@ when it is down or absent.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Hosts.html b/jsapi/LuCI.network.Hosts.html index a8e32ef97f..9f89c276c3 100644 --- a/jsapi/LuCI.network.Hosts.html +++ b/jsapi/LuCI.network.Hosts.html @@ -4873,7 +4873,7 @@ is used as hint.
- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Protocol.html b/jsapi/LuCI.network.Protocol.html index a533bafbfa..75d00eeb8c 100644 --- a/jsapi/LuCI.network.Protocol.html +++ b/jsapi/LuCI.network.Protocol.html @@ -4573,7 +4573,7 @@ interface.

- Returns an array of of Network.Device class instances representing + Returns an array of Network.Device class instances representing the sub-devices attached to this logical interface or null if the logical interface does not support sub-devices, e.g. because it is virtual and not a bridge. @@ -5227,7 +5227,7 @@ default route or null if no default route was found.
-

Return a human readable description for the protcol, such as +

Return a human readable description for the protocol, such as Static address or DHCP client.

This function should be overwritten by subclasses.

@@ -5329,7 +5329,7 @@ default route or null if no default route was found.
-

Get the associared Linux network device of this network.

+

Get the associated Linux network device of this network.

@@ -6527,7 +6527,7 @@ protocol handler or null if no IPv4 addresses were set. Returns the name of the opkg package required for the protocol to -function, e.g. odhcp6c for the dhcpv6 prototocol. +function, e.g. odhcp6c for the dhcpv6 protocol. @@ -7542,7 +7542,7 @@ has no network devices attached.

Checks whether this protocol is "floating".

A "floating" protocol is a protocol which spawns its own interfaces -on demand, like a virtual one but which relies on an existinf lower +on demand, like a virtual one but which relies on an existing lower level interface to initiate the connection.

An example for such a protocol is "pppoe".

This function exists for backwards compatibility with older code @@ -7857,7 +7857,7 @@ returns true.

A "virtual" protocol is a protocol which spawns its own interfaces on demand instead of using existing physical interfaces.

Examples for virtual protocols are 6in4 which gre spawn tunnel -network device on startup, examples for non-virtual protcols are +network device on startup, examples for non-virtual protocols are dhcp or static which apply IP configuration to existing interfaces.

This function should be overwritten by subclasses.

@@ -8103,7 +8103,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiDevice.html b/jsapi/LuCI.network.WifiDevice.html index 86c92bf165..0ea89f038c 100644 --- a/jsapi/LuCI.network.WifiDevice.html +++ b/jsapi/LuCI.network.WifiDevice.html @@ -4612,7 +4612,7 @@ nearby networks.

Returns a promise resolving to an array of scan result objects -describing the networks found in the vincinity. +describing the networks found in the vicinity. @@ -4864,7 +4864,7 @@ this radio device. Returns a promise resolving to an array of Network.WifiNetwork -instances respresenting the wireless networks associated with this +instances representing the wireless networks associated with this radio device. @@ -5085,7 +5085,7 @@ runtime state.

- set(opt, val) + set(opt, value)

@@ -5155,7 +5155,7 @@ runtime state.

- val + value @@ -5244,7 +5244,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiNetwork.html b/jsapi/LuCI.network.WifiNetwork.html index 4b21c821b7..89c97afff3 100644 --- a/jsapi/LuCI.network.WifiNetwork.html +++ b/jsapi/LuCI.network.WifiNetwork.html @@ -3751,7 +3751,7 @@ such networks in parallel.

-

Specifies whether to deauthenticate (true) or disassociate (false) +

Specifies whether to de-authenticate (true) or disassociate (false) the client.

@@ -3827,7 +3827,7 @@ with. Default is 1 which corresponds to Unspecified reasonSpecifies the amount of milliseconds to ban the client from reconnecting. By default, no ban time is set which allows the client -to reassociate / reauthenticate immediately.

+to re-associate / reauthenticate immediately.

@@ -4248,7 +4248,7 @@ information. - Returns a string describing the current encryption or - if the the + Returns a string describing the current encryption or - if the encryption state could not be found in ubus runtime information. @@ -5181,7 +5181,7 @@ information or 00 if it cannot be determined. Returns a Network.Device instance representing the Linux network -device associted with this wireless network. +device associated with this wireless network. @@ -5423,7 +5423,7 @@ name, depending on which information is available.

Get the internal network ID of this wireless network.

-

The network ID is a LuCI specific identifer in the form +

The network ID is a LuCI specific identifier in the form radio#.network# to identify wireless networks by their corresponding radio and network index numbers.

@@ -7383,7 +7383,7 @@ or null if it cannot be determined.
-

Check whether this wifi network supports deauthenticating clients.

+

Check whether this wifi network supports de-authenticating clients.

@@ -7451,7 +7451,7 @@ or null if it cannot be determined. Returns true when this wifi network instance supports forcibly -deauthenticating clients, otherwise false. +de-authenticating clients, otherwise false. @@ -7675,7 +7675,7 @@ instance.

- set(opt, val) + set(opt, value)

@@ -7745,7 +7745,7 @@ instance.

- val + value @@ -7834,7 +7834,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.html b/jsapi/LuCI.network.html index 595999b462..49f4818da4 100644 --- a/jsapi/LuCI.network.html +++ b/jsapi/LuCI.network.html @@ -5017,7 +5017,7 @@ class instance describing the found hosts.

-

Obtains the the network device name of the given object.

+

Obtains the network device name of the given object.

@@ -6753,7 +6753,7 @@ else returns false. -

The netmask to convert into a bit count.

+

The netmask to convert into a bits count.

@@ -7721,7 +7721,7 @@ rename could not be found.
-

Describes an swconfig switch topology by specifying the CPU +

Describes a swconfig switch topology by specifying the CPU connections and external port labels of a switch.

@@ -7800,7 +7800,7 @@ port is hardwired to.

The ports property points to an array describing the populated ports of the switch in the external label order. Each array item is -an object containg the following keys:

+an object containing the following keys:

  • num - the internal switch port number
  • label - the label of the port, e.g. LAN 1 or CPU (eth0)
    • @@ -8732,7 +8732,7 @@ the driver.

    -

    The powersafe mode for all non-peer neigbours, may be an empty +

    The powersafe mode for all non-peer neighbours, may be an empty string ('') or absent if not applicable or supported by the driver.

    The following modes are known:

      @@ -8996,7 +8996,7 @@ receiving rates.

      -

      The amount of failed tranmission attempts. Only applicable to +

      The amount of failed transmission attempts. Only applicable to transmit rates.

      @@ -9208,7 +9208,7 @@ HT or VHT rates.

      -

      Specifies whether the tranmission rate used 40MHz wide channel. +

      Specifies whether the transmission rate used 40MHz wide channel. Only applicable to HT or VHT rates.

      Note: this option exists for backwards compatibility only and its use is discouraged. The mhz field should be used instead to @@ -9418,7 +9418,7 @@ Only applicable to HE rates.

      A wireless scan result object describes a neighbouring wireless -network found in the vincinity.

      +network found in the vicinity.

      @@ -9682,7 +9682,7 @@ conjunction with quality to calculate a quality percentage.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/LuCI.poll.html b/jsapi/LuCI.poll.html index a2d8996272..38befac53f 100644 --- a/jsapi/LuCI.poll.html +++ b/jsapi/LuCI.poll.html @@ -3759,7 +3759,7 @@ loop.

      Add a new operation to the polling loop. If the polling loop is not -already started at this point, it will be implicitely started.

      +already started at this point, it will be implicitly started.

      @@ -3955,8 +3955,8 @@ already is registered.
      -

      Remove an operation from the polling loop. If no further operatons -are registered, the polling loop is implicitely stopped.

      +

      Remove an operation from the polling loop. If no further operations +are registered, the polling loop is implicitly stopped.

      @@ -4299,7 +4299,7 @@ to the document object upon successful stop.

      - Returns true if polling has been stopped or false if it din't + Returns true if polling has been stopped or false if it didn't run to begin with. @@ -4330,7 +4330,7 @@ run to begin with.
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.request.html b/jsapi/LuCI.request.html index 2c59c665b0..4bd6df2a3d 100644 --- a/jsapi/LuCI.request.html +++ b/jsapi/LuCI.request.html @@ -3940,7 +3940,7 @@ if it already was absolute.

      - get(target, options){Promise.<LuCI.response>} + get(url, options){Promise.<LuCI.response>}

      @@ -3987,7 +3987,7 @@ if it already was absolute. - target + url @@ -4120,7 +4120,7 @@ if it already was absolute.

      - post(target, data, options){Promise.<LuCI.response>} + post(url, data, options){Promise.<LuCI.response>}

      @@ -4167,7 +4167,7 @@ if it already was absolute. - target + url @@ -5265,7 +5265,7 @@ instances as sole argument during the HTTP request transfer.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.request.poll.html b/jsapi/LuCI.request.poll.html index 6b521635d5..570dba6a98 100644 --- a/jsapi/LuCI.request.poll.html +++ b/jsapi/LuCI.request.poll.html @@ -3539,7 +3539,7 @@ poll -

      The Request.poll class provides some convience wrappers around +

      The Request.poll class provides some convince wrappers around LuCI.poll mainly to simplify registering repeating HTTP request calls as polling functions.

      @@ -4449,7 +4449,7 @@ else null.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.response.html b/jsapi/LuCI.response.html index 5166247f8f..aed3e6e387 100644 --- a/jsapi/LuCI.response.html +++ b/jsapi/LuCI.response.html @@ -4407,7 +4407,7 @@ using String() and treated as response text.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.rpc.html b/jsapi/LuCI.rpc.html index d4e7197649..9a8d0c780c 100644 --- a/jsapi/LuCI.rpc.html +++ b/jsapi/LuCI.rpc.html @@ -3702,7 +3702,7 @@ and means for listing and invoking remove RPC methods.

      -

      The inteceptor function to register.

      +

      The interceptor function to register.

      @@ -4509,7 +4509,7 @@ signatures of each requested ubus object name will be returned. -

      The inteceptor function to remove.

      +

      The interceptor function to remove.

      @@ -4592,7 +4592,7 @@ if it has not been found.

      - setBaseURL(sid) + setBaseURL(url)

      @@ -4639,7 +4639,7 @@ if it has not been found. - sid + url @@ -4979,7 +4979,7 @@ When the resulting call function is invoked with fn(true, false), the corresponding args object sent to the remote procedure will be { foo: true, bar: false }.
    • params: [ "test" ], filter: function(reply, args, extra) { ... } - -When the resultung generated function is invoked with +When the resulting generated function is invoked with fn("foo", "bar", "baz") then { "test": "foo" } will be sent as argument to the remote procedure and the filter function will be invoked with filterFn(reply, [ "foo" ], "bar", "baz")
      • @@ -5082,7 +5082,7 @@ be returned as default instead. -

      Specfies an optional filter function which is invoked to transform the +

      Specifies an optional filter function which is invoked to transform the received reply data before it is returned to the caller.

      @@ -5738,7 +5738,7 @@ to the expect and filter declarations.
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.session.html b/jsapi/LuCI.session.html index 1bf61338b8..308c45006c 100644 --- a/jsapi/LuCI.session.html +++ b/jsapi/LuCI.session.html @@ -4177,7 +4177,7 @@ being put in the session store.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.uci.html b/jsapi/LuCI.uci.html index e13b16d247..e77a5f313c 100644 --- a/jsapi/LuCI.uci.html +++ b/jsapi/LuCI.uci.html @@ -3541,7 +3541,7 @@

      The LuCI.uci class utilizes LuCI.rpc to declare low level remote UCI ubus procedures and implements a local caching and data -manipulation layer on top to allow for synchroneous operations on +manipulation layer on top to allow for synchronous operations on UCI configuration data.

      @@ -3641,7 +3641,7 @@ UCI configuration data.

      - add(config, type, name){string} + add(conf, type, name){string}

      @@ -3689,7 +3689,7 @@ optionally named according to the given name.

      - config + conf @@ -4115,7 +4115,7 @@ names as keys and arrays of related change records as values.

      - createSID(config){string} + createSID(conf){string}

      @@ -4165,7 +4165,7 @@ by the remote ubus UCI api.

      - config + conf @@ -4264,7 +4264,7 @@ where X denotes a hexadecimal digit.

      - get(config, sid, option){null|string|Array.<string>|LuCI.uci.SectionObject} + get(conf, sid, opt){null|string|Array.<string>|LuCI.uci.SectionObject}

      @@ -4313,7 +4313,7 @@ option name is omitted.

      - config + conf @@ -4369,7 +4369,7 @@ option name is omitted.

      - option + opt @@ -4493,7 +4493,7 @@ found or if the corresponding configuration is not loaded.

      - get_first(config, type, option){null|string|Array.<string>|LuCI.uci.SectionObject} + get_first(conf, type, opt){null|string|Array.<string>|LuCI.uci.SectionObject}

      @@ -4511,7 +4511,7 @@ found or if the corresponding configuration is not loaded.

      Gets the value of the given option or the entire section object of the first found section of the specified type or the first found -section of the entire configuration if no type is specfied.

      +section of the entire configuration if no type is specified.

      @@ -4542,7 +4542,7 @@ section of the entire configuration if no type is specfied.

      - config + conf @@ -4602,7 +4602,7 @@ matching the given type.

      - option + opt @@ -4726,7 +4726,7 @@ found or if the corresponding configuration is not loaded.

      - load(config){Promise.<Array.<string>>} + load(packages){Promise.<Array.<string>>}

      @@ -4778,7 +4778,7 @@ data.

      - config + packages @@ -4881,7 +4881,7 @@ that have been successfully loaded.

      - move(config, sid1, sid2, after){boolean} + move(conf, sid1, sid2, after){boolean}

      @@ -4931,7 +4931,7 @@ before or after the second specified section.

      - config + conf @@ -5150,7 +5150,7 @@ when either the section specified by sid1 or by sid2 i

      - remove(config, sid) + remove(conf, sid)

      @@ -5197,7 +5197,7 @@ when either the section specified by sid1 or by sid2 i - config + conf @@ -5289,7 +5289,7 @@ when either the section specified by sid1 or by sid2 i

      - resolveSID(config, sid){string|null} + resolveSID(conf, sid){string|null}

      @@ -5337,7 +5337,7 @@ section ID value.

      - config + conf @@ -5571,7 +5571,7 @@ have been reloaded by the save operation.

      - sections(config, type, cb){Array.<LuCI.uci.SectionObject>} + sections(conf, type, cb){Array.<LuCI.uci.SectionObject>}

      @@ -5619,7 +5619,7 @@ filtered by type.

      - config + conf @@ -5784,7 +5784,7 @@ configuration, filtered by type of a type has been specified.

      - set(config, sid, option, value) + set(conf, sid, opt, val)

      @@ -5834,7 +5834,7 @@ with a dot, the function will do nothing.

      - config + conf @@ -5880,7 +5880,7 @@ with a dot, the function will do nothing.

      - option + opt @@ -5903,7 +5903,7 @@ with a dot, the function will do nothing.

      - value + val @@ -5980,7 +5980,7 @@ with the given value.

      - set_first(config, type, option, value) + set_first(conf, type, opt, val)

      @@ -6031,7 +6031,7 @@ with a dot, the function will do nothing.

      - config + conf @@ -6091,7 +6091,7 @@ section matching the given type is used.

      - option + opt @@ -6119,7 +6119,7 @@ section matching the given type is used.

      - value + val @@ -6201,7 +6201,7 @@ with the given value.

      - unload(config) + unload(packages)

      @@ -6248,7 +6248,7 @@ with the given value.

      - config + packages @@ -6321,7 +6321,7 @@ names to unload.

      - unset(config, sid, option) + unset(conf, sid, opt)

      @@ -6371,7 +6371,7 @@ configuration.

      - config + conf @@ -6417,7 +6417,7 @@ configuration.

      - option + opt @@ -6486,7 +6486,7 @@ configuration.

      - unset_first(config, type, option) + unset_first(conf, type, opt)

      @@ -6537,7 +6537,7 @@ of the entire config when no type has is specified.

      - config + conf @@ -6597,7 +6597,7 @@ section matching the given type is used.

      - option + opt @@ -6879,7 +6879,7 @@ renamed.

      A section object represents the options and their corresponding values enclosed within a configuration section, as well as some additional meta data such as sort indexes and internal ID.

      -

      Any internal metadata fields are prefixed with a dot which is isn't +

      Any internal metadata fields are prefixed with a dot which isn't an allowed character for normal option names.

      @@ -6954,7 +6954,7 @@ anonymous (true) or named (false).

      -

      The .index property specifes the sort order of the section.

      +

      The .index property specifies the sort order of the section.

      @@ -7225,7 +7225,7 @@ associated name as arguments.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.AbstractElement.html b/jsapi/LuCI.ui.AbstractElement.html index a47ed4001f..1a0bc8919a 100644 --- a/jsapi/LuCI.ui.AbstractElement.html +++ b/jsapi/LuCI.ui.AbstractElement.html @@ -3544,7 +3544,7 @@ implemented by LuCI.ui. It provides the common logic for getting an setting values, for checking the validity state and for wiring up required events.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.AbstractElement. To import @@ -3941,7 +3941,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5281,7 +5281,7 @@ and are displayed in a slightly faded style.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Checkbox.html b/jsapi/LuCI.ui.Checkbox.html index da108d5a56..7fc43759e8 100644 --- a/jsapi/LuCI.ui.Checkbox.html +++ b/jsapi/LuCI.ui.Checkbox.html @@ -3541,7 +3541,7 @@

      The Checkbox class implements a simple checkbox input field.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Checkbox. To import it in @@ -4048,7 +4048,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5395,7 +5395,7 @@ it is required for HTML based form submissions.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.ComboButton.html b/jsapi/LuCI.ui.ComboButton.html index 03cd4afc91..3a276570e0 100644 --- a/jsapi/LuCI.ui.ComboButton.html +++ b/jsapi/LuCI.ui.ComboButton.html @@ -3542,7 +3542,7 @@

      The ComboButton class implements a button element which can be expanded into a dropdown to chose from a set of different action choices.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.ComboButton. To import it in @@ -4331,7 +4331,7 @@ of keeping them.

      Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5156,7 +5156,7 @@ trigger validation runs, e.g. when programmatically altering values.

      ComboButtons support the same properties as Dropdown.InitOptions but enforce -specific values for some properties and add aditional button specific +specific values for some properties and add additional button specific properties.

      @@ -5425,7 +5425,7 @@ choice value as second argument.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Combobox.html b/jsapi/LuCI.ui.Combobox.html index 62ec86e29e..b5d3375874 100644 --- a/jsapi/LuCI.ui.Combobox.html +++ b/jsapi/LuCI.ui.Combobox.html @@ -3544,7 +3544,7 @@ to enter custom values. Historically, comboboxes used to be a dedicated widget type in LuCI but nowadays they are direct aliases of dropdown widgets with a set of enforced default properties for easier instantiation.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Combobox. To import it in @@ -4333,7 +4333,7 @@ of keeping them.

      Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5328,7 +5328,7 @@ forcibly set to true.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Dropdown.html b/jsapi/LuCI.ui.Dropdown.html index 8cad2088ae..721ef7e7ab 100644 --- a/jsapi/LuCI.ui.Dropdown.html +++ b/jsapi/LuCI.ui.Dropdown.html @@ -3542,7 +3542,7 @@

      The Dropdown class implements a rich, stylable dropdown menu which supports non-text choice labels.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Dropdown. To import it in @@ -4436,7 +4436,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -6126,7 +6126,7 @@ expression. Only applicable when create is true.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.DynamicList.html b/jsapi/LuCI.ui.DynamicList.html index 3989a80715..3d596931c8 100644 --- a/jsapi/LuCI.ui.DynamicList.html +++ b/jsapi/LuCI.ui.DynamicList.html @@ -3543,7 +3543,7 @@ an arbitrary amount of input values, either from free formed text input or from a set of predefined choices.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.DynamicList. To import it in @@ -4307,7 +4307,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5360,7 +5360,7 @@ trigger validation runs, e.g. when programmatically altering values.

      -

      In case choices are passed to the dynamic list contructor, the widget +

      In case choices are passed to the dynamic list constructor, the widget supports the same properties as Dropdown.InitOptions but enforces specific values for some dropdown properties.

      @@ -5503,7 +5503,7 @@ it to remain unselected.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.FileUpload.html b/jsapi/LuCI.ui.FileUpload.html index 62d69ca382..9f19f51d39 100644 --- a/jsapi/LuCI.ui.FileUpload.html +++ b/jsapi/LuCI.ui.FileUpload.html @@ -3542,7 +3542,7 @@

      The FileUpload class implements a widget which allows the user to upload, browse, select and delete files beneath a predefined remote directory.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.FileUpload. To import it in @@ -4053,7 +4053,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5298,9 +5298,9 @@ merely controls whether the file remove controls are rendered or not.

      Specifies the remote directory the upload and file browsing actions take -place in. Browsing to directories outside of the root directory is +place in. Browsing to directories outside the root directory is prevented by the widget. Note that this is not a security feature. -Whether remote directories are browseable or not solely depends on the +Whether remote directories are browsable or not solely depends on the ACL setup for the current session.

      @@ -5352,7 +5352,7 @@ ACL setup for the current session.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Hiddenfield.html b/jsapi/LuCI.ui.Hiddenfield.html index 793a4411f6..1da67b42fa 100644 --- a/jsapi/LuCI.ui.Hiddenfield.html +++ b/jsapi/LuCI.ui.Hiddenfield.html @@ -3542,7 +3542,7 @@

      The Hiddenfield class implements an HTML <input type="hidden"> field which allows to store form data without exposing it to the user.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Hiddenfield. To import it in @@ -4052,7 +4052,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5106,7 +5106,7 @@ trigger validation runs, e.g. when programmatically altering values.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Select.html b/jsapi/LuCI.ui.Select.html index f0c96178e4..a8de277359 100644 --- a/jsapi/LuCI.ui.Select.html +++ b/jsapi/LuCI.ui.Select.html @@ -3543,7 +3543,7 @@ or a group of checkboxes or radio buttons, depending on whether multiple values are enabled or not.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Select. To import it in @@ -4087,7 +4087,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5222,7 +5222,10 @@ the following properties are recognized:

      -string +"select" +| + +"individual" @@ -5455,7 +5458,7 @@ selected yet. Only applicable to the select widget type.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Textarea.html b/jsapi/LuCI.ui.Textarea.html index f238d58353..b8e1b72ff1 100644 --- a/jsapi/LuCI.ui.Textarea.html +++ b/jsapi/LuCI.ui.Textarea.html @@ -3541,7 +3541,7 @@

      The Textarea class implements a multiline text area input field.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Textarea. To import it in @@ -4048,7 +4048,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5404,7 +5404,7 @@ contents.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.Textfield.html b/jsapi/LuCI.ui.Textfield.html index ea987e20ca..ee4537c4a7 100644 --- a/jsapi/LuCI.ui.Textfield.html +++ b/jsapi/LuCI.ui.Textfield.html @@ -3541,7 +3541,7 @@

      The Textfield class implements a standard single line text input field.

      UI widget instances are usually not supposed to be created by view code -directly, instead they're implicitely created by LuCI.form when +directly, instead they're implicitly created by LuCI.form when instantiating CBI forms.

      This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Textfield. To import it in @@ -4048,7 +4048,7 @@ an array of strings or null for unset values. Returns true if the input value has been altered by the user or -false if it is unchaged. Note that if the user modifies the initial +false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. @@ -5332,7 +5332,7 @@ corresponding <input> element is empty.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.changes.html b/jsapi/LuCI.ui.changes.html index 3392bf6cd4..1c907b1b15 100644 --- a/jsapi/LuCI.ui.changes.html +++ b/jsapi/LuCI.ui.changes.html @@ -4051,7 +4051,7 @@ complete.

      - setIndicator(numChanges) + setIndicator(n)

      @@ -4102,7 +4102,7 @@ is removed.

      - numChanges + n @@ -4184,7 +4184,7 @@ is removed.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.html b/jsapi/LuCI.ui.html index 65135b4b4f..14efcbd412 100644 --- a/jsapi/LuCI.ui.html +++ b/jsapi/LuCI.ui.html @@ -3686,7 +3686,7 @@ external JavaScript, use L.require("ui").then(...).

      - addNotification(title, contents, classes){Node} + addNotification(title, children, classes){Node}

      @@ -3704,10 +3704,10 @@ external JavaScript, use L.require("ui").then(...).

      Add a notification banner at the top of the current view.

      A notification banner is an alert message usually displayed at the -top of the current view, spanning the entire availibe width. +top of the current view, spanning the entire available width. Notification banners will stay in place until dismissed by the user. Multiple banners may be shown at the same time.

      -

      Additional CSS class names may be passed to influence the appearence of +

      Additional CSS class names may be passed to influence the appearance of the banner. Valid values for the classes depend on the underlying theme.

      @@ -3770,7 +3770,7 @@ will be rendered.

      - contents + children @@ -4609,7 +4609,7 @@ valid function value.
      -

      Remove an header area indicator.

      +

      Remove a header area indicator.

      This function removes the given indicator label from the header indicator area. When the given indicator is not found, this function does nothing.

      @@ -4840,7 +4840,7 @@ resulting class instance is a descendant of LuCI.view.

      By instantiating the view class, its corresponding contents are rendered and included into the view area. Any runtime errors are -catched and rendered using LuCI.error().

      +caught and rendered using LuCI.error().

      @@ -4993,7 +4993,7 @@ separators and appends the resulting nodes to the given parent DOM node.

      <strong> element and the value corresponding to the label are subsequently wrapped into a <span class="nowrap"> element.

      The resulting <span> element tuples are joined by the given separators -to form the final markup which is appened to the given parent DOM node.

      +to form the final markup which is appended to the given parent DOM node.

      @@ -5211,7 +5211,7 @@ accepted by LuCI.dom.content().

      - pingDevice(proto, host){Promise.<Event>} + pingDevice(proto, ipaddr){Promise.<Event>}

      @@ -5228,7 +5228,7 @@ accepted by LuCI.dom.content().

      Perform a device connectivity test.

      -

      Attempt to fetch a well known ressource from the remote device via HTTP +

      Attempt to fetch a well known resource from the remote device via HTTP in order to test connectivity. This function is mainly useful to wait for the router to come back online after a reboot or reconfiguration.

      @@ -5300,7 +5300,7 @@ for the router to come back online after a reboot or reconfiguration.

      - host + ipaddr @@ -5430,7 +5430,7 @@ or rejecting with null when the connectivity check timed out.
      -

      Display or update an header area indicator.

      +

      Display or update a header area indicator.

      An indicator is a small label displayed in the header area of the screen providing few amounts of status information such as item counts or state toggle indicators.

      @@ -5579,7 +5579,10 @@ existing labels it is ignored.

      -string +"active" +| + +"inactive" @@ -5685,7 +5688,7 @@ changes were made.

      - showModal(title, contents, classes){Node} + showModal(title, children, classes){Node}

      @@ -5706,7 +5709,7 @@ changes were made. with the underlying view contents. Only one modal dialog instance can be opened. Invoking showModal() while a modal dialog is already open will replace the open dialog with a new one having the specified contents.

      -

      Additional CSS class names may be passed to influence the appearence of +

      Additional CSS class names may be passed to influence the appearance of the dialog. Valid values for the classes depend on the underlying theme.

      @@ -5768,7 +5771,7 @@ the dialog. Valid values for the classes depend on the underlying theme.

      - contents + children @@ -5914,7 +5917,7 @@ element.

      - uploadFile(path, progessStatusNode){Promise.<LuCI.ui.FileUploadReply>} + uploadFile(path, progressStatusNode){Promise.<LuCI.ui.FileUploadReply>}

      @@ -5991,7 +5994,7 @@ upload a file to a predefined remote destination path.

      - progessStatusNode + progressStatusNode @@ -6277,7 +6280,7 @@ cancelled by the user.
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.menu.html b/jsapi/LuCI.ui.menu.html index 6b0222d665..7c720bef9b 100644 --- a/jsapi/LuCI.ui.menu.html +++ b/jsapi/LuCI.ui.menu.html @@ -4102,7 +4102,7 @@ internal root node if omitted.

      -satisified +satisfied @@ -4118,7 +4118,7 @@ internal root node if omitted.

      -

      Boolean indicating whether the menu enries dependencies are satisfied

      +

      Boolean indicating whether the menu entries dependencies are satisfied

      @@ -4231,7 +4231,7 @@ internal root node if omitted.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.ui.tabs.html b/jsapi/LuCI.ui.tabs.html index b56392876e..49a65d6476 100644 --- a/jsapi/LuCI.ui.tabs.html +++ b/jsapi/LuCI.ui.tabs.html @@ -3931,7 +3931,7 @@ DOM node.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.view.html b/jsapi/LuCI.view.html index 856291156d..e77f5ae488 100644 --- a/jsapi/LuCI.view.html +++ b/jsapi/LuCI.view.html @@ -3899,7 +3899,7 @@ with null.

      Any return values of this function are discarded, but passed through Promise.resolve() to ensure that any returned promise runs to completion before the button -is reenabled. +is re-enabled. @@ -4063,7 +4063,7 @@ with null.

      Any return values of this function are discarded, but passed through Promise.resolve() to ensure that any returned promise runs to completion before the button -is reenabled. +is re-enabled. @@ -4229,7 +4229,7 @@ extending this base class should overwrite the Any return values of this function are discarded, but passed through Promise.resolve() to ensure that any returned promise runs to completion before the button -is reenabled. +is re-enabled. @@ -4535,7 +4535,7 @@ to a Node value.
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/LuCI.xhr.html b/jsapi/LuCI.xhr.html index 5640e7d57e..83af0754c5 100644 --- a/jsapi/LuCI.xhr.html +++ b/jsapi/LuCI.xhr.html @@ -4499,7 +4499,7 @@ when invoked.

      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/form.js.html b/jsapi/form.js.html index 949d05ef37..ca5c9ad620 100644 --- a/jsapi/form.js.html +++ b/jsapi/form.js.html @@ -3738,7 +3738,7 @@ var CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement.p /** * Add another form element as children to this element. * - * @param {AbstractElement} element + * @param {AbstractElement} obj * The form element to add. */ append: function(obj) { @@ -3751,7 +3751,7 @@ var CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement.p * The `parse()` function recursively walks the form element tree and * triggers input value reading and validation for each encountered element. * - * Elements which are hidden due to unsatisified dependencies are skipped. + * Elements which are hidden due to unsatisfied dependencies are skipped. * * @returns {Promise<void>} * Returns a promise resolving once this element's value and the values of @@ -3811,7 +3811,7 @@ var CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement.p /** * Strip any HTML tags from the given input string. * - * @param {string} input + * @param {string} s * The input string to clean. * * @returns {string} @@ -3882,7 +3882,7 @@ var CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement.p * @classdesc * * The `Map` class represents one complete form. A form usually maps one UCI - * configuraton file and is divided into multiple sections containing multiple + * configuration file and is divided into multiple sections containing multiple * fields each. * * It serves as main entry point into the `LuCI.form` for typical view code. @@ -3898,7 +3898,7 @@ var CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement.p * * @param {string} [description] * The description text of the form which is usually rendered as text - * paragraph below the form title and before the actual form conents. + * paragraph below the form title and before the actual form contents. * If omitted, the corresponding paragraph element will not be rendered. */ var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { @@ -4036,11 +4036,11 @@ var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * @param {LuCI.form.AbstractSection} sectionclass * The section class to use for rendering the configuration section. * Note that this value must be the class itself, not a class instance - * obtained from calling `new`. It must also be a class dervied from + * obtained from calling `new`. It must also be a class derived from * `LuCI.form.AbstractSection`. * * @param {...string} classargs - * Additional arguments which are passed as-is to the contructor of the + * Additional arguments which are passed as-is to the constructor of the * given section class. Refer to the class specific constructor * documentation for details. * @@ -4092,7 +4092,7 @@ var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * The `parse()` function recursively walks the form element tree and * triggers input value reading and validation for each child element. * - * Elements which are hidden due to unsatisified dependencies are skipped. + * Elements which are hidden due to unsatisfied dependencies are skipped. * * @returns {Promise<void>} * Returns a promise resolving once the entire form completed parsing all @@ -4122,7 +4122,7 @@ var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @param {boolean} [silent=false] * If set to `true`, trigger an alert message to the user in case saving - * the form data failes. Otherwise fail silently. + * the form data failures. Otherwise fail silently. * * @returns {Promise<void>} * Returns a promise resolving once the entire save operation is complete. @@ -4222,15 +4222,15 @@ var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { /** * Find a form option element instance. * - * @param {string} name_or_id + * @param {string} name * The name or the full ID of the option element to look up. * * @param {string} [section_id] * The ID of the UCI section containing the option to look up. May be * omitted if a full ID is passed as first argument. * - * @param {string} [config] - * The name of the UCI configuration the option instance is belonging to. + * @param {string} [config_name] + * The name of the UCI configuration the option instance belongs to. * Defaults to the main UCI configuration of the map if omitted. * * @returns {Array<LuCI.form.AbstractValue,string>|null} @@ -4331,7 +4331,7 @@ var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @param {string} [description] * The description text of the form which is usually rendered as text - * paragraph below the form title and before the actual form conents. + * paragraph below the form title and before the actual form contents. * If omitted, the corresponding paragraph element will not be rendered. */ var CBIJSONMap = CBIMap.extend(/** @lends LuCI.form.JSONMap.prototype */ { @@ -4455,7 +4455,7 @@ var CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * triggers input value reading and validation for each encountered child * option element. * - * Options which are hidden due to unsatisified dependencies are skipped. + * Options which are hidden due to unsatisfied dependencies are skipped. * * @returns {Promise<void>} * Returns a promise resolving once the values of all child elements have @@ -4501,7 +4501,7 @@ var CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * contents. If omitted, no description will be rendered. * * @throws {Error} - * Throws an exeption if a tab with the same `name` already exists. + * Throws an exception if a tab with the same `name` already exists. */ tab: function(name, title, description) { if (this.tabs && this.tabs[name]) @@ -4531,11 +4531,11 @@ var CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * @param {LuCI.form.AbstractValue} optionclass * The option class to use for rendering the configuration option. Note * that this value must be the class itself, not a class instance obtained - * from calling `new`. It must also be a class dervied from + * from calling `new`. It must also be a class derived from * [LuCI.form.AbstractSection]{@link LuCI.form.AbstractSection}. * * @param {...*} classargs - * Additional arguments which are passed as-is to the contructor of the + * Additional arguments which are passed as-is to the constructor of the * given option class. Refer to the class specific constructor * documentation for details. * @@ -4558,17 +4558,17 @@ var CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract /** * Add a configuration option widget to a tab of the section. * - * @param {string} tabname + * @param {string} tabName * The name of the section tab to add the option element to. * * @param {LuCI.form.AbstractValue} optionclass * The option class to use for rendering the configuration option. Note * that this value must be the class itself, not a class instance obtained - * from calling `new`. It must also be a class dervied from + * from calling `new`. It must also be a class derived from * [LuCI.form.AbstractSection]{@link LuCI.form.AbstractSection}. * * @param {...*} classargs - * Additional arguments which are passed as-is to the contructor of the + * Additional arguments which are passed as-is to the constructor of the * given option class. Refer to the class specific constructor * documentation for details. * @@ -4911,7 +4911,7 @@ var CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.AbstractVa /** * If set to `true`, the underlying ui input widget value is not cleared - * from the configuration on unsatisfied depedencies. The default behavior + * from the configuration on unsatisfied dependencies. The default behavior * is to remove the values of all options whose dependencies are not * fulfilled. * @@ -5073,10 +5073,10 @@ var CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.AbstractVa */ /** - * Add a dependency contraint to the option. + * Add a dependency constraint to the option. * * Dependency constraints allow making the presence of option elements - * dependant on the current values of certain other options within the + * dependent on the current values of certain other options within the * same form. An option element with unsatisfied dependencies will be * hidden from the view and its current value is omitted when saving. * @@ -5088,7 +5088,7 @@ var CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.AbstractVa * a logical "and" expression. * * Option names may be given in "dot notation" which allows to reference - * option elements outside of the current form section. If a name without + * option elements outside the current form section. If a name without * dot is specified, it refers to an option within the same configuration * section. If specified as <code>configname.sectionid.optionname</code>, * options anywhere within the same form may be specified. @@ -5154,11 +5154,11 @@ var CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.AbstractVa * </li> * </ul> * - * @param {string|Object<string, string|RegExp>} optionname_or_depends + * @param {string|Object<string, string|RegExp>} field * The name of the option to depend on or an object describing multiple - * dependencies which must be satified (a logical "and" expression). + * dependencies which must be satisfied (a logical "and" expression). * - * @param {string} optionvalue|RegExp + * @param {string|RegExp} value * When invoked with a plain option name as first argument, this parameter * specifies the expected value. In case an object is passed as first * argument, this parameter is ignored. @@ -6660,7 +6660,7 @@ var CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection.p * @returns {*|Promise<*>} * Return values of this function are ignored but if a promise is returned, * it is run to completion before the rendering is continued, allowing - * custom logic to perform asynchroneous work before the modal dialog + * custom logic to perform asynchronous work before the modal dialog * is shown. */ addModalOptions: function(modalSection, section_id, ev) { @@ -6832,7 +6832,7 @@ var CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection.p * * Another important difference is that the table cells show a readonly text * preview of the corresponding option elements by default, unless the child - * option element is explicitely made writable by setting the `editable` + * option element is explicitly made writable by setting the `editable` * property to `true`. * * Additionally, the grid section honours a `modalonly` property of child @@ -6881,7 +6881,7 @@ var CBIGridSection = CBITableSection.extend(/** @lends LuCI.form.GridSection.pro * contents. If omitted, no description will be rendered. * * @throws {Error} - * Throws an exeption if a tab with the same `name` already exists. + * Throws an exception if a tab with the same `name` already exists. */ tab: function(name, title, description) { CBIAbstractSection.prototype.tab.call(this, name, title, description); @@ -7199,7 +7199,7 @@ var CBIValue = CBIAbstractValue.extend(/** @lends LuCI.form.Value.prototype */ { * @param {string} key * The choice value to add. * - * @param {Node|string} value + * @param {Node|string} val * The caption for the choice value. May be a DOM node, a document fragment * or a plain text string. If omitted, the `key` value is used as caption. */ @@ -7411,7 +7411,7 @@ var CBIDynamicList = CBIValue.extend(/** @lends LuCI.form.DynamicList.prototype * @classdesc * * The `ListValue` class implements a simple static HTML select element - * allowing the user to chose a single value from a set of predefined choices. + * allowing the user chose a single value from a set of predefined choices. * It builds upon the {@link LuCI.ui.Select} widget. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form @@ -7860,7 +7860,7 @@ var CBIDummyValue = CBIValue.extend(/** @lends LuCI.form.DummyValue.prototype */ __name__: 'CBI.DummyValue', /** - * Set an URL which is opened when clicking on the dummy value text. + * Set a URL which is opened when clicking on the dummy value text. * * By setting this property, the dummy value text is wrapped in an `<a>` * element with the property value used as `href` attribute. @@ -8333,7 +8333,7 @@ var CBISectionValue = CBIValue.extend(/** @lends LuCI.form.SectionValue.prototyp * @hideconstructor * @classdesc * - * The LuCI form class provides high level abstractions for creating creating + * The LuCI form class provides high level abstractions for creating * UCI- or JSON backed configurations forms. * * To import the class in views, use `'require form'`, to import it in @@ -8405,7 +8405,7 @@ return baseclass.extend(/** @lends LuCI.form.prototype */ {
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/fs.js.html b/jsapi/fs.js.html index 0cb9708f5d..aa67cbd335 100644 --- a/jsapi/fs.js.html +++ b/jsapi/fs.js.html @@ -3763,7 +3763,7 @@ var FileSystem = baseclass.extend(/** @lends LuCI.fs.prototype */ { /** * Unlink the given file. * - * @param {string} + * @param {string} path * The file path to remove. * * @returns {Promise<number>} @@ -3879,7 +3879,7 @@ var FileSystem = baseclass.extend(/** @lends LuCI.fs.prototype */ { * @param {string} path * The file path to read. * - * @param {string} [type=text] + * @param {"blob"|"text"|"blob"} [type=text] * The expected type of read file contents. Valid values are `text` to * interpret the contents as string, `json` to parse the contents as JSON * or `blob` to return the contents as Blob instance. @@ -3921,7 +3921,7 @@ var FileSystem = baseclass.extend(/** @lends LuCI.fs.prototype */ { * @param {string[]} [params] * The arguments to pass to the command. * - * @param {string} [type=text] + * @param {"blob"|"text"|"blob"} [type=text] * The expected output type of the invoked program. Valid values are * `text` to interpret the output as string, `json` to parse the output * as JSON or `blob` to return the output as Blob instance. @@ -3973,7 +3973,7 @@ return FileSystem;
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/index.html b/jsapi/index.html index 31442d32ee..f38188db98 100644 --- a/jsapi/index.html +++ b/jsapi/index.html @@ -3560,7 +3560,7 @@ is the central JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/luci.js.html b/jsapi/luci.js.html index bda622dedf..5186844452 100644 --- a/jsapi/luci.js.html +++ b/jsapi/luci.js.html @@ -3615,7 +3615,7 @@ * subclass. * * @returns {LuCI.baseclass} - * Returns a new LuCI.baseclass sublassed from this class, extended + * Returns a new LuCI.baseclass subclassed from this class, extended * by the given properties and with its prototype set to this base * class to enable inheritance. The resulting value represents a * class constructor and can be instantiated with `new`. @@ -3752,7 +3752,7 @@ * would copy all values till the end. * * @param {...*} [extra_args] - * Extra arguments to add to prepend to the resultung array. + * Extra arguments to add to prepend to the resulting array. * * @returns {Array<*>} * Returns a new array consisting of the optional extra arguments @@ -4370,7 +4370,7 @@ * * @instance * @memberof LuCI.request - * @param {string} target + * @param {string} url * The URL to request. * * @param {LuCI.request.RequestOptions} [options] @@ -4388,7 +4388,7 @@ * * @instance * @memberof LuCI.request - * @param {string} target + * @param {string} url * The URL to request. * * @param {*} [data] @@ -4459,7 +4459,7 @@ * @hideconstructor * @classdesc * - * The `Request.poll` class provides some convience wrappers around + * The `Request.poll` class provides some convince wrappers around * {@link LuCI.poll} mainly to simplify registering repeating HTTP * request calls as polling functions. */ @@ -4589,7 +4589,7 @@ /** * Add a new operation to the polling loop. If the polling loop is not - * already started at this point, it will be implicitely started. + * already started at this point, it will be implicitly started. * * @instance * @memberof LuCI.poll @@ -4632,8 +4632,8 @@ }, /** - * Remove an operation from the polling loop. If no further operatons - * are registered, the polling loop is implicitely stopped. + * Remove an operation from the polling loop. If no further operations + * are registered, the polling loop is implicitly stopped. * * @instance * @memberof LuCI.poll @@ -4695,7 +4695,7 @@ * @instance * @memberof LuCI.poll * @returns {boolean} - * Returns `true` if polling has been stopped or `false` if it din't + * Returns `true` if polling has been stopped or `false` if it didn't * run to begin with. */ stop: function() { @@ -4865,7 +4865,7 @@ * The `Node` argument to append the children to. * * @param {*} [children] - * The childrens to append to the given node. + * The children to append to the given node. * * When `children` is an array, then each item of the array * will be either appended as child element or text node, @@ -4880,11 +4880,11 @@ * as first and the return value of the `children` function as * second parameter. * - * When `children` is is a DOM `Node` instance, it will be + * When `children` is a DOM `Node` instance, it will be * appended to the given `node`. * * When `children` is any other non-`null` value, it will be - * converted to a string and appened to the `innerHTML` property + * converted to a string and appended to the `innerHTML` property * of the given `node`. * * @returns {Node|null} @@ -4923,7 +4923,7 @@ * Replaces the content of the given node with the given children. * * This function first removes any children of the given DOM - * `Node` and then adds the given given children following the + * `Node` and then adds the given children following the * rules outlined below. * * @instance @@ -4932,7 +4932,7 @@ * The `Node` argument to replace the children of. * * @param {*} [children] - * The childrens to replace into the given node. + * The children to replace into the given node. * * When `children` is an array, then each item of the array * will be either appended as child element or text node, @@ -4947,11 +4947,11 @@ * as first and the return value of the `children` function as * second parameter. * - * When `children` is is a DOM `Node` instance, it will be + * When `children` is a DOM `Node` instance, it will be * appended to the given `node`. * * When `children` is any other non-`null` value, it will be - * converted to a string and appened to the `innerHTML` property + * converted to a string and appended to the `innerHTML` property * of the given `node`. * * @returns {Node|null} @@ -5005,7 +5005,7 @@ * * When `val` is of any other type, it will be added as attribute * to the given `node` as-is, with the underlying `setAttribute()` - * call implicitely turning it into a string. + * call implicitly turning it into a string. */ attr: function(node, key, val) { if (!this.elem(node)) @@ -5568,7 +5568,7 @@ * Any return values of this function are discarded, but * passed through `Promise.resolve()` to ensure that any * returned promise runs to completion before the button - * is reenabled. + * is re-enabled. */ handleSave: function(ev) { var tasks = []; @@ -5612,7 +5612,7 @@ * Any return values of this function are discarded, but * passed through `Promise.resolve()` to ensure that any * returned promise runs to completion before the button - * is reenabled. + * is re-enabled. */ handleSaveApply: function(ev, mode) { return this.handleSave(ev).then(function() { @@ -5649,7 +5649,7 @@ * Any return values of this function are discarded, but * passed through `Promise.resolve()` to ensure that any * returned promise runs to completion before the button - * is reenabled. + * is re-enabled. */ handleReset: function(ev) { var tasks = []; @@ -5861,7 +5861,7 @@ /** * A wrapper around {@link LuCI#raise raise()} which also renders - * the error either as modal overlay when `ui.js` is already loaed + * the error either as modal overlay when `ui.js` is already loaded * or directly into the view body. * * @instance @@ -6336,7 +6336,7 @@ * omitted, it defaults to an empty string. * * @param {string[]} [parts] - * An array of parts to join into an URL path. Parts may contain + * An array of parts to join into a URL path. Parts may contain * slashes and any of the other characters mentioned above. * * @return {string} @@ -6356,7 +6356,7 @@ }, /** - * Construct an URL pathrelative to the script path of the server + * Construct a URL with path relative to the script path of the server * side LuCI application (usually `/cgi-bin/luci`). * * The resulting URL is guaranteed to only contain the characters @@ -6367,7 +6367,7 @@ * @memberof LuCI * * @param {string[]} [parts] - * An array of parts to join into an URL path. Parts may contain + * An array of parts to join into a URL path. Parts may contain * slashes and any of the other characters mentioned above. * * @return {string} @@ -6378,7 +6378,7 @@ }, /** - * Construct an URL path relative to the global static resource path + * Construct a URL path relative to the global static resource path * of the LuCI ui (usually `/luci-static/resources`). * * The resulting URL is guaranteed to only contain the characters @@ -6389,7 +6389,7 @@ * @memberof LuCI * * @param {string[]} [parts] - * An array of parts to join into an URL path. Parts may contain + * An array of parts to join into a URL path. Parts may contain * slashes and any of the other characters mentioned above. * * @return {string} @@ -6400,7 +6400,7 @@ }, /** - * Construct an URL path relative to the media resource path of the + * Construct a URL path relative to the media resource path of the * LuCI ui (usually `/luci-static/$theme_name`). * * The resulting URL is guaranteed to only contain the characters @@ -6411,7 +6411,7 @@ * @memberof LuCI * * @param {string[]} [parts] - * An array of parts to join into an URL path. Parts may contain + * An array of parts to join into a URL path. Parts may contain * slashes and any of the other characters mentioned above. * * @return {string} @@ -6465,14 +6465,14 @@ * The object to extract the keys from. If the given value is * not an object, the function will return an empty array. * - * @param {string} [key] + * @param {string|null} [key] * 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. * - * @param {string} [sortmode] - * May be either `addr` or `num` to override the natural + * @param {"addr"|"num"} [sortmode] + * Can be either `addr` or `num` to override the natural * lexicographic sorting with a sorting suitable for IP/MAC style * addresses or numeric values respectively. * @@ -6583,7 +6583,7 @@ }, /** - * Returns a promise resolving with either the given value or or with + * Returns a promise resolving with either the given value or with * the given default in case the input value is a rejecting promise. * * @instance @@ -7006,7 +7006,7 @@
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/network.js.html b/jsapi/network.js.html index da0f812c84..9f870fcc77 100644 --- a/jsapi/network.js.html +++ b/jsapi/network.js.html @@ -3744,8 +3744,8 @@ function getWifiNetidBySid(sid) { var s = uci.get('wireless', sid); if (s != null && s['.type'] == 'wifi-iface') { var radioname = s.device; - if (typeof(s.device) == 'string') { - var i = 0, netid = null, sections = uci.sections('wireless', 'wifi-iface'); + if (typeof(radioname) == 'string') { + var sections = uci.sections('wireless', 'wifi-iface'); for (var i = 0, n = 0; i < sections.length; i++) { if (sections[i].device != s.device) continue; @@ -4213,7 +4213,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * @method * * @param {string} netmask - * The netmask to convert into a bit count. + * The netmask to convert into a bits count. * * @param {boolean} [v6=false] * Whether to parse the given netmask as IPv4 (`false`) or IPv6 (`true`) @@ -5145,7 +5145,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { }, /** - * Describes an swconfig switch topology by specifying the CPU + * Describes a swconfig switch topology by specifying the CPU * connections and external port labels of a switch. * * @typedef {Object<string, Object|Array>} SwitchTopology @@ -5160,7 +5160,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * @property {Array<Object<string, boolean|number|string>>} ports * The `ports` property points to an array describing the populated * ports of the switch in the external label order. Each array item is - * an object containg the following keys: + * an object containing the following keys: * - `num` - the internal switch port number * - `label` - the label of the port, e.g. `LAN 1` or `CPU (eth0)` * - `device` - the connected Linux network device name (CPU ports only) @@ -5264,7 +5264,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { }, /** - * Obtains the the network device name of the given object. + * Obtains the network device name of the given object. * * @param {LuCI.network.Protocol|LuCI.network.Device|LuCI.network.WifiDevice|LuCI.network.WifiNetwork|string} obj * The object to get the device name from. @@ -5572,7 +5572,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { }, /** - * Get the associared Linux network device of this network. + * Get the associated Linux network device of this network. * * @returns {null|string} * Returns the name of the associated network device or `null` if @@ -5609,7 +5609,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { }, /** - * Return a human readable description for the protcol, such as + * Return a human readable description for the protocol, such as * `Static address` or `DHCP client`. * * This function should be overwritten by subclasses. @@ -5960,7 +5960,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * * @returns {string} * Returns the name of the opkg package required for the protocol to - * function, e.g. `odhcp6c` for the `dhcpv6` prototocol. + * function, e.g. `odhcp6c` for the `dhcpv6` protocol. */ getOpkgPackage: function() { return null; @@ -6007,7 +6007,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * on demand instead of using existing physical interfaces. * * Examples for virtual protocols are `6in4` which `gre` spawn tunnel - * network device on startup, examples for non-virtual protcols are + * network device on startup, examples for non-virtual protocols are * `dhcp` or `static` which apply IP configuration to existing interfaces. * * This function should be overwritten by subclasses. @@ -6024,7 +6024,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * Checks whether this protocol is "floating". * * A "floating" protocol is a protocol which spawns its own interfaces - * on demand, like a virtual one but which relies on an existinf lower + * on demand, like a virtual one but which relies on an existing lower * level interface to initiate the connection. * * An example for such a protocol is "pppoe". @@ -6237,7 +6237,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * interface. * * @returns {null|Array<LuCI.network.Device>} - * Returns an array of of `Network.Device` class instances representing + * Returns an array of `Network.Device` class instances representing * the sub-devices attached to this logical interface or `null` if the * logical interface does not support sub-devices, e.g. because it is * virtual and not a bridge. @@ -6843,7 +6843,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { * @param {string} opt * The name of the UCI option to set. * - * @param {null|string|string[]} val + * @param {null|string|string[]} value * The value to set or `null` to remove the given option from the * configuration. */ @@ -6943,7 +6943,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { /** * A wireless scan result object describes a neighbouring wireless - * network found in the vincinity. + * network found in the vicinity. * * @typedef {Object<string, number|string|LuCI.network.WifiEncryption>} WifiScanResult * @memberof LuCI.network @@ -6981,7 +6981,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { * * @returns {Promise<Array<LuCI.network.WifiScanResult>>} * Returns a promise resolving to an array of scan result objects - * describing the networks found in the vincinity. + * describing the networks found in the vicinity. */ getScanList: function() { return callIwinfoScan(this.sid); @@ -7032,7 +7032,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { * * @returns {Promise<Array<LuCI.network.WifiNetwork>>} * Returns a promise resolving to an array of `Network.WifiNetwork` - * instances respresenting the wireless networks associated with this + * instances representing the wireless networks associated with this * radio device. */ getWifiNetworks: function() { @@ -7161,7 +7161,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * @param {string} opt * The name of the UCI option to set. * - * @param {null|string|string[]} val + * @param {null|string|string[]} value * The value to set or `null` to remove the given option from the * configuration. */ @@ -7248,7 +7248,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ /** * Get the internal network ID of this wireless network. * - * The network ID is a LuCI specific identifer in the form + * The network ID is a LuCI specific identifier in the form * `radio#.network#` to identify wireless networks by their corresponding * radio and network index numbers. * @@ -7430,7 +7430,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * Query the current encryption settings from runtime information. * * @returns {string} - * Returns a string describing the current encryption or `-` if the the + * Returns a string describing the current encryption or `-` if the * encryption state could not be found in `ubus` runtime information. */ getActiveEncryption: function() { @@ -7531,7 +7531,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * - `UNKNOWN` * * @property {number} [mesh non-peer PS] - * The powersafe mode for all non-peer neigbours, may be an empty + * The powersafe mode for all non-peer neighbours, may be an empty * string (`''`) or absent if not applicable or supported by the driver. * * The following modes are known: @@ -7566,7 +7566,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * The amount of bytes that have been received or sent. * * @property {number} [failed] - * The amount of failed tranmission attempts. Only applicable to + * The amount of failed transmission attempts. Only applicable to * transmit rates. * * @property {number} [retries] @@ -7590,7 +7590,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * HT or VHT rates. * * @property {number} [40mhz] - * Specifies whether the tranmission rate used 40MHz wide channel. + * Specifies whether the transmission rate used 40MHz wide channel. * Only applicable to HT or VHT rates. * * Note: this option exists for backwards compatibility only and its @@ -7855,18 +7855,18 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * * @returns {LuCI.network.Device} * Returns a `Network.Device` instance representing the Linux network - * device associted with this wireless network. + * device associated with this wireless network. */ getDevice: function() { return Network.prototype.instantiateDevice(this.getIfname()); }, /** - * Check whether this wifi network supports deauthenticating clients. + * Check whether this wifi network supports de-authenticating clients. * * @returns {boolean} * Returns `true` when this wifi network instance supports forcibly - * deauthenticating clients, otherwise `false`. + * de-authenticating clients, otherwise `false`. */ isClientDisconnectSupported: function() { return L.isObject(this.ubus('hostapd', 'del_client')); @@ -7879,7 +7879,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * The MAC address of the client to disconnect. * * @param {boolean} [deauth=false] - * Specifies whether to deauthenticate (`true`) or disassociate (`false`) + * Specifies whether to de-authenticate (`true`) or disassociate (`false`) * the client. * * @param {number} [reason=1] @@ -7889,7 +7889,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * @param {number} [ban_time=0] * Specifies the amount of milliseconds to ban the client from * reconnecting. By default, no ban time is set which allows the client - * to reassociate / reauthenticate immediately. + * to re-associate / reauthenticate immediately. * * @returns {Promise<number>} * Returns a promise resolving to the underlying ubus call result code @@ -7925,7 +7925,7 @@ return Network;
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/rpc.js.html b/jsapi/rpc.js.html index 5b4e6b0f79..fce481ffd1 100644 --- a/jsapi/rpc.js.html +++ b/jsapi/rpc.js.html @@ -3720,7 +3720,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ { * the corresponding args object sent to the remote procedure will be * `{ foo: true, bar: false }`. * - `params: [ "test" ], filter: function(reply, args, extra) { ... }` - - * When the resultung generated function is invoked with + * When the resulting generated function is invoked with * `fn("foo", "bar", "baz")` then `{ "test": "foo" }` will be sent as * argument to the remote procedure and the filter function will be * invoked with `filterFn(reply, [ "foo" ], "bar", "baz")` @@ -3760,7 +3760,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ { * be returned as default instead. * * @property {LuCI.rpc~filterFn} [filter] - * Specfies an optional filter function which is invoked to transform the + * Specifies an optional filter function which is invoked to transform the * received reply data before it is returned to the caller. * * @property {boolean} [reject=false] @@ -3913,7 +3913,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ { /** * Set the RPC base URL to use. * - * @param {string} sid + * @param {string} url * Sets the RPC URL endpoint to issue requests against. */ setBaseURL: function(url) { @@ -3988,7 +3988,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ { * Registers a new interceptor function. * * @param {LuCI.rpc~interceptorFn} interceptorFn - * The inteceptor function to register. + * The interceptor function to register. * * @returns {LuCI.rpc~interceptorFn} * Returns the given function value. @@ -4003,7 +4003,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ { * Removes a registered interceptor function. * * @param {LuCI.rpc~interceptorFn} interceptorFn - * The inteceptor function to remove. + * The interceptor function to remove. * * @returns {boolean} * Returns `true` if the given function has been removed or `false` @@ -4029,7 +4029,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ {
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/uci.js.html b/jsapi/uci.js.html index 2492d65c9b..a131f68f4b 100644 --- a/jsapi/uci.js.html +++ b/jsapi/uci.js.html @@ -3552,7 +3552,7 @@ function isEmpty(object, ignore) { * * The `LuCI.uci` class utilizes {@link LuCI.rpc} to declare low level * remote UCI `ubus` procedures and implements a local caching and data - * manipulation layer on top to allow for synchroneous operations on + * manipulation layer on top to allow for synchronous operations on * UCI configuration data. */ return baseclass.extend(/** @lends LuCI.uci.prototype */ { @@ -3627,7 +3627,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * identifier in the form `cfgXXXXXX` once the configuration is saved * by the remote `ubus` UCI api. * - * @param {string} config + * @param {string} conf * The configuration to generate the new section ID for. * * @returns {string} @@ -3650,7 +3650,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * Resolves a given section ID in extended notation to the internal * section ID value. * - * @param {string} config + * @param {string} conf * The configuration to resolve the section ID for. * * @param {string} sid @@ -3743,7 +3743,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * To force reloading a configuration, it has to be unloaded with * {@link LuCI.uci#unload uci.unload()} first. * - * @param {string|string[]} config + * @param {string|string[]} packages * The name of the configuration or an array of configuration * names to load. * @@ -3779,7 +3779,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { /** * Unloads the given UCI configurations from the local cache. * - * @param {string|string[]} config + * @param {string|string[]} packages * The name of the configuration or an array of configuration * names to unload. */ @@ -3801,7 +3801,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * Adds a new section of the given type to the given configuration, * optionally named according to the given name. * - * @param {string} config + * @param {string} conf * The name of the configuration to add the section to. * * @param {string} type @@ -3836,7 +3836,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { /** * Removes the section with the given ID from the given configuration. * - * @param {string} config + * @param {string} conf * The name of the configuration to remove the section from. * * @param {string} sid @@ -3868,7 +3868,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * enclosed within a configuration section, as well as some additional * meta data such as sort indexes and internal ID. * - * Any internal metadata fields are prefixed with a dot which is isn't + * Any internal metadata fields are prefixed with a dot which isn't * an allowed character for normal option names. * * @typedef {Object<string, boolean|number|string|string[]>} SectionObject @@ -3879,7 +3879,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * anonymous (`true`) or named (`false`). * * @property {number} .index - * The `.index` property specifes the sort order of the section. + * The `.index` property specifies the sort order of the section. * * @property {string} .name * The `.name` property holds the name of the section object. It may be @@ -3917,7 +3917,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * Enumerates the sections of the given configuration, optionally * filtered by type. * - * @param {string} config + * @param {string} conf * The name of the configuration to enumerate the sections for. * * @param {string} [type] @@ -3970,13 +3970,13 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * of the given configuration or the entire section object if the * option name is omitted. * - * @param {string} config + * @param {string} conf * The name of the configuration to read the value from. * * @param {string} sid * The name or ID of the section to read. * - * @param {string} [option] + * @param {string} [opt] * The option name to read the value from. If the option name is * omitted or `null`, the entire section is returned instead. * @@ -4064,16 +4064,16 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * If either config, section or option is null, or if `option` begins * with a dot, the function will do nothing. * - * @param {string} config + * @param {string} conf * The name of the configuration to set the option value in. * * @param {string} sid * The name or ID of the section to set the option value in. * - * @param {string} option + * @param {string} opt * The option name to set the value for. * - * @param {null|string|string[]} value + * @param {null|string|string[]} val * The option value to set. If the value is `null` or an empty string, * the option will be removed, otherwise it will be set or overwritten * with the given value. @@ -4150,13 +4150,13 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * This function is a convenience wrapper around * `uci.set(config, section, option, null)`. * - * @param {string} config + * @param {string} conf * The name of the configuration to remove the option from. * * @param {string} sid * The name or ID of the section to remove the option from. * - * @param {string} option + * @param {string} opt * The name of the option to remove. */ unset: function(conf, sid, opt) { @@ -4166,9 +4166,9 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { /** * Gets the value of the given option or the entire section object of * the first found section of the specified type or the first found - * section of the entire configuration if no type is specfied. + * section of the entire configuration if no type is specified. * - * @param {string} config + * @param {string} conf * The name of the configuration to read the value from. * * @param {string} [type] @@ -4176,7 +4176,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * section of the entire config is read, otherwise the first section * matching the given type. * - * @param {string} [option] + * @param {string} [opt] * The option name to read the value from. If the option name is * omitted or `null`, the entire section is returned instead. * @@ -4209,7 +4209,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * If either config, type or option is null, or if `option` begins * with a dot, the function will do nothing. * - * @param {string} config + * @param {string} conf * The name of the configuration to set the option value in. * * @param {string} [type] @@ -4217,10 +4217,10 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * section of the entire config is written to, otherwise the first * section matching the given type is used. * - * @param {string} option + * @param {string} opt * The option name to set the value for. * - * @param {null|string|string[]} value + * @param {null|string|string[]} val * The option value to set. If the value is `null` or an empty string, * the option will be removed, otherwise it will be set or overwritten * with the given value. @@ -4244,7 +4244,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * This function is a convenience wrapper around * `uci.set_first(config, type, option, null)`. * - * @param {string} config + * @param {string} conf * The name of the configuration to set the option value in. * * @param {string} [type] @@ -4252,7 +4252,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * section of the entire config is written to, otherwise the first * section matching the given type is used. * - * @param {string} option + * @param {string} opt * The option name to set the value for. */ unset_first: function(conf, type, opt) { @@ -4263,7 +4263,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ { * Move the first specified section within the given configuration * before or after the second specified section. * - * @param {string} config + * @param {string} conf * The configuration to move the section within. * * @param {string} sid1 @@ -4532,7 +4532,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ {
      - Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
      diff --git a/jsapi/ui.js.html b/jsapi/ui.js.html index 8b7c92ee3c..873dea89d9 100644 --- a/jsapi/ui.js.html +++ b/jsapi/ui.js.html @@ -3560,7 +3560,7 @@ var modalDiv = null, * events. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -3668,7 +3668,7 @@ var UIElement = baseclass.extend(/** @lends LuCI.ui.AbstractElement.prototype */ * @memberof LuCI.ui.AbstractElement * @returns {boolean} * Returns `true` if the input value has been altered by the user or - * `false` if it is unchaged. Note that if the user modifies the initial + * `false` if it is unchanged. Note that if the user modifies the initial * value and changes it back to the original state, it is still reported * as changed. */ @@ -3850,7 +3850,7 @@ var UIElement = baseclass.extend(/** @lends LuCI.ui.AbstractElement.prototype */ * The `Textfield` class implements a standard single line text input field. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -3975,7 +3975,7 @@ var UITextfield = UIElement.extend(/** @lends LuCI.ui.Textfield.prototype */ { * The `Textarea` class implements a multiline text area input field. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -4091,7 +4091,7 @@ var UITextarea = UIElement.extend(/** @lends LuCI.ui.Textarea.prototype */ { * The `Checkbox` class implements a simple checkbox input field. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -4230,7 +4230,7 @@ var UICheckbox = UIElement.extend(/** @lends LuCI.ui.Checkbox.prototype */ { * values are enabled or not. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -4260,7 +4260,7 @@ var UISelect = UIElement.extend(/** @lends LuCI.ui.Select.prototype */ { * @property {boolean} [multiple=false] * Specifies whether multiple choice values may be selected. * - * @property {string} [widget=select] + * @property {"select"|"individual"} [widget=select] * Specifies the kind of widget to render. May be either `select` or * `individual`. When set to `select` an HTML `<select>` element will be * used, otherwise a group of checkbox or radio button elements is created, @@ -4438,7 +4438,7 @@ var UISelect = UIElement.extend(/** @lends LuCI.ui.Select.prototype */ { * supports non-text choice labels. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -5522,7 +5522,7 @@ var UIDropdown = UIElement.extend(/** @lends LuCI.ui.Dropdown.prototype */ { * with a set of enforced default properties for easier instantiation. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -5589,7 +5589,7 @@ var UICombobox = UIDropdown.extend(/** @lends LuCI.ui.Combobox.prototype */ { * into a dropdown to chose from a set of different action choices. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -5612,7 +5612,7 @@ var UIComboButton = UIDropdown.extend(/** @lends LuCI.ui.ComboButton.prototype * /** * ComboButtons support the same properties as * [Dropdown.InitOptions]{@link LuCI.ui.Dropdown.InitOptions} but enforce - * specific values for some properties and add aditional button specific + * specific values for some properties and add additional button specific * properties. * * @typedef {LuCI.ui.Dropdown.InitOptions} InitOptions @@ -5706,7 +5706,7 @@ var UIComboButton = UIDropdown.extend(/** @lends LuCI.ui.ComboButton.prototype * * from a set of predefined choices. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -5729,7 +5729,7 @@ var UIComboButton = UIDropdown.extend(/** @lends LuCI.ui.ComboButton.prototype * */ var UIDynamicList = UIElement.extend(/** @lends LuCI.ui.DynamicList.prototype */ { /** - * In case choices are passed to the dynamic list contructor, the widget + * In case choices are passed to the dynamic list constructor, the widget * supports the same properties as [Dropdown.InitOptions]{@link LuCI.ui.Dropdown.InitOptions} * but enforces specific values for some dropdown properties. * @@ -6061,7 +6061,7 @@ var UIDynamicList = UIElement.extend(/** @lends LuCI.ui.DynamicList.prototype */ * which allows to store form data without exposing it to the user. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -6127,7 +6127,7 @@ var UIHiddenfield = UIElement.extend(/** @lends LuCI.ui.Hiddenfield.prototype */ * browse, select and delete files beneath a predefined remote directory. * * UI widget instances are usually not supposed to be created by view code - * directly, instead they're implicitely created by `LuCI.form` when + * directly, instead they're implicitly created by `LuCI.form` when * instantiating CBI forms. * * This class is automatically instantiated as part of `LuCI.ui`. To use it @@ -6172,9 +6172,9 @@ var UIFileUpload = UIElement.extend(/** @lends LuCI.ui.FileUpload.prototype */ { * * @property {string} [root_directory=/etc/luci-uploads] * Specifies the remote directory the upload and file browsing actions take - * place in. Browsing to directories outside of the root directory is + * place in. Browsing to directories outside the root directory is * prevented by the widget. Note that this is not a security feature. - * Whether remote directories are browseable or not solely depends on the + * Whether remote directories are browsable or not solely depends on the * ACL setup for the current session. */ __init__: function(value, options) { @@ -6619,7 +6619,7 @@ var UIMenu = baseclass.singleton(/** @lends LuCI.ui.menu.prototype */ { * @property {string} name - The internal name of the node, as used in the URL * @property {number} order - The sort index of the menu node * @property {string} [title] - The title of the menu node, `null` if the node should be hidden - * @property {satisified} boolean - Boolean indicating whether the menu enries dependencies are satisfied + * @property {satisfied} boolean - Boolean indicating whether the menu entries dependencies are satisfied * @property {readonly} [boolean] - Boolean indicating whether the menu entries underlying ACLs are readonly * @property {LuCI.ui.menu.MenuNode[]} [children] - Array of child menu nodes. */ @@ -7061,7 +7061,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * be opened. Invoking showModal() while a modal dialog is already open will * replace the open dialog with a new one having the specified contents. * - * Additional CSS class names may be passed to influence the appearence of + * Additional CSS class names may be passed to influence the appearance of * the dialog. Valid values for the classes depend on the underlying theme. * * @see LuCI.dom.content @@ -7069,7 +7069,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * @param {string} [title] * The title of the dialog. If `null`, no title element will be rendered. * - * @param {*} contents + * @param {*} children * The contents to add to the modal dialog. This should be a DOM node or * a document fragment in most cases. The value is passed as-is to the * `dom.content()` function - refer to its documentation for applicable @@ -7193,11 +7193,11 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * Add a notification banner at the top of the current view. * * A notification banner is an alert message usually displayed at the - * top of the current view, spanning the entire availibe width. + * top of the current view, spanning the entire available width. * Notification banners will stay in place until dismissed by the user. * Multiple banners may be shown at the same time. * - * Additional CSS class names may be passed to influence the appearence of + * Additional CSS class names may be passed to influence the appearance of * the banner. Valid values for the classes depend on the underlying theme. * * @see LuCI.dom.content @@ -7206,7 +7206,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * The title of the notification banner. If `null`, no title element * will be rendered. * - * @param {*} contents + * @param {*} children * The contents to add to the notification banner. This should be a DOM * node or a document fragment in most cases. The value is passed as-is * to the `dom.content()` function - refer to its documentation for @@ -7257,7 +7257,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { }, /** - * Display or update an header area indicator. + * Display or update a header area indicator. * * An indicator is a small label displayed in the header area of the screen * providing few amounts of status information such as item counts or state @@ -7284,7 +7284,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * Note that this parameter only applies to new indicators, when updating * existing labels it is ignored. * - * @param {string} [style=active] + * @param {"active"|"inactive"} [style=active] * The indicator style to use. May be either `active` or `inactive`. * * @returns {boolean} @@ -7327,7 +7327,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { }, /** - * Remove an header area indicator. + * Remove a header area indicator. * * This function removes the given indicator label from the header indicator * area. When the given indicator is not found, this function does nothing. @@ -7361,7 +7361,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * subsequently wrapped into a `<span class="nowrap">` element. * * The resulting `<span>` element tuples are joined by the given separators - * to form the final markup which is appened to the given parent DOM node. + * to form the final markup which is appended to the given parent DOM node. * * @param {Node} node * The parent DOM node to append the markup to. Any previous child elements @@ -7688,7 +7688,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * @param {string} path * The remote file path to upload the local file to. * - * @param {Node} [progessStatusNode] + * @param {Node} [progressStatusNode] * An optional DOM text node whose content text is set to the progress * percentage value during file upload. * @@ -7802,7 +7802,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { /** * Perform a device connectivity test. * - * Attempt to fetch a well known ressource from the remote device via HTTP + * Attempt to fetch a well known resource from the remote device via HTTP * in order to test connectivity. This function is mainly useful to wait * for the router to come back online after a reboot or reconfiguration. * @@ -7810,7 +7810,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * The protocol to use for fetching the resource. May be either `http` * (the default) or `https`. * - * @param {string} [host=window.location.host] + * @param {string} [ipaddr=window.location.host] * Override the host address to probe. By default the current host as seen * in the address bar is probed. * @@ -7899,7 +7899,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * * @instance * @memberof LuCI.ui.changes - * @param {number} numChanges + * @param {number} n * The number of changes to indicate. */ setIndicator: function(n) { @@ -8440,7 +8440,7 @@ var UI = baseclass.extend(/** @lends LuCI.ui.prototype */ { * * By instantiating the view class, its corresponding contents are * rendered and included into the view area. Any runtime errors are - * catched and rendered using [LuCI.error()]{@link LuCI#error}. + * caught and rendered using [LuCI.error()]{@link LuCI#error}. * * @param {string} path * The view path to render. @@ -8494,7 +8494,7 @@ return UI; -- 2.30.2