sformisano/get-files-matching-glob

# Utility function to cache glob results

[![Build Status](https://travis-ci.org/sformisano/get-files-matching-glob.svg?branch=master)](https://travis-ci.org/sformisano/get-files-matching-glob)
[![Coverage Status](https://coveralls.io/repos/github/sformisano/getFilesMatchingGlobPattern/badge.svg?branch=master)](https://coveralls.io/github/sformisano/getFilesMatchingGlobPattern?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/b6d866ebfe5915c7e83c/maintainability)](https://codeclimate.com/github/sformisano/get-files-matching-glob/maintainability)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

[![NPM](https://nodei.co/npm/get-files-matching-glob.png?mini=true)](https://npmjs.org/package/get-files-matching-glob)

Takes a glob pattern as argument, checks the cache to see if data has already been requested for this pattern. If there's cached data, returns it. If not, returns the matching files and caches them. Throws an exception if no files match the glob pattern or if the argument passed to the glob pattern parameter is not a string.

# Instructions

### Install

```
npm install --save get-files-matching-glob
```

### Usage

```js
const getFilesMatchingGlob = require('get-files-matching-glob')

const useCache = true // true/false to cache paths (defaults to true)
const myFiles = getFilesMatchingGlob('some/glob/string/**/*.js', useCache)

// do whatever you want with myFiles which will be an array of all the matching files found
```