Skip to content

Commit 18c6d17

Browse files
bnbtargos
authored andcommitted
doc: add fspromises mkdir example
Signed-off-by: Tierney Cyren <[email protected]> PR-URL: #40843 Reviewed-By: Adrian Estrada <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent a544a09 commit 18c6d17

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

doc/api/fs.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -982,6 +982,34 @@ property indicating whether parent directories should be created. Calling
982982
`fsPromises.mkdir()` when `path` is a directory that exists results in a
983983
rejection only when `recursive` is false.
984984
985+
```mjs
986+
import { mkdir } from 'node:fs/promises';
987+
988+
try {
989+
const projectFolder = new URL('./test/project/', import.meta.url);
990+
const createDir = await mkdir(path, { recursive: true });
991+
992+
console.log(`created ${createDir}`);
993+
} catch (err) {
994+
console.error(err.message);
995+
}
996+
```
997+
998+
```cjs
999+
const { mkdir } = require('node:fs/promises');
1000+
const { resolve, join } = require('node:path');
1001+
1002+
async function makeDirectory() {
1003+
const projectFolder = join(__dirname, 'test', 'project');
1004+
const dirCreation = await mkdir(projectFolder, { recursive: true });
1005+
1006+
console.log(dirCreation);
1007+
return dirCreation;
1008+
}
1009+
1010+
makeDirectory().catch(console.error);
1011+
```
1012+
9851013
### `fsPromises.mkdtemp(prefix[, options])`
9861014
9871015
<!-- YAML

0 commit comments

Comments
 (0)