From 8bfc421a65c339b1b58eeb60a9b9d07efb0b5f02 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:27:18 +0200 Subject: [PATCH 01/34] * added warning to fs.accessSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 8bc585d3a7291a..a6b01ac655f727 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -574,6 +574,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `fs.constants.F_OK` From 2708c48eadd200c70e56bddf996c9d25f16b62eb Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:34:19 +0200 Subject: [PATCH 02/34] * Added warning to fs.appendFileSync with link for instructions about blocking calls --- doc/api/fs.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index a6b01ac655f727..a9cdb53db3fab9 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -643,6 +643,9 @@ changes: description: The `file` parameter can be a file descriptor now. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). + * `file` {string|Buffer|number} filename or file descriptor * `data` {string|Buffer} * `options` {Object|string} From 1d62048b89c9ab3c4dcaa2cf7d04d705899b2b3a Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:36:45 +0200 Subject: [PATCH 03/34] * Added warning to fs.chownSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index a9cdb53db3fab9..2d81a791a80cd6 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -724,6 +724,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). * `path` {string|Buffer|URL} * `uid` {integer} From 5e48d73049a50384a051f155466cdeaef787744d Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:37:23 +0200 Subject: [PATCH 04/34] * Added warning to fs.closeSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 2d81a791a80cd6..5781d35e010172 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -754,6 +754,8 @@ to the completion callback. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). * `fd` {integer} From b4e810a2d5adf8fc04b801e321ea0af3ff453cee Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:38:21 +0200 Subject: [PATCH 05/34] * Added warning to fs.copyFileSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 5781d35e010172..4a8e65abe33b0e 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -814,6 +814,8 @@ fs.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL, callback); +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). * `src` {string|Buffer|URL} source filename to copy * `dest` {string|Buffer|URL} destination filename of the copy operation From 5f11ddcf8eeb1f4c11ab66f482742bd2fabc2190 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:56:57 +0200 Subject: [PATCH 06/34] * Added warning to fs.fchmodSync && fs.existsSync with link for instructions about blocking calls --- doc/api/fs.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 4a8e65abe33b0e..92646d0997ea7a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -575,7 +575,7 @@ changes: protocol. Support is currently still *experimental*. --> Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `fs.constants.F_OK` @@ -644,7 +644,7 @@ changes: --> Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `file` {string|Buffer|number} filename or file descriptor * `data` {string|Buffer} @@ -725,7 +725,7 @@ changes: protocol. Support is currently still *experimental*. --> Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `uid` {integer} @@ -755,7 +755,7 @@ to the completion callback. added: v0.1.21 --> Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} @@ -815,7 +815,7 @@ fs.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL, callback); added: v8.5.0 --> Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking)). +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `src` {string|Buffer|URL} source filename to copy * `dest` {string|Buffer|URL} destination filename of the copy operation @@ -1139,6 +1139,8 @@ are given to the completion callback. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} * `mode` {integer} From d05f0862234cc00e8f8cb07b47a724cbdd12920a Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:58:07 +0200 Subject: [PATCH 07/34] * Added warning to fs.fchownSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 92646d0997ea7a..29d9e983d307c3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1170,6 +1170,8 @@ to the completion callback. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} * `uid` {integer} From cfac7b7fe4cbc525f0eb917c0af9af4dccb254c6 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 20:59:35 +0200 Subject: [PATCH 08/34] * Added warning to fs.fdataSynch with link for instructions about blocking calls --- doc/api/fs.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 29d9e983d307c3..b28f542cc32293 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1200,6 +1200,9 @@ given to the completion callback. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). + * `fd` {integer} From ff29537671697e361bb8955275f00d0289ee7726 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:00:04 +0200 Subject: [PATCH 09/34] * Added warning to fs.fstatSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index b28f542cc32293..7833531cb86034 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1231,6 +1231,8 @@ except that the file to be stat-ed is specified by the file descriptor `fd`. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} From 2a49606cf1d61003ca2ae48478729139113b536e Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:00:48 +0200 Subject: [PATCH 10/34] * Added warning to fs.fsyncSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 7833531cb86034..b7201eb418bd6f 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1259,6 +1259,8 @@ to the completion callback. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} From a5ae266f53e70b451274f402514207735c5d9c00 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:01:42 +0200 Subject: [PATCH 11/34] * Added warning to fs.ftruncateSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index b7201eb418bd6f..451de64b8dda96 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1329,6 +1329,8 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} * `len` {integer} **Default:** `0` From 602f98da25618e7f11765a2b74908fb96b409e3a Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:03:11 +0200 Subject: [PATCH 12/34] * Added warning to fs.futimesSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 451de64b8dda96..3a938e993386d6 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1372,6 +1372,8 @@ changes: description: Numeric strings, `NaN` and `Infinity` are now allowed time specifiers. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} * `atime` {integer} From 2aa9f8cdc28ca8db3cc38fc08ee1942078556f80 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:04:24 +0200 Subject: [PATCH 13/34] * Added warning to fs.lchmodSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 3a938e993386d6..6ac9e10d949d7d 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1405,6 +1405,8 @@ Only available on macOS. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer} * `mode` {integer} From df301a128000824d514ce6048195d0b9078c2bcc Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:04:56 +0200 Subject: [PATCH 14/34] * Added warning to fs.linkSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 6ac9e10d949d7d..242592b1409745 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1476,6 +1476,8 @@ changes: `URL` objects using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `existingPath` {string|Buffer|URL} * `newPath` {string|Buffer|URL} From 9a7c6a268170b7d9e28e580de183818bcf0166a0 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:05:35 +0200 Subject: [PATCH 15/34] * Added warning to fs.linkSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 242592b1409745..91eacb236667e4 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1517,6 +1517,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} From 954e3ed0fa3057a613d922d655488136b9de062a Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:06:11 +0200 Subject: [PATCH 16/34] * Added warning to fs.mkdirSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 91eacb236667e4..458e39bbc708b2 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1555,6 +1555,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `0o777` From d09e99df73b6febf59bd43a2696708fbfcf9b14d Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:07:17 +0200 Subject: [PATCH 17/34] * Added warning to fs.mkdtempSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 458e39bbc708b2..e829dd46adcc2f 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1639,6 +1639,8 @@ fs.mkdtemp(`${tmpDir}${sep}`, (err, folder) => { +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `prefix` {string} * `options` {string|Object} From 011ddb3f152bd623a0ccca8a7f7d759b7a6f696e Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:08:25 +0200 Subject: [PATCH 18/34] * Added warning to fs.openSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index e829dd46adcc2f..40af713cf50f3a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1760,6 +1760,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `flags` {string|number} From 0cdd522a1a82f718aeb1607e065f6a7902b9d4c3 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:09:08 +0200 Subject: [PATCH 19/34] * Added warning to fs.readdirSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 40af713cf50f3a..aa592a6af9cce4 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1852,6 +1852,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `options` {string|Object} From 2981dcf3a56e9ecc32c90fe55abc2ba9440e1a7b Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:09:57 +0200 Subject: [PATCH 20/34] * Added warning to fs.readFileSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index aa592a6af9cce4..9995ea1f7267e9 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1954,6 +1954,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/3163 description: The `path` parameter can be a file descriptor now. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL|integer} filename or file descriptor * `options` {Object|string} From 32e6df192a5515d5a1121274640c7925db1e1b57 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:10:47 +0200 Subject: [PATCH 21/34] * Added warning to fs.readlinkSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 9995ea1f7267e9..a4edfd3adc9ccc 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2017,6 +2017,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `options` {string|Object} From 2932f6ea8bd93ef0c4e40d0dd17e7e17ce114d4d Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:11:14 +0200 Subject: [PATCH 22/34] * Added warning to fs.readSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index a4edfd3adc9ccc..1455fe12ea93a2 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2039,6 +2039,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/4518 description: The `length` parameter can now be `0`. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `fd` {integer} * `buffer` {string|Buffer|Uint8Array} From 609346a44dbda82571bc686daddc92f59e487742 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:12:15 +0200 Subject: [PATCH 23/34] * Added warning to fs.realPathSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 1455fe12ea93a2..6d425f582a097c 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2153,6 +2153,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/3594 description: The `cache` parameter was removed. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} * `options` {string|Object} From fccdef80a2e9a90242dd716e694cbe1a784fc748 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:12:40 +0200 Subject: [PATCH 24/34] * Added warning to fs.renameSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 6d425f582a097c..2a7745dd1fd198 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2236,6 +2236,8 @@ changes: objects using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `oldPath` {string|Buffer|URL} * `newPath` {string|Buffer|URL} From b219c77097f0cbe2c69f998947cd32d764804b65 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:13:07 +0200 Subject: [PATCH 25/34] * Added warning to fs.rmdirSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 2a7745dd1fd198..a0c92a037c86b5 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2277,6 +2277,8 @@ changes: description: The `path` parameters can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} From 86dbd84fb74e15aabea1d29d521823ca82c25d02 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:13:34 +0200 Subject: [PATCH 26/34] * Added warning to fs.statSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index a0c92a037c86b5..0e3c54bcd00fb5 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2328,6 +2328,8 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer|URL} From 24421b931dfbda641dbe2fa7d1b86dfff8938130 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:14:08 +0200 Subject: [PATCH 27/34] * Added warning to fs.symlinkSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 0e3c54bcd00fb5..3e901f9c8faca7 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2377,6 +2377,8 @@ changes: using `file:` protocol. Support is currently still *experimental*. --> +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `target` {string|Buffer|URL} * `path` {string|Buffer|URL} From 9f7e313877f40d02198c2f256272fb68fad546ac Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:14:39 +0200 Subject: [PATCH 28/34] * Added warning to fs.truncateSync with link for instructions about blocking calls --- doc/api/fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 3e901f9c8faca7..403a3165c2272b 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2412,6 +2412,8 @@ being thrown in the future. +Warning: this is **blocking call**, do not use in an asynchronous environment unless +you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). * `path` {string|Buffer} * `len` {integer} **Default:** `0` From 9943cb3547b4da8e967fdcc29a8c205290c8beb4 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:24:00 +0200 Subject: [PATCH 29/34] * Refactored the note according to trott's recomendation * Added the note to more sync functions --- doc/api/fs.md | 148 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 90 insertions(+), 58 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 403a3165c2272b..eae29db84e7e45 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -574,8 +574,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `fs.constants.F_OK` @@ -642,9 +643,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/3163 description: The `file` parameter can be a file descriptor now. --> - -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `file` {string|Buffer|number} filename or file descriptor * `data` {string|Buffer} @@ -724,8 +725,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `uid` {integer} @@ -754,8 +756,9 @@ to the completion callback. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} @@ -814,8 +817,9 @@ fs.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL, callback); -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `src` {string|Buffer|URL} source filename to copy * `dest` {string|Buffer|URL} destination filename of the copy operation @@ -1139,8 +1143,9 @@ are given to the completion callback. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `mode` {integer} @@ -1170,8 +1175,9 @@ to the completion callback. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `uid` {integer} @@ -1200,9 +1206,9 @@ given to the completion callback. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). - +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} @@ -1231,8 +1237,9 @@ except that the file to be stat-ed is specified by the file descriptor `fd`. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} @@ -1259,8 +1266,9 @@ to the completion callback. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} @@ -1329,8 +1337,9 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `len` {integer} **Default:** `0` @@ -1372,8 +1381,9 @@ changes: description: Numeric strings, `NaN` and `Infinity` are now allowed time specifiers. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `atime` {integer} @@ -1405,8 +1415,9 @@ Only available on macOS. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer} * `mode` {integer} @@ -1476,8 +1487,9 @@ changes: `URL` objects using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `existingPath` {string|Buffer|URL} * `newPath` {string|Buffer|URL} @@ -1517,8 +1529,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} @@ -1555,8 +1568,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `0o777` @@ -1639,8 +1653,9 @@ fs.mkdtemp(`${tmpDir}${sep}`, (err, folder) => { -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `prefix` {string} * `options` {string|Object} @@ -1760,8 +1775,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `flags` {string|number} @@ -1852,8 +1868,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `options` {string|Object} @@ -1954,8 +1971,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/3163 description: The `path` parameter can be a file descriptor now. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL|integer} filename or file descriptor * `options` {Object|string} @@ -2017,8 +2035,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `options` {string|Object} @@ -2039,8 +2058,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/4518 description: The `length` parameter can now be `0`. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `buffer` {string|Buffer|Uint8Array} @@ -2153,8 +2173,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/3594 description: The `cache` parameter was removed. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `options` {string|Object} @@ -2236,8 +2257,9 @@ changes: objects using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `oldPath` {string|Buffer|URL} * `newPath` {string|Buffer|URL} @@ -2277,8 +2299,9 @@ changes: description: The `path` parameters can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} @@ -2328,8 +2351,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} @@ -2377,8 +2401,9 @@ changes: using `file:` protocol. Support is currently still *experimental*. --> -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `target` {string|Buffer|URL} * `path` {string|Buffer|URL} @@ -2412,8 +2437,9 @@ being thrown in the future. -Warning: this is **blocking call**, do not use in an asynchronous environment unless -you know what you are doing. More info [here](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer} * `len` {integer} **Default:** `0` @@ -2454,6 +2480,9 @@ changes: description: The `path` parameter can be a WHATWG `URL` object using `file:` protocol. Support is currently still *experimental*. --> +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} @@ -2533,6 +2562,9 @@ changes: description: Numeric strings, `NaN` and `Infinity` are now allowed time specifiers. --> +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `path` {string|Buffer|URL} * `atime` {integer} From a974d6c1a0ccceb91aeb96305d24ab8e1b73a953 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 21:27:00 +0200 Subject: [PATCH 30/34] * Added the note to more sync functions --- doc/api/fs.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index eae29db84e7e45..c2ce801b6586c7 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2910,6 +2910,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/3163 description: The `file` parameter can be a file descriptor now. --> +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `file` {string|Buffer|integer} filename or file descriptor * `data` {string|Buffer|Uint8Array} @@ -2931,6 +2934,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/7856 description: The `offset` and `length` parameters are optional now. --> +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `buffer` {Buffer|Uint8Array} @@ -2946,6 +2952,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/7856 description: The `position` parameter is optional now. --> +Note that this is a blocking call. Avoid this method in an asynchronous +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +for more information. * `fd` {integer} * `string` {string} From 30a2eb9a1436e1d0149b1f6cca4551bde75472d6 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 23:09:35 +0200 Subject: [PATCH 31/34] * Removed redundant dot after links --- doc/api/fs.md | 66 +++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index c2ce801b6586c7..14e4d6dc09fde7 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -575,7 +575,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -644,7 +644,7 @@ changes: description: The `file` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `file` {string|Buffer|number} filename or file descriptor @@ -726,7 +726,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -757,7 +757,7 @@ to the completion callback. added: v0.1.21 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -818,7 +818,7 @@ fs.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL, callback); added: v8.5.0 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `src` {string|Buffer|URL} source filename to copy @@ -1144,7 +1144,7 @@ are given to the completion callback. added: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1176,7 +1176,7 @@ to the completion callback. added: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1207,7 +1207,7 @@ given to the completion callback. added: v0.1.96 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1238,7 +1238,7 @@ except that the file to be stat-ed is specified by the file descriptor `fd`. added: v0.1.95 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1267,7 +1267,7 @@ to the completion callback. added: v0.1.96 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1338,7 +1338,7 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation. added: v0.8.6 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1382,7 +1382,7 @@ changes: time specifiers. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -1416,7 +1416,7 @@ Only available on macOS. deprecated: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer} @@ -1488,7 +1488,7 @@ changes: still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `existingPath` {string|Buffer|URL} @@ -1530,7 +1530,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -1569,7 +1569,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -1654,7 +1654,7 @@ fs.mkdtemp(`${tmpDir}${sep}`, (err, folder) => { added: v5.10.0 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `prefix` {string} @@ -1776,7 +1776,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -1869,7 +1869,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -1972,7 +1972,7 @@ changes: description: The `path` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL|integer} filename or file descriptor @@ -2036,7 +2036,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -2059,7 +2059,7 @@ changes: description: The `length` parameter can now be `0`. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -2174,7 +2174,7 @@ changes: description: The `cache` parameter was removed. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -2258,7 +2258,7 @@ changes: *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `oldPath` {string|Buffer|URL} @@ -2300,7 +2300,7 @@ changes: `file:` protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -2352,7 +2352,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -2402,7 +2402,7 @@ changes: *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `target` {string|Buffer|URL} @@ -2438,7 +2438,7 @@ being thrown in the future. added: v0.8.6 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer} @@ -2481,7 +2481,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -2563,7 +2563,7 @@ changes: time specifiers. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `path` {string|Buffer|URL} @@ -2911,7 +2911,7 @@ changes: description: The `file` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `file` {string|Buffer|integer} filename or file descriptor @@ -2935,7 +2935,7 @@ changes: description: The `offset` and `length` parameters are optional now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} @@ -2953,7 +2953,7 @@ changes: description: The `position` parameter is optional now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking). +environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) for more information. * `fd` {integer} From 3c34644e388d39bef041afa86445bc335ca488c1 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 23:15:21 +0200 Subject: [PATCH 32/34] * Changed all links of "Overview Blocking vs Non-blocking" article to 1 link and all the rest are references. --- doc/api/fs.md | 67 ++++++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 33 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 14e4d6dc09fde7..ee0d2ea5fc10c6 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -575,7 +575,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -644,7 +644,7 @@ changes: description: The `file` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `file` {string|Buffer|number} filename or file descriptor @@ -726,7 +726,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -757,7 +757,7 @@ to the completion callback. added: v0.1.21 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -818,7 +818,7 @@ fs.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL, callback); added: v8.5.0 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `src` {string|Buffer|URL} source filename to copy @@ -1144,7 +1144,7 @@ are given to the completion callback. added: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1176,7 +1176,7 @@ to the completion callback. added: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1207,7 +1207,7 @@ given to the completion callback. added: v0.1.96 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1238,7 +1238,7 @@ except that the file to be stat-ed is specified by the file descriptor `fd`. added: v0.1.95 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1267,7 +1267,7 @@ to the completion callback. added: v0.1.96 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1338,7 +1338,7 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation. added: v0.8.6 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1382,7 +1382,7 @@ changes: time specifiers. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -1416,7 +1416,7 @@ Only available on macOS. deprecated: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer} @@ -1488,7 +1488,7 @@ changes: still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `existingPath` {string|Buffer|URL} @@ -1530,7 +1530,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -1569,7 +1569,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -1654,7 +1654,7 @@ fs.mkdtemp(`${tmpDir}${sep}`, (err, folder) => { added: v5.10.0 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `prefix` {string} @@ -1776,7 +1776,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -1869,7 +1869,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -1972,7 +1972,7 @@ changes: description: The `path` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL|integer} filename or file descriptor @@ -2036,7 +2036,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -2059,7 +2059,7 @@ changes: description: The `length` parameter can now be `0`. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -2174,7 +2174,7 @@ changes: description: The `cache` parameter was removed. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -2258,7 +2258,7 @@ changes: *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `oldPath` {string|Buffer|URL} @@ -2300,7 +2300,7 @@ changes: `file:` protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -2352,7 +2352,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -2402,7 +2402,7 @@ changes: *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `target` {string|Buffer|URL} @@ -2438,7 +2438,7 @@ being thrown in the future. added: v0.8.6 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer} @@ -2481,7 +2481,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -2563,7 +2563,7 @@ changes: time specifiers. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `path` {string|Buffer|URL} @@ -2911,7 +2911,7 @@ changes: description: The `file` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `file` {string|Buffer|integer} filename or file descriptor @@ -2935,7 +2935,7 @@ changes: description: The `offset` and `length` parameters are optional now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -2953,7 +2953,7 @@ changes: description: The `position` parameter is optional now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking](https://nodejs.org/en/docs/guides/blocking-vs-non-blocking) +environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] for more information. * `fd` {integer} @@ -3236,3 +3236,4 @@ The following constants are meant for use with the [`fs.Stats`][] object's [inode]: https://en.wikipedia.org/wiki/Inode [Naming Files, Paths, and Namespaces]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx [MSDN-Using-Streams]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx +[blocking-vs-non-blocking]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/ From a0328ba05f0675a739725c1b034cbe3a50153e75 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 23:20:14 +0200 Subject: [PATCH 33/34] * Capital letters for the link ref --- doc/api/fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index ee0d2ea5fc10c6..79596639e4f1d0 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3236,4 +3236,4 @@ The following constants are meant for use with the [`fs.Stats`][] object's [inode]: https://en.wikipedia.org/wiki/Inode [Naming Files, Paths, and Namespaces]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx [MSDN-Using-Streams]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx -[blocking-vs-non-blocking]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/ +[Blocking-Vs-Non-Blocking]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/ From 0cb4b4010904800e323d120edd959df01fc72a62 Mon Sep 17 00:00:00 2001 From: Jonathan Doron Date: Wed, 6 Dec 2017 23:30:24 +0200 Subject: [PATCH 34/34] * Changed the link refs to more linting friendly to: [Overview of Blocking vs Non-Blocking][] --- doc/api/fs.md | 68 +++++++++++++++++++++++++-------------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 79596639e4f1d0..15f3167c7d559b 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -575,7 +575,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -644,7 +644,7 @@ changes: description: The `file` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `file` {string|Buffer|number} filename or file descriptor @@ -726,7 +726,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -757,7 +757,7 @@ to the completion callback. added: v0.1.21 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -818,7 +818,7 @@ fs.copyFile('source.txt', 'destination.txt', COPYFILE_EXCL, callback); added: v8.5.0 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `src` {string|Buffer|URL} source filename to copy @@ -1144,7 +1144,7 @@ are given to the completion callback. added: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1176,7 +1176,7 @@ to the completion callback. added: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1207,7 +1207,7 @@ given to the completion callback. added: v0.1.96 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1238,7 +1238,7 @@ except that the file to be stat-ed is specified by the file descriptor `fd`. added: v0.1.95 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1267,7 +1267,7 @@ to the completion callback. added: v0.1.96 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1338,7 +1338,7 @@ The last three bytes are null bytes ('\0'), to compensate the over-truncation. added: v0.8.6 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1382,7 +1382,7 @@ changes: time specifiers. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -1416,7 +1416,7 @@ Only available on macOS. deprecated: v0.4.7 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer} @@ -1488,7 +1488,7 @@ changes: still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `existingPath` {string|Buffer|URL} @@ -1530,7 +1530,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -1569,7 +1569,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -1654,7 +1654,7 @@ fs.mkdtemp(`${tmpDir}${sep}`, (err, folder) => { added: v5.10.0 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `prefix` {string} @@ -1776,7 +1776,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -1869,7 +1869,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -1972,7 +1972,7 @@ changes: description: The `path` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL|integer} filename or file descriptor @@ -2036,7 +2036,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -2059,7 +2059,7 @@ changes: description: The `length` parameter can now be `0`. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -2174,7 +2174,7 @@ changes: description: The `cache` parameter was removed. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -2258,7 +2258,7 @@ changes: *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `oldPath` {string|Buffer|URL} @@ -2300,7 +2300,7 @@ changes: `file:` protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -2352,7 +2352,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -2402,7 +2402,7 @@ changes: *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `target` {string|Buffer|URL} @@ -2438,7 +2438,7 @@ being thrown in the future. added: v0.8.6 --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer} @@ -2481,7 +2481,7 @@ changes: protocol. Support is currently still *experimental*. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -2563,7 +2563,7 @@ changes: time specifiers. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `path` {string|Buffer|URL} @@ -2911,7 +2911,7 @@ changes: description: The `file` parameter can be a file descriptor now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `file` {string|Buffer|integer} filename or file descriptor @@ -2935,7 +2935,7 @@ changes: description: The `offset` and `length` parameters are optional now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -2953,7 +2953,7 @@ changes: description: The `position` parameter is optional now. --> Note that this is a blocking call. Avoid this method in an asynchronous -environment. See [Overview of Blocking vs Non-Blocking][blocking-vs-non-blocking] +environment. See [Overview of Blocking vs Non-Blocking][] for more information. * `fd` {integer} @@ -3236,4 +3236,4 @@ The following constants are meant for use with the [`fs.Stats`][] object's [inode]: https://en.wikipedia.org/wiki/Inode [Naming Files, Paths, and Namespaces]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx [MSDN-Using-Streams]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx -[Blocking-Vs-Non-Blocking]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/ +[Overview of Blocking vs Non-Blocking]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/