symlinks

symlinks

Glob symlinks, async or sync. API and CLI. CLI also has --del for deleting matching symlinks.

Install

Install with npm:

$ npm install symlinks --save

Usage

var symlinks = require('symlinks');

// async
symlinks('node_modules/*', function(err, links) {
  if (err) throw err;
  console.log(links);
});

// sync
var links = symlinks.sync('node_modules/*');
console.log(links);

CLI

Get a list of symlinks that match a glob pattern (glob pattern might need to be wrapped in quotes depending on the pattern and platform):

$ symlinks node_modules/*

Delete

Delete matching symlinks with --del (glob pattern might need to be wrapped in quotes depending on the pattern and platform):

$ symlinks node_modules/* --del

API

symlinks

Get an array of symlinks that match the given glob pattern.

Params

• patterns {String|Array}
• options {Object}: Options to pass to matched
• cb {Function}: callback that exposes err and an array of symlinks

Example

symlinks('node_modules/*', function(err, links) {
  if (err) throw err;
  console.log(links);
});

.sync

Synchronous version, returns an array of symlinks that match the given glob pattern.

Params

• patterns {String|Array}
• options {Object}: Options to pass to matched
• cb {Function}: callback that exposes err and an array of symlinks

Example

var links = symlinks.sync('node_modules/*');
console.log(links);

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on February 29, 2016.