From 89a50c2f8f45a4d5a1bfbc2eb8e29e5836feeccb Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Thu, 2 Apr 2020 21:50:07 +0200 Subject: docs: update js api docs Signed-off-by: Jo-Philipp Wich --- docs/jsapi/LuCI.html | 768 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 508 insertions(+), 260 deletions(-) (limited to 'docs/jsapi/LuCI.html') diff --git a/docs/jsapi/LuCI.html b/docs/jsapi/LuCI.html index 5bf4e3262c..d7cf33cedc 100644 --- a/docs/jsapi/LuCI.html +++ b/docs/jsapi/LuCI.html @@ -43,8 +43,18 @@ Members +
  • Class
    • + +
  • dom
    • +
  • env
    • +
  • Poll
    • + +
  • Request
    • + +
  • view
    • + -
  • +
  • - LuCI.Class + LuCI.baseclass
      @@ -246,9 +256,9 @@
    • -
  • +
  • - LuCI.Headers + LuCI.headers
      @@ -274,9 +284,9 @@
    • -
  • +
  • - LuCI.Network + LuCI.network
      @@ -368,9 +378,9 @@
    • -
  • +
  • - LuCI.Network.Device + LuCI.network.Device
      @@ -436,9 +446,9 @@
    • -
  • +
  • - LuCI.Network.Hosts + LuCI.network.Hosts
      @@ -476,9 +486,9 @@
    • -
  • +
  • - LuCI.Network.Protocol + LuCI.network.Protocol
      @@ -580,9 +588,9 @@
    • -
  • +
  • - LuCI.Network.WifiDevice + LuCI.network.WifiDevice
      @@ -630,9 +638,9 @@
    • -
  • +
  • - LuCI.Network.WifiNetwork + LuCI.network.WifiNetwork
      @@ -728,9 +736,9 @@
    • -
  • +
  • - LuCI.Poll + LuCI.poll
      @@ -762,9 +770,9 @@
    • -
  • +
  • - LuCI.Request + LuCI.request
      @@ -804,9 +812,9 @@
    • -
  • +
  • - LuCI.Request.poll + LuCI.request.poll
      @@ -842,26 +850,26 @@
    • -
  • +
  • - LuCI.Response + LuCI.response
      @@ -1646,9 +1654,9 @@
    • -
  • +
  • - LuCI.XHR + LuCI.xhr
      @@ -1831,7 +1839,7 @@ accessible using the global L variable.

      Classes

      -
      Class
      +
      baseclass
      dom
      @@ -1840,19 +1848,19 @@ accessible using the global L variable.

      fs
      -
      Headers
      +
      headers
      -
      Network
      +
      network
      -
      Poll
      +
      poll
      -
      Request
      +
      request
      -
      Response
      +
      response
      rpc
      @@ -1867,7 +1875,7 @@ accessible using the global L variable.

      view
      -
      XHR
      +
      xhr
      @@ -1879,6 +1887,102 @@ accessible using the global L variable.

      +
      +
      +

      Class

      +
      + + +
      +
      + +
      +

      Legacy L.Class class alias. New view code should use 'require baseclass'; +to request the LuCI.baseclass class.

      +
      + + + +
      + + + + + + + +
      Deprecated
      • Yes
      + + + + + + + + + + + + + + + +
      + + + +
      + + + +
      +
      +

      dom

      +
      + + +
      +
      + +
      +

      Legacy L.dom class alias. New view code should use 'require dom'; +to request the LuCI.dom class.

      +
      + + + +
      + + + + + + + +
      Deprecated
      • Yes
      + + + + + + + + + + + + + + + +
      + + + +
      + + +

      env

      @@ -1916,6 +2020,150 @@ as request timeouts, base URLs etc.

      + +
      + + + + + + + +
      +
      +

      Poll

      +
      + + +
      +
      + +
      +

      Legacy L.Poll class alias. New view code should use 'require poll'; +to request the LuCI.poll class.

      +
      + + + +
      + + + + + + + +
      Deprecated
      • Yes
      + + + + + + + + + + + + + + + +
      + + + +
      + + + +
      +
      +

      Request

      +
      + + +
      +
      + +
      +

      Legacy L.Request class alias. New view code should use 'require request'; +to request the LuCI.request class.

      +
      + + + +
      + + + + + + + +
      Deprecated
      • Yes
      + + + + + + + + + + + + + + + +
      + + + +
      + + + +
      +
      +

      view

      +
      + + +
      +
      + +
      +

      Legacy L.view class alias. New view code should use 'require view'; +to request the LuCI.view class.

      +
      + + + +
      + + + + + + + +
      Deprecated
      • Yes
      + + + + + + + + + + + + + +
      @@ -1940,7 +2188,7 @@ as request timeouts, base URLs etc.

      - luci.js, line 1389 + luci.js, line 2280
      @@ -2152,7 +2400,7 @@ as parameters.

      - luci.js, line 1349 + luci.js, line 2240
      @@ -2391,7 +2639,7 @@ argument or copied from the given error instance.

      - luci.js, line 1989 + luci.js, line 2880
      @@ -2404,7 +2652,7 @@ argument or copied from the given error instance.

      Issues a GET request to the given url and invokes the specified callback function. The function is a wrapper around -Request.request().

      +Request.request().

      @@ -2603,7 +2851,7 @@ callback function. The function is a wrapper around
      - luci.js, line 2111 + luci.js, line 3002
      @@ -2706,7 +2954,7 @@ when it didn't run to begin with.
      - luci.js, line 1623 + luci.js, line 2514
      @@ -2899,7 +3147,7 @@ has no sub-features.
      - luci.js, line 1836 + luci.js, line 2727
      @@ -3054,7 +3302,7 @@ not null, else returns false.
      - luci.js, line 1816 + luci.js, line 2707
      @@ -3154,7 +3402,7 @@ not null, else returns false.
      - luci.js, line 1803 + luci.js, line 2694
      @@ -3311,7 +3559,7 @@ slashes and any of the other characters mentioned above.

      - luci.js, line 1728 + luci.js, line 2619
      @@ -3498,7 +3746,7 @@ slashes and any of the other characters mentioned above.

      - luci.js, line 2059 + luci.js, line 2950
      @@ -3511,7 +3759,7 @@ slashes and any of the other characters mentioned above.

      Register a polling HTTP request that invokes the specified callback function. The function is a wrapper around -Request.poll.add().

      +Request.poll.add().

      @@ -3779,7 +4027,7 @@ default, regardless of the parameters specified with args.

      Returns the internally created function that has been passed to -Request.poll.add(). This value can +Request.poll.add(). This value can be passed to Poll.remove() to remove the polling request. @@ -3803,7 +4051,7 @@ polling request.
      - luci.js, line 2017 + luci.js, line 2908
      @@ -3816,7 +4064,7 @@ polling request.

      Issues a POST request to the given url and invokes the specified callback function. The function is a wrapper around -Request.request(). The request is +Request.request(). The request is sent using application/x-www-form-urlencoded encoding and will contain a field token with the current value of LuCI.env.token by default.

      @@ -4018,7 +4266,7 @@ by default.

      - luci.js, line 1283 + luci.js, line 2174
      @@ -4252,12 +4500,12 @@ argument or copied from the given error instance.

      - require(name){Promise.<LuCI#Class>} + require(name){Promise.<LuCI.baseclass>}

      - luci.js, line 1428 + luci.js, line 2319
      @@ -4395,7 +4643,7 @@ circular dependencies.

      -

      Throws NetworkError when the underlying LuCI.Request +

      Throws NetworkError when the underlying LuCI.request call failed.

      @@ -4489,7 +4737,7 @@ class instance.

      - Promise.<LuCI#Class> + Promise.<LuCI.baseclass> @@ -4515,7 +4763,7 @@ class instance.

      - luci.js, line 1944 + luci.js, line 2835
      @@ -4686,7 +4934,7 @@ to the given default value on error.
      - luci.js, line 1781 + luci.js, line 2672
      @@ -4843,7 +5091,7 @@ slashes and any of the other characters mentioned above.

      - luci.js, line 2124 + luci.js, line 3015
      @@ -4946,7 +5194,7 @@ when it was already running.
      - luci.js, line 1865 + luci.js, line 2756
      @@ -5163,7 +5411,7 @@ addresses or numeric values respectively.

      - luci.js, line 2098 + luci.js, line 2989
      @@ -5311,7 +5559,7 @@ it could not be found.
      - luci.js, line 1910 + luci.js, line 2801
      @@ -5461,7 +5709,7 @@ space and returned as array.

      - luci.js, line 1759 + luci.js, line 2650
      @@ -5624,7 +5872,7 @@ slashes and any of the other characters mentioned above.

      - luci.js, line 1948 + luci.js, line 2839
      @@ -5795,7 +6043,7 @@ else null.

      -- cgit v1.2.3