Skip to content

Commit

Permalink
doc: remove unnecessary module format comments
Browse files Browse the repository at this point in the history
Now that the docs have toggles for CJS vs. ESM, there is no need to
include a comment explaining which module type is being used.

PR-URL: #39219
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
  • Loading branch information
Trott authored and targos committed Jul 11, 2021
1 parent ab9ccd0 commit db74a35
Showing 1 changed file with 0 additions and 12 deletions.
12 changes: 0 additions & 12 deletions doc/api/fs.md
Expand Up @@ -14,24 +14,20 @@ way modeled on standard POSIX functions.
To use the promise-based APIs:

```mjs
// Using ESM Module syntax:
import * as fs from 'fs/promises';
```

```cjs
// Using CommonJS syntax:
const fs = require('fs/promises');
```

To use the callback and sync APIs:

```mjs
// Using ESM Module syntax:
import * as fs from 'fs';
```

```cjs
// Using CommonJS syntax:
const fs = require('fs');
```

Expand All @@ -44,7 +40,6 @@ Promise-based operations return a promise that is fulfilled when the
asynchronous operation is complete.

```mjs
// Using ESM Module syntax:
import { unlink } from 'fs/promises';

try {
Expand All @@ -56,7 +51,6 @@ try {
```

```cjs
// Using CommonJS syntax
const { unlink } = require('fs/promises');

(async function(path) {
Expand All @@ -78,7 +72,6 @@ reserved for an exception. If the operation is completed successfully, then
the first argument is `null` or `undefined`.

```mjs
// Using ESM syntax
import { unlink } from 'fs';

unlink('/tmp/hello', (err) => {
Expand All @@ -88,7 +81,6 @@ unlink('/tmp/hello', (err) => {
```

```cjs
// Using CommonJS syntax
const { unlink } = require('fs');

unlink('/tmp/hello', (err) => {
Expand All @@ -108,7 +100,6 @@ execution until the operation is complete. Exceptions are thrown immediately
and can be handled using `try…catch`, or can be allowed to bubble up.

```mjs
// Using ESM syntax
import { unlinkSync } from 'fs';

try {
Expand All @@ -120,7 +111,6 @@ try {
```

```cjs
// Using CommonJS syntax
const { unlinkSync } = require('fs');

try {
Expand Down Expand Up @@ -6316,7 +6306,6 @@ It is important to correctly order the operations by awaiting the results
of one before invoking the other:
```mjs
// Using ESM syntax
import { rename, stat } from 'fs/promises';

const from = '/tmp/hello';
Expand All @@ -6332,7 +6321,6 @@ try {
```
```cjs
// Using CommonJS syntax
const { rename, stat } = require('fs/promises');

(async function(from, to) {
Expand Down

0 comments on commit db74a35

Please sign in to comment.