Module symlink

Callable

• symlink(target: PathLike, path: PathLike, type: Type | undefined | null, callback: function): void
• symlink(target: PathLike, path: PathLike, callback: function): void

• Asynchronous symlink(2) - Create a new symbolic link to an existing file.

  Parameters

  • target: PathLike

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

  • path: PathLike

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

  • type: Type | undefined | null

    May be set to 'dir', 'file', or 'junction' (default is 'file') and is only available on Windows (ignored on other platforms). When using 'junction', the target argument will automatically be normalized to an absolute path.

  • callback: function

    • • (err: ErrnoException | null): void

      • Parameters

        • err: ErrnoException | null

        Returns void

  Returns void

• Asynchronous symlink(2) - Create a new symbolic link to an existing file.

  Parameters

  • target: PathLike

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

  • path: PathLike

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

  • callback: function

    • • (err: ErrnoException | null): void

      • Parameters

        • err: ErrnoException | null

        Returns void

  Returns void