glob-cache
Advanced tools
Comparing version 0.3.3 to 0.3.4
@@ -6,2 +6,14 @@ # Change Log | ||
## [0.3.4](https://github.com/tunnckoCore/opensource/compare/glob-cache@0.3.3...glob-cache@0.3.4) (2020-02-04) | ||
### Bug Fixes | ||
* docs runner, regen docs, and create-jest-runner updates ([d854e3d](https://github.com/tunnckoCore/opensource/commit/d854e3d335fa1d2c82d87321a07c6659fe6dcee1)) | ||
* dooh, readmes and bugs ([871666e](https://github.com/tunnckoCore/opensource/commit/871666e7eabbca6bf65cbc257311f0a46d410752)) | ||
## [0.3.3](https://github.com/tunnckoCore/opensource/compare/glob-cache@0.3.2...glob-cache@0.3.3) (2020-02-04) | ||
@@ -8,0 +20,0 @@ |
{ | ||
"name": "glob-cache", | ||
"version": "0.3.3", | ||
"version": "0.3.4", | ||
"licenseStart": 2020, | ||
@@ -92,3 +92,3 @@ "license": "(Parity-7.0.0 AND Prosperity-3.0.0) OR Patron-1.0.0", | ||
}, | ||
"gitHead": "36720fdd18247b0ce9134b9631a6d5848e6c6c0d" | ||
"gitHead": "66acb69b616e923f601e632bfe398c07d86fa739" | ||
} |
@@ -10,5 +10,3 @@ <p align="center"> | ||
> Caching layer (using `cacache`) for any file globbing solution (`glob`, | ||
> `fast-glob`, `tiny-glob` and `globby`). Makes you Instant Fast™ and allows you | ||
> to hook into very specific & important part of the process | ||
> Caching layer (using `cacache`) for any file globbing solution (`glob`, `fast-glob`, `tiny-glob` and `globby`). Makes you Instant Fast™ and allows you to hook into very specific & important part of the process | ||
@@ -72,18 +70,19 @@ Please consider following this project's author, | ||
- [Install](#install) | ||
- [globCache](#globcache) | ||
- [Signature](#signature) | ||
- [Params](#params) | ||
- [Examples](#examples) | ||
- [API](#api) | ||
* [globCache](#globcache) | ||
+ [Signature](#signature) | ||
+ [Params](#params) | ||
+ [Examples](#examples) | ||
- [Contributing](#contributing) | ||
- [Guides and Community](#guides-and-community) | ||
- [Support the project](#support-the-project) | ||
* [Guides and Community](#guides-and-community) | ||
* [Support the project](#support-the-project) | ||
- [Contributors](#contributors) | ||
- [License](#license) | ||
_(TOC generated by [verb](https://github.com/verbose/verb) using | ||
[markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ | ||
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_ | ||
## Install | ||
This project requires [**Node.js**](https://nodejs.org) **>=10.18** _(see | ||
This project requires [**Node.js**](https://nodejs.org) **>=10.18** | ||
_(see | ||
[Support & Release Policy](https://github.com/tunnckoCoreLabs/support-release-policy))_. | ||
@@ -98,2 +97,4 @@ Install it using [**yarn**](https://yarnpkg.com) or | ||
## API | ||
<!-- docks-start --> | ||
@@ -105,6 +106,5 @@ | ||
Match files and folders using glob patterns. Returns a resolved Promise | ||
containing a `{ results, cacache }` object - where `results` is an array of | ||
[Context](#context-and-how-it-works) objects and `cacache` is the [cacache][] | ||
package. | ||
Match files and folders using glob patterns. Returns a resolved Promise containing | ||
a `{ results, cacache }` object - where `results` is an array of [Context](#context-and-how-it-works) objects | ||
and `cacache` is the [cacache][] package. | ||
@@ -123,15 +123,9 @@ <span id="globcache-signature"></span> | ||
- `options.include` **{Array<string>}** - string or array of string glob | ||
patterns | ||
- `options.include` **{Array<string>}** - string or array of string glob patterns | ||
- `options.exclude` **{string}** - ignore patterns | ||
- `options.always` **{boolean}** - a boolean that makes `options.hook` to always | ||
be called | ||
- `options.hook` **{Function}** - a hook function passed with | ||
[Context](#context-and-how-it-works) | ||
- `options.glob` **{Function}** - a globbing library like [glob][], [globby][], | ||
[fast-glob][], [tiny-glob][], defaults to `fast-glob` | ||
- `options.globOptions` **{object}** - options passed to the `options.glob` | ||
library | ||
- `options.cacheLocation` **{string}** - a filepath location of the cache, | ||
defaults to `./.cache/glob-cache` | ||
- `options.always` **{boolean}** - a boolean that makes `options.hook` to always be called | ||
- `options.hook` **{Function}** - a hook function passed with [Context](#context-and-how-it-works) | ||
- `options.glob` **{Function}** - a globbing library like [glob][], [globby][], [fast-glob][], [tiny-glob][], defaults to `fast-glob` | ||
- `options.globOptions` **{object}** - options passed to the `options.glob` library | ||
- `options.cacheLocation` **{string}** - a filepath location of the cache, defaults to `./.cache/glob-cache` | ||
- `returns` **{Promise}** | ||
@@ -213,6 +207,6 @@ | ||
Copyright (c) 2020-present, [Charlike Mike Reagent](https://tunnckocore.com) | ||
`<opensource@tunnckocore.com>` & [contributors](#wonderful-contributors).<br> | ||
Released under the [(Parity-7.0.0 AND Prosperity-3.0.0) OR Patron-1.0.0 | ||
License][license-url]. | ||
Copyright (c) 2020-present, | ||
[Charlike Mike Reagent](https://tunnckocore.com) `<opensource@tunnckocore.com>` | ||
& [contributors](#wonderful-contributors).<br> Released under the | ||
[(Parity-7.0.0 AND Prosperity-3.0.0) OR Patron-1.0.0 License][license-url]. | ||
@@ -312,2 +306,2 @@ <!-- badges --> | ||
[globby]: https://github.com/sindresorhus/globby | ||
[tiny-glob]: https://github.com/terkelg/tiny-glob | ||
[tiny-glob]: https://github.com/terkelg/tiny-glob |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
25309
300