# path-symlink

> Create symlinks in a safe way

Latest version **0.0.3** (published 2017-01-03) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2017-01-03 |
| First published | 2017-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ragingwind |
| Maintainers | ragingwind |
| Keywords | symlink, dotfile |

## Links

- npm: https://www.npmjs.com/package/path-symlink
- Repository: https://github.com/ragingwind/path-symlink
- Homepage: https://github.com/ragingwind/path-symlink#readme
- Issues: https://github.com/ragingwind/path-symlink/issues
- npm.io page: https://npm.io/package/path-symlink

## Dependencies (2)

- [pify](https://npm.io/package/pify.md) ^2.3.0
- [globby](https://npm.io/package/globby.md) ^6.1.0

## 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

- 0.0.3 (latest) — 2017-01-03
- 0.0.2 — 2017-01-03
- 0.0.1 — 2017-01-03

## README

# path-symlink [![Build Status](https://travis-ci.org/ragingwind/path-symlink.svg?branch=master)](https://travis-ci.org/ragingwind/path-symlink)

> Create symlinks in a safe way


## Install

```
$ npm install --save path-symlink
```


## Usage

```js
const pathSymlink = require('path-symlink');

pathSymlink(['~/.dotfiles/**/*.symlink', '~/Downloads/local/*'], $HOME).then(links) {
}
```

## API

### pathSymlink(src, dest, [options])

Return a Promise for an array of creating symbolic links

#### src

Type: pattern for [globby](https://github.com/sindresorhus/globby)

Source files to become a symbolic link

#### dest

Type: `string`

Path for root directory for symbolic links

#### options

##### strip

Type: `boolean`<br>
Default: `true`

Whether strip extension string in a path or not

## License

MIT © [ragingwind](http://ragingwind.me)

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