https://github.com/okunishinishi/node-filelink

Node.js module to link files.
https://github.com/okunishinishi/node-filelink

Last synced: 2 months ago
JSON representation

Node.js module to link files.

• Host: GitHub
• URL: https://github.com/okunishinishi/node-filelink
• Owner: okunishinishi
• License: mit
• Created: 2015-09-21T01:50:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:14:15.000Z (about 2 years ago)
• Last Synced: 2024-10-31T18:12:58.426Z (3 months ago)
• Language: JavaScript
• Size: 216 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
filelink

==========



[![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



Create file links.





Installation

-----

```bash

$ npm install filelink --save

```



Usage

---------

Create a relative symlink.

```javascript

'use strict'

const filelink = require('filelink')

filelink('src/foo.js', 'dest/foo-link.js', {

  force: true

}).then(() => {

  /* ... */

});

```



Options

-------

| Key | Description | Default |

| --- | ---- | --- |

| type | Type of link. "symlink" or "link" | "symlink" |

| force | Force to create link. | false |

| mkdirp | Create parent directories. | false |



License

-------

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