From 3942789dc62d6a0e7fcfb0a935bfe5c8d372245b Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 09:33:40 +0100 Subject: documentation: add JS api docs Signed-off-by: Jo-Philipp Wich (cherry picked from commit d9452d1157aef6b8752fac0f4ed1e0b9221abb31) --- documentation/jsapi/LuCI.fs.html | 2143 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 2143 insertions(+) create mode 100644 documentation/jsapi/LuCI.fs.html (limited to 'documentation/jsapi/LuCI.fs.html') diff --git a/documentation/jsapi/LuCI.fs.html b/documentation/jsapi/LuCI.fs.html new file mode 100644 index 0000000000..abae649cbe --- /dev/null +++ b/documentation/jsapi/LuCI.fs.html @@ -0,0 +1,2143 @@ + + + + + JSDoc: Class: fs + + + + + + + + + + +
+ +

Class: fs

+ + + + + + +
+ +
+ +

+ LuCI.fs

+ +

Provides high level utilities to wrap file system related RPC calls. +To import the class in views, use 'require fs', to import it in +external JavaScript, use L.require("fs").then(...).

+ + +
+ +
+
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + +

Methods

+ + + + + + + +

exec(command, paramsopt, envopt) → {Promise.<LuCI.fs.FileExecResult>}

+ + + + + + +
+

Execute the specified command, optionally passing params and +environment variables.

+

Note: The command must be either the path to an executable, +or a basename without arguments in which case it will be searched +in $PATH. If specified, the values given in params will be passed +as arguments to the command.

+

The key/value pairs in the optional env table are translated to +setenv() calls prior to running the command.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
command + + +string + + + + + + + + + +

The command to invoke.

params + + +Array.<string> + + + + + + <optional>
+ + + + + +

The arguments to pass to the command.

env + + +Object.<string, string> + + + + + + <optional>
+ + + + + +

Environment variables to set.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to an object describing the execution +results or rejecting with an error stating the failure reason.

+
+ + + +
+
+ Type +
+
+ +Promise.<LuCI.fs.FileExecResult> + + +
+
+ + + + + + + + + + + + + +

lines(path) → {Promise.<Array.<string>>}

+ + + + + + +
+

Read the contents of the given file, split it into lines, trim +leading and trailing white space of each line and return the +resulting array.

+

This function is guaranteed to not reject its promises, on failure, +an empty array will be returned.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +string + + + +

The file path to read.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to an array containing the stripped lines +of the given file or [] on failure.

+
+ + + +
+
+ Type +
+
+ +Promise.<Array.<string>> + + +
+
+ + + + + + + + + + + + + +

list(path) → {Promise.<Array.<LuCI.fs.FileStatEntry>>}

+ + + + + + +
+

Obtains a listing of the specified directory.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +string + + + +

The directory path to list.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to an array of stat detail objects or +rejecting with an error stating the failure reason.

+
+ + + +
+
+ Type +
+
+ +Promise.<Array.<LuCI.fs.FileStatEntry>> + + +
+
+ + + + + + + + + + + + + +

read(path) → {Promise.<string>}

+ + + + + + +
+

Read the contents of the given file and return them. +Note: this function is unsuitable for obtaining binary data.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +string + + + +

The file path to read.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to a string containing the file contents or +rejecting with an error stating the failure reason.

+
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

remove(The) → {Promise.<number>}

+ + + + + + +
+

Unlink the given file.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
The + + +string + + + +

file path to remove.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to 0 or rejecting with an error stating +the failure reason.

+
+ + + +
+
+ Type +
+
+ +Promise.<number> + + +
+
+ + + + + + + + + + + + + +

stat(path) → {Promise.<LuCI.fs.FileStatEntry>}

+ + + + + + +
+

Return file stat information on the specified path.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +string + + + +

The filesystem path to stat.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to a stat detail object or +rejecting with an error stating the failure reason.

+
+ + + +
+
+ Type +
+
+ +Promise.<LuCI.fs.FileStatEntry> + + +
+
+ + + + + + + + + + + + + +

trimmed(path) → {Promise.<string>}

+ + + + + + +
+

Read the contents of the given file, trim leading and trailing white +space and return the trimmed result. In case of errors, return an empty +string instead.

+

Note: this function is useful to read single-value files in /sys +or /proc.

+

This function is guaranteed to not reject its promises, on failure, +an empty string will be returned.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
path + + +string + + + +

The file path to read.

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to the file contents or the empty string +on failure.

+
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

write(path, dataopt, modeopt) → {Promise.<number>}

+ + + + + + +
+

Write the given data to the specified file path. +If the specified file path does not exist, it will be created, given +sufficient permissions.

+

Note: data will be converted to a string using String(data) or to +'' when it is null.

+
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
path + + +string + + + + + + + + + +

The file path to write to.

data + + +* + + + + + + <optional>
+ + + + + +

The file data to write. If it is null, it will be set to an empty +string.

mode + + +number + + + + + + <optional>
+ + + + + +

The permissions to use on file creation. Default is 420 (0644).

+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+

Returns a promise resolving to 0 or rejecting with an error stating +the failure reason.

+
+ + + +
+
+ Type +
+
+ +Promise.<number> + + +
+
+ + + + + + + + + + + +

Type Definitions

+ + + +

FileExecResult

+ + + + + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
code + + +number + + + + + + + +

The exit code of the invoked command

stdout + + +string + + + + + + <optional>
+ + + +

The stdout produced by the command, if any

stderr + + +string + + + + + + <optional>
+ + + +

The stderr produced by the command, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

FileStatEntry

+ + + + + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + +

Name of the directory entry

type + + +string + + + +

Type of the entry, one of block, char, directory, fifo, symlink, file, socket or unknown

size + + +number + + + +

Size in bytes

mode + + +number + + + +

Access permissions

atime + + +number + + + +

Last access time in seconds since epoch

mtime + + +number + + + +

Last modification time in seconds since epoch

ctime + + +number + + + +

Last change time in seconds since epoch

inode + + +number + + + +

Inode number

uid + + +number + + + +

Numeric owner id

gid + + +number + + + +

Numeric group id

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) +
+ + + + + \ No newline at end of file -- cgit v1.2.3