get-symlinks v3.0.1

get-symlinks

Get all symbolic link (file symlinks) using glob

Install

$ npm install get-symlinks

Usage

const getSymlinks = require('get-symlinks');

getSymlinks(['/home/guntur/.*']).then(symlinks => {
    console.log(symlinks);
});

const symlinks = getSymlinks.sync(['/home/guntur/.*', '!/home/guntur/.*rc']);
console.log(symlinks);

API

getSymlinks(patterns, [options])

• Params:
  • patterns: <string | string[]> (required) - See the globby patterns.
  • options: <object> (optional) - See the globby options.
• Returns: <Promise<string[]> - An array of symlinks paths.

getSymlinks.sync(patterns, [options])

• Params:
  • patterns: <string | string[]> (required) - See the globby patterns.
  • options: <object> (optional) - See the globby options.
• Returns: <string[]> - An array of symlinks paths.

Related

• del-symlinks - Delete symlinks using glob.
• is-symbolic-link - Check if PATH is symbolic link
• make-symlinks - Create symbolic link (symlinks) using glob.

License

MIT © Guntur Poetra