Mercurial > hg > nginx-site
changeset 2818:2594d336342d
Documented fs.Stats, statSync and lstatSync in njs.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 29 Dec 2021 14:07:09 +0300 |
parents | d84856836c20 |
children | b7ff3d1915a1 |
files | xml/en/docs/njs/reference.xml |
diffstat | 1 files changed, 190 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/njs/reference.xml Tue Dec 28 19:23:21 2021 +0300 +++ b/xml/en/docs/njs/reference.xml Wed Dec 29 14:07:09 2021 +0300 @@ -9,7 +9,7 @@ <article name="Reference" link="/en/docs/njs/reference.html" lang="en" - rev="78"> + rev="79"> <section id="summary"> @@ -3316,6 +3316,26 @@ </list> </tag-desc> +<tag-name id="fs_lstatsync"><literal>lstatSync(<value>path</value>[, +<value>options</value>])</literal></tag-name> +<tag-desc> +Synchronously retrieves +the <link id="fs_stats"><literal>fs.Stats</literal></link> object +for the symbolic link referred to by <literal>path</literal> +(<link doc="changes.xml" id="njs0.7.1">0.7.1</link>). +The <literal>options</literal> parameter is expected to be +an object with the following keys: +<list type="tag"> +<tag-name><literal>throwIfNoEntry</literal></tag-name> +<tag-desc> +a boolean value which indicates +whether an exception is thrown if no file system entry exists, +rather than returning <literal>undefined</literal>, +by default is <literal>false</literal>. +</tag-desc> +</list> +</tag-desc> + <tag-name id="fs_mkdirsync"><literal>mkdirSync(<value>path</value>[, <value>options</value>])</literal></tag-name> <tag-desc> @@ -3443,6 +3463,29 @@ (<link doc="changes.xml" id="njs0.4.2">0.4.2</link>). </tag-desc> +<tag-name id="fs_statsync"><literal>statSync(<value>path</value>,[ +<value>options</value>])</literal></tag-name> +<tag-desc> +Synchronously retrieves +the <link id="fs_stats"><literal>fs.Stats</literal></link> object +for the specified <literal>path</literal> +(<link doc="changes.xml" id="njs0.7.1">0.7.1</link>). +The <literal>path</literal> can be a +<literal>string</literal> or +<literal>buffer</literal>. +The <literal>options</literal> parameter is expected to be +an object with the following keys: +<list type="tag"> +<tag-name><literal>throwIfNoEntry</literal></tag-name> +<tag-desc> +a boolean value which indicates whether +an exception is thrown if no file system entry exists +rather than returning <literal>undefined</literal>, +by default is <literal>true</literal>. +</tag-desc> +</list> +</tag-desc> + <tag-name id="fs_symlinksync"><literal>symlinkSync(<value>target</value>, <value>path</value>)</literal></tag-name> <tag-desc> @@ -3563,6 +3606,152 @@ </section> +<section id="fs_stats" name="fs.Stats"> + +<para> +The <literal>fs.Stats</literal> object provides information about a file. +The object is returned from +<link id="fs_statsync">fs.statSync()</link> and +<link id="fs_lstatsync">fs.lstatSync()</link>. + +<list type= "bullet" compact="no"> + +<listitem> +<literal>stats.isBlockDevice()</literal>—returns +<literal>true</literal> if the <literal>fs.Stats</literal> object describes +a block device. +</listitem> + +<listitem> +<literal>stats.isDirectory()</literal>—returns +<literal>true</literal> if the <literal>fs.Stats</literal> object describes +a file system directory. +</listitem> + +<listitem> +<literal>stats.isFIFO()</literal>—returns +<literal>true</literal> if the <literal>fs.Stats</literal> object describes +a first-in-first-out (FIFO) pipe. +</listitem> + +<listitem> +<literal>stats.isFile()</literal>—returns +<literal>true</literal> if the <literal>fs.Stats</literal> object describes +a regular file. +</listitem> + +<listitem> +<literal>stats.isSocket()</literal>—returns +<literal>true</literal> if the <literal>fs.Stats</literal> object describes +a socket. +</listitem> + +<listitem> +<literal>stats.isSymbolicLink()</literal>—returns +<literal>true</literal> if the <literal>fs.Stats</literal> object describes +a symbolic link. +</listitem> + +<listitem> +<literal>stats.dev</literal>— +the numeric identifier of the device containing the file. +</listitem> + +<listitem> +<literal>stats.ino</literal>— +the file system specific <literal>Inode</literal> number for the file. +</listitem> + +<listitem> +<literal>stats.mode</literal>— +a bit-field describing the file type and mode. +</listitem> + +<listitem> +<literal>stats.nlink</literal>— +the number of hard-links that exist for the file. +</listitem> + +<listitem> +<literal>stats.uid</literal>— +the numeric user identifier of the user that owns the file (POSIX). +</listitem> + +<listitem> +<literal>stats.gid</literal>— +the numeric group identifier of the group that owns the file (POSIX). +</listitem> + +<listitem> +<literal>stats.rdev</literal>— +the numeric device identifier if the file represents a device. +</listitem> + +<listitem> +<literal>stats.size</literal>— +the size of the file in bytes. +</listitem> + +<listitem> +<literal>stats.blksize</literal>— +the file system block size for i/o operations. +</listitem> + +<listitem> +<literal>stats.blocks</literal>— +the number of blocks allocated for this file. +</listitem> + +<listitem> +<literal>stats.atimeMs</literal>— +the timestamp indicating the last time this file was accessed expressed +in milliseconds since the POSIX Epoch. +</listitem> + +<listitem> +<literal>stats.mtimeMs</literal>— +the timestamp indicating the last time this file was modified expressed +in milliseconds since the POSIX Epoch. +</listitem> + +<listitem> +<literal>stats.ctimeMs</literal>— +the timestamp indicating the last time this file was changed expressed +in milliseconds since the POSIX Epoch. +</listitem> + +<listitem> +<literal>stats.birthtimeMs</literal>— +the timestamp indicating the creation time of this file expressed +in milliseconds since the POSIX Epoch. +</listitem> + +<listitem> +<literal>stats.atime</literal>— +the timestamp indicating the last time this file was accessed. +</listitem> + +<listitem> +<literal>stats.mtime</literal>— +the timestamp indicating the last time this file was modified. +</listitem> + +<listitem> +<literal>stats.ctime</literal>— +the timestamp indicating the last time this file was changed. +</listitem> + +<listitem> +<literal>stats.birthtime</literal>— +the timestamp indicating the creation time of this file. +</listitem> + +</list> +</para> + +</section> + + <section id="access_const" name="File Access Constants"> <para>