Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add fspromises mkdir example #40843

Merged
merged 8 commits into from
Jun 12, 2022
Merged
30 changes: 29 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1007,6 +1007,34 @@ property indicating whether parent directories should be created. Calling
`fsPromises.mkdir()` when `path` is a directory that exists results in a
rejection only when `recursive` is false.

```mjs
import { mkdir } from 'node:fs/promises';

try {
const projectFolder = new URL('./test/project/', import.meta.url);
const createDir = await mkdir(path, { recursive: true });

console.log(`created ${createDir}`);
} catch (err) {
console.error(err.message);
}
```

```cjs
const { mkdir } = require('node:fs/promises');
const { resolve, join } = require('node:path');

async function makeDirectory() {
const projectFolder = join(__dirname, 'test', 'project');
const dirCreation = await mkdir(projectFolder, { recursive: true });

console.log(dirCreation);
return dirCreation;
}

makeDirectory().catch(console.error);
```

### `fsPromises.mkdtemp(prefix[, options])`

<!-- YAML
Expand Down Expand Up @@ -1035,7 +1063,7 @@ The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use.

```mjs
import { mkdtemp } from 'fs/promises';
import { mkdtemp } from 'node:fs/promises';

try {
await mkdtemp(path.join(os.tmpdir(), 'foo-'));
Expand Down