55 lines
2.4 KiB
Markdown
Executable file
55 lines
2.4 KiB
Markdown
Executable file
RegExp.prototype.flags <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
|
|
|
[![Build Status][travis-svg]][travis-url]
|
|
[![dependency status][deps-svg]][deps-url]
|
|
[![dev dependency status][dev-deps-svg]][dev-deps-url]
|
|
[![License][license-image]][license-url]
|
|
[![Downloads][downloads-image]][downloads-url]
|
|
|
|
[![npm badge][npm-badge-png]][package-url]
|
|
|
|
[![browser support][testling-svg]][testling-url]
|
|
|
|
An ES6 spec-compliant `RegExp.prototype.flags` shim. Invoke its "shim" method to shim RegExp.prototype.flags if it is unavailable.
|
|
*Note*: `RegExp#flags` requires a true ES5 environment - specifically, one with ES5 getters.
|
|
|
|
This package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES5-supported environment and complies with the [spec](http://www.ecma-international.org/ecma-262/6.0/#sec-get-regexp.prototype.flags).
|
|
|
|
Most common usage:
|
|
```js
|
|
var flags = require('regexp.prototype.flags');
|
|
|
|
assert(flags(/a/) === '');
|
|
assert(flags(new RegExp('a') === '');
|
|
assert(flags(/a/mig) === 'gim');
|
|
assert(flags(new RegExp('a', 'mig')) === 'gim');
|
|
|
|
if (!RegExp.prototype.flags) {
|
|
flags.shim();
|
|
}
|
|
|
|
assert(flags(/a/) === /a/.flags);
|
|
assert(flags(new RegExp('a') === new RegExp('a').flags);
|
|
assert(flags(/a/mig) === /a/mig.flags);
|
|
assert(flags(new RegExp('a', 'mig')) === new RegExp('a', 'mig').flags);
|
|
```
|
|
|
|
## Tests
|
|
Simply clone the repo, `npm install`, and run `npm test`
|
|
|
|
[package-url]: https://npmjs.com/package/regexp.prototype.flags
|
|
[npm-version-svg]: http://versionbadg.es/es-shims/RegExp.prototype.flags.svg
|
|
[travis-svg]: https://travis-ci.org/es-shims/RegExp.prototype.flags.svg
|
|
[travis-url]: https://travis-ci.org/es-shims/RegExp.prototype.flags
|
|
[deps-svg]: https://david-dm.org/es-shims/RegExp.prototype.flags.svg
|
|
[deps-url]: https://david-dm.org/es-shims/RegExp.prototype.flags
|
|
[dev-deps-svg]: https://david-dm.org/es-shims/RegExp.prototype.flags/dev-status.svg
|
|
[dev-deps-url]: https://david-dm.org/es-shims/RegExp.prototype.flags#info=devDependencies
|
|
[testling-svg]: https://ci.testling.com/es-shims/RegExp.prototype.flags.png
|
|
[testling-url]: https://ci.testling.com/es-shims/RegExp.prototype.flags
|
|
[npm-badge-png]: https://nodei.co/npm/regexp.prototype.flags.png?downloads=true&stars=true
|
|
[license-image]: http://img.shields.io/npm/l/regexp.prototype.flags.svg
|
|
[license-url]: LICENSE
|
|
[downloads-image]: http://img.shields.io/npm/dm/regexp.prototype.flags.svg
|
|
[downloads-url]: http://npm-stat.com/charts.html?package=regexp.prototype.flags
|