url.format(URL[, options])

• URL <URL> 一个 WHATWG URL 对象

  ¥URL <URL> A WHATWG URL object

• options <Object>

  • auth <boolean> 如果序列化 URL 字符串应包含用户名和密码，则为 true，否则为 false。默认值：true。

    ¥auth <boolean> true if the serialized URL string should include the username and password, false otherwise. Default: true.

  • fragment <boolean> 如果序列化 URL 字符串应包含片段，则为 true，否则为 false。默认值：true。

    ¥fragment <boolean> true if the serialized URL string should include the fragment, false otherwise. Default: true.

  • search <boolean> 如果序列化 URL 字符串应包含搜索查询，则为 true，否则为 false。默认值：true。

    ¥search <boolean> true if the serialized URL string should include the search query, false otherwise. Default: true.

  • unicode <boolean> true 如果 URL 字符串的主机组件中出现的 Unicode 字符应直接编码，而不是 Punycode 编码。默认值：false。

    ¥unicode <boolean> true if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to being Punycode encoded. Default: false.

• 返回：<string>

  ¥Returns: <string>

返回 WHATWG URL 对象的 URL String 表示的可自定义序列化。

¥Returns a customizable serialization of a URL String representation of a WHATWG URL object.

网址对象具有 toString() 方法和 href 属性，用于返回网址的字符串序列化。但是，这些都不能以任何方式自定义。url.format(URL[, options]) 方法允许对输出进行基本的自定义。

¥The URL object has both a toString() method and href property that return string serializations of the URL. These are not, however, customizable in any way. The url.format(URL[, options]) method allows for basic customization of the output.

import url from 'node:url';
const myURL = new URL('https://a:b@測試?abc#foo');

console.log(myURL.href);
// Prints https://a:b@xn--g6w251d/?abc#foo

console.log(myURL.toString());
// Prints https://a:b@xn--g6w251d/?abc#foo

console.log(url.format(myURL, { fragment: false, unicode: true, auth: false }));
// Prints 'https://測試/?abc'const url = require('node:url');
const myURL = new URL('https://a:b@測試?abc#foo');

console.log(myURL.href);
// Prints https://a:b@xn--g6w251d/?abc#foo

console.log(myURL.toString());
// Prints https://a:b@xn--g6w251d/?abc#foo

console.log(url.format(myURL, { fragment: false, unicode: true, auth: false }));
// Prints 'https://測試/?abc'拷贝