rahad-all-downloader 2.1.16 → 2.1.18

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