npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

read-glob-promise

v2.0.0

Published

Promise to read files with glob pattern

Downloads

21

Readme

read-glob-promise

Build Status Build status Coverage Status Dependency Status devDependency Status

Promise version of read-glob:

Search files with glob pattern and read them asynchronously

var readGlob = require('read-glob-promise');

readGlob('*.txt')
.then(function(bufs) {
  bufs; //=> [<Buffer ... >, <Buffer ... >, ...]
})
.catch(function(err) {
  console.log(err.message);
});

Installation

NPM version

Use npm.

npm install read-glob-promise

API

var readGlob = require('read-glob-promise');

readGlob(pattern [, options])

pattern: String (glob pattern)
options: Object or String
Return: Object (Promise)

When it finish reading files, it will be fulfilled with an Array of file contents as its first argument.

When it fails to read the files, it will be rejected with an error as its first argument.

var readGlob = require('read-glob-promise');

// foo.txt: lorem
// bar.txt: ipsum
// baz.txt: dolor

readGlob('{foo,ba*}.txt', 'utf8')
.then(function(contents) {
  contents; //=> ['lorem', 'ipsum', 'dolor']
});

readGlob('{foo,bar.baz}.txt', {nobrace: true})
.then(function(contents) {
  contents; //=> []
});

options

The option object will be directly passed to glob and fs.readFile, or the encoding string sets the encoding of fs.readFile.

Unlike the original API, glob's nodir option is true by default.

License

Copyright (c) 2014 Shinnosuke Watanabe

Licensed under the MIT License.