Logo for jsDocs.io

symlink-dir

  • Version 10.0.1
  • Published
  • 15.4 kB
  • 2 dependencies
  • MIT license

Install

npm i symlink-dir
yarn add symlink-dir
pnpm add symlink-dir

Overview

Cross-platform directory symlinking

Index

Functions

Functions

function symlinkDir

symlinkDir: (
    target: string,
    path: string,
    opts?: SymlinkDirOptions
) => Promise<{ reused: boolean; warn?: string }>;

    function symlinkDirSync

    symlinkDirSync: (
        target: string,
        path: string,
        opts?: SymlinkDirOptions
    ) => { reused: boolean; warn?: string };

      Package Files (1)

      Dependencies (2)

      Dev Dependencies (5)

      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/symlink-dir.

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