Строка запроса

Модуль querystring предоставляет утилиты для разбора и форматирования строк запроса URL. К нему можно получить доступ, используя:

const querystring = require('querystring');

querystring.escape(str)

• str <строка>

Метод querystring.escape() выполняет кодирование процентов URL для заданной str способом, оптимизированным для конкретных требований строк запроса URL.

Метод querystring.escape() используется querystring.stringify() и, как правило, не должен использоваться напрямую. Он экспортируется в основном для того, чтобы код приложения мог предоставить альтернативную реализацию кодирования процентов, если необходимо, присвоив querystring.escape альтернативной функции.

querystring.parse(str[, sep[, eq[, options]]])

• str <строка> Строка запроса URL для разбора
• sep <строка> Подстрока, используемая для разграничения пар ключ-значение в строке запроса. По умолчанию '&'.
• eq <строка>. Подстрока, используемая для разграничения ключей и значений в строке запроса. По умолчанию '='.
• options <Объект>
  • decodeURIComponent <Функция> Функция, используемая при декодировании процентов, закодированных в строке запроса. По умолчанию querystring.unescape().
  • maxKeys <число> Указывает максимальное количество ключей для разбора. По умолчанию 1000. Укажите 0 для удаления ограничений подсчета ключей.

Метод querystring.parse() разбирает строку запроса URL (str) в набор пар ключ-значение.

Например, строка запроса 'foo=bar&abc=xyz&abc=123' разбирается в:

{
  foo: 'bar',
  abc: ['xyz', '123']
}

Примечание: Объект, возвращаемый методом querystring.parse() , не прототипически расширяется от JavaScript Object. Это означает, что типичные методы Object , такие как obj.toString(), obj.hasOwnProperty(), и другие, не определены и не будут работать.

По умолчанию для процентов, закодированных в строке запроса, будет предполагаться кодировка UTF-8. Если используется альтернативная кодировка символов, необходимо указать альтернативный параметр decodeURIComponent, как показано в следующем примере:

// Assuming gbkDecodeURIComponent function already exists...

querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
                  { decodeURIComponent: gbkDecodeURIComponent });

querystring.stringify(obj[, sep[, eq[, options]]])

• obj <Объект> Объект для сериализации в строку запроса URL
• sep <строка> Подстрока, используемая для разграничения пар ключ-значение в строке запроса. По умолчанию '&'.
• eq <строка>. Подстрока, используемая для разграничения ключей и значений в строке запроса. По умолчанию '='.
• options
  • encodeURIComponent <Функция> Функция, используемая при преобразовании небезопасных в URL символов в кодировку процентов в строке запроса. По умолчанию querystring.escape().

Метод querystring.stringify() создает строку запроса URL из заданного obj , перебирая «собственные свойства» объекта.

Он сериализует следующие типы значений, переданных в obj: <строка> | <число> | <логическое значение> | <массив строк> | <массив чисел> | <массив логических значений>. Любые другие входные значения будут преобразованы в пустые строки.

Например:

querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });
// returns 'foo=bar&baz=qux&baz=quux&corge='

querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':');
// returns 'foo:bar;baz:qux'

По умолчанию символы, требующие кодирования процентов в строке запроса, будут закодированы как UTF-8. Если требуется альтернативная кодировка, необходимо указать альтернативный параметр encodeURIComponent, как показано в следующем примере:

// Assuming gbkEncodeURIComponent function already exists,

querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
                      { encodeURIComponent: gbkEncodeURIComponent });

querystring.unescape(str)

• str <строка>

Метод querystring.unescape() выполняет декодирование символов, закодированных в процентах URL, в заданной str.

Метод querystring.unescape() используется querystring.parse() и, как правило, не должен использоваться напрямую. Он экспортируется в основном для того, чтобы код приложения мог предоставить альтернативную реализацию декодирования, если необходимо, присвоив querystring.unescape альтернативной функции.

По умолчанию метод querystring.unescape() попытается использовать встроенный в JavaScript метод decodeURIComponent() для декодирования. Если это не удастся, будет использоваться более безопасный эквивалент, который не будет выбрасывать исключение при некорректных URL.