Wondering what’s next for npm?Check out our public roadmap! »

is-symlink-sync

2.0.0 • Public • Published

is-symlink-sync

npm version Build Status Build status Coverage Status

Synchronously check if a file is a symbolic link

const isSymlinkSync = require('is-symlink-sync');
 
isSymlinkSync('path/to/symlink'); //=> true
isSymlinkSync('path/to/non-symlink'); //=> false

Installation

Use npm.

npm install is-symlink-sync

API

const isSymlinkSync = require('is-symlink-sync');

isSymlinkSync(filePath)

filePath: string, Buffer or URL
Return: boolean

It returns true if the file exists and is a symbolic link, otherwise false.

Only when the argument type is invalid, it throws an error.

isSymlinkSync(Buffer.from('123')); // doesn't throw any errors
isSymlinkSync(123); // throws a TypeError

License

Copyright (c) 2015 - 2017 Shinnosuke Watanabe

Licensed under the MIT License.

Install

npm i is-symlink-sync

DownloadsWeekly Downloads

522

Version

2.0.0

License

MIT

Last publish

Collaborators

  • avatar