diff options
| author | Sergey Ponomarev <stokito@gmail.com> | 2023-09-23 10:39:34 +0300 |
|---|---|---|
| committer | Sergey Ponomarev <stokito@gmail.com> | 2023-09-23 10:39:34 +0300 |
| commit | 7744ad0075bda689346a3868f36a57c8b53b23c8 (patch) | |
| tree | 55889c3c6cb0edd173b3ac82e493e48041227f8e /modules/luci-base/htdocs/luci-static/resources/rpc.js | |
| parent | d35dd2d48994266278a9d066cbb99f849c46eb5d (diff) | |
luci-base: Fix typos in JsDocs
In some places argument name was renamed but in the JsDoc it's remain old.
Added more typing for string enum fields like:
@param {string} [type=text]
replaced with:
@param {"blob"|"text"|"blob"} [type=text]
Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
Diffstat (limited to 'modules/luci-base/htdocs/luci-static/resources/rpc.js')
| -rw-r--r-- | modules/luci-base/htdocs/luci-static/resources/rpc.js | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/modules/luci-base/htdocs/luci-static/resources/rpc.js b/modules/luci-base/htdocs/luci-static/resources/rpc.js index f37f7bb6a4..8010066594 100644 --- a/modules/luci-base/htdocs/luci-static/resources/rpc.js +++ b/modules/luci-base/htdocs/luci-static/resources/rpc.js @@ -186,7 +186,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")` @@ -226,7 +226,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] @@ -379,7 +379,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) { @@ -454,7 +454,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. @@ -469,7 +469,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` |
