is-symlink

Returns true if a filepath is a symbolic link

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
is-symlink
401.0.06 years ago8 years agoMinified + gzip package size for is-symlink in KB

Readme

is-symlink NPM version NPM monthly downloads NPM total downloads Linux Build Status
Returns true if a filepath is a symbolic link

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:
$ npm install --save is-symlink

Usage

const isSymlink = require('is-symlink');

// promise
isSymlink('/foo/bar')
  .then(isLink => {
    console.log(isLink);
  });

// or async-await 
(async function() {
  console.log(await isSymlink('/foo/bar'));
})();

// async callback
isSymlink('/foo/bar', (err, isLink) => {
  console.log(isLink);
});

// sync
console.log(isSymlink.sync('/foo/bar'));

About

Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test


Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:
micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme
, v0.6.0, on August 09, 2018.