fs.mkdir(path[, options], callback)

版本历史

版本	变更
v18.0.0	将无效回调传给 `callback` 参数现在会抛出 `ERR_INVALID_ARG_TYPE` 而不是 `ERR_INVALID_CALLBACK`。
v13.11.0, v12.17.0	在 `recursive` 模式下，回调现在将接收第一个创建的路径作为参数。
v10.12.0	第二个参数现在可以是具有 `recursive` 和 `mode` 属性的 `options` 对象。
v10.0.0	参数 `callback` 不再是可选的。不传入它会在运行时抛出 `TypeError`。
v7.6.0	参数 `path` 可以是使用 `file:` 协议的 WHATWG `URL` 对象。
v7.0.0	参数 `callback` 不再是可选的。不传入它将触发 ID 为 DEP0013 的弃用警告。
v0.1.8	新增于: v0.1.8

path <string> | <Buffer> | <URL>
options <Object> | <integer>
- recursive <boolean> 默认值: false
- mode <string> | <integer> Windows 上不支持。 默认值: 0o777。
callback <Function>
- err <Error>
- path <string> | <undefined> 仅当创建目录时将 recursive 设置为 true。

异步地创建目录。

回调给出一个可能的异常和创建的第一个目录路径（如果 recursive 为 true），(err[, path])。当 recursive 为 true 时，如果没有创建目录，则 path 仍然为 undefined。

可选的 options 参数可以是指定 mode（权限和粘性位）的整数，也可以是具有 mode 属性和 recursive 属性（指示是否应创建父目录）的对象。当 path 是已存在的目录时，调用 fs.mkdir() 仅在 recursive 为 false 时才导致错误。

import { mkdir } from 'node:fs';

// 创建 /tmp/a/apple，不管 `/tmp` 和 /tmp/a 是否存在。
mkdir('/tmp/a/apple', { recursive: true }, (err) => {
  if (err) throw err;
});

在 Windows 上，即使使用递归，在根目录上使用 fs.mkdir() 也会导致错误：

import { mkdir } from 'node:fs';

mkdir('/', { recursive: true }, (err) => {
  // => [Error: EPERM: operation not permitted, mkdir 'C:\']
});

有关更多详细信息，请参阅 POSIX mkdir(2) 文档。

History

Version	Changes
v18.0.0	Passing an invalid callback to the `callback` argument now throws `ERR_INVALID_ARG_TYPE` instead of `ERR_INVALID_CALLBACK`.
v13.11.0, v12.17.0	In `recursive` mode, the callback now receives the first created path as an argument.
v10.12.0	The second argument can now be an `options` object with `recursive` and `mode` properties.
v10.0.0	The `callback` parameter is no longer optional. Not passing it will throw a `TypeError` at runtime.
v7.6.0	The `path` parameter can be a WHATWG `URL` object using `file:` protocol.
v7.0.0	The `callback` parameter is no longer optional. Not passing it will emit a deprecation warning with id DEP0013.
v0.1.8	Added in: v0.1.8

path <string> | <Buffer> | <URL>
options <Object> | <integer>
- recursive <boolean> Default: false
- mode <string> | <integer> Not supported on Windows. Default: 0o777.
callback <Function>
- err <Error>
- path <string> | <undefined> Present only if a directory is created with recursive set to true.

Asynchronously creates a directory.

The callback is given a possible exception and, if recursive is true, the first directory path created, (err[, path]). path can still be undefined when recursive is true, if no directory was created.

The optional options argument can be an integer specifying mode (permission and sticky bits), or an object with a mode property and a recursive property indicating whether parent directories should be created. Calling fs.mkdir() when path is a directory that exists results in an error only when recursive is false.

import { mkdir } from 'node:fs';

// Creates /tmp/a/apple, regardless of whether `/tmp` and /tmp/a exist.
mkdir('/tmp/a/apple', { recursive: true }, (err) => {
  if (err) throw err;
});

On Windows, using fs.mkdir() on the root directory even with recursion will result in an error:

import { mkdir } from 'node:fs';

mkdir('/', { recursive: true }, (err) => {
  // => [Error: EPERM: operation not permitted, mkdir 'C:\']
});

See the POSIX mkdir(2) documentation for more details.