0d2481a0171357926f139c7f9ea0b61275d87f66683173a89ca55c2e95d282c14e6564374ac9b8521a80060c95bbb84838d77a9de42d58f46b18c5781b6b09 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972
  1. /**
  2. * The `node:url` module provides utilities for URL resolution and parsing. It can
  3. * be accessed using:
  4. *
  5. * ```js
  6. * import url from 'node:url';
  7. * ```
  8. * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/url.js)
  9. */
  10. declare module "url" {
  11. import { Blob as NodeBlob } from "node:buffer";
  12. import { ClientRequestArgs } from "node:http";
  13. import { ParsedUrlQuery, ParsedUrlQueryInput } from "node:querystring";
  14. // Input to `url.format`
  15. interface UrlObject {
  16. auth?: string | null | undefined;
  17. hash?: string | null | undefined;
  18. host?: string | null | undefined;
  19. hostname?: string | null | undefined;
  20. href?: string | null | undefined;
  21. pathname?: string | null | undefined;
  22. protocol?: string | null | undefined;
  23. search?: string | null | undefined;
  24. slashes?: boolean | null | undefined;
  25. port?: string | number | null | undefined;
  26. query?: string | null | ParsedUrlQueryInput | undefined;
  27. }
  28. // Output of `url.parse`
  29. interface Url {
  30. auth: string | null;
  31. hash: string | null;
  32. host: string | null;
  33. hostname: string | null;
  34. href: string;
  35. path: string | null;
  36. pathname: string | null;
  37. protocol: string | null;
  38. search: string | null;
  39. slashes: boolean | null;
  40. port: string | null;
  41. query: string | null | ParsedUrlQuery;
  42. }
  43. interface UrlWithParsedQuery extends Url {
  44. query: ParsedUrlQuery;
  45. }
  46. interface UrlWithStringQuery extends Url {
  47. query: string | null;
  48. }
  49. interface FileUrlToPathOptions {
  50. /**
  51. * `true` if the `path` should be return as a windows filepath, `false` for posix, and `undefined` for the system default.
  52. * @default undefined
  53. * @since v22.1.0
  54. */
  55. windows?: boolean | undefined;
  56. }
  57. interface PathToFileUrlOptions {
  58. /**
  59. * `true` if the `path` should be return as a windows filepath, `false` for posix, and `undefined` for the system default.
  60. * @default undefined
  61. * @since v22.1.0
  62. */
  63. windows?: boolean | undefined;
  64. }
  65. /**
  66. * The `url.parse()` method takes a URL string, parses it, and returns a URL
  67. * object.
  68. *
  69. * A `TypeError` is thrown if `urlString` is not a string.
  70. *
  71. * A `URIError` is thrown if the `auth` property is present but cannot be decoded.
  72. *
  73. * `url.parse()` uses a lenient, non-standard algorithm for parsing URL
  74. * strings. It is prone to security issues such as [host name spoofing](https://hackerone.com/reports/678487) and incorrect handling of usernames and passwords. Do not use with untrusted
  75. * input. CVEs are not issued for `url.parse()` vulnerabilities. Use the `WHATWG URL` API instead.
  76. * @since v0.1.25
  77. * @deprecated Use the WHATWG URL API instead.
  78. * @param urlString The URL string to parse.
  79. * @param [parseQueryString=false] If `true`, the `query` property will always be set to an object returned by the {@link querystring} module's `parse()` method. If `false`, the `query` property
  80. * on the returned URL object will be an unparsed, undecoded string.
  81. * @param [slashesDenoteHost=false] If `true`, the first token after the literal string `//` and preceding the next `/` will be interpreted as the `host`. For instance, given `//foo/bar`, the
  82. * result would be `{host: 'foo', pathname: '/bar'}` rather than `{pathname: '//foo/bar'}`.
  83. */
  84. function parse(urlString: string): UrlWithStringQuery;
  85. function parse(
  86. urlString: string,
  87. parseQueryString: false | undefined,
  88. slashesDenoteHost?: boolean,
  89. ): UrlWithStringQuery;
  90. function parse(urlString: string, parseQueryString: true, slashesDenoteHost?: boolean): UrlWithParsedQuery;
  91. function parse(urlString: string, parseQueryString: boolean, slashesDenoteHost?: boolean): Url;
  92. /**
  93. * The `url.format()` method returns a formatted URL string derived from `urlObject`.
  94. *
  95. * ```js
  96. * import url from 'node:url';
  97. * url.format({
  98. * protocol: 'https',
  99. * hostname: 'example.com',
  100. * pathname: '/some/path',
  101. * query: {
  102. * page: 1,
  103. * format: 'json',
  104. * },
  105. * });
  106. *
  107. * // => 'https://example.com/some/path?page=1&format=json'
  108. * ```
  109. *
  110. * If `urlObject` is not an object or a string, `url.format()` will throw a `TypeError`.
  111. *
  112. * The formatting process operates as follows:
  113. *
  114. * * A new empty string `result` is created.
  115. * * If `urlObject.protocol` is a string, it is appended as-is to `result`.
  116. * * Otherwise, if `urlObject.protocol` is not `undefined` and is not a string, an `Error` is thrown.
  117. * * For all string values of `urlObject.protocol` that _do not end_ with an ASCII
  118. * colon (`:`) character, the literal string `:` will be appended to `result`.
  119. * * If either of the following conditions is true, then the literal string `//` will be appended to `result`:
  120. * * `urlObject.slashes` property is true;
  121. * * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or `file`;
  122. * * If the value of the `urlObject.auth` property is truthy, and either `urlObject.host` or `urlObject.hostname` are not `undefined`, the value of `urlObject.auth` will be coerced into a string
  123. * and appended to `result` followed by the literal string `@`.
  124. * * If the `urlObject.host` property is `undefined` then:
  125. * * If the `urlObject.hostname` is a string, it is appended to `result`.
  126. * * Otherwise, if `urlObject.hostname` is not `undefined` and is not a string,
  127. * an `Error` is thrown.
  128. * * If the `urlObject.port` property value is truthy, and `urlObject.hostname` is not `undefined`:
  129. * * The literal string `:` is appended to `result`, and
  130. * * The value of `urlObject.port` is coerced to a string and appended to `result`.
  131. * * Otherwise, if the `urlObject.host` property value is truthy, the value of `urlObject.host` is coerced to a string and appended to `result`.
  132. * * If the `urlObject.pathname` property is a string that is not an empty string:
  133. * * If the `urlObject.pathname` _does not start_ with an ASCII forward slash
  134. * (`/`), then the literal string `'/'` is appended to `result`.
  135. * * The value of `urlObject.pathname` is appended to `result`.
  136. * * Otherwise, if `urlObject.pathname` is not `undefined` and is not a string, an `Error` is thrown.
  137. * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result` followed by the output of calling the
  138. * `querystring` module's `stringify()` method passing the value of `urlObject.query`.
  139. * * Otherwise, if `urlObject.search` is a string:
  140. * * If the value of `urlObject.search` _does not start_ with the ASCII question
  141. * mark (`?`) character, the literal string `?` is appended to `result`.
  142. * * The value of `urlObject.search` is appended to `result`.
  143. * * Otherwise, if `urlObject.search` is not `undefined` and is not a string, an `Error` is thrown.
  144. * * If the `urlObject.hash` property is a string:
  145. * * If the value of `urlObject.hash` _does not start_ with the ASCII hash (`#`)
  146. * character, the literal string `#` is appended to `result`.
  147. * * The value of `urlObject.hash` is appended to `result`.
  148. * * Otherwise, if the `urlObject.hash` property is not `undefined` and is not a
  149. * string, an `Error` is thrown.
  150. * * `result` is returned.
  151. * @since v0.1.25
  152. * @legacy Use the WHATWG URL API instead.
  153. * @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
  154. */
  155. function format(urlObject: URL, options?: URLFormatOptions): string;
  156. /**
  157. * The `url.format()` method returns a formatted URL string derived from `urlObject`.
  158. *
  159. * ```js
  160. * import url from 'node:url';
  161. * url.format({
  162. * protocol: 'https',
  163. * hostname: 'example.com',
  164. * pathname: '/some/path',
  165. * query: {
  166. * page: 1,
  167. * format: 'json',
  168. * },
  169. * });
  170. *
  171. * // => 'https://example.com/some/path?page=1&format=json'
  172. * ```
  173. *
  174. * If `urlObject` is not an object or a string, `url.format()` will throw a `TypeError`.
  175. *
  176. * The formatting process operates as follows:
  177. *
  178. * * A new empty string `result` is created.
  179. * * If `urlObject.protocol` is a string, it is appended as-is to `result`.
  180. * * Otherwise, if `urlObject.protocol` is not `undefined` and is not a string, an `Error` is thrown.
  181. * * For all string values of `urlObject.protocol` that _do not end_ with an ASCII
  182. * colon (`:`) character, the literal string `:` will be appended to `result`.
  183. * * If either of the following conditions is true, then the literal string `//` will be appended to `result`:
  184. * * `urlObject.slashes` property is true;
  185. * * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or `file`;
  186. * * If the value of the `urlObject.auth` property is truthy, and either `urlObject.host` or `urlObject.hostname` are not `undefined`, the value of `urlObject.auth` will be coerced into a string
  187. * and appended to `result` followed by the literal string `@`.
  188. * * If the `urlObject.host` property is `undefined` then:
  189. * * If the `urlObject.hostname` is a string, it is appended to `result`.
  190. * * Otherwise, if `urlObject.hostname` is not `undefined` and is not a string,
  191. * an `Error` is thrown.
  192. * * If the `urlObject.port` property value is truthy, and `urlObject.hostname` is not `undefined`:
  193. * * The literal string `:` is appended to `result`, and
  194. * * The value of `urlObject.port` is coerced to a string and appended to `result`.
  195. * * Otherwise, if the `urlObject.host` property value is truthy, the value of `urlObject.host` is coerced to a string and appended to `result`.
  196. * * If the `urlObject.pathname` property is a string that is not an empty string:
  197. * * If the `urlObject.pathname` _does not start_ with an ASCII forward slash
  198. * (`/`), then the literal string `'/'` is appended to `result`.
  199. * * The value of `urlObject.pathname` is appended to `result`.
  200. * * Otherwise, if `urlObject.pathname` is not `undefined` and is not a string, an `Error` is thrown.
  201. * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result` followed by the output of calling the
  202. * `querystring` module's `stringify()` method passing the value of `urlObject.query`.
  203. * * Otherwise, if `urlObject.search` is a string:
  204. * * If the value of `urlObject.search` _does not start_ with the ASCII question
  205. * mark (`?`) character, the literal string `?` is appended to `result`.
  206. * * The value of `urlObject.search` is appended to `result`.
  207. * * Otherwise, if `urlObject.search` is not `undefined` and is not a string, an `Error` is thrown.
  208. * * If the `urlObject.hash` property is a string:
  209. * * If the value of `urlObject.hash` _does not start_ with the ASCII hash (`#`)
  210. * character, the literal string `#` is appended to `result`.
  211. * * The value of `urlObject.hash` is appended to `result`.
  212. * * Otherwise, if the `urlObject.hash` property is not `undefined` and is not a
  213. * string, an `Error` is thrown.
  214. * * `result` is returned.
  215. * @since v0.1.25
  216. * @legacy Use the WHATWG URL API instead.
  217. * @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`.
  218. */
  219. function format(urlObject: UrlObject | string): string;
  220. /**
  221. * The `url.resolve()` method resolves a target URL relative to a base URL in a
  222. * manner similar to that of a web browser resolving an anchor tag.
  223. *
  224. * ```js
  225. * import url from 'node:url';
  226. * url.resolve('/one/two/three', 'four'); // '/one/two/four'
  227. * url.resolve('http://example.com/', '/one'); // 'http://example.com/one'
  228. * url.resolve('http://example.com/one', '/two'); // 'http://example.com/two'
  229. * ```
  230. *
  231. * To achieve the same result using the WHATWG URL API:
  232. *
  233. * ```js
  234. * function resolve(from, to) {
  235. * const resolvedUrl = new URL(to, new URL(from, 'resolve://'));
  236. * if (resolvedUrl.protocol === 'resolve:') {
  237. * // `from` is a relative URL.
  238. * const { pathname, search, hash } = resolvedUrl;
  239. * return pathname + search + hash;
  240. * }
  241. * return resolvedUrl.toString();
  242. * }
  243. *
  244. * resolve('/one/two/three', 'four'); // '/one/two/four'
  245. * resolve('http://example.com/', '/one'); // 'http://example.com/one'
  246. * resolve('http://example.com/one', '/two'); // 'http://example.com/two'
  247. * ```
  248. * @since v0.1.25
  249. * @legacy Use the WHATWG URL API instead.
  250. * @param from The base URL to use if `to` is a relative URL.
  251. * @param to The target URL to resolve.
  252. */
  253. function resolve(from: string, to: string): string;
  254. /**
  255. * Returns the [Punycode](https://tools.ietf.org/html/rfc5891#section-4.4) ASCII serialization of the `domain`. If `domain` is an
  256. * invalid domain, the empty string is returned.
  257. *
  258. * It performs the inverse operation to {@link domainToUnicode}.
  259. *
  260. * ```js
  261. * import url from 'node:url';
  262. *
  263. * console.log(url.domainToASCII('español.com'));
  264. * // Prints xn--espaol-zwa.com
  265. * console.log(url.domainToASCII('中文.com'));
  266. * // Prints xn--fiq228c.com
  267. * console.log(url.domainToASCII('xn--iñvalid.com'));
  268. * // Prints an empty string
  269. * ```
  270. * @since v7.4.0, v6.13.0
  271. */
  272. function domainToASCII(domain: string): string;
  273. /**
  274. * Returns the Unicode serialization of the `domain`. If `domain` is an invalid
  275. * domain, the empty string is returned.
  276. *
  277. * It performs the inverse operation to {@link domainToASCII}.
  278. *
  279. * ```js
  280. * import url from 'node:url';
  281. *
  282. * console.log(url.domainToUnicode('xn--espaol-zwa.com'));
  283. * // Prints español.com
  284. * console.log(url.domainToUnicode('xn--fiq228c.com'));
  285. * // Prints 中文.com
  286. * console.log(url.domainToUnicode('xn--iñvalid.com'));
  287. * // Prints an empty string
  288. * ```
  289. * @since v7.4.0, v6.13.0
  290. */
  291. function domainToUnicode(domain: string): string;
  292. /**
  293. * This function ensures the correct decodings of percent-encoded characters as
  294. * well as ensuring a cross-platform valid absolute path string.
  295. *
  296. * ```js
  297. * import { fileURLToPath } from 'node:url';
  298. *
  299. * const __filename = fileURLToPath(import.meta.url);
  300. *
  301. * new URL('file:///C:/path/').pathname; // Incorrect: /C:/path/
  302. * fileURLToPath('file:///C:/path/'); // Correct: C:\path\ (Windows)
  303. *
  304. * new URL('file://nas/foo.txt').pathname; // Incorrect: /foo.txt
  305. * fileURLToPath('file://nas/foo.txt'); // Correct: \\nas\foo.txt (Windows)
  306. *
  307. * new URL('file:///你好.txt').pathname; // Incorrect: /%E4%BD%A0%E5%A5%BD.txt
  308. * fileURLToPath('file:///你好.txt'); // Correct: /你好.txt (POSIX)
  309. *
  310. * new URL('file:///hello world').pathname; // Incorrect: /hello%20world
  311. * fileURLToPath('file:///hello world'); // Correct: /hello world (POSIX)
  312. * ```
  313. * @since v10.12.0
  314. * @param url The file URL string or URL object to convert to a path.
  315. * @return The fully-resolved platform-specific Node.js file path.
  316. */
  317. function fileURLToPath(url: string | URL, options?: FileUrlToPathOptions): string;
  318. /**
  319. * This function ensures that `path` is resolved absolutely, and that the URL
  320. * control characters are correctly encoded when converting into a File URL.
  321. *
  322. * ```js
  323. * import { pathToFileURL } from 'node:url';
  324. *
  325. * new URL('/foo#1', 'file:'); // Incorrect: file:///foo#1
  326. * pathToFileURL('/foo#1'); // Correct: file:///foo%231 (POSIX)
  327. *
  328. * new URL('/some/path%.c', 'file:'); // Incorrect: file:///some/path%.c
  329. * pathToFileURL('/some/path%.c'); // Correct: file:///some/path%25.c (POSIX)
  330. * ```
  331. * @since v10.12.0
  332. * @param path The path to convert to a File URL.
  333. * @return The file URL object.
  334. */
  335. function pathToFileURL(path: string, options?: PathToFileUrlOptions): URL;
  336. /**
  337. * This utility function converts a URL object into an ordinary options object as
  338. * expected by the `http.request()` and `https.request()` APIs.
  339. *
  340. * ```js
  341. * import { urlToHttpOptions } from 'node:url';
  342. * const myURL = new URL('https://a:b@測試?abc#foo');
  343. *
  344. * console.log(urlToHttpOptions(myURL));
  345. * /*
  346. * {
  347. * protocol: 'https:',
  348. * hostname: 'xn--g6w251d',
  349. * hash: '#foo',
  350. * search: '?abc',
  351. * pathname: '/',
  352. * path: '/?abc',
  353. * href: 'https://a:b@xn--g6w251d/?abc#foo',
  354. * auth: 'a:b'
  355. * }
  356. *
  357. * ```
  358. * @since v15.7.0, v14.18.0
  359. * @param url The `WHATWG URL` object to convert to an options object.
  360. * @return Options object
  361. */
  362. function urlToHttpOptions(url: URL): ClientRequestArgs;
  363. interface URLFormatOptions {
  364. /**
  365. * `true` if the serialized URL string should include the username and password, `false` otherwise.
  366. * @default true
  367. */
  368. auth?: boolean | undefined;
  369. /**
  370. * `true` if the serialized URL string should include the fragment, `false` otherwise.
  371. * @default true
  372. */
  373. fragment?: boolean | undefined;
  374. /**
  375. * `true` if the serialized URL string should include the search query, `false` otherwise.
  376. * @default true
  377. */
  378. search?: boolean | undefined;
  379. /**
  380. * `true` if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to
  381. * being Punycode encoded.
  382. * @default false
  383. */
  384. unicode?: boolean | undefined;
  385. }
  386. /**
  387. * Browser-compatible `URL` class, implemented by following the WHATWG URL
  388. * Standard. [Examples of parsed URLs](https://url.spec.whatwg.org/#example-url-parsing) may be found in the Standard itself.
  389. * The `URL` class is also available on the global object.
  390. *
  391. * In accordance with browser conventions, all properties of `URL` objects
  392. * are implemented as getters and setters on the class prototype, rather than as
  393. * data properties on the object itself. Thus, unlike `legacy urlObject`s,
  394. * using the `delete` keyword on any properties of `URL` objects (e.g. `delete myURL.protocol`, `delete myURL.pathname`, etc) has no effect but will still
  395. * return `true`.
  396. * @since v7.0.0, v6.13.0
  397. */
  398. class URL {
  399. /**
  400. * Creates a `'blob:nodedata:...'` URL string that represents the given `Blob` object and can be used to retrieve the `Blob` later.
  401. *
  402. * ```js
  403. * import {
  404. * Blob,
  405. * resolveObjectURL,
  406. * } from 'node:buffer';
  407. *
  408. * const blob = new Blob(['hello']);
  409. * const id = URL.createObjectURL(blob);
  410. *
  411. * // later...
  412. *
  413. * const otherBlob = resolveObjectURL(id);
  414. * console.log(otherBlob.size);
  415. * ```
  416. *
  417. * The data stored by the registered `Blob` will be retained in memory until `URL.revokeObjectURL()` is called to remove it.
  418. *
  419. * `Blob` objects are registered within the current thread. If using Worker
  420. * Threads, `Blob` objects registered within one Worker will not be available
  421. * to other workers or the main thread.
  422. * @since v16.7.0
  423. * @experimental
  424. */
  425. static createObjectURL(blob: NodeBlob): string;
  426. /**
  427. * Removes the stored `Blob` identified by the given ID. Attempting to revoke a
  428. * ID that isn't registered will silently fail.
  429. * @since v16.7.0
  430. * @experimental
  431. * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`.
  432. */
  433. static revokeObjectURL(id: string): void;
  434. /**
  435. * Checks if an `input` relative to the `base` can be parsed to a `URL`.
  436. *
  437. * ```js
  438. * const isValid = URL.canParse('/foo', 'https://example.org/'); // true
  439. *
  440. * const isNotValid = URL.canParse('/foo'); // false
  441. * ```
  442. * @since v19.9.0
  443. * @param input The absolute or relative input URL to parse. If `input` is relative, then `base` is required. If `input` is absolute, the `base` is ignored. If `input` is not a string, it is
  444. * `converted to a string` first.
  445. * @param base The base URL to resolve against if the `input` is not absolute. If `base` is not a string, it is `converted to a string` first.
  446. */
  447. static canParse(input: string, base?: string): boolean;
  448. /**
  449. * Parses a string as a URL. If `base` is provided, it will be used as the base URL for the purpose of resolving non-absolute `input` URLs.
  450. * Returns `null` if `input` is not a valid.
  451. * @param input The absolute or relative input URL to parse. If `input` is relative, then `base` is required. If `input` is absolute, the `base` is ignored. If `input` is not a string, it is
  452. * `converted to a string` first.
  453. * @param base The base URL to resolve against if the `input` is not absolute. If `base` is not a string, it is `converted to a string` first.
  454. * @since v22.1.0
  455. */
  456. static parse(input: string, base?: string): URL | null;
  457. constructor(input: string | { toString: () => string }, base?: string | URL);
  458. /**
  459. * Gets and sets the fragment portion of the URL.
  460. *
  461. * ```js
  462. * const myURL = new URL('https://example.org/foo#bar');
  463. * console.log(myURL.hash);
  464. * // Prints #bar
  465. *
  466. * myURL.hash = 'baz';
  467. * console.log(myURL.href);
  468. * // Prints https://example.org/foo#baz
  469. * ```
  470. *
  471. * Invalid URL characters included in the value assigned to the `hash` property
  472. * are `percent-encoded`. The selection of which characters to
  473. * percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
  474. */
  475. hash: string;
  476. /**
  477. * Gets and sets the host portion of the URL.
  478. *
  479. * ```js
  480. * const myURL = new URL('https://example.org:81/foo');
  481. * console.log(myURL.host);
  482. * // Prints example.org:81
  483. *
  484. * myURL.host = 'example.com:82';
  485. * console.log(myURL.href);
  486. * // Prints https://example.com:82/foo
  487. * ```
  488. *
  489. * Invalid host values assigned to the `host` property are ignored.
  490. */
  491. host: string;
  492. /**
  493. * Gets and sets the host name portion of the URL. The key difference between`url.host` and `url.hostname` is that `url.hostname` does _not_ include the
  494. * port.
  495. *
  496. * ```js
  497. * const myURL = new URL('https://example.org:81/foo');
  498. * console.log(myURL.hostname);
  499. * // Prints example.org
  500. *
  501. * // Setting the hostname does not change the port
  502. * myURL.hostname = 'example.com';
  503. * console.log(myURL.href);
  504. * // Prints https://example.com:81/foo
  505. *
  506. * // Use myURL.host to change the hostname and port
  507. * myURL.host = 'example.org:82';
  508. * console.log(myURL.href);
  509. * // Prints https://example.org:82/foo
  510. * ```
  511. *
  512. * Invalid host name values assigned to the `hostname` property are ignored.
  513. */
  514. hostname: string;
  515. /**
  516. * Gets and sets the serialized URL.
  517. *
  518. * ```js
  519. * const myURL = new URL('https://example.org/foo');
  520. * console.log(myURL.href);
  521. * // Prints https://example.org/foo
  522. *
  523. * myURL.href = 'https://example.com/bar';
  524. * console.log(myURL.href);
  525. * // Prints https://example.com/bar
  526. * ```
  527. *
  528. * Getting the value of the `href` property is equivalent to calling {@link toString}.
  529. *
  530. * Setting the value of this property to a new value is equivalent to creating a
  531. * new `URL` object using `new URL(value)`. Each of the `URL` object's properties will be modified.
  532. *
  533. * If the value assigned to the `href` property is not a valid URL, a `TypeError` will be thrown.
  534. */
  535. href: string;
  536. /**
  537. * Gets the read-only serialization of the URL's origin.
  538. *
  539. * ```js
  540. * const myURL = new URL('https://example.org/foo/bar?baz');
  541. * console.log(myURL.origin);
  542. * // Prints https://example.org
  543. * ```
  544. *
  545. * ```js
  546. * const idnURL = new URL('https://測試');
  547. * console.log(idnURL.origin);
  548. * // Prints https://xn--g6w251d
  549. *
  550. * console.log(idnURL.hostname);
  551. * // Prints xn--g6w251d
  552. * ```
  553. */
  554. readonly origin: string;
  555. /**
  556. * Gets and sets the password portion of the URL.
  557. *
  558. * ```js
  559. * const myURL = new URL('https://abc:xyz@example.com');
  560. * console.log(myURL.password);
  561. * // Prints xyz
  562. *
  563. * myURL.password = '123';
  564. * console.log(myURL.href);
  565. * // Prints https://abc:123@example.com/
  566. * ```
  567. *
  568. * Invalid URL characters included in the value assigned to the `password` property
  569. * are `percent-encoded`. The selection of which characters to
  570. * percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
  571. */
  572. password: string;
  573. /**
  574. * Gets and sets the path portion of the URL.
  575. *
  576. * ```js
  577. * const myURL = new URL('https://example.org/abc/xyz?123');
  578. * console.log(myURL.pathname);
  579. * // Prints /abc/xyz
  580. *
  581. * myURL.pathname = '/abcdef';
  582. * console.log(myURL.href);
  583. * // Prints https://example.org/abcdef?123
  584. * ```
  585. *
  586. * Invalid URL characters included in the value assigned to the `pathname` property are `percent-encoded`. The selection of which characters
  587. * to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
  588. */
  589. pathname: string;
  590. /**
  591. * Gets and sets the port portion of the URL.
  592. *
  593. * The port value may be a number or a string containing a number in the range `0` to `65535` (inclusive). Setting the value to the default port of the `URL` objects given `protocol` will
  594. * result in the `port` value becoming
  595. * the empty string (`''`).
  596. *
  597. * The port value can be an empty string in which case the port depends on
  598. * the protocol/scheme:
  599. *
  600. * <omitted>
  601. *
  602. * Upon assigning a value to the port, the value will first be converted to a
  603. * string using `.toString()`.
  604. *
  605. * If that string is invalid but it begins with a number, the leading number is
  606. * assigned to `port`.
  607. * If the number lies outside the range denoted above, it is ignored.
  608. *
  609. * ```js
  610. * const myURL = new URL('https://example.org:8888');
  611. * console.log(myURL.port);
  612. * // Prints 8888
  613. *
  614. * // Default ports are automatically transformed to the empty string
  615. * // (HTTPS protocol's default port is 443)
  616. * myURL.port = '443';
  617. * console.log(myURL.port);
  618. * // Prints the empty string
  619. * console.log(myURL.href);
  620. * // Prints https://example.org/
  621. *
  622. * myURL.port = 1234;
  623. * console.log(myURL.port);
  624. * // Prints 1234
  625. * console.log(myURL.href);
  626. * // Prints https://example.org:1234/
  627. *
  628. * // Completely invalid port strings are ignored
  629. * myURL.port = 'abcd';
  630. * console.log(myURL.port);
  631. * // Prints 1234
  632. *
  633. * // Leading numbers are treated as a port number
  634. * myURL.port = '5678abcd';
  635. * console.log(myURL.port);
  636. * // Prints 5678
  637. *
  638. * // Non-integers are truncated
  639. * myURL.port = 1234.5678;
  640. * console.log(myURL.port);
  641. * // Prints 1234
  642. *
  643. * // Out-of-range numbers which are not represented in scientific notation
  644. * // will be ignored.
  645. * myURL.port = 1e10; // 10000000000, will be range-checked as described below
  646. * console.log(myURL.port);
  647. * // Prints 1234
  648. * ```
  649. *
  650. * Numbers which contain a decimal point,
  651. * such as floating-point numbers or numbers in scientific notation,
  652. * are not an exception to this rule.
  653. * Leading numbers up to the decimal point will be set as the URL's port,
  654. * assuming they are valid:
  655. *
  656. * ```js
  657. * myURL.port = 4.567e21;
  658. * console.log(myURL.port);
  659. * // Prints 4 (because it is the leading number in the string '4.567e21')
  660. * ```
  661. */
  662. port: string;
  663. /**
  664. * Gets and sets the protocol portion of the URL.
  665. *
  666. * ```js
  667. * const myURL = new URL('https://example.org');
  668. * console.log(myURL.protocol);
  669. * // Prints https:
  670. *
  671. * myURL.protocol = 'ftp';
  672. * console.log(myURL.href);
  673. * // Prints ftp://example.org/
  674. * ```
  675. *
  676. * Invalid URL protocol values assigned to the `protocol` property are ignored.
  677. */
  678. protocol: string;
  679. /**
  680. * Gets and sets the serialized query portion of the URL.
  681. *
  682. * ```js
  683. * const myURL = new URL('https://example.org/abc?123');
  684. * console.log(myURL.search);
  685. * // Prints ?123
  686. *
  687. * myURL.search = 'abc=xyz';
  688. * console.log(myURL.href);
  689. * // Prints https://example.org/abc?abc=xyz
  690. * ```
  691. *
  692. * Any invalid URL characters appearing in the value assigned the `search` property will be `percent-encoded`. The selection of which
  693. * characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
  694. */
  695. search: string;
  696. /**
  697. * Gets the `URLSearchParams` object representing the query parameters of the
  698. * URL. This property is read-only but the `URLSearchParams` object it provides
  699. * can be used to mutate the URL instance; to replace the entirety of query
  700. * parameters of the URL, use the {@link search} setter. See `URLSearchParams` documentation for details.
  701. *
  702. * Use care when using `.searchParams` to modify the `URL` because,
  703. * per the WHATWG specification, the `URLSearchParams` object uses
  704. * different rules to determine which characters to percent-encode. For
  705. * instance, the `URL` object will not percent encode the ASCII tilde (`~`)
  706. * character, while `URLSearchParams` will always encode it:
  707. *
  708. * ```js
  709. * const myURL = new URL('https://example.org/abc?foo=~bar');
  710. *
  711. * console.log(myURL.search); // prints ?foo=~bar
  712. *
  713. * // Modify the URL via searchParams...
  714. * myURL.searchParams.sort();
  715. *
  716. * console.log(myURL.search); // prints ?foo=%7Ebar
  717. * ```
  718. */
  719. readonly searchParams: URLSearchParams;
  720. /**
  721. * Gets and sets the username portion of the URL.
  722. *
  723. * ```js
  724. * const myURL = new URL('https://abc:xyz@example.com');
  725. * console.log(myURL.username);
  726. * // Prints abc
  727. *
  728. * myURL.username = '123';
  729. * console.log(myURL.href);
  730. * // Prints https://123:xyz@example.com/
  731. * ```
  732. *
  733. * Any invalid URL characters appearing in the value assigned the `username` property will be `percent-encoded`. The selection of which
  734. * characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce.
  735. */
  736. username: string;
  737. /**
  738. * The `toString()` method on the `URL` object returns the serialized URL. The
  739. * value returned is equivalent to that of {@link href} and {@link toJSON}.
  740. */
  741. toString(): string;
  742. /**
  743. * The `toJSON()` method on the `URL` object returns the serialized URL. The
  744. * value returned is equivalent to that of {@link href} and {@link toString}.
  745. *
  746. * This method is automatically called when an `URL` object is serialized
  747. * with [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).
  748. *
  749. * ```js
  750. * const myURLs = [
  751. * new URL('https://www.example.com'),
  752. * new URL('https://test.example.org'),
  753. * ];
  754. * console.log(JSON.stringify(myURLs));
  755. * // Prints ["https://www.example.com/","https://test.example.org/"]
  756. * ```
  757. */
  758. toJSON(): string;
  759. }
  760. interface URLSearchParamsIterator<T> extends NodeJS.Iterator<T, NodeJS.BuiltinIteratorReturn, unknown> {
  761. [Symbol.iterator](): URLSearchParamsIterator<T>;
  762. }
  763. /**
  764. * The `URLSearchParams` API provides read and write access to the query of a `URL`. The `URLSearchParams` class can also be used standalone with one of the
  765. * four following constructors.
  766. * The `URLSearchParams` class is also available on the global object.
  767. *
  768. * The WHATWG `URLSearchParams` interface and the `querystring` module have
  769. * similar purpose, but the purpose of the `querystring` module is more
  770. * general, as it allows the customization of delimiter characters (`&#x26;` and `=`).
  771. * On the other hand, this API is designed purely for URL query strings.
  772. *
  773. * ```js
  774. * const myURL = new URL('https://example.org/?abc=123');
  775. * console.log(myURL.searchParams.get('abc'));
  776. * // Prints 123
  777. *
  778. * myURL.searchParams.append('abc', 'xyz');
  779. * console.log(myURL.href);
  780. * // Prints https://example.org/?abc=123&#x26;abc=xyz
  781. *
  782. * myURL.searchParams.delete('abc');
  783. * myURL.searchParams.set('a', 'b');
  784. * console.log(myURL.href);
  785. * // Prints https://example.org/?a=b
  786. *
  787. * const newSearchParams = new URLSearchParams(myURL.searchParams);
  788. * // The above is equivalent to
  789. * // const newSearchParams = new URLSearchParams(myURL.search);
  790. *
  791. * newSearchParams.append('a', 'c');
  792. * console.log(myURL.href);
  793. * // Prints https://example.org/?a=b
  794. * console.log(newSearchParams.toString());
  795. * // Prints a=b&#x26;a=c
  796. *
  797. * // newSearchParams.toString() is implicitly called
  798. * myURL.search = newSearchParams;
  799. * console.log(myURL.href);
  800. * // Prints https://example.org/?a=b&#x26;a=c
  801. * newSearchParams.delete('a');
  802. * console.log(myURL.href);
  803. * // Prints https://example.org/?a=b&#x26;a=c
  804. * ```
  805. * @since v7.5.0, v6.13.0
  806. */
  807. class URLSearchParams implements Iterable<[string, string]> {
  808. constructor(
  809. init?:
  810. | URLSearchParams
  811. | string
  812. | Record<string, string | readonly string[]>
  813. | Iterable<[string, string]>
  814. | ReadonlyArray<[string, string]>,
  815. );
  816. /**
  817. * Append a new name-value pair to the query string.
  818. */
  819. append(name: string, value: string): void;
  820. /**
  821. * If `value` is provided, removes all name-value pairs
  822. * where name is `name` and value is `value`.
  823. *
  824. * If `value` is not provided, removes all name-value pairs whose name is `name`.
  825. */
  826. delete(name: string, value?: string): void;
  827. /**
  828. * Returns an ES6 `Iterator` over each of the name-value pairs in the query.
  829. * Each item of the iterator is a JavaScript `Array`. The first item of the `Array` is the `name`, the second item of the `Array` is the `value`.
  830. *
  831. * Alias for `urlSearchParams[@@iterator]()`.
  832. */
  833. entries(): URLSearchParamsIterator<[string, string]>;
  834. /**
  835. * Iterates over each name-value pair in the query and invokes the given function.
  836. *
  837. * ```js
  838. * const myURL = new URL('https://example.org/?a=b&#x26;c=d');
  839. * myURL.searchParams.forEach((value, name, searchParams) => {
  840. * console.log(name, value, myURL.searchParams === searchParams);
  841. * });
  842. * // Prints:
  843. * // a b true
  844. * // c d true
  845. * ```
  846. * @param fn Invoked for each name-value pair in the query
  847. * @param thisArg To be used as `this` value for when `fn` is called
  848. */
  849. forEach<TThis = this>(
  850. fn: (this: TThis, value: string, name: string, searchParams: URLSearchParams) => void,
  851. thisArg?: TThis,
  852. ): void;
  853. /**
  854. * Returns the value of the first name-value pair whose name is `name`. If there
  855. * are no such pairs, `null` is returned.
  856. * @return or `null` if there is no name-value pair with the given `name`.
  857. */
  858. get(name: string): string | null;
  859. /**
  860. * Returns the values of all name-value pairs whose name is `name`. If there are
  861. * no such pairs, an empty array is returned.
  862. */
  863. getAll(name: string): string[];
  864. /**
  865. * Checks if the `URLSearchParams` object contains key-value pair(s) based on `name` and an optional `value` argument.
  866. *
  867. * If `value` is provided, returns `true` when name-value pair with
  868. * same `name` and `value` exists.
  869. *
  870. * If `value` is not provided, returns `true` if there is at least one name-value
  871. * pair whose name is `name`.
  872. */
  873. has(name: string, value?: string): boolean;
  874. /**
  875. * Returns an ES6 `Iterator` over the names of each name-value pair.
  876. *
  877. * ```js
  878. * const params = new URLSearchParams('foo=bar&#x26;foo=baz');
  879. * for (const name of params.keys()) {
  880. * console.log(name);
  881. * }
  882. * // Prints:
  883. * // foo
  884. * // foo
  885. * ```
  886. */
  887. keys(): URLSearchParamsIterator<string>;
  888. /**
  889. * Sets the value in the `URLSearchParams` object associated with `name` to `value`. If there are any pre-existing name-value pairs whose names are `name`,
  890. * set the first such pair's value to `value` and remove all others. If not,
  891. * append the name-value pair to the query string.
  892. *
  893. * ```js
  894. * const params = new URLSearchParams();
  895. * params.append('foo', 'bar');
  896. * params.append('foo', 'baz');
  897. * params.append('abc', 'def');
  898. * console.log(params.toString());
  899. * // Prints foo=bar&#x26;foo=baz&#x26;abc=def
  900. *
  901. * params.set('foo', 'def');
  902. * params.set('xyz', 'opq');
  903. * console.log(params.toString());
  904. * // Prints foo=def&#x26;abc=def&#x26;xyz=opq
  905. * ```
  906. */
  907. set(name: string, value: string): void;
  908. /**
  909. * The total number of parameter entries.
  910. * @since v19.8.0
  911. */
  912. readonly size: number;
  913. /**
  914. * Sort all existing name-value pairs in-place by their names. Sorting is done
  915. * with a [stable sorting algorithm](https://en.wikipedia.org/wiki/Sorting_algorithm#Stability), so relative order between name-value pairs
  916. * with the same name is preserved.
  917. *
  918. * This method can be used, in particular, to increase cache hits.
  919. *
  920. * ```js
  921. * const params = new URLSearchParams('query[]=abc&#x26;type=search&#x26;query[]=123');
  922. * params.sort();
  923. * console.log(params.toString());
  924. * // Prints query%5B%5D=abc&#x26;query%5B%5D=123&#x26;type=search
  925. * ```
  926. * @since v7.7.0, v6.13.0
  927. */
  928. sort(): void;
  929. /**
  930. * Returns the search parameters serialized as a string, with characters
  931. * percent-encoded where necessary.
  932. */
  933. toString(): string;
  934. /**
  935. * Returns an ES6 `Iterator` over the values of each name-value pair.
  936. */
  937. values(): URLSearchParamsIterator<string>;
  938. [Symbol.iterator](): URLSearchParamsIterator<[string, string]>;
  939. }
  940. import { URL as _URL, URLSearchParams as _URLSearchParams } from "url";
  941. global {
  942. interface URLSearchParams extends _URLSearchParams {}
  943. interface URL extends _URL {}
  944. interface Global {
  945. URL: typeof _URL;
  946. URLSearchParams: typeof _URLSearchParams;
  947. }
  948. /**
  949. * `URL` class is a global reference for `import { URL } from 'url'`
  950. * https://nodejs.org/api/url.html#the-whatwg-url-api
  951. * @since v10.0.0
  952. */
  953. var URL: typeof globalThis extends {
  954. onmessage: any;
  955. URL: infer T;
  956. } ? T
  957. : typeof _URL;
  958. /**
  959. * `URLSearchParams` class is a global reference for `import { URLSearchParams } from 'node:url'`
  960. * https://nodejs.org/api/url.html#class-urlsearchparams
  961. * @since v10.0.0
  962. */
  963. var URLSearchParams: typeof globalThis extends {
  964. onmessage: any;
  965. URLSearchParams: infer T;
  966. } ? T
  967. : typeof _URLSearchParams;
  968. }
  969. }
  970. declare module "node:url" {
  971. export * from "url";
  972. }