# is-symbolic-link

> Indicates if path is symbolic link

Latest version **2.0.3** (published 2017-05-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-symbolic-link
pnpm add is-symbolic-link
yarn add is-symbolic-link
bun add is-symbolic-link
```

## 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 | 2.0.3 |
| Published | 2017-05-26 |
| First published | 2016-10-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Guntur Poetra |
| Maintainers | guntur |
| Keywords | async, await, boolean, check, is-ln, link, ln, lnfs, promise, symbolic, symlink, value |

## Links

- npm: https://www.npmjs.com/package/is-symbolic-link
- Repository: https://github.com/iguntur/is-symbolic-link
- Homepage: https://github.com/iguntur/is-symbolic-link#readme
- Issues: https://github.com/iguntur/is-symbolic-link/issues
- npm.io page: https://npm.io/package/is-symbolic-link

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 2.0.3 (latest) — 2017-05-26
- 2.0.2 — 2017-01-04
- 2.0.1 — 2017-01-04
- 2.0.0 — 2017-01-04
- 1.0.3 — 2016-11-01
- 1.0.2 — 2016-11-01
- 1.0.1 — 2016-10-17
- 1.0.0 — 2016-10-16
- 0.1.0 — 2016-10-07

## README

# is-symbolic-link [![Build Status](https://travis-ci.org/iguntur/is-symbolic-link.svg?branch=master)](https://travis-ci.org/iguntur/is-symbolic-link)

> Indicates if path is symbolic link


## Install

``` bash
$ npm install --save is-symbolic-link
```


## Usage

```js
const isSymbolicLink = require('is-symbolic-link');

isSymbolicLink('/home/guntur/.npmrc').then(val => {
	console.log(val);
	//=> true
});

console.log(isSymbolicLink.sync('/home/guntur/todo.md'));
//=> false
```


## API

### isSymbolicLink(input)

Returns a promise value of an input

### isSymbolicLink.sync(input)

Returns a boolean value of an input

#### input

- Type: `string`


## Related

- [get-symlinks](https://github.com/iguntur/get-symlinks)


## License

MIT © [Guntur Poetra](http://guntur.starmediateknik.com)

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