HEADS UP!
The API was completely changed in v0.2. The main export is now an async function that expects a callback, and instead of globbing local files, reflinks are created from npm package names.
const reflinks = require('{%= name %}');
// returns a promise by default
reflinks(['micromatch', 'generate'])
.then(res => {
console.log(res.links);
// results in:
// [ '[generate]: https://github.com/generate/generate',
// '[micromatch]: https://github.com/micromatch/micromatch' ]
})
.catch(console.error);
// or takes a callback
reflinks(['base', 'verb', 'generate'], function(err, res) {
console.log(res.links);
// results in:
// [ '[generate]: https://github.com/generate/generate',
// '[verb]: https://github.com/verbose/verb',
// '[base]: https://github.com/node-base/base' ]
});
By default results are cached for 7 days. See [pkg-cache][] for more details and API documentation related to caching packages.
Disable caching by setting options.cache
to false.
Type: Boolean
Default: undefined
reflinks(['base'], { cache: false }, function(err, links) {
if (err) return console.log(err);
});
This option is also aliased as reflinksCache
.
Delete the cache by setting options.clearCache
to true.
Type: Boolean
Default: undefined
reflinks(['base'], { clearCache: true }, function(err, links) {
if (err) return console.log(err);
});