Mercurial > hg > nginx-site
comparison xml/ru/docs/njs/reference.xml @ 2604:a29676472a11
Added Buffer object info to some njs methods.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 30 Sep 2020 22:12:05 +0100 |
parents | 90b32c2c0155 |
children | 0ec1e1b063d7 |
comparison
equal
deleted
inserted
replaced
2603:94ebfbcd68bb | 2604:a29676472a11 |
---|---|
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> | 7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> |
8 | 8 |
9 <article name="Справочник" | 9 <article name="Справочник" |
10 link="/ru/docs/njs/reference.html" | 10 link="/ru/docs/njs/reference.html" |
11 lang="ru" | 11 lang="ru" |
12 rev="54"> | 12 rev="55"> |
13 | 13 |
14 <section id="summary"> | 14 <section id="summary"> |
15 | 15 |
16 <para> | 16 <para> |
17 <link doc="index.xml">njs</link> предоставляет объекты, методы и свойства | 17 <link doc="index.xml">njs</link> предоставляет объекты, методы и свойства |
923 <literal>hash.update()</literal>. | 923 <literal>hash.update()</literal>. |
924 Кодировка может быть | 924 Кодировка может быть |
925 <literal>hex</literal>, | 925 <literal>hex</literal>, |
926 <literal>base64</literal> и | 926 <literal>base64</literal> и |
927 <literal>base64url</literal>. | 927 <literal>base64url</literal>. |
928 Если кодировка не указана, то будет возвращена байтовая строка. | 928 Если кодировка не указана, то будет возвращен объект буфера |
929 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>). | |
930 <note> | |
931 До версии <link doc="changes.xml" id="njs0.4.4">0.4.4</link> | |
932 вместо объекта буфера возвращалась байтовая строка. | |
933 </note> | |
929 </tag-desc> | 934 </tag-desc> |
930 | 935 |
931 </list> | 936 </list> |
932 </para> | 937 </para> |
933 | 938 |
1033 <tag-name id="fs_appendfilesync"><literal>appendFileSync(<value>имяФайла</value>, | 1038 <tag-name id="fs_appendfilesync"><literal>appendFileSync(<value>имяФайла</value>, |
1034 <value>данные</value>[, <value>options</value>])</literal></tag-name> | 1039 <value>данные</value>[, <value>options</value>])</literal></tag-name> |
1035 <tag-desc> | 1040 <tag-desc> |
1036 Синхронно добавляет указанные <literal>данные</literal> | 1041 Синхронно добавляет указанные <literal>данные</literal> |
1037 в файл с указанным <literal>именем</literal>. | 1042 в файл с указанным <literal>именем</literal>. |
1043 <literal>Данными</literal> могут быть строка | |
1044 или объект буфера (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>. | |
1038 Если файл не существует, то он будет создан. | 1045 Если файл не существует, то он будет создан. |
1039 Параметр <literal>options</literal> должен быть | 1046 Параметр <literal>options</literal> должен быть |
1040 объектом со следующими ключами: | 1047 объектом со следующими ключами: |
1041 <list type="tag"> | 1048 <list type="tag"> |
1042 | 1049 |
1084 или объектом с ключами: | 1091 или объектом с ключами: |
1085 <list type="tag"> | 1092 <list type="tag"> |
1086 | 1093 |
1087 <tag-name id="fs_readdirsync_encoding"><literal>кодировка</literal></tag-name> | 1094 <tag-name id="fs_readdirsync_encoding"><literal>кодировка</literal></tag-name> |
1088 <tag-desc> | 1095 <tag-desc> |
1089 кодировка, по умолчанию не указана. | 1096 кодировка, по умолчанию <literal>utf8</literal>. |
1090 Кодировка может быть <literal>utf8</literal>. | 1097 Кодировка может быть <literal>utf8</literal> и <literal>буфер</literal> |
1098 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>). | |
1091 </tag-desc> | 1099 </tag-desc> |
1092 | 1100 |
1093 <tag-name id="fs_readdirsync_withfiletypes"><literal>withFileTypes</literal></tag-name> | 1101 <tag-name id="fs_readdirsync_withfiletypes"><literal>withFileTypes</literal></tag-name> |
1094 <tag-desc> | 1102 <tag-desc> |
1095 если <literal>true</literal>, то массив файлов будет содержать | 1103 если <literal>true</literal>, то массив файлов будет содержать |
1105 <tag-desc> | 1113 <tag-desc> |
1106 Синхронно возвращает содержимое файла | 1114 Синхронно возвращает содержимое файла |
1107 с указанным <literal>именем</literal>. | 1115 с указанным <literal>именем</literal>. |
1108 Параметр <literal>options</literal> хранит | 1116 Параметр <literal>options</literal> хранит |
1109 <literal>строку</literal>, которая задаёт кодировку. | 1117 <literal>строку</literal>, которая задаёт кодировку. |
1110 Если кодировка не указана, | 1118 Если кодировка указана, то будет возвращена строка, |
1111 то будет возвращена <link id="string_tobytes">байтовая строка</link>. | 1119 иначе будет возвращён объект буфера |
1112 Если указана кодировка <literal>utf8</literal>, | 1120 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>). |
1113 то будет возвращена строка Unicode. | 1121 <note> |
1122 До версии <link doc="changes.xml" id="njs0.4.4">0.4.4</link> | |
1123 возвращалась <link id="string_tobytes">байтовая строка</link> | |
1124 в случае, если не была указана кодировка. | |
1125 </note> | |
1114 Иначе ожидается, что <literal>options</literal> является | 1126 Иначе ожидается, что <literal>options</literal> является |
1115 объектом с ключами: | 1127 объектом с ключами: |
1116 <list type="tag"> | 1128 <list type="tag"> |
1117 | 1129 |
1118 <tag-name><literal>кодировка</literal></tag-name> | 1130 <tag-name><literal>кодировка</literal></tag-name> |
1119 <tag-desc> | 1131 <tag-desc> |
1120 кодировка, по умолчанию не указана. | 1132 кодировка, по умолчанию не указана. |
1121 Кодировка может быть <literal>utf8</literal> | 1133 Кодировка может быть <literal>utf8</literal>, |
1134 <literal>hex</literal> | |
1135 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>), | |
1136 <literal>base64</literal> | |
1137 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>), | |
1138 <literal>base64url</literal> | |
1139 (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>). | |
1122 </tag-desc> | 1140 </tag-desc> |
1123 | 1141 |
1124 <tag-name><literal>флаг</literal></tag-name> | 1142 <tag-name><literal>флаг</literal></tag-name> |
1125 <tag-desc> | 1143 <tag-desc> |
1126 <link id="njs_api_fs_flags">флаг</link> файловой системы, | 1144 <link id="njs_api_fs_flags">флаг</link> файловой системы, |
1131 <example> | 1149 <example> |
1132 >> var fs = require('fs') | 1150 >> var fs = require('fs') |
1133 undefined | 1151 undefined |
1134 >> var file = fs.readFileSync('/file/path.tar.gz') | 1152 >> var file = fs.readFileSync('/file/path.tar.gz') |
1135 undefined | 1153 undefined |
1136 >> var gzipped = /^\x1f\x8b/.test(file); gzipped | 1154 >> var gzipped = file.slice(0,2).toString('hex') === '1f8b'; gzipped |
1137 true | 1155 true |
1138 </example> | 1156 </example> |
1139 </tag-desc> | 1157 </tag-desc> |
1140 | 1158 |
1141 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>путь</value>[, | 1159 <tag-name id="fs_realpathsync"><literal>realpathSync(<value>путь</value>[, |
1189 <value>данные</value>[, | 1207 <value>данные</value>[, |
1190 <value>options</value>])</literal></tag-name> | 1208 <value>options</value>])</literal></tag-name> |
1191 <tag-desc> | 1209 <tag-desc> |
1192 Синхронно записывает <literal>данные</literal> в файл | 1210 Синхронно записывает <literal>данные</literal> в файл |
1193 с указанным <literal>именем</literal>. | 1211 с указанным <literal>именем</literal>. |
1212 <literal>Данными</literal> могут быть строка | |
1213 или объект буфера (<link doc="changes.xml" id="njs0.4.4">0.4.4</link>. | |
1194 Если файл не существует, то он будет создан. | 1214 Если файл не существует, то он будет создан. |
1195 Если файл существует, то он будет заменён. | 1215 Если файл существует, то он будет заменён. |
1196 Параметр <literal>options</literal> должен быть | 1216 Параметр <literal>options</literal> должен быть |
1197 объектом с ключами: | 1217 объектом с ключами: |
1198 <list type="tag"> | 1218 <list type="tag"> |