Node.js v25.0.0 文档

querystring.decode()#

querystring.decode() 函数是 querystring.parse() 的别名。

querystring.encode()#

querystring.encode() 函数是 querystring.stringify() 的别名。

querystring.escape(str)#

• str <string>

querystring.escape() 方法对给定的 str 执行 URL 百分号编码，其方式针对 URL 查询字符串的特定要求进行了优化。

querystring.escape() 方法由 querystring.stringify() 使用，通常不应直接使用。导出它的主要目的是允许应用程序代码在必要时提供一个替换的百分号编码实现，方法是将 querystring.escape 赋值给一个替代函数。

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

• str <string> 要解析的 URL 查询字符串
• sep <string> 用于在查询字符串中分隔键值对的子字符串。默认值： '&'。
• eq <string> 用于在查询字符串中分隔键和值的子字符串。默认值： '='。
• options <Object>
  • decodeURIComponent <Function> 在解码查询字符串中经过百分号编码的字符时使用的函数。默认值： querystring.unescape()。
  • maxKeys <number> 指定要解析的最大键数。指定 0 可移除键计数限制。默认值： 1000。

querystring.parse() 方法将 URL 查询字符串 (str) 解析为键值对的集合。

例如，查询字符串 'foo=bar&abc=xyz&abc=123' 被解析为：

{
  "foo": "bar",
  "abc": ["xyz", "123"]
} copy

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 }); copy

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

• obj <Object> 要序列化为 URL 查询字符串的对象
• sep <string> 用于在查询字符串中分隔键值对的子字符串。默认值： '&'。
• eq <string> 用于在查询字符串中分隔键和值的子字符串。默认值： '='。
• options
  • encodeURIComponent <Function> 在查询字符串中将 URL 不安全字符转换为百分号编码时使用的函数。默认值： querystring.escape()。

querystring.stringify() 方法通过迭代给定 obj 的“自有属性”来生成一个 URL 查询字符串。

它会序列化 obj 中传入的以下类型的值：<string> | <number> | <bigint> | <boolean> | <string[]> | <number[]> | <bigint[]> | <boolean[]>。数值必须是有限的。任何其他输入值都将被强制转换为空字符串。

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' copy

默认情况下，查询字符串中需要进行百分号编码的字符将被编码为 UTF-8。如果需要其他编码，则需要指定一个替代的 encodeURIComponent 选项：

// Assuming gbkEncodeURIComponent function already exists,

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

querystring.unescape(str)#

• str <string>

querystring.unescape() 方法对给定的 str 执行 URL 百分号编码字符的解码。

querystring.unescape() 方法由 querystring.parse() 使用，通常不应直接使用。导出它的主要目的是允许应用程序代码在必要时提供一个替换的解码实现，方法是将 querystring.unescape 赋值给一个替代函数。

默认情况下，querystring.unescape() 方法会尝试使用 JavaScript 内置的 decodeURIComponent() 方法进行解码。如果解码失败，它将使用一个更安全的等效方法，该方法不会因格式错误的 URL 而抛出错误。