Node.js v18.18.2 文档

querystring.decode()#

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

querystring.encode()#

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

querystring.escape(str)#

• str <字符串>

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

querystring.escape()方法由querystring.stringify()使用，通常不应该直接使用。导出它主要是为了允许应用程序代码在必要时通过将querystring.escape分配给替代函数来提供替换百分比编码实现。

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

• str <string>要解析的 URL 查询字符串
• sep <string>用于分隔查询字符串中的键和值对的子字符串。默认值： '&'。
• eq <字符串>。用于分隔查询字符串中的键和值的子字符串。默认值： '='。
• options <对象>
  • 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 <字符串> . 用于分隔查询字符串中的键和值的子字符串。默认值： '='。
• options
  • encodeURIComponent <Function>将 URL 不安全字符转换为查询字符串中的百分比编码时使用的函数。默认值： querystring.escape()。

querystring.stringify()方法通过迭代对象的“自己的属性”，从给定的obj生成 URL 查询字符串。

它序列化在obj中传递的以下类型的值： <string> | <数字> | <bigint> | <布尔值> | <字符串[]> | <数字[]> | <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 <字符串>

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

querystring.unescape()方法由querystring.parse()使用，通常不应该直接使用。导出它主要是为了允许应用程序代码在必要时通过将querystring.unescape分配给替代函数来提供替代解码实现。

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