https://github.com/iguntur/is-symbolic-link

Check if filepath is symbolic link
https://github.com/iguntur/is-symbolic-link

await link ln promise symlink

Last synced: about 2 months ago
JSON representation

Check if filepath is symbolic link

• Host: GitHub
• URL: https://github.com/iguntur/is-symbolic-link
• Owner: iguntur
• License: mit
• Created: 2016-10-07T05:29:48.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-04T05:34:30.000Z (about 7 years ago)
• Last Synced: 2024-11-06T22:44:08.049Z (about 2 months ago)
• Topics: await, link, ln, promise, symlink
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

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)

> Check if filepath is symbolic link

## Install

``` bash

$ npm install 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) - Get all symbolic link in directory

## License

MIT © [Guntur Poetra](https://github.com/iguntur)