Function mkdirSync

  • mkdirSync(path, options): string | undefined

  • Synchronously creates a directory. Returns undefined, or if recursive is true, the first directory path created. This is the synchronous version of mkdir.

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

    Parameters

    • path: PathLike
    • options: MakeDirectoryOptions & {
          recursive: true;
      }

    Returns string | undefined

    Since

    v0.1.21

  • mkdirSync(path, options?): void

  • Synchronous mkdir(2) - create a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optionaloptions: null | Mode | MakeDirectoryOptions & {
          recursive?: false;
      }

      Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.

    Returns void

  • mkdirSync(path, options?): string | undefined

  • Synchronous mkdir(2) - create a directory.

    Parameters

    • path: PathLike

      A path to a file. If a URL is provided, it must use the file: protocol.

    • Optionaloptions: null | Mode | MakeDirectoryOptions

      Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.

    Returns string | undefined

Settings

Member Visibility