# is-symlink [![NPM version](https://img.shields.io/npm/v/is-symlink.svg?style=flat)](https://www.npmjs.com/package/is-symlink) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-symlink.svg?style=flat)](https://npmjs.org/package/is-symlink) [![NPM total downloads](https://img.shields.io/npm/dt/is-symlink.svg?style=flat)](https://npmjs.org/package/is-symlink) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-symlink.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-symlink)

> Returns true if a filepath is a symbolic link

Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save is-symlink
```

## Usage

```js
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

<details>
<summary><strong>Contributing</strong></summary>

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

</details>

<details>
<summary><strong>Running Tests</strong></summary>

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:

```sh
$ npm install && npm test
```

</details>

<details>
<summary><strong>Building docs</strong></summary>

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

</details>

### Related projects

You might also be interested in these projects:

[micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")

### Author

**Jon Schlinkert**

* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)

### License

Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 09, 2018._