From f54a9840c88b1640d6347f1f07e85f0673a1fb64 Mon Sep 17 00:00:00 2001 From: Tierney Cyren Date: Sun, 12 Jun 2022 04:33:29 -0500 Subject: [PATCH] doc: add fspromises mkdir example Signed-off-by: Tierney Cyren PR-URL: https://github.com/nodejs/node/pull/40843 Reviewed-By: Adrian Estrada Reviewed-By: Antoine du Hamel Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: James M Snell --- doc/api/fs.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 2f987829ccf6ec..167712f1643a8e 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1055,6 +1055,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])`