# filelink

> Create file links.

Latest version **4.1.2** (published 2020-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install filelink
pnpm add filelink
yarn add filelink
bun add filelink
```

## 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 | 4.1.2 |
| Published | 2020-10-13 |
| First published | 2015-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | file, symlink |

## Links

- npm: https://www.npmjs.com/package/filelink
- Repository: https://github.com/okunishinishi/node-filelink
- Homepage: https://github.com/okunishinishi/node-filelink#readme
- Issues: https://github.com/okunishinishi/node-filelink/issues
- npm.io page: https://npm.io/package/filelink

## Dependencies (4)

- [argx](https://npm.io/package/argx.md) ^4.0.4
- [asfs](https://npm.io/package/asfs.md) ^2.3.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [filedel](https://npm.io/package/filedel.md) ^4.1.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 4.1.2 (latest) — 2020-10-13
- 4.1.1 — 2020-04-15
- 4.0.1 — 2019-02-24
- 4.0.0 — 2018-04-17
- 3.0.6 — 2016-08-07
- 3.0.5 — 2016-07-30
- 3.0.4 — 2016-07-12
- 3.0.3 — 2016-05-07
- 3.0.2 — 2016-05-07
- 3.0.0 — 2016-05-07
- 2.0.0 — 2016-03-07
- 1.0.1 — 2015-09-21
- 1.0.0 — 2015-09-21

## README

filelink
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-filelink
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-filelink
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-filelink.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-filelink
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-filelink.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-filelink/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-filelink
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-filelink.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-filelink.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-filelink
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-filelink.svg
[bd_npm_url]: http://www.npmjs.org/package/filelink
[bd_npm_shield_url]: http://img.shields.io/npm/v/filelink.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Create file links.

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install filelink --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

Create a relative symlink.

```javascript
'use strict'

const filelink = require('filelink')

filelink('src/foo.js', 'dest/foo-link.js', {
  force: true
}).then(() => {
  /* ... */
});
```




<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Options.md.hbs" Start -->

<a name="section-doc-guides-03-options-md"></a>

Options
-------

| Key | Description | Default |
| --- | ---- | --- |
| type | Type of link. "symlink" or "link" | "symlink" |
| force | Force to create link. | false |
| mkdirp | Create parent directories. | false |

<!-- Section from "doc/guides/03.Options.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-filelink/blob/master/LICENSE).

<!-- LICENSE End -->

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