first commit
This commit is contained in:
77
build/node_modules/lnfs/readme.md
generated
vendored
Normal file
77
build/node_modules/lnfs/readme.md
generated
vendored
Normal file
@@ -0,0 +1,77 @@
|
||||
# lnfs [](https://travis-ci.org/kevva/lnfs)
|
||||
|
||||
> Safely force create symlinks
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install --save lnfs
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
var symlink = require('lnfs');
|
||||
|
||||
symlink('foo.txt', 'bar.txt', function (err) {
|
||||
console.log('Symlink successfully created!');
|
||||
});
|
||||
|
||||
symlink.sync('foo.txt', 'bar.txt');
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### lnfs(src, dest, type, callback)
|
||||
|
||||
#### src
|
||||
|
||||
*Required*
|
||||
Type: `string`
|
||||
|
||||
Path to source file.
|
||||
|
||||
#### dest
|
||||
|
||||
*Required*
|
||||
Type: `string`
|
||||
|
||||
Path to destination.
|
||||
|
||||
#### type
|
||||
|
||||
Type: `string`
|
||||
Default: `file`
|
||||
|
||||
Can be set to `dir`, `file`, or `junction` and is only available on Windows (ignored on other platforms).
|
||||
|
||||
#### callback(err)
|
||||
|
||||
Type: `function`
|
||||
|
||||
Returns nothing but a possible exception.
|
||||
|
||||
|
||||
## CLI
|
||||
|
||||
```
|
||||
$ npm install --global lnfs
|
||||
```
|
||||
|
||||
```
|
||||
$ lnfs --help
|
||||
|
||||
Usage
|
||||
$ lnfs <file> <target>
|
||||
|
||||
Example
|
||||
$ lnfs foo.txt bar.txt
|
||||
```
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Kevin Mårtensson](https://github.com/kevva)
|
||||
Reference in New Issue
Block a user