Logo for jsDocs.io

mkdirp

  • Version 3.0.1
  • Published
  • 107 kB
  • No dependencies
  • MIT license

Install

npm i mkdirp
yarn add mkdirp
pnpm add mkdirp

Overview

Recursively mkdir, like `mkdir -p`

Index

Variables

Functions

Variables

variable manual

const manual: ((
    path: string,
    options?: MkdirpOptions | undefined,
    made?: string | void | undefined
) => Promise<string | void | undefined>) & {
    sync: (
        path: string,
        options?: MkdirpOptions | undefined,
        made?: string | void | undefined
    ) => string | void | undefined;
};

    variable mkdirp

    const mkdirp: ((
        path: string,
        opts?: MkdirpOptions
    ) => Promise<string | void | undefined>) & {
        mkdirpSync: (path: string, opts?: MkdirpOptions) => string | void;
        mkdirpNative: ((
            path: string,
            options?: MkdirpOptions | undefined
        ) => Promise<string | void | undefined>) & {
            sync: (
                path: string,
                options?: MkdirpOptions | undefined
            ) => string | void | undefined;
        };
        mkdirpNativeSync: (
            path: string,
            options?: MkdirpOptions | undefined
        ) => string | void | undefined;
        mkdirpManual: ((
            path: string,
            options?: MkdirpOptions | undefined,
            made?: string | void | undefined
        ) => Promise<string | void | undefined>) & {
            sync: (
                path: string,
                options?: MkdirpOptions | undefined,
                made?: string | void | undefined
            ) => string | void | undefined;
        };
        mkdirpManualSync: (
            path: string,
            options?: MkdirpOptions | undefined,
            made?: string | void | undefined
        ) => string | void | undefined;
        sync: (path: string, opts?: MkdirpOptions) => string | void;
        native: ((
            path: string,
            options?: MkdirpOptions | undefined
        ) => Promise<string | void | undefined>) & {
            sync: (
                path: string,
                options?: MkdirpOptions | undefined
            ) => string | void | undefined;
        };
        nativeSync: (
            path: string,
            options?: MkdirpOptions | undefined
        ) => string | void | undefined;
        manual: ((
            path: string,
            options?: MkdirpOptions | undefined,
            made?: string | void | undefined
        ) => Promise<string | void | undefined>) & {
            sync: (
                path: string,
                options?: MkdirpOptions | undefined,
                made?: string | void | undefined
            ) => string | void | undefined;
        };
        manualSync: (
            path: string,
            options?: MkdirpOptions | undefined,
            made?: string | void | undefined
        ) => string | void | undefined;
        useNative: ((opts?: MkdirpOptions | undefined) => boolean) & {
            sync: (opts?: MkdirpOptions | undefined) => boolean;
        };
        useNativeSync: (opts?: MkdirpOptions | undefined) => boolean;
    };

      variable mkdirpManual

      const mkdirpManual: ((
          path: string,
          options?: MkdirpOptions,
          made?: string | undefined | void
      ) => Promise<string | undefined | void>) & {
          sync: (
              path: string,
              options?: MkdirpOptions,
              made?: string | undefined | void
          ) => string | undefined | void;
      };

        variable mkdirpNative

        const mkdirpNative: ((
            path: string,
            options?: MkdirpOptions
        ) => Promise<string | void | undefined>) & {
            sync: (path: string, options?: MkdirpOptions) => string | void | undefined;
        };

          variable native

          const native: ((
              path: string,
              options?: MkdirpOptions | undefined
          ) => Promise<string | void | undefined>) & {
              sync: (
                  path: string,
                  options?: MkdirpOptions | undefined
              ) => string | void | undefined;
          };

            variable useNative

            const useNative: ((opts?: MkdirpOptions) => boolean) & {
                sync: (opts?: MkdirpOptions) => boolean;
            };

              Functions

              function manualSync

              manualSync: (
                  path: string,
                  options?: MkdirpOptions | undefined,
                  made?: string | void | undefined
              ) => string | void | undefined;

                function mkdirpManualSync

                mkdirpManualSync: (
                    path: string,
                    options?: MkdirpOptions,
                    made?: string | undefined | void
                ) => string | undefined | void;

                  function mkdirpNativeSync

                  mkdirpNativeSync: (
                      path: string,
                      options?: MkdirpOptions
                  ) => string | void | undefined;

                    function mkdirpSync

                    mkdirpSync: (path: string, opts?: MkdirpOptions) => string | void;

                      function nativeSync

                      nativeSync: (
                          path: string,
                          options?: MkdirpOptions | undefined
                      ) => string | void | undefined;

                        function sync

                        sync: (path: string, opts?: MkdirpOptions) => string | void;

                          function useNativeSync

                          useNativeSync: (opts?: MkdirpOptions) => boolean;

                            Package Files (4)

                            Dependencies (0)

                            No dependencies.

                            Dev Dependencies (10)

                            Peer Dependencies (0)

                            No peer dependencies.

                            Badge

                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/mkdirp.

                            • Markdown
                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/mkdirp)
                            • HTML
                              <a href="https://www.jsdocs.io/package/mkdirp"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>