Node.js v21.7.2 文档

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 上抛出异常。