# copy-symlink

> copy symlink, because fs.copyFile can't

Latest version **2.0.0** (published 2020-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install copy-symlink
pnpm add copy-symlink
yarn add copy-symlink
bun add copy-symlink
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-09-25 |
| First published | 2018-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | copy, symlink |

## Links

- npm: https://www.npmjs.com/package/copy-symlink
- Repository: https://github.com/coderaiser/copy-symlink
- Homepage: http://github.com/coderaiser/copy-symlink
- Issues: https://github.com/coderaiser/copy-symlink/issues
- npm.io page: https://npm.io/package/copy-symlink

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-09-25
- 1.0.0 — 2018-09-26

## README

Copy Symlink [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
=========

Copy symlink because [fs.copyFile](https://nodejs.org/dist/latest-v8.x/docs/api/fs.html#fs_fs_copyfile_src_dest_flags_callback) can't.

When you use `fs.copyFile` it gets [realpath](https://nodejs.org/dist/latest-v10.x/docs/api/fs.html#fs_fs_realpath_path_options_callback) and then copies content of a source file from `realpath`.

`copy-symlink` also gets `realpath` but then creates `symbolic link` on a new location.

## Install

```
npm i copy-symlink
```

## API

### copySymlink(src, dest)

It is a promise so you can use it this way:

```js
const copySymlink = require('copy-symlink');
const src = './symlink';
const dst = './symlink-copy';

copySymlink()
    .then(console.log)
    .catch(console.error);
```

Or using `async-await`

```js
const copySymlink = require('copy-symlink');

async () => {
   await copySymlink();
}();
```

## Related

- [fs-copy-file](https://github.com/coderaiser/fs-copy-file"fs-copy-file") - Copies src to dest.
- [fs-copy-file-sync](https://github.com/coderaiser/fs-copy-file-sync "fs-copy-file-sync") - Synchronously copies src to dest.

## License
MIT

[NPMIMGURL]:                https://img.shields.io/npm/v/copy-symlink.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/copy-symlink/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/david/coderaiser/copy-symlink.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/copy-symlink/badge.svg?branch=master&service=github
[NPMURL]:                   https://npmjs.org/package/copy-symlink "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/copy-symlink  "Build Status"
[DependencyStatusURL]:      https://david-dm.org/coderaiser/copy-symlink "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]:              https://coveralls.io/github/coderaiser/copy-symlink?branch=master

---
_Source: https://npm.io/package/copy-symlink · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._