From 7dbc29ed4b3dac7481c65e60713e3cfd0b02f385 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Fri, 7 Feb 2025 15:33:06 +0100 Subject: [PATCH] doc: make MDN links to global classes more consistent MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/56924 Reviewed-By: Michaël Zasso Reviewed-By: Luigi Pinca Reviewed-By: Ulises Gascón Reviewed-By: Akhil Marsonya Reviewed-By: James M Snell --- doc/api/single-executable-applications.md | 3 +-- doc/api/url.md | 3 +-- doc/api/zlib.md | 8 ++------ 3 files changed, 4 insertions(+), 10 deletions(-) diff --git a/doc/api/single-executable-applications.md b/doc/api/single-executable-applications.md index 30ebd0fc38aaa6..27c57283a7b483 100644 --- a/doc/api/single-executable-applications.md +++ b/doc/api/single-executable-applications.md @@ -322,7 +322,7 @@ added: - v20.12.0 --> -Similar to [`sea.getAsset()`][], but returns the result in a [`Blob`][]. +Similar to [`sea.getAsset()`][], but returns the result in a {Blob}. An error is thrown when no matching asset can be found. * `key` {string} the key for the asset in the dictionary specified by the @@ -423,7 +423,6 @@ to help us document them. [Mach-O]: https://en.wikipedia.org/wiki/Mach-O [PE]: https://en.wikipedia.org/wiki/Portable_Executable [Windows SDK]: https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/ -[`Blob`]: https://developer.mozilla.org/en-US/docs/Web/API/Blob [`process.execPath`]: process.md#processexecpath [`require()`]: modules.md#requireid [`require.main`]: modules.md#accessing-the-main-module diff --git a/doc/api/url.md b/doc/api/url.md index 5ef961a5e79fd1..116e5dea1d8c99 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -956,7 +956,7 @@ added: * `iterable` {Iterable} An iterable object whose elements are key-value pairs Instantiate a new `URLSearchParams` object with an iterable map in a way that -is similar to [`Map`][]'s constructor. `iterable` can be an `Array` or any +is similar to {Map}'s constructor. `iterable` can be an `Array` or any iterable object. That means `iterable` can be another `URLSearchParams`, in which case the constructor will simply create a clone of the provided `URLSearchParams`. Elements of `iterable` are key-value pairs, and can @@ -1951,7 +1951,6 @@ console.log(myURL.origin); [WHATWG URL Standard]: https://url.spec.whatwg.org/ [`Error`]: errors.md#class-error [`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify -[`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map [`TypeError`]: errors.md#class-typeerror [`URLSearchParams`]: #class-urlsearchparams [`array.toString()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toString diff --git a/doc/api/zlib.md b/doc/api/zlib.md index a12e9c3fc680f0..bdce9a81d3034f 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -1139,8 +1139,8 @@ Creates and returns a new [`Unzip`][] object. -All of these take a [`Buffer`][], [`TypedArray`][], [`DataView`][], -[`ArrayBuffer`][] or string as the first argument, an optional second argument +All of these take a {Buffer}, {TypedArray}, {DataView}, {ArrayBuffer}, or string +as the first argument, an optional second argument to supply options to the `zlib` classes and will call the supplied callback with `callback(error, result)`. @@ -1488,19 +1488,15 @@ Decompress a chunk of data with [`Unzip`][]. [Streams API]: stream.md [`.flush()`]: #zlibflushkind-callback [`Accept-Encoding`]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 -[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer [`BrotliCompress`]: #class-zlibbrotlicompress [`BrotliDecompress`]: #class-zlibbrotlidecompress -[`Buffer`]: buffer.md#class-buffer [`Content-Encoding`]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 -[`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView [`DeflateRaw`]: #class-zlibdeflateraw [`Deflate`]: #class-zlibdeflate [`Gunzip`]: #class-zlibgunzip [`Gzip`]: #class-zlibgzip [`InflateRaw`]: #class-zlibinflateraw [`Inflate`]: #class-zlibinflate -[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray [`Unzip`]: #class-zlibunzip [`buffer.kMaxLength`]: buffer.md#bufferkmaxlength [`deflateInit2` and `inflateInit2`]: https://zlib.net/manual.html#Advanced