# HG changeset patch # User Yaroslav Zhuravlev # Date 1597145732 -3600 # Node ID cd97adddd757b8080c29c2027d9f079f103698b9 # Parent e162a71453b0dfae9a4010cd84a1ab539cc584fe Documented Query String in njs Reference. diff --git a/xml/en/docs/njs/reference.xml b/xml/en/docs/njs/reference.xml --- a/xml/en/docs/njs/reference.xml +++ b/xml/en/docs/njs/reference.xml @@ -9,7 +9,7 @@
+ rev="52">
@@ -1254,6 +1254,182 @@ but fails if the file already exists
+ +
+ + +The Query String module provides support +for parsing and formatting URL query strings +(0.4.3). +The Query String module object is returned by +require('querystring'). + + + + + +querystring.decode() + +is an alias for +querystring.parse(). + + +querystring.encode() + +is an alias for +querystring.stringify(). + + +querystring.escape(string) + + +Performs URL encoding of the given string, +returns an escaped query string. +The method is used by +querystring.stringify() +and should not be used directly. + + + +querystring.parse(string[, +separator[, +equal[, +options]]]) + + +Parses the query string URL and returns an object. + + + +The separator parameter is a substring +for delimiting key and value pairs in the query string, +by default is “&”. + + + +The equal parameter is a substring +for delimiting keys and values in the query string, +by default is “=”. + + + +The options parameter is expected to be +an object with the following keys: + +decodeURIComponent +function + +Function used +to decode percent-encoded characters in the query string, +by default is +querystring.unescape() + + +maxKeys +number + +the maximum number of keys to parse, +by default is 1000. +The 0 value removes limitations for counting keys. + + + +By default, percent-encoded characters within the query string are assumed +to use the UTF-8 encoding, +invalid UTF-8 sequences will be replaced with +the U+FFFD replacement character. + + + +For example, for the following query string + +'foo=bar&abc=xyz&abc=123' + +the output will be: + +{ + foo: 'bar', + abc: ['xyz', '123'] +} + + + + + +querystring.stringify(object[, +separator[, +equal[, +options]]]) + + +Serializes an object and returns a URL query string. + + + +The separator parameter is a substring +for delimiting key and value pairs in the query string, +by default is “&”. + + + +The equal parameter is a substring +for delimiting keys and values in the query string, +by default is “=”. + + + +The options parameter is expected to be +an object with the following keys: + +encodeURIComponent +function + +The function to use when converting +URL-unsafe characters to percent-encoding in the query string, +by default is +querystring.escape(). + + + + + + +By default, characters that require percent-encoding within the query string +are encoded as UTF-8. +If other encoding is required, then +encodeURIComponent option should be specified. + + + +For example, for the following command + +querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' }); + +the query string will be: + +'foo=bar&baz=qux&baz=quux&123=' + + + + + +querystring.unescape(string) + + +Performs decoding of URL percent-encoded characters +of the string, +returns an unescaped query string. +The method is used by +querystring.parse() +and should not be used directly. + + + + + + +
+
diff --git a/xml/ru/docs/njs/reference.xml b/xml/ru/docs/njs/reference.xml --- a/xml/ru/docs/njs/reference.xml +++ b/xml/ru/docs/njs/reference.xml @@ -9,7 +9,7 @@
+ rev="52">
@@ -1257,6 +1257,182 @@ FIFO-канал.
+ +
+ + +Модуль Query String предоставляет поддержку +синтаксического разбора и форматирования строки запроса URL. +(0.4.3). +Объект модуля Query String доступен через +require('querystring'). + + + + + +querystring.decode() + +является псевдонимом для +querystring.parse(). + + +querystring.encode() + +является псевдонимом для +querystring.stringify(). + + +querystring.escape(строка) + + +Кодирует заданную строку, +возвращает экранированную строку. +Метод используется методом +querystring.stringify() +и не должен использоваться напрямую. + + + +querystring.parse(строка[, +separator[, +equal[, +options]]]) + + +Осуществляет синтаксический разбор строки запроса и возвращает объект. + + + +Параметр separator является подстрокой, +разделяющей в строке запроса пары ключей и значений, +по умолчанию “&”. + + + +Параметр equal является подстрокой, +разделяющей в строке запроса ключи и значения, +по умолчанию “=”. + + + +Параметр options должен быть +объектом со следующими ключами: + +decodeURIComponent +функция + +Функция, используемая +при декодировании процентно-кодированных символов в строке запроса, +по умолчанию +querystring.unescape() + + +maxKeys +число + +максимальное число ключей для синтаксического разбора, +по умолчанию 1000. +Значение 0 удаляет ограничение на подсчёт ключей. + + + +По умолчанию предполагается, что процентно-кодированные символы в строке запроса +используют кодировку UTF-8, +неверная последовательность байтов UTF-8 будет заменена на +U+FFFD. + + + +Пример для строки запроса: + +'foo=bar&abc=xyz&abc=123' + +результат: + +{ + foo: 'bar', + abc: ['xyz', '123'] +} + + + + + +querystring.stringify(object[, +separator[, +equal[, +options]]]) + + +Осуществляет синтаксический разбор объекта и возвращает строку запроса. + + + +Параметр separator является подстрокой, +разделяющей в строке запроса пары ключей и значений, +по умолчанию “&”. + + + +Параметр equal является подстрокой, +разделяющей в строке запроса ключи и значения, +по умолчанию “=”. + + + +Параметр options должен быть +объектом со следующими ключами: + +encodeURIComponent +функция + +Функция, используемая при декодировании +URL-небезопасных символов в в процентно-кодированные символы в строке запроса, +по умолчанию +querystring.escape(). + + + + + + +По умолчанию символы, требующие процентной кодировки внутри строки запроса, +кодируются в UTF-8. +Если требуется другая кодировка, то +необходимо указать опцию encodeURIComponent. + + + +Пример: + +querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], 123: '' }); + +результат: + +'foo=bar&baz=qux&baz=quux&123=' + + + + + +querystring.unescape(строка) + + +Осуществляет декодирование процентно-кодированных символов URL +в строке, +возвращает неэкранированную строку запроса. +Метод используется методом +querystring.parse() +и не должен использоваться напрямую. + + + + + + +
+