# glob-escape

> Escape glob patterns

Latest version **0.0.2** (published 2016-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install glob-escape
pnpm add glob-escape
yarn add glob-escape
bun add glob-escape
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2016-07-08 |
| First published | 2016-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sven Schönung |
| Maintainers | sven.schoenung |
| Keywords | backslash, escape, glob, globbing, globs, gulpfriendly, match, matcher, minimatch, pattern, patterns, wildcard, wildcards |

## Links

- npm: https://www.npmjs.com/package/glob-escape
- Repository: https://github.com/svenschoenung/glob-escape
- Homepage: https://github.com/svenschoenung/glob-escape.git
- Issues: https://github.com/svenschoenung/glob-escape/issues
- npm.io page: https://npm.io/package/glob-escape

## Recent versions

- 0.0.2 (latest) — 2016-07-08
- 0.0.1 — 2016-05-02

## README

[![npm Version](https://img.shields.io/npm/v/glob-escape.svg)](https://www.npmjs.com/package/glob-escape)
[![Build Status](https://travis-ci.org/svenschoenung/glob-escape.svg?branch=master)](https://travis-ci.org/svenschoenung/glob-escape)
[![Coverage Status](https://coveralls.io/repos/github/svenschoenung/glob-escape/badge.svg?branch=master)](https://coveralls.io/github/svenschoenung/glob-escape?branch=master)
[![Dependency Status](https://david-dm.org/svenschoenung/glob-escape.svg)](https://david-dm.org/svenschoenung/glob-escape)
[![devDependency Status](https://david-dm.org/svenschoenung/glob-escape/dev-status.svg)](https://david-dm.org/svenschoenung/glob-escape#info=devDependencies)
[![Code Climate](https://codeclimate.com/github/svenschoenung/glob-escape/badges/gpa.svg)](https://codeclimate.com/github/svenschoenung/glob-escape)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/dee709366a3245268e25a81e6a124ce6)](https://www.codacy.com/app/svenschoenung/glob-escape)

# glob-escape

Escapes glob patterns. Works for packages like [`minimatch`](https://www.npmjs.com/package/minimatch), [`multimatch`](https://www.npmjs.com/package/multimatch), [`glob`](https://www.npmjs.com/package/glob), [`glob-stream`](https://www.npmjs.com/package/glob-stream), [`globby`](https://www.npmjs.com/package/globby), [`vinyl-fs`](https://www.npmjs.com/package/vinyl-fs) and [`gulp`](https://www.npmjs.com/package/gulp`).

## Installation

    npm install glob-escape

## Usage

```js
var escapeGlob = require('glob-escape');
var glob = require('glob');
    
glob('algorithms/a*.txt', function(err, array) {
  // array might contain several files like:
  //   - algorithms/a*.txt
  //   - algorithms/alpha-beta_pruning.txt
  //   - algorithms/augmented_lagrangian_method.txt
});
    
glob(escapeGlob('algorithms/a*.txt'), function(err, array) {
  // array will only contain one file:
  //   - algorithms/a*.txt
});
```

## API

### escapeGlob(glob)

Escapes all glob patterns in the provided `glob`.

`glob` may be a string or an array of strings.

Returns the escaped glob.

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/glob-escape · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._