Skip to content

Commit 8844703

Browse files
xeioexy82
authored andcommitted
Documented njs fs.readlinkSync().
1 parent 2a08467 commit 8844703

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

xml/en/docs/njs/reference.xml

+17-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<article name="Reference"
1010
link="/en/docs/njs/reference.html"
1111
lang="en"
12-
rev="125">
12+
rev="126">
1313

1414
<section id="summary">
1515

@@ -4932,6 +4932,7 @@ undefined
49324932
<tr><td><link id="fs_promises_open"><literal>fs.promises.open()</literal></link></td></tr>
49334933
<tr><td><link id="fs_readdirsync"><literal>fs.readdirSync()</literal></link></td></tr>
49344934
<tr><td><link id="fs_readfilesync"><literal>fs.readFileSync()</literal></link></td></tr>
4935+
<tr><td><link id="fs_readlinksync"><literal>fs.readlinkSync()</literal></link></td></tr>
49354936
<tr><td><link id="fs_readsync"><literal>fs.readSync()</literal></link></td></tr>
49364937
<tr><td><link id="fs_realpathsync"><literal>fs.realpathSync()</literal></link></td></tr>
49374938
<tr><td><link id="fs_renamesync"><literal>fs.renameSync()</literal></link></td></tr>
@@ -5208,6 +5209,21 @@ true
52085209
</example>
52095210
</tag-desc>
52105211

5212+
<tag-name id="fs_readlinksync"><literal>readlinkSync(<value>path</value>[,
5213+
<value>options</value>])</literal></tag-name>
5214+
<tag-desc>
5215+
Synchronously gets the contents of the symbolic link <literal>path</literal>
5216+
using
5217+
<link url="https://man7.org/linux/man-pages/man2/readlink.2.html">readlink(2)</link>
5218+
(<link doc="changes.xml" id="njs0.8.7">0.8.7</link>).
5219+
The <literal>options</literal> argument can be a string specifying an encoding,
5220+
or an object with <literal>encoding</literal> property
5221+
specifying the character encoding to use.
5222+
If the <literal>encoding</literal> is <value>buffer</value>,
5223+
the result is returned as a <literal>Buffer</literal> object,
5224+
otherwise as a string.
5225+
</tag-desc>
5226+
52115227
<tag-name id="fs_readsync"><literal>readSync(<value>fd</value>,
52125228
<value>buffer</value>, <value>offset</value>[,
52135229
<value>length</value>[, <value>position</value>]])</literal></tag-name>

0 commit comments

Comments
 (0)