**RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex).\n\nKeep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of \"direct\" (single-step) conversions, see [conversions.js](conversions.js).\n\n# Contribute\n\nIf there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.\n\n# License\nCopyright © 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE).\n# parse-asn1\n\n[](http://travis-ci.org/crypto-browserify/parse-asn1)\n[](https://www.npmjs.org/package/parse-asn1)\n\n[](https://github.com/feross/standard)\n\nutility library for parsing asn1 files for use with browserify-sign.\n# is-number [](https://www.npmjs.com/package/is-number) [](https://npmjs.org/package/is-number) [](https://travis-ci.org/jonschlinkert/is-number)\n\n> Returns true if the value is a number. comprehensive tests.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-number\n```\n\n## Usage\n\nTo understand some of the rationale behind the decisions made in this library (and to learn about some oddities of number evaluation in JavaScript), [see this gist](https://gist.github.com/jonschlinkert/e30c70c713da325d0e81).\n\n```js\nvar isNumber = require('is-number');\n```\n\n### true\n\nSee the [tests](./test.js) for more examples.\n\n```js\nisNumber(5e3) //=> 'true'\nisNumber(0xff) //=> 'true'\nisNumber(-1.1) //=> 'true'\nisNumber(0) //=> 'true'\nisNumber(1) //=> 'true'\nisNumber(1.1) //=> 'true'\nisNumber(10) //=> 'true'\nisNumber(10.10) //=> 'true'\nisNumber(100) //=> 'true'\nisNumber('-1.1') //=> 'true'\nisNumber('0') //=> 'true'\nisNumber('012') //=> 'true'\nisNumber('0xff') //=> 'true'\nisNumber('1') //=> 'true'\nisNumber('1.1') //=> 'true'\nisNumber('10') //=> 'true'\nisNumber('10.10') //=> 'true'\nisNumber('100') //=> 'true'\nisNumber('5e3') //=> 'true'\nisNumber(parseInt('012')) //=> 'true'\nisNumber(parseFloat('012')) //=> 'true'\n```\n\n### False\n\nSee the [tests](./test.js) for more examples.\n\n```js\nisNumber('foo') //=> 'false'\nisNumber([1]) //=> 'false'\nisNumber([]) //=> 'false'\nisNumber(function () {}) //=> 'false'\nisNumber(Infinity) //=> 'false'\nisNumber(NaN) //=> 'false'\nisNumber(new Array('abc')) //=> 'false'\nisNumber(new Array(2)) //=> 'false'\nisNumber(new Buffer('abc')) //=> 'false'\nisNumber(null) //=> 'false'\nisNumber(undefined) //=> 'false'\nisNumber({abc: 'abc'}) //=> 'false'\n```\n\n## About\n\n### Related projects\n\n* [even](https://www.npmjs.com/package/even): Get the even numbered items from an array. | [homepage](https://github.com/jonschlinkert/even \"Get the even numbered items from an array.\")\n* [is-even](https://www.npmjs.com/package/is-even): Return true if the given number is even. | [homepage](https://github.com/jonschlinkert/is-even \"Return true if the given number is even.\")\n* [is-odd](https://www.npmjs.com/package/is-odd): Returns true if the given number is odd. | [homepage](https://github.com/jonschlinkert/is-odd \"Returns true if the given number is odd.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n* [odd](https://www.npmjs.com/package/odd): Get the odd numbered items from an array. | [homepage](https://github.com/jonschlinkert/odd \"Get the odd numbered items from an array.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/is-number/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on September 10, 2016._\n# hsla-regex\n\n[](https://travis-ci.org/regexps/hsla-regex)\n\nRegex for matching HSLA colors.\n\n## Installation\n\n```bash\nnpm install --save hsla-regex\n```\n\n## Usage\n\n```javascript\nvar hslaRegex = require('hsla-regex');\n\nhslaRegex({ exact: true }).test('hsla(123, 45%, 67%, .8)'); // => true\nhslaRegex({ exact: true }).test('foo bar'); // => false\n\nhslaRegex({ exact: true }).exec('hsla(1, 1.111%, 1.1111%, .8)');\n// => [\n// 'hsla(1, 1.111%, 1.1111%, .8)',\n// '1',\n// '1.111%',\n// '1.1111%',\n// '.8'\n// index: 0,\n// input: 'hsla(1, 1.111%, 1.1111%, .8)'\n// ]\n\n'hsla(123, 45%, 67%, .8) cats and dogs'.match(hslaRegex());\n// = ['hsla(123, 45%, 67%, .8)']\n```\n\n## License\n\nMIT\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\nCrafted with <3 by John Otander ([@4lpine](https://twitter.com/4lpine)).\n\n***\n\n> This package was initially generated with [yeoman](http://yeoman.io) and the [p generator](https://github.com/johnotander/generator-p.git).\n# posthtml-parser\n[](http://badge.fury.io/js/posthtml-parser)\n[](https://travis-ci.org/posthtml/posthtml-parser?branch=master)\n[](https://coveralls.io/r/posthtml/posthtml-parser?branch=master)\n\nParse HTML/XML to [PostHTML AST](https://github.com/posthtml/posthtml-parser#posthtml-ast-format).\nMore about [PostHTML](https://github.com/posthtml/posthtml#readme)\n\n## Install\n\n[NPM](http://npmjs.com) install\n```\n$ npm install posthtml-parser\n```\n\n## Usage\n\n#### Input HTML\n```html\n<a class=\"animals\" href=\"#\">\n <span class=\"animals__cat\" style=\"background: url(cat.png)\">Cat</span>\n</a>\n```\n```js\nconst parser = require('posthtml-parser')\nconst fs = require('fs')\nconst html = fs.readFileSync('path/to/input.html').toString()\n\nconsole.log(parser(html)) // Logs a PostHTML AST\n```\n\n#### input HTML\n```html\n<a class=\"animals\" href=\"#\">\n <span class=\"animals__cat\" style=\"background: url(cat.png)\">Cat</span>\n</a>\n```\n\n#### Result PostHTMLTree\n```js\n[{\n tag: 'a',\n attrs: {\n class: 'animals',\n href: '#'\n },\n content: [\n '\\n ',\n {\n tag: 'span',\n attrs: {\n class: 'animals__cat',\n style: 'background: url(cat.png)'\n },\n content: ['Cat']\n },\n '\\n'\n ]\n}]\n```\n\n## PostHTML AST Format\n\nAny parser being used with PostHTML should return a standard PostHTML [Abstract Syntax Tree](https://www.wikiwand.com/en/Abstract_syntax_tree) (AST). Fortunately, this is a very easy format to produce and understand. The AST is an array that can contain strings and objects. Any strings represent plain text content to be written to the output. Any objects represent HTML tags.\n\nTag objects generally look something like this:\n\n```js\n{\n tag: 'div',\n attrs: {\n class: 'foo'\n },\n content: ['hello world!']\n}\n```\n\nTag objects can contain three keys. The `tag` key takes the name of the tag as the value. This can include custom tags. The optional `attrs` key takes an object with key/value pairs representing the attributes of the html tag. A boolean attribute has an empty string as its value. Finally, the optional `content` key takes an array as its value, which is a PostHTML AST. In this manner, the AST is a tree that should be walked recursively.\n\n## Options\n\n### `directives`\nType: `Array` \nDefault: `[{name: '!doctype', start: '<', end: '>'}]` \nDescription: *Adds processing of custom directives. Note: The property ```name``` in custom directives can be ```String``` or ```RegExp``` type* \n\n### `xmlMode`\nType: `Boolean` \nDefault: `false` \nDescription: *Indicates whether special tags (`<script>` and `<style>`) should get special treatment and if \"empty\" tags (eg. `<br>`) can have children. If false, the content of special tags will be text only. For feeds and other XML content (documents that don't consist of HTML), set this to true.*\n\n### `decodeEntities`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, entities within the document will be decoded.*\n\n### `lowerCaseTags`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, all tags will be lowercased. If `xmlMode` is disabled.*\n\n### `lowerCaseAttributeNames`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, all attribute names will be lowercased. This has noticeable impact on speed.*\n\n### `recognizeCDATA`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, CDATA sections will be recognized as text even if the `xmlMode` option is not enabled. NOTE: If `xmlMode` is set to `true` then CDATA sections will always be recognized as text.*\n\n### `recognizeSelfClosing`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, self-closing tags will trigger the `onclosetag` event even if `xmlMode` is not set to `true`. NOTE: If `xmlMode` is set to `true` then self-closing tags will always be recognized.*\n\n## License\n\n[MIT](LICENSE)\nNative Abstractions for Node.js\n===============================\n\n**A header file filled with macro and utility goodness for making add-on development for Node.js easier across versions 0.8, 0.10, 0.12, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11.**\n\n***Current version: 2.13.2***\n\n*(See [CHANGELOG.md](https://github.com/nodejs/nan/blob/master/CHANGELOG.md) for complete ChangeLog)*\n\n[](https://nodei.co/npm/nan/) [](https://nodei.co/npm/nan/)\n\n[](https://travis-ci.org/nodejs/nan)\n[](https://ci.appveyor.com/project/RodVagg/nan)\n\nThanks to the crazy changes in V8 (and some in Node core), keeping native addons compiling happily across versions, particularly 0.10 to 0.12 to 4.0, is a minor nightmare. The goal of this project is to store all logic necessary to develop native Node.js addons without having to inspect `NODE_MODULE_VERSION` and get yourself into a macro-tangle.\n\nThis project also contains some helper utilities that make addon development a bit more pleasant.\n\n * **[News & Updates](#news)**\n * **[Usage](#usage)**\n * **[Example](#example)**\n * **[API](#api)**\n * **[Tests](#tests)**\n * **[Knowns issues](#issues)**\n * **[Governance & Contributing](#governance)**\n\n<a name=\"news\"></a>\n\n## News & Updates\n\n<a name=\"usage\"></a>\n\n## Usage\n\nSimply add **NAN** as a dependency in the *package.json* of your Node addon:\n\n``` bash\n$ npm install --save nan\n```\n\nPull in the path to **NAN** in your *binding.gyp* so that you can use `#include <nan.h>` in your *.cpp* files:\n\n``` python\n\"include_dirs\" : [\n \"<!(node -e \\\"require('nan')\\\")\"\n]\n```\n\nThis works like a `-I<path-to-NAN>` when compiling your addon.\n\n<a name=\"example\"></a>\n\n## Example\n\nJust getting started with Nan? Take a look at the **[Node Add-on Examples](https://github.com/nodejs/node-addon-examples)**.\n\nRefer to a [quick-start **Nan** Boilerplate](https://github.com/fcanas/node-native-boilerplate) for a ready-to-go project that utilizes basic Nan functionality.\n\nFor a simpler example, see the **[async pi estimation example](https://github.com/nodejs/nan/tree/master/examples/async_pi_estimate)** in the examples directory for full code and an explanation of what this Monte Carlo Pi estimation example does. Below are just some parts of the full example that illustrate the use of **NAN**.\n\nYet another example is **[nan-example-eol](https://github.com/CodeCharmLtd/nan-example-eol)**. It shows newline detection implemented as a native addon.\n\nAlso take a look at our comprehensive **[C++ test suite](https://github.com/nodejs/nan/tree/master/test/cpp)** which has a plethora of code snippets for your pasting pleasure.\n\n<a name=\"api\"></a>\n\n## API\n\nAdditional to the NAN documentation below, please consult:\n\n* [The V8 Getting Started * Guide](https://github.com/v8/v8/wiki/Getting%20Started%20with%20Embedding)\n* [The V8 Embedders * Guide](https://github.com/v8/v8/wiki/Embedder%27s%20Guide)\n* [V8 API Documentation](https://v8docs.nodesource.com/)\n* [Node Add-on Documentation](https://nodejs.org/api/addons.html)\n\n<!-- START API -->\n\n### JavaScript-accessible methods\n\nA _template_ is a blueprint for JavaScript functions and objects in a context. You can use a template to wrap C++ functions and data structures within JavaScript objects so that they can be manipulated from JavaScript. See the V8 Embedders Guide section on [Templates](https://github.com/v8/v8/wiki/Embedder%27s-Guide#templates) for further information.\n\nIn order to expose functionality to JavaScript via a template, you must provide it to V8 in a form that it understands. Across the versions of V8 supported by NAN, JavaScript-accessible method signatures vary widely, NAN fully abstracts method declaration and provides you with an interface that is similar to the most recent V8 API but is backward-compatible with older versions that still use the now-deceased `v8::Argument` type.\n\n* **Method argument types**\n - <a href=\"doc/methods.md#api_nan_function_callback_info\"><b><code>Nan::FunctionCallbackInfo</code></b></a>\n - <a href=\"doc/methods.md#api_nan_property_callback_info\"><b><code>Nan::PropertyCallbackInfo</code></b></a>\n - <a href=\"doc/methods.md#api_nan_return_value\"><b><code>Nan::ReturnValue</code></b></a>\n* **Method declarations**\n - <a href=\"doc/methods.md#api_nan_method\"><b>Method declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_getter\"><b>Getter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_setter\"><b>Setter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_getter\"><b>Property getter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_setter\"><b>Property setter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_enumerator\"><b>Property enumerator declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_deleter\"><b>Property deleter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_query\"><b>Property query declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_getter\"><b>Index getter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_setter\"><b>Index setter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_enumerator\"><b>Index enumerator declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_deleter\"><b>Index deleter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_query\"><b>Index query declaration</b></a>\n* Method and template helpers\n - <a href=\"doc/methods.md#api_nan_set_method\"><b><code>Nan::SetMethod()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_prototype_method\"><b><code>Nan::SetPrototypeMethod()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_accessor\"><b><code>Nan::SetAccessor()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_named_property_handler\"><b><code>Nan::SetNamedPropertyHandler()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_indexed_property_handler\"><b><code>Nan::SetIndexedPropertyHandler()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_template\"><b><code>Nan::SetTemplate()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_prototype_template\"><b><code>Nan::SetPrototypeTemplate()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_instance_template\"><b><code>Nan::SetInstanceTemplate()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_call_handler\"><b><code>Nan::SetCallHandler()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_call_as_function_handler\"><b><code>Nan::SetCallAsFunctionHandler()</code></b></a>\n\n### Scopes\n\nA _local handle_ is a pointer to an object. All V8 objects are accessed using handles, they are necessary because of the way the V8 garbage collector works.\n\nA handle scope can be thought of as a container for any number of handles. When you've finished with your handles, instead of deleting each one individually you can simply delete their scope.\n\nThe creation of `HandleScope` objects is different across the supported versions of V8. Therefore, NAN provides its own implementations that can be used safely across these.\n\n - <a href=\"doc/scopes.md#api_nan_handle_scope\"><b><code>Nan::HandleScope</code></b></a>\n - <a href=\"doc/scopes.md#api_nan_escapable_handle_scope\"><b><code>Nan::EscapableHandleScope</code></b></a>\n\nAlso see the V8 Embedders Guide section on [Handles and Garbage Collection](https://github.com/v8/v8/wiki/Embedder%27s%20Guide#handles-and-garbage-collection).\n\n### Persistent references\n\nAn object reference that is independent of any `HandleScope` is a _persistent_ reference. Where a `Local` handle only lives as long as the `HandleScope` in which it was allocated, a `Persistent` handle remains valid until it is explicitly disposed.\n\nDue to the evolution of the V8 API, it is necessary for NAN to provide a wrapper implementation of the `Persistent` classes to supply compatibility across the V8 versions supported.\n\n - <a href=\"doc/persistent.md#api_nan_persistent_base\"><b><code>Nan::PersistentBase & v8::PersistentBase</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_non_copyable_persistent_traits\"><b><code>Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_copyable_persistent_traits\"><b><code>Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_persistent\"><b><code>Nan::Persistent</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_global\"><b><code>Nan::Global</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_weak_callback_info\"><b><code>Nan::WeakCallbackInfo</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_weak_callback_type\"><b><code>Nan::WeakCallbackType</code></b></a>\n\nAlso see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).\n\n### New\n\nNAN provides a `Nan::New()` helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.\n\n - <a href=\"doc/new.md#api_nan_new\"><b><code>Nan::New()</code></b></a>\n - <a href=\"doc/new.md#api_nan_undefined\"><b><code>Nan::Undefined()</code></b></a>\n - <a href=\"doc/new.md#api_nan_null\"><b><code>Nan::Null()</code></b></a>\n - <a href=\"doc/new.md#api_nan_true\"><b><code>Nan::True()</code></b></a>\n - <a href=\"doc/new.md#api_nan_false\"><b><code>Nan::False()</code></b></a>\n - <a href=\"doc/new.md#api_nan_empty_string\"><b><code>Nan::EmptyString()</code></b></a>\n\n### Converters\n\nNAN contains functions that convert `v8::Value`s to other `v8::Value` types and native types. Since type conversion is not guaranteed to succeed, they return `Nan::Maybe` types. These converters can be used in place of `value->ToX()` and `value->XValue()` (where `X` is one of the types, e.g. `Boolean`) in a way that provides a consistent interface across V8 versions. Newer versions of V8 use the new `v8::Maybe` and `v8::MaybeLocal` types for these conversions, older versions don't have this functionality so it is provided by NAN.\n\n - <a href=\"doc/converters.md#api_nan_to\"><b><code>Nan::To()</code></b></a>\n\n### Maybe Types\n\nThe `Nan::MaybeLocal` and `Nan::Maybe` types are monads that encapsulate `v8::Local` handles that _may be empty_.\n\n* **Maybe Types**\n - <a href=\"doc/maybe_types.md#api_nan_maybe_local\"><b><code>Nan::MaybeLocal</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_maybe\"><b><code>Nan::Maybe</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_nothing\"><b><code>Nan::Nothing</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_just\"><b><code>Nan::Just</code></b></a>\n* **Maybe Helpers**\n - <a href=\"doc/maybe_types.md#api_nan_call\"><b><code>Nan::Call()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_to_detail_string\"><b><code>Nan::ToDetailString()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_to_array_index\"><b><code>Nan::ToArrayIndex()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_equals\"><b><code>Nan::Equals()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_new_instance\"><b><code>Nan::NewInstance()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_function\"><b><code>Nan::GetFunction()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_set\"><b><code>Nan::Set()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_define_own_property\"><b><code>Nan::DefineOwnProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_force_set\"><del><b><code>Nan::ForceSet()</code></b></del></a>\n - <a href=\"doc/maybe_types.md#api_nan_get\"><b><code>Nan::Get()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_property_attribute\"><b><code>Nan::GetPropertyAttributes()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has\"><b><code>Nan::Has()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_delete\"><b><code>Nan::Delete()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_property_names\"><b><code>Nan::GetPropertyNames()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_own_property_names\"><b><code>Nan::GetOwnPropertyNames()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_set_prototype\"><b><code>Nan::SetPrototype()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_object_proto_to_string\"><b><code>Nan::ObjectProtoToString()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_own_property\"><b><code>Nan::HasOwnProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_real_named_property\"><b><code>Nan::HasRealNamedProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_real_indexed_property\"><b><code>Nan::HasRealIndexedProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_real_named_callback_property\"><b><code>Nan::HasRealNamedCallbackProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_real_named_property_in_prototype_chain\"><b><code>Nan::GetRealNamedPropertyInPrototypeChain()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_real_named_property\"><b><code>Nan::GetRealNamedProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_call_as_function\"><b><code>Nan::CallAsFunction()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_call_as_constructor\"><b><code>Nan::CallAsConstructor()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_source_line\"><b><code>Nan::GetSourceLine()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_line_number\"><b><code>Nan::GetLineNumber()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_start_column\"><b><code>Nan::GetStartColumn()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_end_column\"><b><code>Nan::GetEndColumn()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_clone_element_at\"><b><code>Nan::CloneElementAt()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_private\"><b><code>Nan::HasPrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_private\"><b><code>Nan::GetPrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_set_private\"><b><code>Nan::SetPrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_delete_private\"><b><code>Nan::DeletePrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_make_maybe\"><b><code>Nan::MakeMaybe()</code></b></a>\n\n### Script\n\nNAN provides a `v8::Script` helpers as the API has changed over the supported versions of V8.\n\n - <a href=\"doc/script.md#api_nan_compile_script\"><b><code>Nan::CompileScript()</code></b></a>\n - <a href=\"doc/script.md#api_nan_run_script\"><b><code>Nan::RunScript()</code></b></a>\n\n### JSON\n\nThe _JSON_ object provides the c++ versions of the methods offered by the `JSON` object in javascript. V8 exposes these methods via the `v8::JSON` object.\n\n - <a href=\"doc/json.md#api_nan_json_parse\"><b><code>Nan::JSON.Parse</code></b></a>\n - <a href=\"doc/json.md#api_nan_json_stringify\"><b><code>Nan::JSON.Stringify</code></b></a>\n\nRefer to the V8 JSON object in the [V8 documentation](https://v8docs.nodesource.com/node-8.11/da/d6f/classv8_1_1_j_s_o_n.html) for more information about these methods and their arguments.\n\n### Errors\n\nNAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.\n\nNote that an Error object is simply a specialized form of `v8::Value`.\n\nAlso consult the V8 Embedders Guide section on [Exceptions](https://developers.google.com/v8/embed#exceptions) for more information.\n\n - <a href=\"doc/errors.md#api_nan_error\"><b><code>Nan::Error()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_range_error\"><b><code>Nan::RangeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_reference_error\"><b><code>Nan::ReferenceError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_syntax_error\"><b><code>Nan::SyntaxError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_type_error\"><b><code>Nan::TypeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_error\"><b><code>Nan::ThrowError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_range_error\"><b><code>Nan::ThrowRangeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_reference_error\"><b><code>Nan::ThrowReferenceError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_syntax_error\"><b><code>Nan::ThrowSyntaxError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_type_error\"><b><code>Nan::ThrowTypeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_fatal_exception\"><b><code>Nan::FatalException()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_errno_exception\"><b><code>Nan::ErrnoException()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_try_catch\"><b><code>Nan::TryCatch</code></b></a>\n\n### Buffers\n\nNAN's `node::Buffer` helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.\n\n - <a href=\"doc/buffers.md#api_nan_new_buffer\"><b><code>Nan::NewBuffer()</code></b></a>\n - <a href=\"doc/buffers.md#api_nan_copy_buffer\"><b><code>Nan::CopyBuffer()</code></b></a>\n - <a href=\"doc/buffers.md#api_nan_free_callback\"><b><code>Nan::FreeCallback()</code></b></a>\n\n### Nan::Callback\n\n`Nan::Callback` makes it easier to use `v8::Function` handles as callbacks. A class that wraps a `v8::Function` handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.\n\n - <a href=\"doc/callback.md#api_nan_callback\"><b><code>Nan::Callback</code></b></a>\n\n### Asynchronous work helpers\n\n`Nan::AsyncWorker`, `Nan::AsyncProgressWorker` and `Nan::AsyncProgressQueueWorker` are helper classes that make working with asynchronous code easier.\n\n - <a href=\"doc/asyncworker.md#api_nan_async_worker\"><b><code>Nan::AsyncWorker</code></b></a>\n - <a href=\"doc/asyncworker.md#api_nan_async_progress_worker\"><b><code>Nan::AsyncProgressWorkerBase & Nan::AsyncProgressWorker</code></b></a>\n - <a href=\"doc/asyncworker.md#api_nan_async_progress_queue_worker\"><b><code>Nan::AsyncProgressQueueWorker</code></b></a>\n - <a href=\"doc/asyncworker.md#api_nan_async_queue_worker\"><b><code>Nan::AsyncQueueWorker</code></b></a>\n\n### Strings & Bytes\n\nMiscellaneous string & byte encoding and decoding functionality provided for compatibility across supported versions of V8 and Node. Implemented by NAN to ensure that all encoding types are supported, even for older versions of Node where they are missing.\n\n - <a href=\"doc/string_bytes.md#api_nan_encoding\"><b><code>Nan::Encoding</code></b></a>\n - <a href=\"doc/string_bytes.md#api_nan_encode\"><b><code>Nan::Encode()</code></b></a>\n - <a href=\"doc/string_bytes.md#api_nan_decode_bytes\"><b><code>Nan::DecodeBytes()</code></b></a>\n - <a href=\"doc/string_bytes.md#api_nan_decode_write\"><b><code>Nan::DecodeWrite()</code></b></a>\n\n### Object Wrappers\n\nThe `ObjectWrap` class can be used to make wrapped C++ objects and a factory of wrapped objects.\n\n - <a href=\"doc/object_wrappers.md#api_nan_object_wrap\"><b><code>Nan::ObjectWrap</code></b></a>\n\n### V8 internals\n\nThe hooks to access V8 internals—including GC and statistics—are different across the supported versions of V8, therefore NAN provides its own hooks that call the appropriate V8 methods.\n\n - <a href=\"doc/v8_internals.md#api_nan_gc_callback\"><b><code>NAN_GC_CALLBACK()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_add_gc_epilogue_callback\"><b><code>Nan::AddGCEpilogueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_remove_gc_epilogue_callback\"><b><code>Nan::RemoveGCEpilogueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_add_gc_prologue_callback\"><b><code>Nan::AddGCPrologueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_remove_gc_prologue_callback\"><b><code>Nan::RemoveGCPrologueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_get_heap_statistics\"><b><code>Nan::GetHeapStatistics()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_counter_function\"><b><code>Nan::SetCounterFunction()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_create_histogram_function\"><b><code>Nan::SetCreateHistogramFunction()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_add_histogram_sample_function\"><b><code>Nan::SetAddHistogramSampleFunction()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_idle_notification\"><b><code>Nan::IdleNotification()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_low_memory_notification\"><b><code>Nan::LowMemoryNotification()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_context_disposed_notification\"><b><code>Nan::ContextDisposedNotification()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_get_internal_field_pointer\"><b><code>Nan::GetInternalFieldPointer()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_internal_field_pointer\"><b><code>Nan::SetInternalFieldPointer()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_adjust_external_memory\"><b><code>Nan::AdjustExternalMemory()</code></b></a>\n\n### Miscellaneous V8 Helpers\n\n - <a href=\"doc/v8_misc.md#api_nan_utf8_string\"><b><code>Nan::Utf8String</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_get_current_context\"><b><code>Nan::GetCurrentContext()</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_set_isolate_data\"><b><code>Nan::SetIsolateData()</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_get_isolate_data\"><b><code>Nan::GetIsolateData()</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_typedarray_contents\"><b><code>Nan::TypedArrayContents</code></b></a>\n\n### Miscellaneous Node Helpers\n\n - <a href=\"doc/node_misc.md#api_nan_asyncresource\"><b><code>Nan::AsyncResource</code></b></a>\n - <a href=\"doc/node_misc.md#api_nan_make_callback\"><b><code>Nan::MakeCallback()</code></b></a>\n - <a href=\"doc/node_misc.md#api_nan_module_init\"><b><code>NAN_MODULE_INIT()</code></b></a>\n - <a href=\"doc/node_misc.md#api_nan_export\"><b><code>Nan::Export()</code></b></a>\n\n<!-- END API -->\n\n<a name=\"tests\"></a>\n\n### Tests\n\nTo run the NAN tests do:\n\n``` sh\nnpm install\nnpm run-script rebuild-tests\nnpm test\n```\n\nOr just:\n\n``` sh\nnpm install\nmake test\n```\n\n<a name=\"issues\"></a>\n\n## Known issues\n\n### Compiling against Node.js 0.12 on OSX\n\nWith new enough compilers available on OSX, the versions of V8 headers corresponding to Node.js 0.12\ndo not compile anymore. The error looks something like:\n\n```\n❯ CXX(target) Release/obj.target/accessors/cpp/accessors.o\nIn file included from ../cpp/accessors.cpp:9:\nIn file included from ../../nan.h:51:\nIn file included from /Users/ofrobots/.node-gyp/0.12.18/include/node/node.h:61:\n/Users/ofrobots/.node-gyp/0.12.18/include/node/v8.h:5800:54: error: 'CreateHandle' is a protected member of 'v8::HandleScope'\n return Handle<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(\n ~~~~~~~~~~~~~^~~~~~~~~~~~\n```\n\nThis can be worked around by patching your local versions of v8.h corresponding to Node 0.12 to make\n`v8::Handle` a friend of `v8::HandleScope`. Since neither Node.js not V8 support this release line anymore\nthis patch cannot be released by either project in an official release.\n\nFor this reason, we do not test against Node.js 0.12 on OSX in this project's CI. If you need to support\nthat configuration, you will need to either get an older compiler, or apply a source patch to the version\nof V8 headers as a workaround.\n\n<a name=\"governance\"></a>\n\n## Governance & Contributing\n\nNAN is governed by the [Node.js Addon API Working Group](https://github.com/nodejs/CTC/blob/master/WORKING_GROUPS.md#addon-api)\n\n### Addon API Working Group (WG)\n\nThe NAN project is jointly governed by a Working Group which is responsible for high-level guidance of the project.\n\nMembers of the WG are also known as Collaborators, there is no distinction between the two, unlike other Node.js projects.\n\nThe WG has final authority over this project including:\n\n* Technical direction\n* Project governance and process (including this policy)\n* Contribution policy\n* GitHub repository hosting\n* Maintaining the list of additional Collaborators\n\nFor the current list of WG members, see the project [README.md](./README.md#collaborators).\n\nIndividuals making significant and valuable contributions are made members of the WG and given commit-access to the project. These individuals are identified by the WG and their addition to the WG is discussed via GitHub and requires unanimous consensus amongst those WG members participating in the discussion with a quorum of 50% of WG members required for acceptance of the vote.\n\n_Note:_ If you make a significant contribution and are not considered for commit-access log an issue or contact a WG member directly.\n\nFor the current list of WG members / Collaborators, see the project [README.md](./README.md#collaborators).\n\n### Consensus Seeking Process\n\nThe WG follows a [Consensus Seeking](https://en.wikipedia.org/wiki/Consensus-seeking_decision-making) decision making model.\n\nModifications of the contents of the NAN repository are made on a collaborative basis. Anybody with a GitHub account may propose a modification via pull request and it will be considered by the WG. All pull requests must be reviewed and accepted by a WG member with sufficient expertise who is able to take full responsibility for the change. In the case of pull requests proposed by an existing WG member, an additional WG member is required for sign-off. Consensus should be sought if additional WG members participate and there is disagreement around a particular modification.\n\nIf a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.\n\n<a id=\"developers-certificate-of-origin\"></a>\n\n## Developer's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n* (a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n* (b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n* (c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n* (d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n\n<a name=\"collaborators\"></a>\n\n### WG Members / Collaborators\n\n<table><tbody>\n<tr><th align=\"left\">Rod Vagg</th><td><a href=\"https://github.com/rvagg\">GitHub/rvagg</a></td><td><a href=\"http://twitter.com/rvagg\">Twitter/@rvagg</a></td></tr>\n<tr><th align=\"left\">Benjamin Byholm</th><td><a href=\"https://github.com/kkoopa/\">GitHub/kkoopa</a></td><td>-</td></tr>\n<tr><th align=\"left\">Trevor Norris</th><td><a href=\"https://github.com/trevnorris\">GitHub/trevnorris</a></td><td><a href=\"http://twitter.com/trevnorris\">Twitter/@trevnorris</a></td></tr>\n<tr><th align=\"left\">Nathan Rajlich</th><td><a href=\"https://github.com/TooTallNate\">GitHub/TooTallNate</a></td><td><a href=\"http://twitter.com/TooTallNate\">Twitter/@TooTallNate</a></td></tr>\n<tr><th align=\"left\">Brett Lawson</th><td><a href=\"https://github.com/brett19\">GitHub/brett19</a></td><td><a href=\"http://twitter.com/brett19x\">Twitter/@brett19x</a></td></tr>\n<tr><th align=\"left\">Ben Noordhuis</th><td><a href=\"https://github.com/bnoordhuis\">GitHub/bnoordhuis</a></td><td><a href=\"http://twitter.com/bnoordhuis\">Twitter/@bnoordhuis</a></td></tr>\n<tr><th align=\"left\">David Siegel</th><td><a href=\"https://github.com/agnat\">GitHub/agnat</a></td><td><a href=\"http://twitter.com/agnat\">Twitter/@agnat</a></td></tr>\n<tr><th align=\"left\">Michael Ira Krufky</th><td><a href=\"https://github.com/mkrufky\">GitHub/mkrufky</a></td><td><a href=\"http://twitter.com/mkrufky\">Twitter/@mkrufky</a></td></tr>\n</tbody></table>\n\n## Licence & copyright\n\nCopyright (c) 2018 NAN WG Members / Collaborators (listed above).\n\nNative Abstractions for Node.js is licensed under an MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.\nDeAsync.js\n=======\n[](https://www.npmjs.org/package/deasync)\n\nDeAsync turns async function into sync, implemented with a blocking mechanism by calling Node.js event loop at JavaScript layer. The core of deasync is writen in C++.\n\n## Motivation\n\nSuppose you maintain a library that exposes a function <code>getData</code>. Your users call it to get actual data: \n<code>var myData = getData();</code> \nUnder the hood data is saved in a file so you implemented <code>getData</code> using Node.js built-in <code>fs.readFileSync</code>. It's obvious both <code>getData</code> and <code>fs.readFileSync</code> are sync functions. One day you were told to switch the underlying data source to a repo such as MongoDB which can only be accessed asynchronously. You were also told to avoid pissing off your users, <code>getData</code> API cannot be changed to return merely a promise or demand a callback parameter. How do you meet both requirements?\n\nYou may tempted to use [node-fibers](https://github.com/laverdet/node-fibers) or a module derived from it, but node fibers can only wrap async function call into a sync function inside a fiber. In the case above you cannot assume all callers are inside fibers. On the other hand, if you start a fiber in `getData` then `getData` itself will still return immediately without waiting for the async call result. For similar reason ES6 generators introduced in Node v0.11 won't work either. \n\nWhat really needed is a way to block subsequent JavaScript from running without blocking entire thread by yielding to allow other events in the event loop to be handled. Ideally the blockage is removed as soon as the result of async function is available. A less ideal but often acceptable alternative is a `sleep` function which you can use to implement the blockage like ```while(!done) sleep(100);```. It is less ideal because sleep duration has to be guessed. It is important the `sleep` function not only shouldn't block entire thread, but also shouldn't incur busy wait that pegs the CPU to 100%. \n</small>\n\nDeAsync supports both alternatives.\n\n## Usages\n\n* Generic wrapper of async function with conventional API signature `function(p1,...pn,function cb(error,result){})`. Returns `result` and throws `error` as exception if not null:\n\n```javascript\nvar deasync = require('deasync');\nvar cp = require('child_process');\nvar exec = deasync(cp.exec);\n// output result of ls -la\ntry{\n console.log(exec('ls -la'));\n}\ncatch(err){\n console.log(err);\n}\n// done is printed last, as supposed, with cp.exec wrapped in deasync; first without.\nconsole.log('done');\n```\n\n* For async function with unconventional API, for instance `function asyncFunction(p1,function cb(res){})`, use `loopWhile(predicateFunc)` where `predicateFunc` is a function that returns boolean loop condition\n\n```javascript\nvar done = false;\nvar data;\nasyncFunction(p1,function cb(res){\n data = res;\n done = true;\n});\nrequire('deasync').loopWhile(function(){return !done;});\n// data is now populated\n```\n\n* Sleep (a wrapper of setTimeout)\n\n```javascript\nfunction SyncFunction(){\n var ret;\n setTimeout(function(){\n ret = \"hello\";\n },3000);\n while(ret === undefined) {\n require('deasync').sleep(100);\n }\n // returns hello with sleep; undefined without\n return ret; \n}\n```\n\n## Installation\nExcept on a few [ platforms + Node version combinations](https://github.com/abbr/deasync-bin) where binary distribution is included, DeAsync uses node-gyp to compile C++ source code so you may need the compilers listed in [node-gyp](https://github.com/TooTallNate/node-gyp). You may also need to [update npm's bundled node-gyp](https://github.com/TooTallNate/node-gyp/wiki/Updating-npm's-bundled-node-gyp).\n\nTo install, run\n\n```npm install deasync```\n\n## Recommendation\nUnlike other (a)sync js packages that mostly have only syntactic impact, DeAsync also changes code execution sequence. As such, it is intended to solve niche cases like the above one. If all you are facing is syntatic problem such as callback hell, using a less drastic package implemented in pure js is recommended.\n\n## Support\nPull requests and issue reporting are welcome. For issues to be considered by maintainer\n 1. they must be reproducible\n 2. there must be evidence the issue is related to DeAsync\n\nTo that end, the issue should contain platform information, error message relevant to DeAsync, and preferably code snippet. If code snippet is supplied, it must be self-contained, i.e. independent from your runtime environment or other modules not explictly specified via `require` in the code snippet.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n# html-escaper [](https://travis-ci.org/WebReflection/html-escaper) [](https://coveralls.io/github/WebReflection/html-escaper?branch=master)\nA simple module to escape/unescape common problematic entities.\n\n### How\nThis package is available in npm so `npm install html-escaper` is all you need to do, using eventually the global flag too.\n\nOnce the module is present\n```js\nvar html = require('html-escaper');\n\n// two basic methods\nhtml.escape('string');\nhtml.unescape('escaped string');\n```\n\n### Why\nthere is basically one rule only: do not **ever** replace one char after another if you are transforming a string into another.\n\n```js\n// WARNING: THIS IS WRONG\n// if you are that kind of dev that does this\nfunction escape(s) {\n return s.replace(/&/g, \"&\")\n .replace(/</g, \"<\")\n .replace(/>/g, \">\")\n .replace(/'/g, \"'\")\n .replace(/\"/g, \""\");\n}\n\n// you might be the same dev that does this too\nfunction unescape(s) {\n return s.replace(/&/g, \"&\")\n .replace(/</g, \"<\")\n .replace(/>/g, \">\")\n .replace(/'/g, \"'\")\n .replace(/"/g, '\"');\n}\n\n// guess what we have here ?\nunescape('&lt;');\n\n// now guess this XSS too ...\nunescape('&lt;script&gt;alert(\"yo\")&lt;/script&gt;');\n\n```\n\nThe last example will produce `<script>alert(\"yo\")</script>` instead of the expected `<script>alert(\"yo\")</script>`.\n\nNothing like this could possibly happen if we grab all chars at once and either ways.\nIt's just a fortunate case that after swapping `&` with `&` no other replace will be affected, but it's not portable and universally a bad practice.\n\nGrab all chars at once, no excuses!\n\n**more details**\nAs somebody might think it's an `unescape` issue only, it's not. Being an anti-pattern with side effects works both ways.\n\nAs example, changing the order of the replacement in escaping would produce the unexpected:\n```js\nfunction escape(s) {\n return s.replace(/</g, \"<\")\n .replace(/>/g, \">\")\n .replace(/'/g, \"'\")\n .replace(/\"/g, \""\")\n .replace(/&/g, \"&\");\n}\n\nescape('<'); // &lt; instead of <\n```\nIf we do not want to code with the fear that the order wasn't perfect or that our order in either escaping or unescaping is different from the order another method or function used, if we understand the issue and we agree it's potentially a disaster prone approach, if we add the fact in this case creating 4 RegExp objects each time and invoking 4 times `.replace` trough the `String.prototype` is also potentially slower than creating one function only holding one object, or holding the function too, we should agree there is not absolutely any valid reason to keep proposing a char-by-char implementation.\n\nWe have proofs this approach can fail already so ... why should we risk? Just avoid and grab all chars at once or simply use this tiny utility.\n\n### Backtick\nInternt explorer < 9 has [some backtick issue](https://html5sec.org/#102)\n\nFor compatibility sake with common server-side HTML entities encoders and decoders, and in order to have the most reliable I/O, this little utility will NOT fix this IE < 9 problem.\n\nIt is also important to note that if we create valid HTML and we set attributes at runtime through this utility, backticks in strings cannot possibly affect attribute behaviors.\n\n```js\nvar img = new Image();\nimg.src = html.escape(\n 'x` `<script>alert(1)</script>\"` `'\n);\n// it won't cause problems even in IE < 9\n```\n\n**However**, if you use `innerHTML` and you target IE < 9 then [this **might** be a problem](https://github.com/nette/nette/issues/1496).\n\nAccordingly, if you need more chars and/or backticks to be escaped and unescaped, feel free to use alternatives like [lodash](https://github.com/lodash/lodash) or [he](https://www.npmjs.com/package/he)\n\nHere a bit more of [my POV](https://github.com/WebReflection/html-escaper/commit/52d554fc6e8583b6ffdd357967cf71962fc07cf6#commitcomment-10625122) and why I haven't implemented same thing alternatives did. Good news: those are alternatives ;-)\n# buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][npm-url]\n\n#### The buffer module from [node.js](https://nodejs.org/), for the browser.\n\n[![saucelabs][saucelabs-image]][saucelabs-url]\n\n[travis-image]: https://img.shields.io/travis/feross/buffer/master.svg\n[travis-url]: https://travis-ci.org/feross/buffer\n[npm-image]: https://img.shields.io/npm/v/buffer.svg\n[npm-url]: https://npmjs.org/package/buffer\n[downloads-image]: https://img.shields.io/npm/dm/buffer.svg\n[saucelabs-image]: https://saucelabs.com/browser-matrix/buffer.svg\n[saucelabs-url]: https://saucelabs.com/u/buffer\n\nWith [browserify](http://browserify.org), simply `require('buffer')` or use the `Buffer` global and you will get this module.\n\nThe goal is to provide an API that is 100% identical to\n[node's Buffer API](https://nodejs.org/api/buffer.html). Read the\n[official docs](https://nodejs.org/api/buffer.html) for the full list of properties,\ninstance methods, and class methods that are supported.\n\n## features\n\n- Manipulate binary data like a boss, in all browsers -- even IE6!\n- Super fast. Backed by Typed Arrays (`Uint8Array`/`ArrayBuffer`, not `Object`)\n- Extremely small bundle size (**5.04KB minified + gzipped**, 35.5KB with comments)\n- Excellent browser support (IE 6+, Chrome 4+, Firefox 3+, Safari 5.1+, Opera 11+, iOS, etc.)\n- Preserves Node API exactly, with one minor difference (see below)\n- Square-bracket `buf[4]` notation works, even in old browsers like IE6!\n- Does not modify any browser prototypes or put anything on `window`\n- Comprehensive test suite (including all buffer tests from node.js core)\n\n## install\n\nTo use this module directly (without browserify), install it:\n\n```bash\nnpm install buffer\n```\n\nThis module was previously called **native-buffer-browserify**, but please use **buffer**\nfrom now on.\n\nA standalone bundle is available [here](https://wzrd.in/standalone/buffer), for non-browserify users.\n\n## usage\n\nThe module's API is identical to node's `Buffer` API. Read the\n[official docs](https://nodejs.org/api/buffer.html) for the full list of properties,\ninstance methods, and class methods that are supported.\n\nAs mentioned above, `require('buffer')` or use the `Buffer` global with\n[browserify](http://browserify.org) and this module will automatically be included\nin your bundle. Almost any npm module will work in the browser, even if it assumes that\nthe node `Buffer` API will be available.\n\nTo depend on this module explicitly (without browserify), require it like this:\n\n```js\nvar Buffer = require('buffer/').Buffer // note: the trailing slash is important!\n```\n\nTo require this module explicitly, use `require('buffer/')` which tells the node.js module\nlookup algorithm (also used by browserify) to use the **npm module** named `buffer`\ninstead of the **node.js core** module named `buffer`!\n\n## how does it work?\n\nThe Buffer constructor returns instances of `Uint8Array` that have their prototype\nchanged to `Buffer.prototype`. Furthermore, `Buffer` is a subclass of `Uint8Array`,\nso the returned instances will have all the node `Buffer` methods and the\n`Uint8Array` methods. Square bracket notation works as expected -- it returns a\nsingle octet.\n\nThe `Uint8Array` prototype remains unmodified.\n\n## one minor difference\n\n#### In old browsers, `buf.slice()` does not modify parent buffer's memory\n\nIf you only support modern browsers (specifically, those with typed array support),\nthen this issue does not affect you. If you support super old browsers, then read on.\n\nIn node, the `slice()` method returns a new `Buffer` that shares underlying memory\nwith the original Buffer. When you modify one buffer, you modify the other.\n[Read more.](https://nodejs.org/api/buffer.html#buffer_buf_slice_start_end)\n\nIn browsers with typed array support, this `Buffer` implementation supports this\nbehavior. In browsers without typed arrays, an alternate buffer implementation is\nused that is based on `Object` which has no mechanism to point separate\n`Buffer`s to the same underlying slab of memory.\n\nYou can see which browser versions lack typed array support\n[here](https://github.com/feross/buffer/blob/master/index.js#L22-L48).\n\n## tracking the latest node api\n\nThis module tracks the Buffer API in the latest (unstable) version of node.js. The Buffer\nAPI is considered **stable** in the\n[node stability index](https://nodejs.org/docs/latest/api/documentation.html#documentation_stability_index),\nso it is unlikely that there will ever be breaking changes.\nNonetheless, when/if the Buffer API changes in node, this module's API will change\naccordingly.\n\n## related packages\n\n- [`buffer-equals`](https://www.npmjs.com/package/buffer-equals) - Node.js 0.12 buffer.equals() ponyfill\n- [`buffer-reverse`](https://www.npmjs.com/package/buffer-reverse) - A lite module for reverse-operations on buffers\n- [`buffer-xor`](https://www.npmjs.com/package/buffer-xor) - A simple module for bitwise-xor on buffers\n- [`is-buffer`](https://www.npmjs.com/package/is-buffer) - Determine if an object is a Buffer without including the whole `Buffer` package\n- [`typedarray-to-buffer`](https://www.npmjs.com/package/typedarray-to-buffer) - Convert a typed array to a Buffer without a copy\n\n## performance\n\nSee perf tests in `/perf`.\n\n`BrowserBuffer` is the browser `buffer` module (this repo). `Uint8Array` is included as a\nsanity check (since `BrowserBuffer` uses `Uint8Array` under the hood, `Uint8Array` will\nalways be at least a bit faster). Finally, `NodeBuffer` is the node.js buffer module,\nwhich is included to compare against.\n\nNOTE: Performance has improved since these benchmarks were taken. PR welcoem to update the README.\n\n### Chrome 38\n\n| Method | Operations | Accuracy | Sampled | Fastest |\n|:-------|:-----------|:---------|:--------|:-------:|\n| BrowserBuffer#bracket-notation | 11,457,464 ops/sec | ±0.86% | 66 | ✓ |\n| Uint8Array#bracket-notation | 10,824,332 ops/sec | ±0.74% | 65 | |\n| | | | |\n| BrowserBuffer#concat | 450,532 ops/sec | ±0.76% | 68 | |\n| Uint8Array#concat | 1,368,911 ops/sec | ±1.50% | 62 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16000) | 903,001 ops/sec | ±0.96% | 67 | |\n| Uint8Array#copy(16000) | 1,422,441 ops/sec | ±1.04% | 66 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16) | 11,431,358 ops/sec | ±0.46% | 69 | |\n| Uint8Array#copy(16) | 13,944,163 ops/sec | ±1.12% | 68 | ✓ |\n| | | | |\n| BrowserBuffer#new(16000) | 106,329 ops/sec | ±6.70% | 44 | |\n| Uint8Array#new(16000) | 131,001 ops/sec | ±2.85% | 31 | ✓ |\n| | | | |\n| BrowserBuffer#new(16) | 1,554,491 ops/sec | ±1.60% | 65 | |\n| Uint8Array#new(16) | 6,623,930 ops/sec | ±1.66% | 65 | ✓ |\n| | | | |\n| BrowserBuffer#readDoubleBE | 112,830 ops/sec | ±0.51% | 69 | ✓ |\n| DataView#getFloat64 | 93,500 ops/sec | ±0.57% | 68 | |\n| | | | |\n| BrowserBuffer#readFloatBE | 146,678 ops/sec | ±0.95% | 68 | ✓ |\n| DataView#getFloat32 | 99,311 ops/sec | ±0.41% | 67 | |\n| | | | |\n| BrowserBuffer#readUInt32LE | 843,214 ops/sec | ±0.70% | 69 | ✓ |\n| DataView#getUint32 | 103,024 ops/sec | ±0.64% | 67 | |\n| | | | |\n| BrowserBuffer#slice | 1,013,941 ops/sec | ±0.75% | 67 | |\n| Uint8Array#subarray | 1,903,928 ops/sec | ±0.53% | 67 | ✓ |\n| | | | |\n| BrowserBuffer#writeFloatBE | 61,387 ops/sec | ±0.90% | 67 | |\n| DataView#setFloat32 | 141,249 ops/sec | ±0.40% | 66 | ✓ |\n\n### Firefox 33\n\n| Method | Operations | Accuracy | Sampled | Fastest |\n|:-------|:-----------|:---------|:--------|:-------:|\n| BrowserBuffer#bracket-notation | 20,800,421 ops/sec | ±1.84% | 60 | |\n| Uint8Array#bracket-notation | 20,826,235 ops/sec | ±2.02% | 61 | ✓ |\n| | | | |\n| BrowserBuffer#concat | 153,076 ops/sec | ±2.32% | 61 | |\n| Uint8Array#concat | 1,255,674 ops/sec | ±8.65% | 52 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16000) | 1,105,312 ops/sec | ±1.16% | 63 | |\n| Uint8Array#copy(16000) | 1,615,911 ops/sec | ±0.55% | 66 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16) | 16,357,599 ops/sec | ±0.73% | 68 | |\n| Uint8Array#copy(16) | 31,436,281 ops/sec | ±1.05% | 68 | ✓ |\n| | | | |\n| BrowserBuffer#new(16000) | 52,995 ops/sec | ±6.01% | 35 | |\n| Uint8Array#new(16000) | 87,686 ops/sec | ±5.68% | 45 | ✓ |\n| | | | |\n| BrowserBuffer#new(16) | 252,031 ops/sec | ±1.61% | 66 | |\n| Uint8Array#new(16) | 8,477,026 ops/sec | ±0.49% | 68 | ✓ |\n| | | | |\n| BrowserBuffer#readDoubleBE | 99,871 ops/sec | ±0.41% | 69 | |\n| DataView#getFloat64 | 285,663 ops/sec | ±0.70% | 68 | ✓ |\n| | | | |\n| BrowserBuffer#readFloatBE | 115,540 ops/sec | ±0.42% | 69 | |\n| DataView#getFloat32 | 288,722 ops/sec | ±0.82% | 68 | ✓ |\n| | | | |\n| BrowserBuffer#readUInt32LE | 633,926 ops/sec | ±1.08% | 67 | ✓ |\n| DataView#getUint32 | 294,808 ops/sec | ±0.79% | 64 | |\n| | | | |\n| BrowserBuffer#slice | 349,425 ops/sec | ±0.46% | 69 | |\n| Uint8Array#subarray | 5,965,819 ops/sec | ±0.60% | 65 | ✓ |\n| | | | |\n| BrowserBuffer#writeFloatBE | 59,980 ops/sec | ±0.41% | 67 | |\n| DataView#setFloat32 | 317,634 ops/sec | ±0.63% | 68 | ✓ |\n\n### Safari 8\n\n| Method | Operations | Accuracy | Sampled | Fastest |\n|:-------|:-----------|:---------|:--------|:-------:|\n| BrowserBuffer#bracket-notation | 10,279,729 ops/sec | ±2.25% | 56 | ✓ |\n| Uint8Array#bracket-notation | 10,030,767 ops/sec | ±2.23% | 59 | |\n| | | | |\n| BrowserBuffer#concat | 144,138 ops/sec | ±1.38% | 65 | |\n| Uint8Array#concat | 4,950,764 ops/sec | ±1.70% | 63 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16000) | 1,058,548 ops/sec | ±1.51% | 64 | |\n| Uint8Array#copy(16000) | 1,409,666 ops/sec | ±1.17% | 65 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16) | 6,282,529 ops/sec | ±1.88% | 58 | |\n| Uint8Array#copy(16) | 11,907,128 ops/sec | ±2.87% | 58 | ✓ |\n| | | | |\n| BrowserBuffer#new(16000) | 101,663 ops/sec | ±3.89% | 57 | |\n| Uint8Array#new(16000) | 22,050,818 ops/sec | ±6.51% | 46 | ✓ |\n| | | | |\n| BrowserBuffer#new(16) | 176,072 ops/sec | ±2.13% | 64 | |\n| Uint8Array#new(16) | 24,385,731 ops/sec | ±5.01% | 51 | ✓ |\n| | | | |\n| BrowserBuffer#readDoubleBE | 41,341 ops/sec | ±1.06% | 67 | |\n| DataView#getFloat64 | 322,280 ops/sec | ±0.84% | 68 | ✓ |\n| | | | |\n| BrowserBuffer#readFloatBE | 46,141 ops/sec | ±1.06% | 65 | |\n| DataView#getFloat32 | 337,025 ops/sec | ±0.43% | 69 | ✓ |\n| | | | |\n| BrowserBuffer#readUInt32LE | 151,551 ops/sec | ±1.02% | 66 | |\n| DataView#getUint32 | 308,278 ops/sec | ±0.94% | 67 | ✓ |\n| | | | |\n| BrowserBuffer#slice | 197,365 ops/sec | ±0.95% | 66 | |\n| Uint8Array#subarray | 9,558,024 ops/sec | ±3.08% | 58 | ✓ |\n| | | | |\n| BrowserBuffer#writeFloatBE | 17,518 ops/sec | ±1.03% | 63 | |\n| DataView#setFloat32 | 319,751 ops/sec | ±0.48% | 68 | ✓ |\n\n### Node 0.11.14\n\n| Method | Operations | Accuracy | Sampled | Fastest |\n|:-------|:-----------|:---------|:--------|:-------:|\n| BrowserBuffer#bracket-notation | 10,489,828 ops/sec | ±3.25% | 90 | |\n| Uint8Array#bracket-notation | 10,534,884 ops/sec | ±0.81% | 92 | ✓ |\n| NodeBuffer#bracket-notation | 10,389,910 ops/sec | ±0.97% | 87 | |\n| | | | |\n| BrowserBuffer#concat | 487,830 ops/sec | ±2.58% | 88 | |\n| Uint8Array#concat | 1,814,327 ops/sec | ±1.28% | 88 | ✓ |\n| NodeBuffer#concat | 1,636,523 ops/sec | ±1.88% | 73 | |\n| | | | |\n| BrowserBuffer#copy(16000) | 1,073,665 ops/sec | ±0.77% | 90 | |\n| Uint8Array#copy(16000) | 1,348,517 ops/sec | ±0.84% | 89 | ✓ |\n| NodeBuffer#copy(16000) | 1,289,533 ops/sec | ±0.82% | 93 | |\n| | | | |\n| BrowserBuffer#copy(16) | 12,782,706 ops/sec | ±0.74% | 85 | |\n| Uint8Array#copy(16) | 14,180,427 ops/sec | ±0.93% | 92 | ✓ |\n| NodeBuffer#copy(16) | 11,083,134 ops/sec | ±1.06% | 89 | |\n| | | | |\n| BrowserBuffer#new(16000) | 141,678 ops/sec | ±3.30% | 67 | |\n| Uint8Array#new(16000) | 161,491 ops/sec | ±2.96% | 60 | |\n| NodeBuffer#new(16000) | 292,699 ops/sec | ±3.20% | 55 | ✓ |\n| | | | |\n| BrowserBuffer#new(16) | 1,655,466 ops/sec | ±2.41% | 82 | |\n| Uint8Array#new(16) | 14,399,926 ops/sec | ±0.91% | 94 | ✓ |\n| NodeBuffer#new(16) | 3,894,696 ops/sec | ±0.88% | 92 | |\n| | | | |\n| BrowserBuffer#readDoubleBE | 109,582 ops/sec | ±0.75% | 93 | ✓ |\n| DataView#getFloat64 | 91,235 ops/sec | ±0.81% | 90 | |\n| NodeBuffer#readDoubleBE | 88,593 ops/sec | ±0.96% | 81 | |\n| | | | |\n| BrowserBuffer#readFloatBE | 139,854 ops/sec | ±1.03% | 85 | ✓ |\n| DataView#getFloat32 | 98,744 ops/sec | ±0.80% | 89 | |\n| NodeBuffer#readFloatBE | 92,769 ops/sec | ±0.94% | 93 | |\n| | | | |\n| BrowserBuffer#readUInt32LE | 710,861 ops/sec | ±0.82% | 92 | |\n| DataView#getUint32 | 117,893 ops/sec | ±0.84% | 91 | |\n| NodeBuffer#readUInt32LE | 851,412 ops/sec | ±0.72% | 93 | ✓ |\n| | | | |\n| BrowserBuffer#slice | 1,673,877 ops/sec | ±0.73% | 94 | |\n| Uint8Array#subarray | 6,919,243 ops/sec | ±0.67% | 90 | ✓ |\n| NodeBuffer#slice | 4,617,604 ops/sec | ±0.79% | 93 | |\n| | | | |\n| BrowserBuffer#writeFloatBE | 66,011 ops/sec | ±0.75% | 93 | |\n| DataView#setFloat32 | 127,760 ops/sec | ±0.72% | 93 | ✓ |\n| NodeBuffer#writeFloatBE | 103,352 ops/sec | ±0.83% | 93 | |\n\n### iojs 1.8.1\n\n| Method | Operations | Accuracy | Sampled | Fastest |\n|:-------|:-----------|:---------|:--------|:-------:|\n| BrowserBuffer#bracket-notation | 10,990,488 ops/sec | ±1.11% | 91 | |\n| Uint8Array#bracket-notation | 11,268,757 ops/sec | ±0.65% | 97 | |\n| NodeBuffer#bracket-notation | 11,353,260 ops/sec | ±0.83% | 94 | ✓ |\n| | | | |\n| BrowserBuffer#concat | 378,954 ops/sec | ±0.74% | 94 | |\n| Uint8Array#concat | 1,358,288 ops/sec | ±0.97% | 87 | |\n| NodeBuffer#concat | 1,934,050 ops/sec | ±1.11% | 78 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16000) | 894,538 ops/sec | ±0.56% | 84 | |\n| Uint8Array#copy(16000) | 1,442,656 ops/sec | ±0.71% | 96 | |\n| NodeBuffer#copy(16000) | 1,457,898 ops/sec | ±0.53% | 92 | ✓ |\n| | | | |\n| BrowserBuffer#copy(16) | 12,870,457 ops/sec | ±0.67% | 95 | |\n| Uint8Array#copy(16) | 16,643,989 ops/sec | ±0.61% | 93 | ✓ |\n| NodeBuffer#copy(16) | 14,885,848 ops/sec | ±0.74% | 94 | |\n| | | | |\n| BrowserBuffer#new(16000) | 109,264 ops/sec | ±4.21% | 63 | |\n| Uint8Array#new(16000) | 138,916 ops/sec | ±1.87% | 61 | |\n| NodeBuffer#new(16000) | 281,449 ops/sec | ±3.58% | 51 | ✓ |\n| | | | |\n| BrowserBuffer#new(16) | 1,362,935 ops/sec | ±0.56% | 99 | |\n| Uint8Array#new(16) | 6,193,090 ops/sec | ±0.64% | 95 | ✓ |\n| NodeBuffer#new(16) | 4,745,425 ops/sec | ±1.56% | 90 | |\n| | | | |\n| BrowserBuffer#readDoubleBE | 118,127 ops/sec | ±0.59% | 93 | ✓ |\n| DataView#getFloat64 | 107,332 ops/sec | ±0.65% | 91 | |\n| NodeBuffer#readDoubleBE | 116,274 ops/sec | ±0.94% | 95 | |\n| | | | |\n| BrowserBuffer#readFloatBE | 150,326 ops/sec | ±0.58% | 95 | ✓ |\n| DataView#getFloat32 | 110,541 ops/sec | ±0.57% | 98 | |\n| NodeBuffer#readFloatBE | 121,599 ops/sec | ±0.60% | 87 | |\n| | | | |\n| BrowserBuffer#readUInt32LE | 814,147 ops/sec | ±0.62% | 93 | |\n| DataView#getUint32 | 137,592 ops/sec | ±0.64% | 90 | |\n| NodeBuffer#readUInt32LE | 931,650 ops/sec | ±0.71% | 96 | ✓ |\n| | | | |\n| BrowserBuffer#slice | 878,590 ops/sec | ±0.68% | 93 | |\n| Uint8Array#subarray | 2,843,308 ops/sec | ±1.02% | 90 | |\n| NodeBuffer#slice | 4,998,316 ops/sec | ±0.68% | 90 | ✓ |\n| | | | |\n| BrowserBuffer#writeFloatBE | 65,927 ops/sec | ±0.74% | 93 | |\n| DataView#setFloat32 | 139,823 ops/sec | ±0.97% | 89 | ✓ |\n| NodeBuffer#writeFloatBE | 135,763 ops/sec | ±0.65% | 96 | |\n| | | | |\n\n## Testing the project\n\nFirst, install the project:\n\n npm install\n\nThen, to run tests in Node.js, run:\n\n npm run test-node\n\nTo test locally in a browser, you can run:\n\n npm run test-browser-local\n\nThis will print out a URL that you can then open in a browser to run the tests, using [Zuul](https://github.com/defunctzombie/zuul).\n\nTo run automated browser tests using Saucelabs, ensure that your `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables are set, then run:\n\n npm test\n\nThis is what's run in Travis, to check against various browsers. The list of browsers is kept in the `.zuul.yml` file.\n\n## JavaScript Standard Style\n\nThis module uses [JavaScript Standard Style](https://github.com/feross/standard).\n\n[](https://github.com/feross/standard)\n\nTo test that the code conforms to the style, `npm install` and run:\n\n ./node_modules/.bin/standard\n\n## credit\n\nThis was originally forked from [buffer-browserify](https://github.com/toots/buffer-browserify).\n\n## license\n\nMIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org), and other contributors. Originally forked from an MIT-licensed module by Romain Beauxis.\n#boolbase\nThis very simple module provides two basic functions, one that always returns true (`trueFunc`) and one that always returns false (`falseFunc`).\n\n###WTF?\n\nBy having only a single instance of these functions around, it's possible to do some nice optimizations. Eg. [`CSSselect`](https://github.com/fb55/CSSselect) uses these functions to determine whether a selector won't match any elements. If that's the case, the DOM doesn't even have to be touched.\n\n###And why is this a separate module?\n\nI'm trying to modularize `CSSselect` and most modules depend on these functions. IMHO, having a separate module is the easiest solution to this problem.\nDeep Extend\n===========\n\nRecursive object extending.\n\n[](https://travis-ci.org/unclechu/node-deep-extend)\n\n[](https://nodei.co/npm/deep-extend/)\n\nInstall\n-------\n\n```bash\n$ npm install deep-extend\n```\n\nUsage\n-----\n\n```javascript\nvar deepExtend = require('deep-extend');\nvar obj1 = {\n a: 1,\n b: 2,\n d: {\n a: 1,\n b: [],\n c: { test1: 123, test2: 321 }\n },\n f: 5,\n g: 123,\n i: 321,\n j: [1, 2]\n};\nvar obj2 = {\n b: 3,\n c: 5,\n d: {\n b: { first: 'one', second: 'two' },\n c: { test2: 222 }\n },\n e: { one: 1, two: 2 },\n f: [],\n g: (void 0),\n h: /abc/g,\n i: null,\n j: [3, 4]\n};\n\ndeepExtend(obj1, obj2);\n\nconsole.log(obj1);\n/*\n{ a: 1,\n b: 3,\n d:\n { a: 1,\n b: { first: 'one', second: 'two' },\n c: { test1: 123, test2: 222 } },\n f: [],\n g: undefined,\n c: 5,\n e: { one: 1, two: 2 },\n h: /abc/g,\n i: null,\n j: [3, 4] }\n*/\n```\n\nUnit testing\n------------\n\n```bash\n$ npm test\n```\n\nChangelog\n---------\n\n[CHANGELOG.md](./CHANGELOG.md)\n\nAny issues?\n-----------\n\nPlease, report about issues\n[here](https://github.com/unclechu/node-deep-extend/issues).\n\nLicense\n-------\n\n[MIT](./LICENSE)\n# acorn-globals\n\nDetect global variables in JavaScript using acorn\n\n[Get supported acorn-globals with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-acorn_globals?utm_source=npm-acorn-globals&utm_medium=referral&utm_campaign=readme)\n\n[](https://travis-ci.org/ForbesLindesay/acorn-globals)\n[](https://david-dm.org/ForbesLindesay/acorn-globals)\n[](https://www.npmjs.org/package/acorn-globals)\n\n## Installation\n\n npm install acorn-globals\n\n## Usage\n\ndetect.js\n\n```js\nvar fs = require('fs');\nvar detect = require('acorn-globals');\n\nvar src = fs.readFileSync(__dirname + '/input.js', 'utf8');\n\nvar scope = detect(src);\nconsole.dir(scope);\n```\n\ninput.js\n\n```js\nvar x = 5;\nvar y = 3, z = 2;\n\nw.foo();\nw = 2;\n\nRAWR=444;\nRAWR.foo();\n\nBLARG=3;\n\nfoo(function () {\n var BAR = 3;\n process.nextTick(function (ZZZZZZZZZZZZ) {\n console.log('beep boop');\n var xyz = 4;\n x += 10;\n x.zzzzzz;\n ZZZ=6;\n });\n function doom () {\n }\n ZZZ.foo();\n\n});\n\nconsole.log(xyz);\n```\n\noutput:\n\n```\n$ node example/detect.js\n[ { name: 'BLARG', nodes: [ [Object] ] },\n { name: 'RAWR', nodes: [ [Object], [Object] ] },\n { name: 'ZZZ', nodes: [ [Object], [Object] ] },\n { name: 'console', nodes: [ [Object], [Object] ] },\n { name: 'foo', nodes: [ [Object] ] },\n { name: 'process', nodes: [ [Object] ] },\n { name: 'w', nodes: [ [Object], [Object] ] },\n { name: 'xyz', nodes: [ [Object] ] } ]\n```\n\n## Security contact information\n\nTo report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.\n\n## License\n\n MIT\n# fill-range [](https://www.npmjs.com/package/fill-range) [](https://npmjs.org/package/fill-range) [](https://npmjs.org/package/fill-range) [](https://travis-ci.org/jonschlinkert/fill-range)\n\n> Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Options](#options)\n * [options.step](#optionsstep)\n * [options.strictRanges](#optionsstrictranges)\n * [options.stringify](#optionsstringify)\n * [options.toRegex](#optionstoregex)\n * [options.transform](#optionstransform)\n- [About](#about)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save fill-range\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add fill-range\n```\n\n## Usage\n\nExpands numbers and letters, optionally using a `step` as the last argument. _(Numbers may be defined as JavaScript numbers or strings)_.\n\n```js\nvar fill = require('fill-range');\nfill(from, to[, step, options]);\n\n// examples\nconsole.log(fill('1', '10')); //=> '[ '1', '2', '3', '4', '5', '6', '7', '8', '9', '10' ]'\nconsole.log(fill('1', '10', {toRegex: true})); //=> [1-9]|10\n```\n\n**Params**\n\n* `from`: **{String|Number}** the number or letter to start with\n* `to`: **{String|Number}** the number or letter to end with\n* `step`: **{String|Number|Object|Function}** Optionally pass a [step](#optionsstep) to use.\n* `options`: **{Object|Function}**: See all available [options](#options)\n\n## Examples\n\nBy default, an array of values is returned.\n\n**Alphabetical ranges**\n\n```js\nconsole.log(fill('a', 'e')); //=> ['a', 'b', 'c', 'd', 'e']\nconsole.log(fill('A', 'E')); //=> [ 'A', 'B', 'C', 'D', 'E' ]\n```\n\n**Numerical ranges**\n\nNumbers can be defined as actual numbers or strings.\n\n```js\nconsole.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]\nconsole.log(fill('1', '5')); //=> [ 1, 2, 3, 4, 5 ]\n```\n\n**Negative ranges**\n\nNumbers can be defined as actual numbers or strings.\n\n```js\nconsole.log(fill('-5', '-1')); //=> [ '-5', '-4', '-3', '-2', '-1' ]\nconsole.log(fill('-5', '5')); //=> [ '-5', '-4', '-3', '-2', '-1', '0', '1', '2', '3', '4', '5' ]\n```\n\n**Steps (increments)**\n\n```js\n// numerical ranges with increments\nconsole.log(fill('0', '25', 4)); //=> [ '0', '4', '8', '12', '16', '20', '24' ]\nconsole.log(fill('0', '25', 5)); //=> [ '0', '5', '10', '15', '20', '25' ]\nconsole.log(fill('0', '25', 6)); //=> [ '0', '6', '12', '18', '24' ]\n\n// alphabetical ranges with increments\nconsole.log(fill('a', 'z', 4)); //=> [ 'a', 'e', 'i', 'm', 'q', 'u', 'y' ]\nconsole.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]\nconsole.log(fill('a', 'z', 6)); //=> [ 'a', 'g', 'm', 's', 'y' ]\n```\n\n## Options\n\n### options.step\n\n**Type**: `number` (formatted as a string or number)\n\n**Default**: `undefined`\n\n**Description**: The increment to use for the range. Can be used with letters or numbers.\n\n**Example(s)**\n\n```js\n// numbers\nconsole.log(fill('1', '10', 2)); //=> [ '1', '3', '5', '7', '9' ]\nconsole.log(fill('1', '10', 3)); //=> [ '1', '4', '7', '10' ]\nconsole.log(fill('1', '10', 4)); //=> [ '1', '5', '9' ]\n\n// letters\nconsole.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]\nconsole.log(fill('a', 'z', 7)); //=> [ 'a', 'h', 'o', 'v' ]\nconsole.log(fill('a', 'z', 9)); //=> [ 'a', 'j', 's' ]\n```\n\n### options.strictRanges\n\n**Type**: `boolean`\n\n**Default**: `false`\n\n**Description**: By default, `null` is returned when an invalid range is passed. Enable this option to throw a `RangeError` on invalid ranges.\n\n**Example(s)**\n\nThe following are all invalid:\n\n```js\nfill('1.1', '2'); // decimals not supported in ranges\nfill('a', '2'); // incompatible range values\nfill(1, 10, 'foo'); // invalid \"step\" argument\n```\n\n### options.stringify\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\n**Description**: Cast all returned values to strings. By default, integers are returned as numbers.\n\n**Example(s)**\n\n```js\nconsole.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]\nconsole.log(fill(1, 5, {stringify: true})); //=> [ '1', '2', '3', '4', '5' ]\n```\n\n### options.toRegex\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\n**Description**: Create a regex-compatible source string, instead of expanding values to an array.\n\n**Example(s)**\n\n```js\n// alphabetical range\nconsole.log(fill('a', 'e', {toRegex: true})); //=> '[a-e]'\n// alphabetical with step\nconsole.log(fill('a', 'z', 3, {toRegex: true})); //=> 'a|d|g|j|m|p|s|v|y'\n// numerical range\nconsole.log(fill('1', '100', {toRegex: true})); //=> '[1-9]|[1-9][0-9]|100'\n// numerical range with zero padding\nconsole.log(fill('000001', '100000', {toRegex: true}));\n//=> '0{5}[1-9]|0{4}[1-9][0-9]|0{3}[1-9][0-9]{2}|0{2}[1-9][0-9]{3}|0[1-9][0-9]{4}|100000'\n```\n\n### options.transform\n\n**Type**: `function`\n\n**Default**: `undefined`\n\n**Description**: Customize each value in the returned array (or [string](#optionstoRegex)). _(you can also pass this function as the last argument to `fill()`)_.\n\n**Example(s)**\n\n```js\n// increase padding by two\nvar arr = fill('01', '05', function(val, a, b, step, idx, arr, options) {\n return repeat('0', (options.maxLength + 2) - val.length) + val;\n});\n\nconsole.log(arr);\n//=> ['0001', '0002', '0003', '0004', '0005']\n```\n\n## About\n\n### Related projects\n\n* [braces](https://www.npmjs.com/package/braces): Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces… [more](https://github.com/jonschlinkert/braces) | [homepage](https://github.com/jonschlinkert/braces \"Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces specification, without sacrificing speed.\")\n* [expand-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See… [more](https://github.com/jonschlinkert/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range \"Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See the benchmarks. Used by micromatch.\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n* [to-regex-range](https://www.npmjs.com/package/to-regex-range): Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… [more](https://github.com/jonschlinkert/to-regex-range) | [homepage](https://github.com/jonschlinkert/to-regex-range \"Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.87 million test assertions.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 103 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 2 | [paulmillr](https://github.com/paulmillr) | \n| 1 | [edorivai](https://github.com/edorivai) | \n| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | \n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 23, 2017._\n[](https://circleci.com/gh/amasad/sane)\n\nsane\n----\n\nI've been driven to insanity by node filesystem watcher wrappers.\nSane aims to be fast, small, and reliable file system watcher. It does that by:\n\n* By default stays away from fs polling because it's very slow and cpu intensive\n* Uses `fs.watch` by default and sensibly works around the various issues\n* Maintains a consistent API across different platforms\n* Where `fs.watch` is not reliable you have the choice of using the following alternatives:\n * [the facebook watchman library](https://facebook.github.io/watchman/)\n * [the watchexec library](https://github.com/watchexec/watchexec)\n * polling\n\n## Install\n\n```\n$ npm install sane\n```\n\n## How to choose a mode\n\nDon't worry too much about choosing the correct mode upfront because sane\nmaintains the same API across all modes and will be easy to switch.\n\n* If you're only supporting Linux and OS X, `watchman` would be the most reliable mode\n* If you're using node > v0.10.0 use the default mode\n* If you're running OS X and you're watching a lot of directories and you're running into https://github.com/joyent/node/issues/5463, use `watchman`\n* If you're in an environment where native file system events aren't available (like Vagrant), you should use polling\n* Otherwise, the default mode should work well for you\n\n## API\n\n### sane(dir, options)\n\nWatches a directory and all its descendant directories for changes, deletions, and additions on files and directories.\n\n```js\nvar watcher = sane('path/to/dir', {glob: ['**/*.js', '**/*.css']});\nwatcher.on('ready', function () { console.log('ready') });\nwatcher.on('change', function (filepath, root, stat) { console.log('file changed', filepath); });\nwatcher.on('add', function (filepath, root, stat) { console.log('file added', filepath); });\nwatcher.on('delete', function (filepath, root) { console.log('file deleted', filepath); });\n// close\nwatcher.close();\n```\n\noptions:\n\n* `glob`: a single string glob pattern or an array of them.\n* `poll`: puts the watcher in polling mode. Under the hood that means `fs.watchFile`.\n* `watchman`: makes the watcher use [watchman](https://facebook.github.io/watchman/).\n* `watchmanPath`: sets a custom path for `watchman` binary.\n* `watchexec`: makes the watcher use [watchexec](https://github.com/watchexec/watchexec).\n* `dot`: enables watching files/directories that start with a dot.\n* `ignored`: a glob, regex, function, or array of any combination.\n\nFor the glob pattern documentation, see [micromatch](https://github.com/micromatch/micromatch).\nIf you choose to use `watchman` you'll have to [install watchman yourself](https://facebook.github.io/watchman/docs/install.html)).\nIf you choose to use `watchexec` you'll have to [install watchexec yourself](https://github.com/watchexec/watchexec)).\nFor the ignored options, see [anymatch](https://github.com/es128/anymatch).\n\n### sane.NodeWatcher(dir, options)\n\nThe default watcher class. Uses `fs.watch` under the hood, and takes the same options as `sane(dir, options)`.\n\n### sane.WatchmanWatcher(dir, options)\n\nThe watchman watcher class. Takes the same options as `sane(dir, options)`.\n\n### sane.Watchexec(dir, options)\n\nThe watchexec watcher class. Takes the same options as `sane(dir, options)`.\n\n### sane.PollWatcher(dir, options)\n\nThe polling watcher class. Takes the same options as `sane(dir, options)` with the addition of:\n\n* interval: indicates how often the files should be polled. (passed to fs.watchFile)\n\n### sane.{Node|Watchman|Watchexec|Poll}Watcher#close\n\nStops watching.\n\n### sane.{Node|Watchman|Watchexec|Poll}Watcher events\n\nEmits the following events:\n\nAll events are passed the file/dir path relative to the root directory\n* `ready` when the program is ready to detect events in the directory\n* `change` when a file changes\n* `add` when a file or directory has been added\n* `delete` when a file or directory has been deleted\n\n## CLI\n\nThis module includes a simple command line interface, which you can install with `npm install sane -g`.\n\n```\nUsage: sane <command> [...directory] [--glob=<filePattern>] [--poll] [--watchman] [--watchman-path=<watchmanBinaryPath>] [--dot] [--wait=<seconds>]\n\nOPTIONS:\n --glob=<filePattern>\n A single string glob pattern or an array of them.\n\n --ignored=<filePattern>\n A glob, regex, function, or array of any combination.\n\n --poll, -p\n Use polling mode.\n\n --watchman, -w\n Use watchman (if available).\n\n --watchman-path=<watchmanBinaryPath>\n Sets a custom path for watchman binary (if using this mode).\n\n --dot, -d\n Enables watching files/directories that start with a dot.\n\n --wait=<seconds>\n Duration, in seconds, that watching will be disabled\n after running <command>. Setting this option will\n throttle calls to <command> for the specified duration.\n --quiet, -q\n Disables sane's console output\n\n --changes-only, -o\n Runs <command> only when a change occur. Skips running <command> at startup\n```\n\nIt will watch the given `directory` and run the given <command> every time a file changes.\n\n### CLI example usage\n- `sane 'echo \"A command ran\"'`\n- `sane 'echo \"A command ran\"' --glob='**/*.css'`\n- `sane 'echo \"A command ran\"' site/assets/css --glob='**/*.css'`\n- `sane 'echo \"A command ran\"' --glob='**/*.css' --ignored='**/ignore.css'`\n- `sane 'echo \"A command ran\"' --wait=3`\n- `sane 'echo \"A command ran\"' -p`\n\n## License\n\nMIT\n\n## Credits\nThe CLI was originally based on the [watch CLI](https://github.com/mikeal/watch). Watch is licensed under the Apache License Version 2.0.\n# <img src=\"./logo.png\" alt=\"bn.js\" width=\"160\" height=\"160\" />\n\n> BigNum in pure javascript\n\n[](http://travis-ci.org/indutny/bn.js)\n\n## Install\n`npm install --save bn.js`\n\n## Usage\n\n```js\nconst BN = require('bn.js');\n\nvar a = new BN('dead', 16);\nvar b = new BN('101010', 2);\n\nvar res = a.add(b);\nconsole.log(res.toString(10)); // 57047\n```\n\n**Note**: decimals are not supported in this library.\n\n## Notation\n\n### Prefixes\n\nThere are several prefixes to instructions that affect the way the work. Here\nis the list of them in the order of appearance in the function name:\n\n* `i` - perform operation in-place, storing the result in the host object (on\n which the method was invoked). Might be used to avoid number allocation costs\n* `u` - unsigned, ignore the sign of operands when performing operation, or\n always return positive value. Second case applies to reduction operations\n like `mod()`. In such cases if the result will be negative - modulo will be\n added to the result to make it positive\n\n### Postfixes\n\nThe only available postfix at the moment is:\n\n* `n` - which means that the argument of the function must be a plain JavaScript\n Number. Decimals are not supported.\n\n### Examples\n\n* `a.iadd(b)` - perform addition on `a` and `b`, storing the result in `a`\n* `a.umod(b)` - reduce `a` modulo `b`, returning positive value\n* `a.iushln(13)` - shift bits of `a` left by 13\n\n## Instructions\n\nPrefixes/postfixes are put in parens at the of the line. `endian` - could be\neither `le` (little-endian) or `be` (big-endian).\n\n### Utilities\n\n* `a.clone()` - clone number\n* `a.toString(base, length)` - convert to base-string and pad with zeroes\n* `a.toNumber()` - convert to Javascript Number (limited to 53 bits)\n* `a.toJSON()` - convert to JSON compatible hex string (alias of `toString(16)`)\n* `a.toArray(endian, length)` - convert to byte `Array`, and optionally zero\n pad to length, throwing if already exceeding\n* `a.toArrayLike(type, endian, length)` - convert to an instance of `type`,\n which must behave like an `Array`\n* `a.toBuffer(endian, length)` - convert to Node.js Buffer (if available). For\n compatibility with browserify and similar tools, use this instead:\n `a.toArrayLike(Buffer, endian, length)`\n* `a.bitLength()` - get number of bits occupied\n* `a.zeroBits()` - return number of less-significant consequent zero bits\n (example: `1010000` has 4 zero bits)\n* `a.byteLength()` - return number of bytes occupied\n* `a.isNeg()` - true if the number is negative\n* `a.isEven()` - no comments\n* `a.isOdd()` - no comments\n* `a.isZero()` - no comments\n* `a.cmp(b)` - compare numbers and return `-1` (a `<` b), `0` (a `==` b), or `1` (a `>` b)\n depending on the comparison result (`ucmp`, `cmpn`)\n* `a.lt(b)` - `a` less than `b` (`n`)\n* `a.lte(b)` - `a` less than or equals `b` (`n`)\n* `a.gt(b)` - `a` greater than `b` (`n`)\n* `a.gte(b)` - `a` greater than or equals `b` (`n`)\n* `a.eq(b)` - `a` equals `b` (`n`)\n* `a.toTwos(width)` - convert to two's complement representation, where `width` is bit width\n* `a.fromTwos(width)` - convert from two's complement representation, where `width` is the bit width\n* `BN.isBN(object)` - returns true if the supplied `object` is a BN.js instance\n\n### Arithmetics\n\n* `a.neg()` - negate sign (`i`)\n* `a.abs()` - absolute value (`i`)\n* `a.add(b)` - addition (`i`, `n`, `in`)\n* `a.sub(b)` - subtraction (`i`, `n`, `in`)\n* `a.mul(b)` - multiply (`i`, `n`, `in`)\n* `a.sqr()` - square (`i`)\n* `a.pow(b)` - raise `a` to the power of `b`\n* `a.div(b)` - divide (`divn`, `idivn`)\n* `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`)\n* `a.divRound(b)` - rounded division\n\n### Bit operations\n\n* `a.or(b)` - or (`i`, `u`, `iu`)\n* `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced\n with `andn` in future)\n* `a.xor(b)` - xor (`i`, `u`, `iu`)\n* `a.setn(b)` - set specified bit to `1`\n* `a.shln(b)` - shift left (`i`, `u`, `iu`)\n* `a.shrn(b)` - shift right (`i`, `u`, `iu`)\n* `a.testn(b)` - test if specified bit is set\n* `a.maskn(b)` - clear bits with indexes higher or equal to `b` (`i`)\n* `a.bincn(b)` - add `1 << b` to the number\n* `a.notn(w)` - not (for the width specified by `w`) (`i`)\n\n### Reduction\n\n* `a.gcd(b)` - GCD\n* `a.egcd(b)` - Extended GCD results (`{ a: ..., b: ..., gcd: ... }`)\n* `a.invm(b)` - inverse `a` modulo `b`\n\n## Fast reduction\n\nWhen doing lots of reductions using the same modulo, it might be beneficial to\nuse some tricks: like [Montgomery multiplication][0], or using special algorithm\nfor [Mersenne Prime][1].\n\n### Reduction context\n\nTo enable this tricks one should create a reduction context:\n\n```js\nvar red = BN.red(num);\n```\nwhere `num` is just a BN instance.\n\nOr:\n\n```js\nvar red = BN.red(primeName);\n```\n\nWhere `primeName` is either of these [Mersenne Primes][1]:\n\n* `'k256'`\n* `'p224'`\n* `'p192'`\n* `'p25519'`\n\nOr:\n\n```js\nvar red = BN.mont(num);\n```\n\nTo reduce numbers with [Montgomery trick][0]. `.mont()` is generally faster than\n`.red(num)`, but slower than `BN.red(primeName)`.\n\n### Converting numbers\n\nBefore performing anything in reduction context - numbers should be converted\nto it. Usually, this means that one should:\n\n* Convert inputs to reducted ones\n* Operate on them in reduction context\n* Convert outputs back from the reduction context\n\nHere is how one may convert numbers to `red`:\n\n```js\nvar redA = a.toRed(red);\n```\nWhere `red` is a reduction context created using instructions above\n\nHere is how to convert them back:\n\n```js\nvar a = redA.fromRed();\n```\n\n### Red instructions\n\nMost of the instructions from the very start of this readme have their\ncounterparts in red context:\n\n* `a.redAdd(b)`, `a.redIAdd(b)`\n* `a.redSub(b)`, `a.redISub(b)`\n* `a.redShl(num)`\n* `a.redMul(b)`, `a.redIMul(b)`\n* `a.redSqr()`, `a.redISqr()`\n* `a.redSqrt()` - square root modulo reduction context's prime\n* `a.redInvm()` - modular inverse of the number\n* `a.redNeg()`\n* `a.redPow(b)` - modular exponentiation\n\n## LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2015.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication\n[1]: https://en.wikipedia.org/wiki/Mersenne_prime\n# invariant\n\n[](https://travis-ci.org/zertosh/invariant)\n\nA mirror of Facebook's `invariant` (e.g. [React](https://github.com/facebook/react/blob/v0.13.3/src/vendor/core/invariant.js), [flux](https://github.com/facebook/flux/blob/2.0.2/src/invariant.js)).\n\nA way to provide descriptive errors in development but generic errors in production.\n\n## Install\n\nWith [npm](http://npmjs.org) do:\n\n```sh\nnpm install invariant\n```\n\n## `invariant(condition, message)`\n\n```js\nvar invariant = require('invariant');\n\ninvariant(someTruthyVal, 'This will not throw');\n// No errors\n\ninvariant(someFalseyVal, 'This will throw an error with this message');\n// Error: Invariant Violation: This will throw an error with this message\n```\n\n**Note:** When `process.env.NODE_ENV` is not `production`, the message is required. If omitted, `invariant` will throw regardless of the truthiness of the condition. When `process.env.NODE_ENV` is `production`, the message is optional – so they can be minified away.\n\n### Browser\n\nWhen used with [browserify](https://github.com/substack/node-browserify), it'll use `browser.js` (instead of `invariant.js`) and the [envify](https://github.com/hughsk/envify) transform will inline the value of `process.env.NODE_ENV`.\n\n### Node\n\nThe node version is optimized around the performance implications of accessing `process.env`. The value of `process.env.NODE_ENV` is cached, and repeatedly used instead of reading `process.env`. See [Server rendering is slower with npm react #812](https://github.com/facebook/react/issues/812)\n# core-js\n\n[](#raising-funds) [](#raising-funds) [](https://gitter.im/zloirock/core-js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://www.npmjs.com/package/core-js) [](http://npm-stat.com/charts.html?package=core-js&author=&from=2014-11-18) [](https://travis-ci.org/zloirock/core-js) [](https://david-dm.org/zloirock/core-js?type=dev)\n## As advertising: the author is looking for a good job :)\n\n## [core-js@3, babel and a look into the future](https://github.com/zloirock/core-js/tree/master/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md)\n\n## Raising funds\n\n`core-js` isn't backed by a company, so the future of this project depends on you. Become a sponsor or a backer [**on Open Collective**](https://opencollective.com/core-js) or [**on Patreon**](https://www.patreon.com/zloirock) if you are interested in `core-js`.\n\n---\n\n<a href=\"https://opencollective.com/core-js/sponsor/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/0/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/1/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/2/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/3/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/4/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/5/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/6/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/7/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/8/avatar.svg\"></a><a href=\"https://opencollective.com/core-js/sponsor/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/sponsor/9/avatar.svg\"></a>\n\n---\n\n<a href=\"https://opencollective.com/core-js#backers\" target=\"_blank\"><img src=\"https://opencollective.com/core-js/backers.svg?width=890\"></a>\n\n---\n\n**It's documentation for obsolete `core-js@2`. If you looking documentation for actual `core-js` version, please, check [this branch](https://github.com/zloirock/core-js/tree/master).**\n\nModular standard library for JavaScript. Includes polyfills for [ECMAScript 5](#ecmascript-5), [ECMAScript 6](#ecmascript-6): [promises](#ecmascript-6-promise), [symbols](#ecmascript-6-symbol), [collections](#ecmascript-6-collections), iterators, [typed arrays](#ecmascript-6-typed-arrays), [ECMAScript 7+ proposals](#ecmascript-7-proposals), [setImmediate](#setimmediate), etc. Some additional features such as [dictionaries](#dict) or [extended partial application](#partial-application). You can require only needed features or use it without global namespace pollution.\n\n[*Example*](http://goo.gl/a2xexl):\n```js\nArray.from(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3]\n'*'.repeat(10); // => '**********'\nPromise.resolve(32).then(x => console.log(x)); // => 32\nsetImmediate(x => console.log(x), 42); // => 42\n```\n\n[*Without global namespace pollution*](http://goo.gl/paOHb0):\n```js\nvar core = require('core-js/library'); // With a modular system, otherwise use global `core`\ncore.Array.from(new core.Set([1, 2, 3, 2, 1])); // => [1, 2, 3]\ncore.String.repeat('*', 10); // => '**********'\ncore.Promise.resolve(32).then(x => console.log(x)); // => 32\ncore.setImmediate(x => console.log(x), 42); // => 42\n```\n\n### Index\n- [Usage](#usage)\n - [Basic](#basic)\n - [CommonJS](#commonjs)\n - [Custom build](#custom-build-from-the-command-line)\n- [Supported engines](#supported-engines)\n- [Features](#features)\n - [ECMAScript 5](#ecmascript-5)\n - [ECMAScript 6](#ecmascript-6)\n - [ECMAScript 6: Object](#ecmascript-6-object)\n - [ECMAScript 6: Function](#ecmascript-6-function)\n - [ECMAScript 6: Array](#ecmascript-6-array)\n - [ECMAScript 6: String](#ecmascript-6-string)\n - [ECMAScript 6: RegExp](#ecmascript-6-regexp)\n - [ECMAScript 6: Number](#ecmascript-6-number)\n - [ECMAScript 6: Math](#ecmascript-6-math)\n - [ECMAScript 6: Date](#ecmascript-6-date)\n - [ECMAScript 6: Promise](#ecmascript-6-promise)\n - [ECMAScript 6: Symbol](#ecmascript-6-symbol)\n - [ECMAScript 6: Collections](#ecmascript-6-collections)\n - [ECMAScript 6: Typed Arrays](#ecmascript-6-typed-arrays)\n - [ECMAScript 6: Reflect](#ecmascript-6-reflect)\n - [ECMAScript 7+ proposals](#ecmascript-7-proposals)\n - [stage 4 proposals](#stage-4-proposals)\n - [stage 3 proposals](#stage-3-proposals)\n - [stage 2 proposals](#stage-2-proposals)\n - [stage 1 proposals](#stage-1-proposals)\n - [stage 0 proposals](#stage-0-proposals)\n - [pre-stage 0 proposals](#pre-stage-0-proposals)\n - [Web standards](#web-standards)\n - [setTimeout / setInterval](#settimeout--setinterval)\n - [setImmediate](#setimmediate)\n - [iterable DOM collections](#iterable-dom-collections)\n - [Non-standard](#non-standard)\n - [Object](#object)\n - [Dict](#dict)\n - [partial application](#partial-application)\n - [Number Iterator](#number-iterator)\n - [escaping strings](#escaping-strings)\n - [delay](#delay)\n - [helpers for iterators](#helpers-for-iterators)\n- [Missing polyfills](#missing-polyfills)\n- [Changelog](./CHANGELOG.md)\n\n## Usage\n### Basic\n```\nnpm i core-js\nbower install core.js\n```\n\n```js\n// Default\nrequire('core-js');\n// Without global namespace pollution\nvar core = require('core-js/library');\n// Shim only\nrequire('core-js/shim');\n```\nIf you need complete build for browser, use builds from `core-js/client` path: \n\n* [default](https://raw.githack.com/zloirock/core-js/v2.6.11/client/core.min.js): Includes all features, standard and non-standard.\n* [as a library](https://raw.githack.com/zloirock/core-js/v2.6.11/client/library.min.js): Like \"default\", but does not pollute the global namespace (see [2nd example at the top](#core-js)).\n* [shim only](https://raw.githack.com/zloirock/core-js/v2.6.11/client/shim.min.js): Only includes the standard methods.\n\nWarning: if you use `core-js` with the extension of native objects, require all needed `core-js` modules at the beginning of entry point of your application, otherwise, conflicts may occur.\n\n### CommonJS\nYou can require only needed modules.\n\n```js\nrequire('core-js/fn/set');\nrequire('core-js/fn/array/from');\nrequire('core-js/fn/array/find-index');\nArray.from(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3]\n[1, 2, NaN, 3, 4].findIndex(isNaN); // => 2\n\n// or, w/o global namespace pollution:\n\nvar Set = require('core-js/library/fn/set');\nvar from = require('core-js/library/fn/array/from');\nvar findIndex = require('core-js/library/fn/array/find-index');\nfrom(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3]\nfindIndex([1, 2, NaN, 3, 4], isNaN); // => 2\n```\nAvailable entry points for methods / constructors, as above examples, and namespaces: for example, `core-js/es6/array` (`core-js/library/es6/array`) contains all [ES6 `Array` features](#ecmascript-6-array), `core-js/es6` (`core-js/library/es6`) contains all ES6 features.\n\n##### Caveats when using CommonJS API:\n\n* `modules` path is internal API, does not inject all required dependencies and can be changed in minor or patch releases. Use it only for a custom build and / or if you know what are you doing.\n* `core-js` is extremely modular and uses a lot of very tiny modules, because of that for usage in browsers bundle up `core-js` instead of usage loader for each file, otherwise, you will have hundreds of requests.\n\n#### CommonJS and prototype methods without global namespace pollution\nIn the `library` version, we can't pollute prototypes of native constructors. Because of that, prototype methods transformed to static methods like in examples above. `babel` `runtime` transformer also can't transform them. But with transpilers we can use one more trick - [bind operator and virtual methods](https://github.com/zenparsing/es-function-bind). Special for that, available `/virtual/` entry points. Example:\n```js\nimport fill from 'core-js/library/fn/array/virtual/fill';\nimport findIndex from 'core-js/library/fn/array/virtual/find-index';\n\nArray(10)::fill(0).map((a, b) => b * b)::findIndex(it => it && !(it % 8)); // => 4\n\n// or\n\nimport {fill, findIndex} from 'core-js/library/fn/array/virtual';\n\nArray(10)::fill(0).map((a, b) => b * b)::findIndex(it => it && !(it % 8)); // => 4\n\n```\n\n### Custom build (from the command-line)\n```\nnpm i core-js && cd node_modules/core-js && npm i\nnpm run grunt build:core.dict,es6 -- --blacklist=es6.promise,es6.math --library=on --path=custom uglify\n```\nWhere `core.dict` and `es6` are modules (namespaces) names, which will be added to the build, `es6.promise` and `es6.math` are modules (namespaces) names, which will be excluded from the build, `--library=on` is flag for build without global namespace pollution and `custom` is target file name.\n\nAvailable namespaces: for example, `es6.array` contains [ES6 `Array` features](#ecmascript-6-array), `es6` contains all modules whose names start with `es6`.\n\n### Custom build (from external scripts)\n\n[`core-js-builder`](https://www.npmjs.com/package/core-js-builder) package exports a function that takes the same parameters as the `build` target from the previous section. This will conditionally include or exclude certain parts of `core-js`:\n\n```js\nrequire('core-js-builder')({\n modules: ['es6', 'core.dict'], // modules / namespaces\n blacklist: ['es6.reflect'], // blacklist of modules / namespaces, by default - empty list\n library: false, // flag for build without global namespace pollution, by default - false\n umd: true // use UMD wrapper for export `core` object, by default - true\n}).then(code => {\n // ...\n}).catch(error => {\n // ...\n});\n```\n## Supported engines\n**Tested in:**\n- Chrome 26+\n- Firefox 4+\n- Safari 5+\n- Opera 12+\n- Internet Explorer 6+ (sure, IE8- with ES3 limitations)\n- Edge\n- Android Browser 2.3+\n- iOS Safari 5.1+\n- PhantomJS 1.9 / 2.1\n- NodeJS 0.8+\n\n...and it doesn't mean `core-js` will not work in other engines, they just have not been tested.\n\n## Features:\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library) <- all features\ncore-js(/library)/shim <- only polyfills\n```\n### ECMAScript 5\nAll features moved to the [`es6` namespace](#ecmascript-6), here just a list of features:\n```js\nObject\n .create(proto | null, descriptors?) -> object\n .getPrototypeOf(object) -> proto | null\n .defineProperty(target, key, desc) -> target, cap for ie8-\n .defineProperties(target, descriptors) -> target, cap for ie8-\n .getOwnPropertyDescriptor(object, key) -> desc\n .getOwnPropertyNames(object) -> array\n .keys(object) -> array\n .seal(object) -> object, cap for ie8-\n .freeze(object) -> object, cap for ie8-\n .preventExtensions(object) -> object, cap for ie8-\n .isSealed(object) -> bool, cap for ie8-\n .isFrozen(object) -> bool, cap for ie8-\n .isExtensible(object) -> bool, cap for ie8-\nArray\n .isArray(var) -> bool\n #slice(start?, end?) -> array, fix for ie7-\n #join(string = ',') -> string, fix for ie7-\n #indexOf(var, from?) -> int\n #lastIndexOf(var, from?) -> int\n #every(fn(val, index, @), that) -> bool\n #some(fn(val, index, @), that) -> bool\n #forEach(fn(val, index, @), that) -> void\n #map(fn(val, index, @), that) -> array\n #filter(fn(val, index, @), that) -> array\n #reduce(fn(memo, val, index, @), memo?) -> var\n #reduceRight(fn(memo, val, index, @), memo?) -> var\n #sort(fn?) -> @, fixes for some engines\nFunction\n #bind(object, ...args) -> boundFn(...args)\nString\n #split(separator, limit) -> array\n #trim() -> str\nRegExp\n #toString() -> str\nNumber\n #toFixed(digits) -> string\n #toPrecision(precision) -> string\nparseInt(str, radix) -> int\nparseFloat(str) -> num\nDate\n .now() -> int\n #toISOString() -> string\n #toJSON() -> string\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es5\n```\n\n### ECMAScript 6\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6\n```\n#### ECMAScript 6: Object\nModules [`es6.object.assign`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.assign.js), [`es6.object.is`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.is.js), [`es6.object.set-prototype-of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.set-prototype-of.js) and [`es6.object.to-string`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.to-string.js).\n\nIn ES6 most `Object` static methods should work with primitives. Modules [`es6.object.freeze`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.freeze.js), [`es6.object.seal`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.seal.js), [`es6.object.prevent-extensions`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.prevent-extensions.js), [`es6.object.is-frozen`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.is-frozen.js), [`es6.object.is-sealed`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.is-sealed.js), [`es6.object.is-extensible`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.is-extensible.js), [`es6.object.get-own-property-descriptor`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.get-own-property-descriptor.js), [`es6.object.get-prototype-of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.get-prototype-of.js), [`es6.object.keys`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.keys.js) and [`es6.object.get-own-property-names`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.get-own-property-names.js).\n\nJust ES5 features: [`es6.object.create`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.create.js), [`es6.object.define-property`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.define-property.js) and [`es6.object.define-properties`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.object.es6.object.define-properties.js).\n```js\nObject\n .assign(target, ...src) -> target\n .is(a, b) -> bool\n .setPrototypeOf(target, proto | null) -> target (required __proto__ - IE11+)\n .create(object | null, descriptors?) -> object\n .getPrototypeOf(var) -> object | null\n .defineProperty(object, key, desc) -> target\n .defineProperties(object, descriptors) -> target\n .getOwnPropertyDescriptor(var, key) -> desc | undefined\n .keys(var) -> array\n .getOwnPropertyNames(var) -> array\n .freeze(var) -> var\n .seal(var) -> var\n .preventExtensions(var) -> var\n .isFrozen(var) -> bool\n .isSealed(var) -> bool\n .isExtensible(var) -> bool\n #toString() -> string, ES6 fix: @@toStringTag support\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/object\ncore-js(/library)/fn/object/assign\ncore-js(/library)/fn/object/is\ncore-js(/library)/fn/object/set-prototype-of\ncore-js(/library)/fn/object/get-prototype-of\ncore-js(/library)/fn/object/create\ncore-js(/library)/fn/object/define-property\ncore-js(/library)/fn/object/define-properties\ncore-js(/library)/fn/object/get-own-property-descriptor\ncore-js(/library)/fn/object/keys\ncore-js(/library)/fn/object/get-own-property-names\ncore-js(/library)/fn/object/freeze\ncore-js(/library)/fn/object/seal\ncore-js(/library)/fn/object/prevent-extensions\ncore-js(/library)/fn/object/is-frozen\ncore-js(/library)/fn/object/is-sealed\ncore-js(/library)/fn/object/is-extensible\ncore-js/fn/object/to-string\n```\n[*Examples*](http://goo.gl/ywdwPz):\n```js\nvar foo = {q: 1, w: 2}\n , bar = {e: 3, r: 4}\n , baz = {t: 5, y: 6};\nObject.assign(foo, bar, baz); // => foo = {q: 1, w: 2, e: 3, r: 4, t: 5, y: 6}\n\nObject.is(NaN, NaN); // => true\nObject.is(0, -0); // => false\nObject.is(42, 42); // => true\nObject.is(42, '42'); // => false\n\nfunction Parent(){}\nfunction Child(){}\nObject.setPrototypeOf(Child.prototype, Parent.prototype);\nnew Child instanceof Child; // => true\nnew Child instanceof Parent; // => true\n\nvar O = {};\nO[Symbol.toStringTag] = 'Foo';\n'' + O; // => '[object Foo]'\n\nObject.keys('qwe'); // => ['0', '1', '2']\nObject.getPrototypeOf('qwe') === String.prototype; // => true\n```\n#### ECMAScript 6: Function\nModules [`es6.function.name`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.function.name.js), [`es6.function.has-instance`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.function.has-instance.js). Just ES5: [`es6.function.bind`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.function.bind.js).\n```js\nFunction\n #bind(object, ...args) -> boundFn(...args)\n #name -> string (IE9+)\n #@@hasInstance(var) -> bool\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js/es6/function\ncore-js/fn/function/name\ncore-js/fn/function/has-instance\ncore-js/fn/function/bind\ncore-js/fn/function/virtual/bind\n```\n[*Example*](http://goo.gl/zqu3Wp):\n```js\n(function foo(){}).name // => 'foo'\n\nconsole.log.bind(console, 42)(43); // => 42 43\n```\n#### ECMAScript 6: Array\nModules [`es6.array.from`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.from.js), [`es6.array.of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.of.js), [`es6.array.copy-within`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.copy-within.js), [`es6.array.fill`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.fill.js), [`es6.array.find`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.find.js), [`es6.array.find-index`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.find-index.js), [`es6.array.iterator`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.iterator.js). ES5 features with fixes: [`es6.array.is-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.is-array.js), [`es6.array.slice`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.slice.js), [`es6.array.join`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.join.js), [`es6.array.index-of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.index-of.js), [`es6.array.last-index-of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.last-index-of.js), [`es6.array.every`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.every.js), [`es6.array.some`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.some.js), [`es6.array.for-each`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.for-each.js), [`es6.array.map`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.map.js), [`es6.array.filter`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.filter.js), [`es6.array.reduce`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.reduce.js), [`es6.array.reduce-right`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.reduce-right.js), [`es6.array.sort`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.array.sort.js).\n```js\nArray\n .from(iterable | array-like, mapFn(val, index)?, that) -> array\n .of(...args) -> array\n .isArray(var) -> bool\n #copyWithin(target = 0, start = 0, end = @length) -> @\n #fill(val, start = 0, end = @length) -> @\n #find(fn(val, index, @), that) -> val\n #findIndex(fn(val, index, @), that) -> index | -1\n #values() -> iterator\n #keys() -> iterator\n #entries() -> iterator\n #join(string = ',') -> string, fix for ie7-\n #slice(start?, end?) -> array, fix for ie7-\n #indexOf(var, from?) -> index | -1\n #lastIndexOf(var, from?) -> index | -1\n #every(fn(val, index, @), that) -> bool\n #some(fn(val, index, @), that) -> bool\n #forEach(fn(val, index, @), that) -> void\n #map(fn(val, index, @), that) -> array\n #filter(fn(val, index, @), that) -> array\n #reduce(fn(memo, val, index, @), memo?) -> var\n #reduceRight(fn(memo, val, index, @), memo?) -> var\n #sort(fn?) -> @, invalid arguments fix\n #@@iterator() -> iterator (values)\n #@@unscopables -> object (cap)\nArguments\n #@@iterator() -> iterator (values, available only in core-js methods)\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/array\ncore-js(/library)/fn/array/from\ncore-js(/library)/fn/array/of\ncore-js(/library)/fn/array/is-array\ncore-js(/library)/fn/array/iterator\ncore-js(/library)/fn/array/copy-within\ncore-js(/library)/fn/array/fill\ncore-js(/library)/fn/array/find\ncore-js(/library)/fn/array/find-index\ncore-js(/library)/fn/array/values\ncore-js(/library)/fn/array/keys\ncore-js(/library)/fn/array/entries\ncore-js(/library)/fn/array/slice\ncore-js(/library)/fn/array/join\ncore-js(/library)/fn/array/index-of\ncore-js(/library)/fn/array/last-index-of\ncore-js(/library)/fn/array/every\ncore-js(/library)/fn/array/some\ncore-js(/library)/fn/array/for-each\ncore-js(/library)/fn/array/map\ncore-js(/library)/fn/array/filter\ncore-js(/library)/fn/array/reduce\ncore-js(/library)/fn/array/reduce-right\ncore-js(/library)/fn/array/sort\ncore-js(/library)/fn/array/virtual/iterator\ncore-js(/library)/fn/array/virtual/copy-within\ncore-js(/library)/fn/array/virtual/fill\ncore-js(/library)/fn/array/virtual/find\ncore-js(/library)/fn/array/virtual/find-index\ncore-js(/library)/fn/array/virtual/values\ncore-js(/library)/fn/array/virtual/keys\ncore-js(/library)/fn/array/virtual/entries\ncore-js(/library)/fn/array/virtual/slice\ncore-js(/library)/fn/array/virtual/join\ncore-js(/library)/fn/array/virtual/index-of\ncore-js(/library)/fn/array/virtual/last-index-of\ncore-js(/library)/fn/array/virtual/every\ncore-js(/library)/fn/array/virtual/some\ncore-js(/library)/fn/array/virtual/for-each\ncore-js(/library)/fn/array/virtual/map\ncore-js(/library)/fn/array/virtual/filter\ncore-js(/library)/fn/array/virtual/reduce\ncore-js(/library)/fn/array/virtual/reduce-right\ncore-js(/library)/fn/array/virtual/sort\n```\n[*Examples*](http://goo.gl/oaUFUf):\n```js\nArray.from(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3]\nArray.from({0: 1, 1: 2, 2: 3, length: 3}); // => [1, 2, 3]\nArray.from('123', Number); // => [1, 2, 3]\nArray.from('123', function(it){\n return it * it;\n}); // => [1, 4, 9]\n\nArray.of(1); // => [1]\nArray.of(1, 2, 3); // => [1, 2, 3]\n\nvar array = ['a', 'b', 'c'];\n\nfor(var val of array)console.log(val); // => 'a', 'b', 'c'\nfor(var val of array.values())console.log(val); // => 'a', 'b', 'c'\nfor(var key of array.keys())console.log(key); // => 0, 1, 2\nfor(var [key, val] of array.entries()){\n console.log(key); // => 0, 1, 2\n console.log(val); // => 'a', 'b', 'c'\n}\n\nfunction isOdd(val){\n return val % 2;\n}\n[4, 8, 15, 16, 23, 42].find(isOdd); // => 15\n[4, 8, 15, 16, 23, 42].findIndex(isOdd); // => 2\n[4, 8, 15, 16, 23, 42].find(isNaN); // => undefined\n[4, 8, 15, 16, 23, 42].findIndex(isNaN); // => -1\n\nArray(5).fill(42); // => [42, 42, 42, 42, 42]\n\n[1, 2, 3, 4, 5].copyWithin(0, 3); // => [4, 5, 3, 4, 5]\n```\n#### ECMAScript 6: String\nModules [`es6.string.from-code-point`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.from-code-point.js), [`es6.string.raw`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.raw.js), [`es6.string.iterator`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.iterator.js), [`es6.string.code-point-at`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.code-point-at.js), [`es6.string.ends-with`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.ends-with.js), [`es6.string.includes`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.includes.js), [`es6.string.repeat`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.repeat.js), [`es6.string.starts-with`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.starts-with.js) and [`es6.string.trim`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.trim.js).\n\nAnnex B HTML methods. Ugly, but it's also the part of the spec. Modules [`es6.string.anchor`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.anchor.js), [`es6.string.big`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.big.js), [`es6.string.blink`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.blink.js), [`es6.string.bold`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.bold.js), [`es6.string.fixed`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.fixed.js), [`es6.string.fontcolor`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.fontcolor.js), [`es6.string.fontsize`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.fontsize.js), [`es6.string.italics`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.italics.js), [`es6.string.link`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.link.js), [`es6.string.small`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.small.js), [`es6.string.strike`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.strike.js), [`es6.string.sub`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.sub.js) and [`es6.string.sup`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.string.sup.js).\n```js\nString\n .fromCodePoint(...codePoints) -> str\n .raw({raw}, ...substitutions) -> str\n #includes(str, from?) -> bool\n #startsWith(str, from?) -> bool\n #endsWith(str, from?) -> bool\n #repeat(num) -> str\n #codePointAt(pos) -> uint\n #trim() -> str, ES6 fix\n #anchor(name) -> str\n #big() -> str\n #blink() -> str\n #bold() -> str\n #fixed() -> str\n #fontcolor(color) -> str\n #fontsize(size) -> str\n #italics() -> str\n #link(url) -> str\n #small() -> str\n #strike() -> str\n #sub() -> str\n #sup() -> str\n #@@iterator() -> iterator (code points)\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/string\ncore-js(/library)/fn/string/from-code-point\ncore-js(/library)/fn/string/raw\ncore-js(/library)/fn/string/includes\ncore-js(/library)/fn/string/starts-with\ncore-js(/library)/fn/string/ends-with\ncore-js(/library)/fn/string/repeat\ncore-js(/library)/fn/string/code-point-at\ncore-js(/library)/fn/string/trim\ncore-js(/library)/fn/string/anchor\ncore-js(/library)/fn/string/big\ncore-js(/library)/fn/string/blink\ncore-js(/library)/fn/string/bold\ncore-js(/library)/fn/string/fixed\ncore-js(/library)/fn/string/fontcolor\ncore-js(/library)/fn/string/fontsize\ncore-js(/library)/fn/string/italics\ncore-js(/library)/fn/string/link\ncore-js(/library)/fn/string/small\ncore-js(/library)/fn/string/strike\ncore-js(/library)/fn/string/sub\ncore-js(/library)/fn/string/sup\ncore-js(/library)/fn/string/iterator\ncore-js(/library)/fn/string/virtual/includes\ncore-js(/library)/fn/string/virtual/starts-with\ncore-js(/library)/fn/string/virtual/ends-with\ncore-js(/library)/fn/string/virtual/repeat\ncore-js(/library)/fn/string/virtual/code-point-at\ncore-js(/library)/fn/string/virtual/trim\ncore-js(/library)/fn/string/virtual/anchor\ncore-js(/library)/fn/string/virtual/big\ncore-js(/library)/fn/string/virtual/blink\ncore-js(/library)/fn/string/virtual/bold\ncore-js(/library)/fn/string/virtual/fixed\ncore-js(/library)/fn/string/virtual/fontcolor\ncore-js(/library)/fn/string/virtual/fontsize\ncore-js(/library)/fn/string/virtual/italics\ncore-js(/library)/fn/string/virtual/link\ncore-js(/library)/fn/string/virtual/small\ncore-js(/library)/fn/string/virtual/strike\ncore-js(/library)/fn/string/virtual/sub\ncore-js(/library)/fn/string/virtual/sup\ncore-js(/library)/fn/string/virtual/iterator\n```\n[*Examples*](http://goo.gl/3UaQ93):\n```js\nfor(var val of 'a𠮷b'){\n console.log(val); // => 'a', '𠮷', 'b'\n}\n\n'foobarbaz'.includes('bar'); // => true\n'foobarbaz'.includes('bar', 4); // => false\n'foobarbaz'.startsWith('foo'); // => true\n'foobarbaz'.startsWith('bar', 3); // => true\n'foobarbaz'.endsWith('baz'); // => true\n'foobarbaz'.endsWith('bar', 6); // => true\n\n'string'.repeat(3); // => 'stringstringstring'\n\n'𠮷'.codePointAt(0); // => 134071\nString.fromCodePoint(97, 134071, 98); // => 'a𠮷b'\n\nvar name = 'Bob';\nString.raw`Hi\\n${name}!`; // => 'Hi\\\\nBob!' (ES6 template string syntax)\nString.raw({raw: 'test'}, 0, 1, 2); // => 't0e1s2t'\n\n'foo'.bold(); // => '<b>foo</b>'\n'bar'.anchor('a\"b'); // => '<a name=\"a"b\">bar</a>'\n'baz'.link('http://example.com'); // => '<a href=\"http://example.com\">baz</a>'\n```\n#### ECMAScript 6: RegExp\nModules [`es6.regexp.constructor`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.regexp.constructor.js) and [`es6.regexp.flags`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.regexp.flags.js).\n\nSupport well-known [symbols](#ecmascript-6-symbol) `@@match`, `@@replace`, `@@search` and `@@split`, modules [`es6.regexp.match`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.regexp.match.js), [`es6.regexp.replace`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.regexp.replace.js), [`es6.regexp.search`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.regexp.search.js) and [`es6.regexp.split`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.regexp.split.js).\n```\n[new] RegExp(pattern, flags?) -> regexp, ES6 fix: can alter flags (IE9+)\n #flags -> str (IE9+)\n #toString() -> str, ES6 fixes\n #@@match(str) -> array | null\n #@@replace(str, replacer) -> string\n #@@search(str) -> index\n #@@split(str, limit) -> array\nString\n #match(tpl) -> var, ES6 fix for support @@match\n #replace(tpl, replacer) -> var, ES6 fix for support @@replace\n #search(tpl) -> var, ES6 fix for support @@search\n #split(tpl, limit) -> var, ES6 fix for support @@split, some fixes for old engines\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js/es6/regexp\ncore-js/fn/regexp/constructor\ncore-js(/library)/fn/regexp/flags\ncore-js/fn/regexp/to-string\ncore-js/fn/regexp/match\ncore-js/fn/regexp/replace\ncore-js/fn/regexp/search\ncore-js/fn/regexp/split\n```\n[*Examples*](http://goo.gl/PiJxBD):\n```js\nRegExp(/./g, 'm'); // => /./m\n\n/foo/.flags; // => ''\n/foo/gim.flags; // => 'gim'\n\n'foo'.match({[Symbol.match]: _ => 1}); // => 1\n'foo'.replace({[Symbol.replace]: _ => 2}); // => 2\n'foo'.search({[Symbol.search]: _ => 3}); // => 3\n'foo'.split({[Symbol.split]: _ => 4}); // => 4\n\nRegExp.prototype.toString.call({source: 'foo', flags: 'bar'}); // => '/foo/bar'\n```\n#### ECMAScript 6: Number\nModule [`es6.number.constructor`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.constructor.js). `Number` constructor support binary and octal literals, [*example*](http://goo.gl/jRd6b3):\n```js\nNumber('0b1010101'); // => 85\nNumber('0o7654321'); // => 2054353\n```\nModules [`es6.number.epsilon`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.epsilon.js), [`es6.number.is-finite`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.is-finite.js), [`es6.number.is-integer`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.is-integer.js), [`es6.number.is-nan`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.is-nan.js), [`es6.number.is-safe-integer`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.is-safe-integer.js), [`es6.number.max-safe-integer`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.max-safe-integer.js), [`es6.number.min-safe-integer`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.min-safe-integer.js), [`es6.number.parse-float`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.parse-float.js), [`es6.number.parse-int`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.parse-int.js), [`es6.number.to-fixed`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.to-fixed.js), [`es6.number.to-precision`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.number.to-precision.js), [`es6.parse-int`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.parse-int.js), [`es6.parse-float`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.parse-float.js).\n```js\n[new] Number(var) -> number | number object\n .isFinite(num) -> bool\n .isNaN(num) -> bool\n .isInteger(num) -> bool\n .isSafeInteger(num) -> bool\n .parseFloat(str) -> num\n .parseInt(str) -> int\n .EPSILON -> num\n .MAX_SAFE_INTEGER -> int\n .MIN_SAFE_INTEGER -> int\n #toFixed(digits) -> string, fixes\n #toPrecision(precision) -> string, fixes\nparseFloat(str) -> num, fixes\nparseInt(str) -> int, fixes\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/number\ncore-js/es6/number/constructor\ncore-js(/library)/fn/number/is-finite\ncore-js(/library)/fn/number/is-nan\ncore-js(/library)/fn/number/is-integer\ncore-js(/library)/fn/number/is-safe-integer\ncore-js(/library)/fn/number/parse-float\ncore-js(/library)/fn/number/parse-int\ncore-js(/library)/fn/number/epsilon\ncore-js(/library)/fn/number/max-safe-integer\ncore-js(/library)/fn/number/min-safe-integer\ncore-js(/library)/fn/number/to-fixed\ncore-js(/library)/fn/number/to-precision\ncore-js(/library)/fn/parse-float\ncore-js(/library)/fn/parse-int\n```\n#### ECMAScript 6: Math\nModules [`es6.math.acosh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.acosh.js), [`es6.math.asinh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.asinh.js), [`es6.math.atanh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.atanh.js), [`es6.math.cbrt`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.cbrt.js), [`es6.math.clz32`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.clz32.js), [`es6.math.cosh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.cosh.js), [`es6.math.expm1`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.expm1.js), [`es6.math.fround`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.fround.js), [`es6.math.hypot`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.hypot.js), [`es6.math.imul`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.imul.js), [`es6.math.log10`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.log10.js), [`es6.math.log1p`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.log1p.js), [`es6.math.log2`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.log2.js), [`es6.math.sign`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.sign.js), [`es6.math.sinh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.sinh.js), [`es6.math.tanh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.tanh.js), [`es6.math.trunc`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.math.trunc.js).\n```js\nMath\n .acosh(num) -> num\n .asinh(num) -> num\n .atanh(num) -> num\n .cbrt(num) -> num\n .clz32(num) -> uint\n .cosh(num) -> num\n .expm1(num) -> num\n .fround(num) -> num\n .hypot(...args) -> num\n .imul(num, num) -> int\n .log1p(num) -> num\n .log10(num) -> num\n .log2(num) -> num\n .sign(num) -> 1 | -1 | 0 | -0 | NaN\n .sinh(num) -> num\n .tanh(num) -> num\n .trunc(num) -> num\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/math\ncore-js(/library)/fn/math/acosh\ncore-js(/library)/fn/math/asinh\ncore-js(/library)/fn/math/atanh\ncore-js(/library)/fn/math/cbrt\ncore-js(/library)/fn/math/clz32\ncore-js(/library)/fn/math/cosh\ncore-js(/library)/fn/math/expm1\ncore-js(/library)/fn/math/fround\ncore-js(/library)/fn/math/hypot\ncore-js(/library)/fn/math/imul\ncore-js(/library)/fn/math/log1p\ncore-js(/library)/fn/math/log10\ncore-js(/library)/fn/math/log2\ncore-js(/library)/fn/math/sign\ncore-js(/library)/fn/math/sinh\ncore-js(/library)/fn/math/tanh\ncore-js(/library)/fn/math/trunc\n```\n#### ECMAScript 6: Date\nModules [`es6.date.to-string`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.date.to-string.js), ES5 features with fixes: [`es6.date.now`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.date.now.js), [`es6.date.to-iso-string`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.date.to-iso-string.js), [`es6.date.to-json`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.date.to-json.js) and [`es6.date.to-primitive`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.date.to-primitive.js).\n```js\nDate\n .now() -> int\n #toISOString() -> string\n #toJSON() -> string\n #toString() -> string\n #@@toPrimitive(hint) -> primitive\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js/es6/date\ncore-js/fn/date/to-string\ncore-js(/library)/fn/date/now\ncore-js(/library)/fn/date/to-iso-string\ncore-js(/library)/fn/date/to-json\ncore-js(/library)/fn/date/to-primitive\n```\n[*Example*](http://goo.gl/haeHLR):\n```js\nnew Date(NaN).toString(); // => 'Invalid Date'\n```\n\n#### ECMAScript 6: Promise\nModule [`es6.promise`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.promise.js).\n```js\nnew Promise(executor(resolve(var), reject(var))) -> promise\n #then(resolved(var), rejected(var)) -> promise\n #catch(rejected(var)) -> promise\n .resolve(promise | var) -> promise\n .reject(var) -> promise\n .all(iterable) -> promise\n .race(iterable) -> promise\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/promise\ncore-js(/library)/fn/promise\n```\nBasic [*example*](http://goo.gl/vGrtUC):\n```js\nfunction sleepRandom(time){\n return new Promise(function(resolve, reject){\n setTimeout(resolve, time * 1e3, 0 | Math.random() * 1e3);\n });\n}\n\nconsole.log('Run'); // => Run\nsleepRandom(5).then(function(result){\n console.log(result); // => 869, after 5 sec.\n return sleepRandom(10);\n}).then(function(result){\n console.log(result); // => 202, after 10 sec.\n}).then(function(){\n console.log('immediately after'); // => immediately after\n throw Error('Irror!');\n}).then(function(){\n console.log('will not be displayed');\n}).catch(x => console.log(x)); // => => Error: Irror!\n```\n`Promise.resolve` and `Promise.reject` [*example*](http://goo.gl/vr8TN3):\n```js\nPromise.resolve(42).then(x => console.log(x)); // => 42\nPromise.reject(42).catch(x => console.log(x)); // => 42\n\nPromise.resolve($.getJSON('/data.json')); // => ES6 promise\n```\n`Promise.all` [*example*](http://goo.gl/RdoDBZ):\n```js\nPromise.all([\n 'foo',\n sleepRandom(5),\n sleepRandom(15),\n sleepRandom(10) // after 15 sec:\n]).then(x => console.log(x)); // => ['foo', 956, 85, 382]\n```\n`Promise.race` [*example*](http://goo.gl/L8ovkJ):\n```js\nfunction timeLimit(promise, time){\n return Promise.race([promise, new Promise(function(resolve, reject){\n setTimeout(reject, time * 1e3, Error('Await > ' + time + ' sec'));\n })]);\n}\n\ntimeLimit(sleepRandom(5), 10).then(x => console.log(x)); // => 853, after 5 sec.\ntimeLimit(sleepRandom(15), 10).catch(x => console.log(x)); // Error: Await > 10 sec\n```\nECMAScript 7 [async functions](https://tc39.github.io/ecmascript-asyncawait) [example](http://goo.gl/wnQS4j):\n```js\nvar delay = time => new Promise(resolve => setTimeout(resolve, time))\n\nasync function sleepRandom(time){\n await delay(time * 1e3);\n return 0 | Math.random() * 1e3;\n};\nasync function sleepError(time, msg){\n await delay(time * 1e3);\n throw Error(msg);\n};\n\n(async () => {\n try {\n console.log('Run'); // => Run\n console.log(await sleepRandom(5)); // => 936, after 5 sec.\n var [a, b, c] = await Promise.all([\n sleepRandom(5),\n sleepRandom(15),\n sleepRandom(10)\n ]);\n console.log(a, b, c); // => 210 445 71, after 15 sec.\n await sleepError(5, 'Irror!');\n console.log('Will not be displayed');\n } catch(e){\n console.log(e); // => Error: 'Irror!', after 5 sec.\n }\n})();\n```\n\n##### Unhandled rejection tracking\n\nIn Node.js, like in native implementation, available events [`unhandledRejection`](https://nodejs.org/api/process.html#process_event_unhandledrejection) and [`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled):\n```js\nprocess.on('unhandledRejection', (reason, promise) => console.log('unhandled', reason, promise));\nprocess.on('rejectionHandled', (promise) => console.log('handled', promise));\n\nvar p = Promise.reject(42);\n// unhandled 42 [object Promise]\n\nsetTimeout(() => p.catch(_ => _), 1e3);\n// handled [object Promise]\n```\nIn a browser on rejection, by default, you will see notify in the console, or you can add a custom handler and a handler on handling unhandled, [*example*](http://goo.gl/Wozskl):\n```js\nwindow.onunhandledrejection = e => console.log('unhandled', e.reason, e.promise);\nwindow.onrejectionhandled = e => console.log('handled', e.reason, e.promise);\n\nvar p = Promise.reject(42);\n// unhandled 42 [object Promise]\n\nsetTimeout(() => p.catch(_ => _), 1e3);\n// handled 42 [object Promise]\n```\n\n#### ECMAScript 6: Symbol\nModule [`es6.symbol`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.symbol.js).\n```js\nSymbol(description?) -> symbol\n .hasInstance -> @@hasInstance\n .isConcatSpreadable -> @@isConcatSpreadable\n .iterator -> @@iterator\n .match -> @@match\n .replace -> @@replace\n .search -> @@search\n .species -> @@species\n .split -> @@split\n .toPrimitive -> @@toPrimitive\n .toStringTag -> @@toStringTag\n .unscopables -> @@unscopables\n .for(key) -> symbol\n .keyFor(symbol) -> key\n .useSimple() -> void\n .useSetter() -> void\nObject\n .getOwnPropertySymbols(object) -> array\n```\nAlso wrapped some methods for correct work with `Symbol` polyfill.\n```js\nObject\n .create(proto | null, descriptors?) -> object\n .defineProperty(target, key, desc) -> target\n .defineProperties(target, descriptors) -> target\n .getOwnPropertyDescriptor(var, key) -> desc | undefined\n .getOwnPropertyNames(var) -> array\n #propertyIsEnumerable(key) -> bool\nJSON\n .stringify(target, replacer?, space?) -> string | undefined\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/symbol\ncore-js(/library)/fn/symbol\ncore-js(/library)/fn/symbol/has-instance\ncore-js(/library)/fn/symbol/is-concat-spreadable\ncore-js(/library)/fn/symbol/iterator\ncore-js(/library)/fn/symbol/match\ncore-js(/library)/fn/symbol/replace\ncore-js(/library)/fn/symbol/search\ncore-js(/library)/fn/symbol/species\ncore-js(/library)/fn/symbol/split\ncore-js(/library)/fn/symbol/to-primitive\ncore-js(/library)/fn/symbol/to-string-tag\ncore-js(/library)/fn/symbol/unscopables\ncore-js(/library)/fn/symbol/for\ncore-js(/library)/fn/symbol/key-for\n```\n[*Basic example*](http://goo.gl/BbvWFc):\n```js\nvar Person = (function(){\n var NAME = Symbol('name');\n function Person(name){\n this[NAME] = name;\n }\n Person.prototype.getName = function(){\n return this[NAME];\n };\n return Person;\n})();\n\nvar person = new Person('Vasya');\nconsole.log(person.getName()); // => 'Vasya'\nconsole.log(person['name']); // => undefined\nconsole.log(person[Symbol('name')]); // => undefined, symbols are uniq\nfor(var key in person)console.log(key); // => only 'getName', symbols are not enumerable\n```\n`Symbol.for` & `Symbol.keyFor` [*example*](http://goo.gl/0pdJjX):\n```js\nvar symbol = Symbol.for('key');\nsymbol === Symbol.for('key'); // true\nSymbol.keyFor(symbol); // 'key'\n```\n[*Example*](http://goo.gl/mKVOQJ) with methods for getting own object keys:\n```js\nvar O = {a: 1};\nObject.defineProperty(O, 'b', {value: 2});\nO[Symbol('c')] = 3;\nObject.keys(O); // => ['a']\nObject.getOwnPropertyNames(O); // => ['a', 'b']\nObject.getOwnPropertySymbols(O); // => [Symbol(c)]\nReflect.ownKeys(O); // => ['a', 'b', Symbol(c)]\n```\n##### Caveats when using `Symbol` polyfill:\n\n* We can't add new primitive type, `Symbol` returns object.\n* `Symbol.for` and `Symbol.keyFor` can't be shimmed cross-realm.\n* By default, to hide the keys, `Symbol` polyfill defines setter in `Object.prototype`. For this reason, uncontrolled creation of symbols can cause memory leak and the `in` operator is not working correctly with `Symbol` polyfill: `Symbol() in {} // => true`.\n\nYou can disable defining setters in `Object.prototype`. [Example](http://goo.gl/N5UD7J):\n```js\nSymbol.useSimple();\nvar s1 = Symbol('s1')\n , o1 = {};\no1[s1] = true;\nfor(var key in o1)console.log(key); // => 'Symbol(s1)_t.qamkg9f3q', w/o native Symbol\n\nSymbol.useSetter();\nvar s2 = Symbol('s2')\n , o2 = {};\no2[s2] = true;\nfor(var key in o2)console.log(key); // nothing\n```\n* Currently, `core-js` not adds setters to `Object.prototype` for well-known symbols for correct work something like `Symbol.iterator in foo`. It can cause problems with their enumerability.\n* Some problems possible with environment exotic objects (for example, IE `localStorage`).\n\n#### ECMAScript 6: Collections\n`core-js` uses native collections in most case, just fixes methods / constructor, if it's required, and in old environment uses fast polyfill (O(1) lookup).\n#### Map\nModule [`es6.map`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.map.js).\n```js\nnew Map(iterable (entries) ?) -> map\n #clear() -> void\n #delete(key) -> bool\n #forEach(fn(val, key, @), that) -> void\n #get(key) -> val\n #has(key) -> bool\n #set(key, val) -> @\n #size -> uint\n #values() -> iterator\n #keys() -> iterator\n #entries() -> iterator\n #@@iterator() -> iterator (entries)\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/map\ncore-js(/library)/fn/map\n```\n[*Examples*](http://goo.gl/GWR7NI):\n```js\nvar a = [1];\n\nvar map = new Map([['a', 1], [42, 2]]);\nmap.set(a, 3).set(true, 4);\n\nconsole.log(map.size); // => 4\nconsole.log(map.has(a)); // => true\nconsole.log(map.has([1])); // => false\nconsole.log(map.get(a)); // => 3\nmap.forEach(function(val, key){\n console.log(val); // => 1, 2, 3, 4\n console.log(key); // => 'a', 42, [1], true\n});\nmap.delete(a);\nconsole.log(map.size); // => 3\nconsole.log(map.get(a)); // => undefined\nconsole.log(Array.from(map)); // => [['a', 1], [42, 2], [true, 4]]\n\nvar map = new Map([['a', 1], ['b', 2], ['c', 3]]);\n\nfor(var [key, val] of map){\n console.log(key); // => 'a', 'b', 'c'\n console.log(val); // => 1, 2, 3\n}\nfor(var val of map.values())console.log(val); // => 1, 2, 3\nfor(var key of map.keys())console.log(key); // => 'a', 'b', 'c'\nfor(var [key, val] of map.entries()){\n console.log(key); // => 'a', 'b', 'c'\n console.log(val); // => 1, 2, 3\n}\n```\n#### Set\nModule [`es6.set`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.set.js).\n```js\nnew Set(iterable?) -> set\n #add(key) -> @\n #clear() -> void\n #delete(key) -> bool\n #forEach(fn(el, el, @), that) -> void\n #has(key) -> bool\n #size -> uint\n #values() -> iterator\n #keys() -> iterator\n #entries() -> iterator\n #@@iterator() -> iterator (values)\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/set\ncore-js(/library)/fn/set\n```\n[*Examples*](http://goo.gl/bmhLwg):\n```js\nvar set = new Set(['a', 'b', 'a', 'c']);\nset.add('d').add('b').add('e');\nconsole.log(set.size); // => 5\nconsole.log(set.has('b')); // => true\nset.forEach(function(it){\n console.log(it); // => 'a', 'b', 'c', 'd', 'e'\n});\nset.delete('b');\nconsole.log(set.size); // => 4\nconsole.log(set.has('b')); // => false\nconsole.log(Array.from(set)); // => ['a', 'c', 'd', 'e']\n\nvar set = new Set([1, 2, 3, 2, 1]);\n\nfor(var val of set)console.log(val); // => 1, 2, 3\nfor(var val of set.values())console.log(val); // => 1, 2, 3\nfor(var key of set.keys())console.log(key); // => 1, 2, 3\nfor(var [key, val] of set.entries()){\n console.log(key); // => 1, 2, 3\n console.log(val); // => 1, 2, 3\n}\n```\n#### WeakMap\nModule [`es6.weak-map`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.weak-map.js).\n```js\nnew WeakMap(iterable (entries) ?) -> weakmap\n #delete(key) -> bool\n #get(key) -> val\n #has(key) -> bool\n #set(key, val) -> @\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/weak-map\ncore-js(/library)/fn/weak-map\n```\n[*Examples*](http://goo.gl/SILXyw):\n```js\nvar a = [1]\n , b = [2]\n , c = [3];\n\nvar wmap = new WeakMap([[a, 1], [b, 2]]);\nwmap.set(c, 3).set(b, 4);\nconsole.log(wmap.has(a)); // => true\nconsole.log(wmap.has([1])); // => false\nconsole.log(wmap.get(a)); // => 1\nwmap.delete(a);\nconsole.log(wmap.get(a)); // => undefined\n\n// Private properties store:\nvar Person = (function(){\n var names = new WeakMap;\n function Person(name){\n names.set(this, name);\n }\n Person.prototype.getName = function(){\n return names.get(this);\n };\n return Person;\n})();\n\nvar person = new Person('Vasya');\nconsole.log(person.getName()); // => 'Vasya'\nfor(var key in person)console.log(key); // => only 'getName'\n```\n#### WeakSet\nModule [`es6.weak-set`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.weak-set.js).\n```js\nnew WeakSet(iterable?) -> weakset\n #add(key) -> @\n #delete(key) -> bool\n #has(key) -> bool\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/weak-set\ncore-js(/library)/fn/weak-set\n```\n[*Examples*](http://goo.gl/TdFbEx):\n```js\nvar a = [1]\n , b = [2]\n , c = [3];\n\nvar wset = new WeakSet([a, b, a]);\nwset.add(c).add(b).add(c);\nconsole.log(wset.has(b)); // => true\nconsole.log(wset.has([2])); // => false\nwset.delete(b);\nconsole.log(wset.has(b)); // => false\n```\n##### Caveats when using collections polyfill:\n\n* Weak-collections polyfill stores values as hidden properties of keys. It works correct and not leak in most cases. However, it is desirable to store a collection longer than its keys.\n\n#### ECMAScript 6: Typed Arrays\nImplementations and fixes `ArrayBuffer`, `DataView`, typed arrays constructors, static and prototype methods. Typed Arrays work only in environments with support descriptors (IE9+), `ArrayBuffer` and `DataView` should work anywhere.\n\nModules [`es6.typed.array-buffer`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.array-buffer.js), [`es6.typed.data-view`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.data-view.js), [`es6.typed.int8-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.int8-array.js), [`es6.typed.uint8-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.uint8-array.js), [`es6.typed.uint8-clamped-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.uint8-clamped-array.js), [`es6.typed.int16-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.int16-array.js), [`es6.typed.uint16-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.uint16-array.js), [`es6.typed.int32-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.int32-array.js), [`es6.typed.uint32-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.uint32-array.js), [`es6.typed.float32-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.float32-array.js) and [`es6.typed.float64-array`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.typed.float64-array.js).\n```js\nnew ArrayBuffer(length) -> buffer\n .isView(var) -> bool\n #slice(start = 0, end = @length) -> buffer\n #byteLength -> uint\n\nnew DataView(buffer, byteOffset = 0, byteLength = buffer.byteLength - byteOffset) -> view\n #getInt8(offset) -> int8\n #getUint8(offset) -> uint8\n #getInt16(offset, littleEndian = false) -> int16\n #getUint16(offset, littleEndian = false) -> uint16\n #getInt32(offset, littleEndian = false) -> int32\n #getUint32(offset, littleEndian = false) -> uint32\n #getFloat32(offset, littleEndian = false) -> float32\n #getFloat64(offset, littleEndian = false) -> float64\n #setInt8(offset, value) -> void\n #setUint8(offset, value) -> void\n #setInt16(offset, value, littleEndian = false) -> void\n #setUint16(offset, value, littleEndian = false) -> void\n #setInt32(offset, value, littleEndian = false) -> void\n #setUint32(offset, value, littleEndian = false) -> void\n #setFloat32(offset, value, littleEndian = false) -> void\n #setFloat64(offset, value, littleEndian = false) -> void\n #buffer -> buffer\n #byteLength -> uint\n #byteOffset -> uint\n\n{\n Int8Array,\n Uint8Array,\n Uint8ClampedArray,\n Int16Array,\n Uint16Array,\n Int32Array,\n Uint32Array,\n Float32Array,\n Float64Array\n}\n new %TypedArray%(length) -> typed\n new %TypedArray%(typed) -> typed\n new %TypedArray%(arrayLike) -> typed\n new %TypedArray%(iterable) -> typed\n new %TypedArray%(buffer, byteOffset = 0, length = (buffer.byteLength - byteOffset) / @BYTES_PER_ELEMENT) -> typed\n .BYTES_PER_ELEMENT -> uint\n .from(arrayLike | iterable, mapFn(val, index)?, that) -> typed\n .of(...args) -> typed\n #BYTES_PER_ELEMENT -> uint\n #copyWithin(target = 0, start = 0, end = @length) -> @\n #every(fn(val, index, @), that) -> bool\n #fill(val, start = 0, end = @length) -> @\n #filter(fn(val, index, @), that) -> typed\n #find(fn(val, index, @), that) -> val\n #findIndex(fn(val, index, @), that) -> index\n #forEach(fn(val, index, @), that) -> void\n #indexOf(var, from?) -> int\n #join(string = ',') -> string\n #lastIndexOf(var, from?) -> int\n #map(fn(val, index, @), that) -> typed\n #reduce(fn(memo, val, index, @), memo?) -> var\n #reduceRight(fn(memo, val, index, @), memo?) -> var\n #reverse() -> @\n #set(arrayLike, offset = 0) -> void\n #slice(start = 0, end = @length) -> typed\n #some(fn(val, index, @), that) -> bool\n #sort(fn(a, b)?) -> @\n #subarray(start = 0, end = @length) -> typed\n #toString() -> string\n #toLocaleString() -> string\n #values() -> iterator\n #keys() -> iterator\n #entries() -> iterator\n #@@iterator() -> iterator (values)\n #buffer -> buffer\n #byteLength -> uint\n #byteOffset -> uint\n #length -> uint\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/typed\ncore-js(/library)/fn/typed\ncore-js(/library)/fn/typed/array-buffer\ncore-js(/library)/fn/typed/data-view\ncore-js(/library)/fn/typed/int8-array\ncore-js(/library)/fn/typed/uint8-array\ncore-js(/library)/fn/typed/uint8-clamped-array\ncore-js(/library)/fn/typed/int16-array\ncore-js(/library)/fn/typed/uint16-array\ncore-js(/library)/fn/typed/int32-array\ncore-js(/library)/fn/typed/uint32-array\ncore-js(/library)/fn/typed/float32-array\ncore-js(/library)/fn/typed/float64-array\n```\n[*Examples*](http://goo.gl/yla75z):\n```js\nnew Int32Array(4); // => [0, 0, 0, 0]\nnew Uint8ClampedArray([1, 2, 3, 666]); // => [1, 2, 3, 255]\nnew Float32Array(new Set([1, 2, 3, 2, 1])); // => [1, 2, 3]\n\nvar buffer = new ArrayBuffer(8);\nvar view = new DataView(buffer);\nview.setFloat64(0, 123.456, true);\nnew Uint8Array(buffer.slice(4)); // => [47, 221, 94, 64]\n\nInt8Array.of(1, 1.5, 5.7, 745); // => [1, 1, 5, -23]\nUint8Array.from([1, 1.5, 5.7, 745]); // => [1, 1, 5, 233]\n\nvar typed = new Uint8Array([1, 2, 3]);\n\nvar a = typed.slice(1); // => [2, 3]\ntyped.buffer === a.buffer; // => false\nvar b = typed.subarray(1); // => [2, 3]\ntyped.buffer === b.buffer; // => true\n\ntyped.filter(it => it % 2); // => [1, 3]\ntyped.map(it => it * 1.5); // => [1, 3, 4]\n\nfor(var val of typed)console.log(val); // => 1, 2, 3\nfor(var val of typed.values())console.log(val); // => 1, 2, 3\nfor(var key of typed.keys())console.log(key); // => 0, 1, 2\nfor(var [key, val] of typed.entries()){\n console.log(key); // => 0, 1, 2\n console.log(val); // => 1, 2, 3\n}\n```\n##### Caveats when using typed arrays:\n\n* Typed Arrays polyfills works completely how should work by the spec, but because of internal use getter / setters on each instance, is slow and consumes significant memory. However, typed arrays polyfills required mainly for IE9 (and for `Uint8ClampedArray` in IE10 and early IE11), all modern engines have native typed arrays and requires only constructors fixes and methods.\n* The current version hasn't special entry points for methods, they can be added only with constructors. It can be added in the future.\n* In the `library` version we can't pollute native prototypes, so prototype methods available as constructors static.\n\n#### ECMAScript 6: Reflect\nModules [`es6.reflect.apply`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.apply.js), [`es6.reflect.construct`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.construct.js), [`es6.reflect.define-property`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.define-property.js), [`es6.reflect.delete-property`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.delete-property.js), [`es6.reflect.enumerate`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.enumerate.js), [`es6.reflect.get`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.get.js), [`es6.reflect.get-own-property-descriptor`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.get-own-property-descriptor.js), [`es6.reflect.get-prototype-of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.get-prototype-of.js), [`es6.reflect.has`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.has.js), [`es6.reflect.is-extensible`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.is-extensible.js), [`es6.reflect.own-keys`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.own-keys.js), [`es6.reflect.prevent-extensions`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.prevent-extensions.js), [`es6.reflect.set`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.set.js), [`es6.reflect.set-prototype-of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es6.reflect.set-prototype-of.js).\n```js\nReflect\n .apply(target, thisArgument, argumentsList) -> var\n .construct(target, argumentsList, newTarget?) -> object\n .defineProperty(target, propertyKey, attributes) -> bool\n .deleteProperty(target, propertyKey) -> bool\n .enumerate(target) -> iterator (removed from the spec and will be removed from core-js@3)\n .get(target, propertyKey, receiver?) -> var\n .getOwnPropertyDescriptor(target, propertyKey) -> desc\n .getPrototypeOf(target) -> object | null\n .has(target, propertyKey) -> bool\n .isExtensible(target) -> bool\n .ownKeys(target) -> array\n .preventExtensions(target) -> bool\n .set(target, propertyKey, V, receiver?) -> bool\n .setPrototypeOf(target, proto) -> bool (required __proto__ - IE11+)\n```\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es6/reflect\ncore-js(/library)/fn/reflect\ncore-js(/library)/fn/reflect/apply\ncore-js(/library)/fn/reflect/construct\ncore-js(/library)/fn/reflect/define-property\ncore-js(/library)/fn/reflect/delete-property\ncore-js(/library)/fn/reflect/enumerate (deprecated and will be removed from the next major release)\ncore-js(/library)/fn/reflect/get\ncore-js(/library)/fn/reflect/get-own-property-descriptor\ncore-js(/library)/fn/reflect/get-prototype-of\ncore-js(/library)/fn/reflect/has\ncore-js(/library)/fn/reflect/is-extensible\ncore-js(/library)/fn/reflect/own-keys\ncore-js(/library)/fn/reflect/prevent-extensions\ncore-js(/library)/fn/reflect/set\ncore-js(/library)/fn/reflect/set-prototype-of\n```\n[*Examples*](http://goo.gl/gVT0cH):\n```js\nvar O = {a: 1};\nObject.defineProperty(O, 'b', {value: 2});\nO[Symbol('c')] = 3;\nReflect.ownKeys(O); // => ['a', 'b', Symbol(c)]\n\nfunction C(a, b){\n this.c = a + b;\n}\n\nvar instance = Reflect.construct(C, [20, 22]);\ninstance.c; // => 42\n```\n\n### ECMAScript 7+ proposals\n[The TC39 process.](https://tc39.github.io/process-document/)\n\n[*CommonJS entry points:*](#commonjs)\n```\ncore-js(/library)/es7\ncore-js(/library)/es7/array\ncore-js(/library)/es7/global\ncore-js(/library)/es7/string\ncore-js(/library)/es7/map\ncore-js(/library)/es7/set\ncore-js(/library)/es7/error\ncore-js(/library)/es7/math\ncore-js(/library)/es7/system\ncore-js(/library)/es7/symbol\ncore-js(/library)/es7/reflect\ncore-js(/library)/es7/observable\n```\n`core-js/stage/4` entry point contains only stage 4 proposals, `core-js/stage/3` - stage 3 and stage 4, etc.\n#### Stage 4 proposals\n\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/stage/4\n```\n* `{Array, %TypedArray%}#includes` [proposal](https://github.com/tc39/Array.prototype.includes) - module [`es7.array.includes`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.array.includes.js), `%TypedArray%` version in modules from [this section](#ecmascript-6-typed-arrays).\n```js\nArray\n #includes(var, from?) -> bool\n{\n Int8Array,\n Uint8Array,\n Uint8ClampedArray,\n Int16Array,\n Uint16Array,\n Int32Array,\n Uint32Array,\n Float32Array,\n Float64Array\n}\n #includes(var, from?) -> bool\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/array/includes\n```\n[*Examples*](http://goo.gl/2Gq4ma):\n```js\n[1, 2, 3].includes(2); // => true\n[1, 2, 3].includes(4); // => false\n[1, 2, 3].includes(2, 2); // => false\n\n[NaN].indexOf(NaN); // => -1\n[NaN].includes(NaN); // => true\nArray(1).indexOf(undefined); // => -1\nArray(1).includes(undefined); // => true\n```\n* `Object.values`, `Object.entries` [proposal](https://github.com/tc39/proposal-object-values-entries) - modules [`es7.object.values`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.values.js), [`es7.object.entries`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.entries.js)\n```js\nObject\n .values(object) -> array\n .entries(object) -> array\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/object/values\ncore-js(/library)/fn/object/entries\n```\n[*Examples*](http://goo.gl/6kuGOn):\n```js\nObject.values({a: 1, b: 2, c: 3}); // => [1, 2, 3]\nObject.entries({a: 1, b: 2, c: 3}); // => [['a', 1], ['b', 2], ['c', 3]]\n\nfor(let [key, value] of Object.entries({a: 1, b: 2, c: 3})){\n console.log(key); // => 'a', 'b', 'c'\n console.log(value); // => 1, 2, 3\n}\n```\n* `Object.getOwnPropertyDescriptors` [proposal](https://github.com/tc39/proposal-object-getownpropertydescriptors) - module [`es7.object.get-own-property-descriptors`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.get-own-property-descriptors.js)\n```js\nObject\n .getOwnPropertyDescriptors(object) -> object\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/object/get-own-property-descriptors\n```\n*Examples*:\n```js\n// Shallow object cloning with prototype and descriptors:\nvar copy = Object.create(Object.getPrototypeOf(O), Object.getOwnPropertyDescriptors(O));\n// Mixin:\nObject.defineProperties(target, Object.getOwnPropertyDescriptors(source));\n```\n* `String#padStart`, `String#padEnd` [proposal](https://github.com/tc39/proposal-string-pad-start-end) - modules [`es7.string.pad-start`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.string.pad-start.js), [`es7.string.pad-end`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.string.pad-end.js)\n```js\nString\n #padStart(length, fillStr = ' ') -> string\n #padEnd(length, fillStr = ' ') -> string\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/string/pad-start\ncore-js(/library)/fn/string/pad-end\ncore-js(/library)/fn/string/virtual/pad-start\ncore-js(/library)/fn/string/virtual/pad-end\n```\n[*Examples*](http://goo.gl/hK5ccv):\n```js\n'hello'.padStart(10); // => ' hello'\n'hello'.padStart(10, '1234'); // => '12341hello'\n'hello'.padEnd(10); // => 'hello '\n'hello'.padEnd(10, '1234'); // => 'hello12341'\n```\n* `Object#__(define|lookup)[GS]etter__`, [annex B ES2017](https://github.com/tc39/ecma262/pull/381), but we haven't special namespace for that - modules [`es7.object.define-setter`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.define-setter.js), [`es7.object.define-getter`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.define-getter.js), [`es7.object.lookup-setter`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.lookup-setter.js) and [`es7.object.lookup-getter`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.object.lookup-getter.js).\n```js\nObject\n #__defineSetter__(key, fn) -> void\n #__defineGetter__(key, fn) -> void\n #__lookupSetter__(key) -> fn | void\n #__lookupGetter__(key) -> fn | void\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/object/define-getter\ncore-js(/library)/fn/object/define-setter\ncore-js(/library)/fn/object/lookup-getter\ncore-js(/library)/fn/object/lookup-setter\n```\n\n#### Stage 3 proposals\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/stage/3\n```\n* `global` [proposal](https://github.com/tc39/proposal-global) - modules [`es7.global`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.global.js) and [`es7.system.global`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.system.global.js) (obsolete)\n```js\nglobal -> object\nSystem\n .global -> object (obsolete)\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/global\ncore-js(/library)/fn/system/global (obsolete)\n```\n[*Examples*](http://goo.gl/gEqMl7):\n```js\nglobal.Array === Array; // => true\n```\n* `Promise#finally` [proposal](https://github.com/tc39/proposal-promise-finally) - module [`es7.promise.finally`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.promise.finally.js)\n```js\nPromise\n #finally(onFinally()) -> promise\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/promise/finally\n```\n[*Examples*](https://goo.gl/AhyBbJ):\n```js\nPromise.resolve(42).finally(() => console.log('You will see it anyway'));\n\nPromise.reject(42).finally(() => console.log('You will see it anyway'));\n\n#### Stage 2 proposals\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/stage/2\n```\n* `String#trimLeft`, `String#trimRight` / `String#trimStart`, `String#trimEnd` [proposal](https://github.com/sebmarkbage/ecmascript-string-left-right-trim) - modules [`es7.string.trim-left`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.string.trim-right.js), [`es7.string.trim-right`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.string.trim-right.js)\n```js\nString\n #trimLeft() -> string\n #trimRight() -> string\n #trimStart() -> string\n #trimEnd() -> string\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/string/trim-start\ncore-js(/library)/fn/string/trim-end\ncore-js(/library)/fn/string/trim-left\ncore-js(/library)/fn/string/trim-right\ncore-js(/library)/fn/string/virtual/trim-start\ncore-js(/library)/fn/string/virtual/trim-end\ncore-js(/library)/fn/string/virtual/trim-left\ncore-js(/library)/fn/string/virtual/trim-right\n```\n[*Examples*](http://goo.gl/Er5lMJ):\n```js\n' hello '.trimLeft(); // => 'hello '\n' hello '.trimRight(); // => ' hello'\n```\n```\n* `Symbol.asyncIterator` for [async iteration proposal](https://github.com/tc39/proposal-async-iteration) - module [`es7.symbol.async-iterator`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.symbol.async-iterator.js)\n```js\nSymbol\n .asyncIterator -> @@asyncIterator\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/symbol/async-iterator\n```\n\n#### Stage 1 proposals\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/stage/1\n```\n* `Promise.try` [proposal](https://github.com/tc39/proposal-promise-try) - module [`es7.promise.try`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.promise.try.js)\n```js\nPromise\n .try(function()) -> promise\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/promise/try\n```\n[*Examples*](https://goo.gl/k5GGRo):\n```js\nPromise.try(() => 42).then(it => console.log(`Promise, resolved as ${it}`));\n\nPromise.try(() => { throw 42; }).catch(it => console.log(`Promise, rejected as ${it}`));\n```\n* `Array#flatten` and `Array#flatMap` [proposal](https://tc39.github.io/proposal-flatMap) - modules [`es7.array.flatten`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.array.flatten.js) and [`es7.array.flat-map`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.array.flat-map.js)\n```js\nArray\n #flatten(depthArg = 1) -> array\n #flatMap(fn(val, key, @), that) -> array\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/array/flatten\ncore-js(/library)/fn/array/flat-map\ncore-js(/library)/fn/array/virtual/flatten\ncore-js(/library)/fn/array/virtual/flat-map\n```\n[*Examples*](https://goo.gl/jTXsZi):\n```js\n[1, [2, 3], [4, 5]].flatten(); // => [1, 2, 3, 4, 5]\n[1, [2, [3, [4]]], 5].flatten(); // => [1, 2, [3, [4]], 5]\n[1, [2, [3, [4]]], 5].flatten(3); // => [1, 2, 3, 4, 5]\n\n[{a: 1, b: 2}, {a: 3, b: 4}, {a: 5, b: 6}].flatMap(it => [it.a, it.b]); // => [1, 2, 3, 4, 5, 6]\n```\n* `.of` and `.from` methods on collection constructors [proposal](https://github.com/tc39/proposal-setmap-offrom) - modules [`es7.set.of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.set.of.js), [`es7.set.from`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.set.from.js), [`es7.map.of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.map.of.js), [`es7.map.from`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.map.from.js), [`es7.weak-set.of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.weak-set.of.js), [`es7.weak-set.from`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.weak-set.from.js), [`es7.weak-map.of`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.weak-map.of.js), [`es7.weak-map.from`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.weak-map.from.js)\n```js\nSet\n .of(...args) -> set\n .from(iterable, mapFn(val, index)?, that?) -> set\nMap\n .of(...args) -> map\n .from(iterable, mapFn(val, index)?, that?) -> map\nWeakSet\n .of(...args) -> weakset\n .from(iterable, mapFn(val, index)?, that?) -> weakset\nWeakMap\n .of(...args) -> weakmap\n .from(iterable, mapFn(val, index)?, that?) -> weakmap\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/set/of\ncore-js(/library)/fn/set/from\ncore-js(/library)/fn/map/of\ncore-js(/library)/fn/map/from\ncore-js(/library)/fn/weak-set/of\ncore-js(/library)/fn/weak-set/from\ncore-js(/library)/fn/weak-map/of\ncore-js(/library)/fn/weak-map/from\n```\n[*Examples*](https://goo.gl/mSC7eU):\n```js\nSet.of(1, 2, 3, 2, 1); // => Set {1, 2, 3}\n\nMap.from([[1, 2], [3, 4]], ([key, val]) => [key ** 2, val ** 2]); // => Map {1: 4, 9: 16}\n```\n* `String#matchAll` [proposal](https://github.com/tc39/String.prototype.matchAll) - module [`es7.string.match-all`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.string.match-all.js)\n```js\nString\n #matchAll(regexp) -> iterator\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/string/match-all\ncore-js(/library)/fn/string/virtual/match-all\n```\n[*Examples*](http://goo.gl/6kp9EB):\n```js\nfor(let [_, d, D] of '1111a2b3cccc'.matchAll(/(\\d)(\\D)/)){\n console.log(d, D); // => 1 a, 2 b, 3 c\n}\n```\n* `Observable` [proposal](https://github.com/zenparsing/es-observable) - modules [`es7.observable`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.observable.js) and [`es7.symbol.observable`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.symbol.observable.js)\n```js\nnew Observable(fn) -> observable\n #subscribe(observer) -> subscription\n #forEach(fn) -> promise\n #@@observable() -> @\n .of(...items) -> observable\n .from(observable | iterable) -> observable\n .@@species -> @\nSymbol\n .observable -> @@observable\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/observable\ncore-js(/library)/fn/symbol/observable\n```\n[*Examples*](http://goo.gl/1LDywi):\n```js\nnew Observable(observer => {\n observer.next('hello');\n observer.next('world');\n observer.complete();\n}).forEach(it => console.log(it))\n .then(_ => console.log('!'));\n```\n* `Math.{clamp, DEG_PER_RAD, degrees, fscale, rad-per-deg, radians, scale}` \n [proposal](https://github.com/rwaldron/proposal-math-extensions) - modules \n [`es7.math.clamp`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.clamp.js), \n [`es7.math.DEG_PER_RAD`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.DEG_PER_RAD.js), \n [`es7.math.degrees`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.degrees.js),\n [`es7.math.fscale`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.fscale.js), \n [`es7.math.RAD_PER_DEG`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.RAD_PER_DEG.js), \n [`es7.math.radians`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.radians.js) and\n [`es7.math.scale`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.scale.js)\n```js\nMath\n .DEG_PER_RAD -> number\n .RAD_PER_DEG -> number\n .clamp(x, lower, upper) -> number\n .degrees(radians) -> number\n .fscale(x, inLow, inHigh, outLow, outHigh) -> number\n .radians(degrees) -> number\n .scale(x, inLow, inHigh, outLow, outHigh) -> number\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/math/clamp\ncore-js(/library)/fn/math/deg-per-rad\ncore-js(/library)/fn/math/degrees\ncore-js(/library)/fn/math/fscale\ncore-js(/library)/fn/math/rad-per-deg\ncore-js(/library)/fn/math/radians\ncore-js(/library)/fn/math/scale\n```\n* `Math.signbit` [proposal](http://jfbastien.github.io/papers/Math.signbit.html) - module [`es7.math.signbit`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.signbit.js)\n```js\nMath\n .signbit(x) -> bool\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/math/signbit\n```\n[*Examples*](http://es6.zloirock.ru/):\n```js\nMath.signbit(NaN); // => NaN\nMath.signbit(1); // => true\nMath.signbit(-1); // => false\nMath.signbit(0); // => true\nMath.signbit(-0); // => false\n```\n\n#### Stage 0 proposals\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/stage/0\n```\n* `String#at` [proposal](https://github.com/mathiasbynens/String.prototype.at) - module [`es7.string.at`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.string.at.js)\n```js\nString\n #at(index) -> string\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/string/at\ncore-js(/library)/fn/string/virtual/at\n```\n[*Examples*](http://goo.gl/XluXI8):\n```js\n'a𠮷b'.at(1); // => '𠮷'\n'a𠮷b'.at(1).length; // => 2\n```\n* `Map#toJSON`, `Set#toJSON` [proposal](https://github.com/DavidBruant/Map-Set.prototype.toJSON) - modules [`es7.map.to-json`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.map.to-json.js), [`es7.set.to-json`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.set.to-json.js) (rejected and will be removed from `core-js@3`)\n```js\nMap\n #toJSON() -> array (rejected and will be removed from core-js@3)\nSet\n #toJSON() -> array (rejected and will be removed from core-js@3)\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/map\ncore-js(/library)/fn/set\n```\n* `Error.isError` [proposal](https://github.com/ljharb/proposal-is-error) - module [`es7.error.is-error`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.error.is-error.js) (withdrawn and will be removed from `core-js@3`)\n```js\nError\n .isError(it) -> bool (withdrawn and will be removed from core-js@3)\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/error/is-error\n```\n* `Math.{iaddh, isubh, imulh, umulh}` [proposal](https://gist.github.com/BrendanEich/4294d5c212a6d2254703) - modules [`es7.math.iaddh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.iaddh.js), [`es7.math.isubh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.isubh.js), [`es7.math.imulh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.imulh.js) and [`es7.math.umulh`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.math.umulh.js)\n```js\nMath\n .iaddh(lo0, hi0, lo1, hi1) -> int32\n .isubh(lo0, hi0, lo1, hi1) -> int32\n .imulh(a, b) -> int32\n .umulh(a, b) -> uint32\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/math/iaddh\ncore-js(/library)/fn/math/isubh\ncore-js(/library)/fn/math/imulh\ncore-js(/library)/fn/math/umulh\n```\n* `global.asap`, [TC39 discussion](https://github.com/rwaldron/tc39-notes/blob/master/es6/2014-09/sept-25.md#510-globalasap-for-enqueuing-a-microtask), module [`es7.asap`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.asap.js)\n```js\nasap(fn) -> void\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/asap\n```\n[*Examples*](http://goo.gl/tx3SRK):\n```js\nasap(() => console.log('called as microtask'));\n```\n\n#### Pre-stage 0 proposals\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/stage/pre\n```\n* `Reflect` metadata [proposal](https://github.com/jonathandturner/decorators/blob/master/specs/metadata.md) - modules [`es7.reflect.define-metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.define-metadata.js), [`es7.reflect.delete-metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.delete-metadata.js), [`es7.reflect.get-metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.get-metadata.js), [`es7.reflect.get-metadata-keys`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.get-metadata-keys.js), [`es7.reflect.get-own-metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.get-own-metadata.js), [`es7.reflect.get-own-metadata-keys`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.get-own-metadata-keys.js), [`es7.reflect.has-metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.has-metadata.js), [`es7.reflect.has-own-metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.has-own-metadata.js) and [`es7.reflect.metadata`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/es7.reflect.metadata.js).\n```js\nReflect\n .defineMetadata(metadataKey, metadataValue, target, propertyKey?) -> void\n .getMetadata(metadataKey, target, propertyKey?) -> var\n .getOwnMetadata(metadataKey, target, propertyKey?) -> var\n .hasMetadata(metadataKey, target, propertyKey?) -> bool\n .hasOwnMetadata(metadataKey, target, propertyKey?) -> bool\n .deleteMetadata(metadataKey, target, propertyKey?) -> bool\n .getMetadataKeys(target, propertyKey?) -> array\n .getOwnMetadataKeys(target, propertyKey?) -> array\n .metadata(metadataKey, metadataValue) -> decorator(target, targetKey?) -> void\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/reflect/define-metadata\ncore-js(/library)/fn/reflect/delete-metadata\ncore-js(/library)/fn/reflect/get-metadata\ncore-js(/library)/fn/reflect/get-metadata-keys\ncore-js(/library)/fn/reflect/get-own-metadata\ncore-js(/library)/fn/reflect/get-own-metadata-keys\ncore-js(/library)/fn/reflect/has-metadata\ncore-js(/library)/fn/reflect/has-own-metadata\ncore-js(/library)/fn/reflect/metadata\n```\n[*Examples*](http://goo.gl/KCo3PS):\n```js\nvar O = {};\nReflect.defineMetadata('foo', 'bar', O);\nReflect.ownKeys(O); // => []\nReflect.getOwnMetadataKeys(O); // => ['foo']\nReflect.getOwnMetadata('foo', O); // => 'bar'\n```\n\n### Web standards\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/web\n```\n#### setTimeout / setInterval\nModule [`web.timers`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/web.timers.js). Additional arguments fix for IE9-.\n```js\nsetTimeout(fn(...args), time, ...args) -> id\nsetInterval(fn(...args), time, ...args) -> id\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/web/timers\ncore-js(/library)/fn/set-timeout\ncore-js(/library)/fn/set-interval\n```\n```js\n// Before:\nsetTimeout(log.bind(null, 42), 1000);\n// After:\nsetTimeout(log, 1000, 42);\n```\n#### setImmediate\nModule [`web.immediate`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/web.immediate.js). [`setImmediate` proposal](https://developer.mozilla.org/en-US/docs/Web/API/Window.setImmediate) polyfill.\n```js\nsetImmediate(fn(...args), ...args) -> id\nclearImmediate(id) -> void\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/web/immediate\ncore-js(/library)/fn/set-immediate\ncore-js(/library)/fn/clear-immediate\n```\n[*Examples*](http://goo.gl/6nXGrx):\n```js\nsetImmediate(function(arg1, arg2){\n console.log(arg1, arg2); // => Message will be displayed with minimum delay\n}, 'Message will be displayed', 'with minimum delay');\n\nclearImmediate(setImmediate(function(){\n console.log('Message will not be displayed');\n}));\n```\n#### Iterable DOM collections\nSome DOM collections should have [iterable interface](https://heycam.github.io/webidl/#idl-iterable) or should be [inherited from `Array`](https://heycam.github.io/webidl/#LegacyArrayClass). That mean they should have `keys`, `values`, `entries` and `@@iterator` methods for iteration. So add them. Module [`web.dom.iterable`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/web.dom.iterable.js):\n```js\n{\n CSSRuleList,\n CSSStyleDeclaration,\n CSSValueList,\n ClientRectList,\n DOMRectList,\n DOMStringList,\n DOMTokenList,\n DataTransferItemList,\n FileList,\n HTMLAllCollection,\n HTMLCollection,\n HTMLFormElement,\n HTMLSelectElement,\n MediaList,\n MimeTypeArray,\n NamedNodeMap,\n NodeList,\n PaintRequestList,\n Plugin,\n PluginArray,\n SVGLengthList,\n SVGNumberList,\n SVGPathSegList,\n SVGPointList,\n SVGStringList,\n SVGTransformList,\n SourceBufferList,\n StyleSheetList,\n TextTrackCueList,\n TextTrackList,\n TouchList\n}\n #@@iterator() -> iterator (values)\n\n{\n DOMTokenList,\n NodeList\n}\n #values() -> iterator\n #keys() -> iterator\n #entries() -> iterator\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/web/dom-collections\ncore-js(/library)/fn/dom-collections/iterator\n```\n[*Examples*](http://goo.gl/lfXVFl):\n```js\nfor(var {id} of document.querySelectorAll('*')){\n if(id)console.log(id);\n}\n\nfor(var [index, {id}] of document.querySelectorAll('*').entries()){\n if(id)console.log(index, id);\n}\n```\n### Non-standard\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/core\n```\n#### Object\nModules [`core.object.is-object`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.object.is-object.js), [`core.object.classof`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.object.classof.js), [`core.object.define`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.object.define.js), [`core.object.make`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.object.make.js).\n```js\nObject\n .isObject(var) -> bool\n .classof(var) -> string\n .define(target, mixin) -> target\n .make(proto | null, mixin?) -> object\n```\n\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/core/object\ncore-js(/library)/fn/object/is-object\ncore-js(/library)/fn/object/define\ncore-js(/library)/fn/object/make\n```\nObject classify [*examples*](http://goo.gl/YZQmGo):\n```js\nObject.isObject({}); // => true\nObject.isObject(isNaN); // => true\nObject.isObject(null); // => false\n\nvar classof = Object.classof;\n\nclassof(null); // => 'Null'\nclassof(undefined); // => 'Undefined'\nclassof(1); // => 'Number'\nclassof(true); // => 'Boolean'\nclassof('string'); // => 'String'\nclassof(Symbol()); // => 'Symbol'\n\nclassof(new Number(1)); // => 'Number'\nclassof(new Boolean(true)); // => 'Boolean'\nclassof(new String('string')); // => 'String'\n\nvar fn = function(){}\n , list = (function(){return arguments})(1, 2, 3);\n\nclassof({}); // => 'Object'\nclassof(fn); // => 'Function'\nclassof([]); // => 'Array'\nclassof(list); // => 'Arguments'\nclassof(/./); // => 'RegExp'\nclassof(new TypeError); // => 'Error'\n\nclassof(new Set); // => 'Set'\nclassof(new Map); // => 'Map'\nclassof(new WeakSet); // => 'WeakSet'\nclassof(new WeakMap); // => 'WeakMap'\nclassof(new Promise(fn)); // => 'Promise'\n\nclassof([].values()); // => 'Array Iterator'\nclassof(new Set().values()); // => 'Set Iterator'\nclassof(new Map().values()); // => 'Map Iterator'\n\nclassof(Math); // => 'Math'\nclassof(JSON); // => 'JSON'\n\nfunction Example(){}\nExample.prototype[Symbol.toStringTag] = 'Example';\n\nclassof(new Example); // => 'Example'\n```\n`Object.define` and `Object.make` [*examples*](http://goo.gl/rtpD5Z):\n```js\n// Before:\nObject.defineProperty(target, 'c', {\n enumerable: true,\n configurable: true,\n get: function(){\n return this.a + this.b;\n }\n});\n\n// After:\nObject.define(target, {\n get c(){\n return this.a + this.b;\n }\n});\n\n// Shallow object cloning with prototype and descriptors:\nvar copy = Object.make(Object.getPrototypeOf(src), src);\n\n// Simple inheritance:\nfunction Vector2D(x, y){\n this.x = x;\n this.y = y;\n}\nObject.define(Vector2D.prototype, {\n get xy(){\n return Math.hypot(this.x, this.y);\n }\n});\nfunction Vector3D(x, y, z){\n Vector2D.apply(this, arguments);\n this.z = z;\n}\nVector3D.prototype = Object.make(Vector2D.prototype, {\n constructor: Vector3D,\n get xyz(){\n return Math.hypot(this.x, this.y, this.z);\n }\n});\n\nvar vector = new Vector3D(9, 12, 20);\nconsole.log(vector.xy); // => 15\nconsole.log(vector.xyz); // => 25\nvector.y++;\nconsole.log(vector.xy); // => 15.811388300841896\nconsole.log(vector.xyz); // => 25.495097567963924\n```\n#### Dict\nModule [`core.dict`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.dict.js). Based on [TC39 discuss](https://github.com/rwaldron/tc39-notes/blob/master/es6/2012-11/nov-29.md#collection-apis-review) / [strawman](http://wiki.ecmascript.org/doku.php?id=harmony:modules_standard#dictionaries).\n```js\n[new] Dict(iterable (entries) | object ?) -> dict\n .isDict(var) -> bool\n .values(object) -> iterator\n .keys(object) -> iterator\n .entries(object) -> iterator (entries)\n .has(object, key) -> bool\n .get(object, key) -> val\n .set(object, key, value) -> object\n .forEach(object, fn(val, key, @), that) -> void\n .map(object, fn(val, key, @), that) -> new @\n .mapPairs(object, fn(val, key, @), that) -> new @\n .filter(object, fn(val, key, @), that) -> new @\n .some(object, fn(val, key, @), that) -> bool\n .every(object, fn(val, key, @), that) -> bool\n .find(object, fn(val, key, @), that) -> val\n .findKey(object, fn(val, key, @), that) -> key\n .keyOf(object, var) -> key\n .includes(object, var) -> bool\n .reduce(object, fn(memo, val, key, @), memo?) -> var\n```\n\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/core/dict\ncore-js(/library)/fn/dict\n```\n`Dict` create object without prototype from iterable or simple object.\n\n[*Examples*](http://goo.gl/pnp8Vr):\n```js\nvar map = new Map([['a', 1], ['b', 2], ['c', 3]]);\n\nDict(); // => {__proto__: null}\nDict({a: 1, b: 2, c: 3}); // => {__proto__: null, a: 1, b: 2, c: 3}\nDict(map); // => {__proto__: null, a: 1, b: 2, c: 3}\nDict([1, 2, 3].entries()); // => {__proto__: null, 0: 1, 1: 2, 2: 3}\n\nvar dict = Dict({a: 42});\ndict instanceof Object; // => false\ndict.a; // => 42\ndict.toString; // => undefined\n'a' in dict; // => true\n'hasOwnProperty' in dict; // => false\n\nDict.isDict({}); // => false\nDict.isDict(Dict()); // => true\n```\n`Dict.keys`, `Dict.values` and `Dict.entries` returns iterators for objects.\n\n[*Examples*](http://goo.gl/xAvECH):\n```js\nvar dict = {a: 1, b: 2, c: 3};\n\nfor(var key of Dict.keys(dict))console.log(key); // => 'a', 'b', 'c'\n\nfor(var val of Dict.values(dict))console.log(val); // => 1, 2, 3\n\nfor(var [key, val] of Dict.entries(dict)){\n console.log(key); // => 'a', 'b', 'c'\n console.log(val); // => 1, 2, 3\n}\n\nnew Map(Dict.entries(dict)); // => Map {a: 1, b: 2, c: 3}\n```\nBasic dict operations for objects with prototype [*examples*](http://goo.gl/B28UnG):\n```js\n'q' in {q: 1}; // => true\n'toString' in {}; // => true\n\nDict.has({q: 1}, 'q'); // => true\nDict.has({}, 'toString'); // => false\n\n({q: 1})['q']; // => 1\n({}).toString; // => function toString(){ [native code] }\n\nDict.get({q: 1}, 'q'); // => 1\nDict.get({}, 'toString'); // => undefined\n\nvar O = {};\nO['q'] = 1;\nO['q']; // => 1\nO['__proto__'] = {w: 2};\nO['__proto__']; // => {w: 2}\nO['w']; // => 2\n\nvar O = {};\nDict.set(O, 'q', 1);\nO['q']; // => 1\nDict.set(O, '__proto__', {w: 2});\nO['__proto__']; // => {w: 2}\nO['w']; // => undefined\n```\nOther methods of `Dict` module are static equivalents of `Array.prototype` methods for dictionaries.\n\n[*Examples*](http://goo.gl/xFi1RH):\n```js\nvar dict = {a: 1, b: 2, c: 3};\n\nDict.forEach(dict, console.log, console);\n// => 1, 'a', {a: 1, b: 2, c: 3}\n// => 2, 'b', {a: 1, b: 2, c: 3}\n// => 3, 'c', {a: 1, b: 2, c: 3}\n\nDict.map(dict, function(it){\n return it * it;\n}); // => {a: 1, b: 4, c: 9}\n\nDict.mapPairs(dict, function(val, key){\n if(key != 'b')return [key + key, val * val];\n}); // => {aa: 1, cc: 9}\n\nDict.filter(dict, function(it){\n return it % 2;\n}); // => {a: 1, c: 3}\n\nDict.some(dict, function(it){\n return it === 2;\n}); // => true\n\nDict.every(dict, function(it){\n return it === 2;\n}); // => false\n\nDict.find(dict, function(it){\n return it > 2;\n}); // => 3\nDict.find(dict, function(it){\n return it > 4;\n}); // => undefined\n\nDict.findKey(dict, function(it){\n return it > 2;\n}); // => 'c'\nDict.findKey(dict, function(it){\n return it > 4;\n}); // => undefined\n\nDict.keyOf(dict, 2); // => 'b'\nDict.keyOf(dict, 4); // => undefined\n\nDict.includes(dict, 2); // => true\nDict.includes(dict, 4); // => false\n\nDict.reduce(dict, function(memo, it){\n return memo + it;\n}); // => 6\nDict.reduce(dict, function(memo, it){\n return memo + it;\n}, ''); // => '123'\n```\n#### Partial application\nModule [`core.function.part`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.function.part.js).\n```js\nFunction\n #part(...args | _) -> fn(...args)\n```\n\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js/core/function\ncore-js(/library)/fn/function/part\ncore-js(/library)/fn/function/virtual/part\ncore-js(/library)/fn/_\n```\n`Function#part` partial apply function without `this` binding. Uses global variable `_` (`core._` for builds without global namespace pollution) as placeholder and not conflict with `Underscore` / `LoDash`.\n\n[*Examples*](http://goo.gl/p9ZJ8K):\n```js\nvar fn1 = log.part(1, 2);\nfn1(3, 4); // => 1, 2, 3, 4\n\nvar fn2 = log.part(_, 2, _, 4);\nfn2(1, 3); // => 1, 2, 3, 4\n\nvar fn3 = log.part(1, _, _, 4);\nfn3(2, 3); // => 1, 2, 3, 4\n\nfn2(1, 3, 5); // => 1, 2, 3, 4, 5\nfn2(1); // => 1, 2, undefined, 4\n```\n#### Number Iterator\nModule [`core.number.iterator`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.number.iterator.js).\n```js\nNumber\n #@@iterator() -> iterator\n```\n\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/core/number\ncore-js(/library)/fn/number/iterator\ncore-js(/library)/fn/number/virtual/iterator\n```\n[*Examples*](http://goo.gl/o45pCN):\n```js\nfor(var i of 3)console.log(i); // => 0, 1, 2\n\n[...10]; // => [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]\n\nArray.from(10, Math.random); // => [0.9817775336559862, 0.02720663254149258, ...]\n\nArray.from(10, function(it){\n return this + it * it;\n}, .42); // => [0.42, 1.42, 4.42, 9.42, 16.42, 25.42, 36.42, 49.42, 64.42, 81.42]\n```\n#### Escaping strings\nModules [`core.regexp.escape`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.regexp.escape.js), [`core.string.escape-html`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.string.escape-html.js) and [`core.string.unescape-html`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.string.unescape-html.js).\n```js\nRegExp\n .escape(str) -> str\nString\n #escapeHTML() -> str\n #unescapeHTML() -> str\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/core/regexp\ncore-js(/library)/core/string\ncore-js(/library)/fn/regexp/escape\ncore-js(/library)/fn/string/escape-html\ncore-js(/library)/fn/string/unescape-html\ncore-js(/library)/fn/string/virtual/escape-html\ncore-js(/library)/fn/string/virtual/unescape-html\n```\n[*Examples*](http://goo.gl/6bOvsQ):\n```js\nRegExp.escape('Hello, []{}()*+?.\\\\^$|!'); // => 'Hello, \\[\\]\\{\\}\\(\\)\\*\\+\\?\\.\\\\\\^\\$\\|!'\n\n'<script>doSomething();</script>'.escapeHTML(); // => '<script>doSomething();</script>'\n'<script>doSomething();</script>'.unescapeHTML(); // => '<script>doSomething();</script>'\n```\n#### delay\nModule [`core.delay`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.delay.js). [Promise](#ecmascript-6-promise)-returning delay function, [esdiscuss](https://esdiscuss.org/topic/promise-returning-delay-function).\n```js\ndelay(ms) -> promise\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/core/delay\ncore-js(/library)/fn/delay\n```\n[*Examples*](http://goo.gl/lbucba):\n```js\ndelay(1e3).then(() => console.log('after 1 sec'));\n\n(async () => {\n await delay(3e3);\n console.log('after 3 sec');\n\n while(await delay(3e3))console.log('each 3 sec');\n})();\n```\n#### Helpers for iterators\nModules [`core.is-iterable`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.is-iterable.js), [`core.get-iterator`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.get-iterator.js), [`core.get-iterator-method`](https://github.com/zloirock/core-js/blob/v2.6.11/modules/core.get-iterator-method.js) - helpers for check iterability / get iterator in the `library` version or, for example, for `arguments` object:\n```js\ncore\n .isIterable(var) -> bool\n .getIterator(iterable) -> iterator\n .getIteratorMethod(var) -> function | undefined\n```\n[*CommonJS entry points:*](#commonjs)\n```js\ncore-js(/library)/fn/is-iterable\ncore-js(/library)/fn/get-iterator\ncore-js(/library)/fn/get-iterator-method\n```\n[*Examples*](http://goo.gl/SXsM6D):\n```js\nvar list = (function(){\n return arguments;\n})(1, 2, 3);\n\nconsole.log(core.isIterable(list)); // true;\n\nvar iter = core.getIterator(list);\nconsole.log(iter.next().value); // 1\nconsole.log(iter.next().value); // 2\nconsole.log(iter.next().value); // 3\nconsole.log(iter.next().value); // undefined\n\ncore.getIterator({}); // TypeError: [object Object] is not iterable!\n\nvar iterFn = core.getIteratorMethod(list);\nconsole.log(typeof iterFn); // 'function'\nvar iter = iterFn.call(list);\nconsole.log(iter.next().value); // 1\nconsole.log(iter.next().value); // 2\nconsole.log(iter.next().value); // 3\nconsole.log(iter.next().value); // undefined\n\nconsole.log(core.getIteratorMethod({})); // undefined\n```\n\n## Missing polyfills\n- ES5 `JSON` is missing now only in IE7- and never will it be added to `core-js`, if you need it in these old browsers, many implementations are available, for example, [json3](https://github.com/bestiejs/json3).\n- ES6 `String#normalize` is not a very useful feature, but this polyfill will be very large. If you need it, you can use [unorm](https://github.com/walling/unorm/).\n- ES6 `Proxy` can't be polyfilled, but for Node.js / Chromium with additional flags you can try [harmony-reflect](https://github.com/tvcutsem/harmony-reflect) for adapt old style `Proxy` API to final ES6 version.\n- ES6 logic for `@@isConcatSpreadable` and `@@species` (in most places) can be polyfilled without problems, but it will cause a serious slowdown in popular cases in some engines. It will be polyfilled when it will be implemented in modern engines.\n- ES7 `SIMD`. `core-js` doesn't add polyfill of this feature because of large size and some other reasons. You can use [this polyfill](https://github.com/tc39/ecmascript_simd/blob/master/src/ecmascript_simd.js).\n- `window.fetch` is not a cross-platform feature, in some environments it makes no sense. For this reason, I don't think it should be in `core-js`. Looking at a large number of requests it *may be* added in the future. Now you can use, for example, [this polyfill](https://github.com/github/fetch).\n- ECMA-402 `Intl` is missed because of size. You can use [this polyfill](https://github.com/andyearnshaw/Intl.js/).\n#is-symbol <sup>[![Version Badge][2]][1]</sup>\n\n[![Build Status][3]][4]\n[![dependency status][5]][6]\n[![dev dependency status][7]][8]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][11]][1]\n\n[![browser support][9]][10]\n\nIs this an ES6 Symbol value?\n\n## Example\n\n```js\nvar isSymbol = require('is-symbol');\nassert(!isSymbol(function () {}));\nassert(!isSymbol(null));\nassert(!isSymbol(function* () { yield 42; return Infinity; });\n\nassert(isSymbol(Symbol.iterator));\nassert(isSymbol(Symbol('foo')));\nassert(isSymbol(Symbol.for('foo')));\nassert(isSymbol(Object(Symbol('foo'))));\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[1]: https://npmjs.org/package/is-symbol\n[2]: http://versionbadg.es/inspect-js/is-symbol.svg\n[3]: https://travis-ci.org/inspect-js/is-symbol.svg\n[4]: https://travis-ci.org/inspect-js/is-symbol\n[5]: https://david-dm.org/inspect-js/is-symbol.svg\n[6]: https://david-dm.org/inspect-js/is-symbol\n[7]: https://david-dm.org/inspect-js/is-symbol/dev-status.svg\n[8]: https://david-dm.org/inspect-js/is-symbol#info=devDependencies\n[11]: https://nodei.co/npm/is-symbol.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/is-symbol.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/is-symbol.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=is-symbol\n# CSS Modules: Scope Locals & Extend\n\n[](https://travis-ci.org/css-modules/postcss-modules-scope)\n\nTransforms:\n\n```css\n:local(.continueButton) {\n color: green;\n}\n```\n\ninto:\n\n```css\n:export {\n continueButton: __buttons_continueButton_djd347adcxz9;\n}\n.__buttons_continueButton_djd347adcxz9 {\n color: green;\n}\n```\n\nso it doesn't pollute CSS global scope and can be simply used in JS like so:\n\n```js\nimport styles from './buttons.css'\nelem.innerHTML = `<button class=\"${styles.continueButton}\">Continue</button>`\n```\n\n## Composition\n\nSince we're exporting class names, there's no reason to export only one. This can give us some really useful reuse of styles:\n\n```css\n.globalButtonStyle {\n background: white;\n border: 1px solid;\n border-radius: 0.25rem;\n}\n.globalButtonStyle:hover {\n box-shadow: 0 0 4px -2px;\n}\n:local(.continueButton) {\n compose-with: globalButtonStyle;\n color: green;\n}\n```\n\nbecomes:\n\n```\n.globalButtonStyle {\n background: white;\n border: 1px solid;\n border-radius: 0.25rem;\n}\n.globalButtonStyle:hover {\n box-shadow: 0 0 4px -2px;\n}\n:local(.continueButton) {\n compose-with: globalButtonStyle;\n color: green;\n}\n```\n\n**Note:** you can also use `composes` as a shorthand for `compose-with`\n\n## Local-by-default & reuse across files\n\nYou're looking for [CSS Modules](https://github.com/css-modules/css-modules). It uses this plugin as well as a few others, and it's amazing.\n\n## Building\n\n```\nnpm install\nnpm test\n```\n\n[](https://travis-ci.org/css-modules/postcss-modules-scope)\n\n* Lines: [](https://coveralls.io/r/css-modules/postcss-modules-scope?branch=master)\n* Statements: [](http://codecov.io/github/css-modules/postcss-modules-scope?branch=master)\n\n## Development\n\n- `npm autotest` will watch `src` and `test` for changes and run the tests, and transpile the ES6 to ES5 on success\n\n## License\n\nISC\n\n## With thanks\n\n- Mark Dalgleish\n- Tobias Koppers\n- Guy Bedford\n\n---\nGlen Maddern, 2015.\nBrowser-friendly inheritance fully compatible with standard node.js\n[inherits](http://nodejs.org/api/util.html#util_util_inherits_constructor_superconstructor).\n\nThis package exports standard `inherits` from node.js `util` module in\nnode environment, but also provides alternative browser-friendly\nimplementation through [browser\nfield](https://gist.github.com/shtylman/4339901). Alternative\nimplementation is a literal copy of standard one located in standalone\nmodule to avoid requiring of `util`. It also has a shim for old\nbrowsers with no `Object.create` support.\n\nWhile keeping you sure you are using standard `inherits`\nimplementation in node.js environment, it allows bundlers such as\n[browserify](https://github.com/substack/node-browserify) to not\ninclude full `util` package to your client code if all you need is\njust `inherits` function. It worth, because browser shim for `util`\npackage is large and `inherits` is often the single function you need\nfrom it.\n\nIt's recommended to use this package instead of\n`require('util').inherits` for any code that has chances to be used\nnot only in node.js but in browser too.\n\n## usage\n\n```js\nvar inherits = require('inherits');\n// then use exactly as the standard one\n```\n\n## note on version ~1.0\n\nVersion ~1.0 had completely different motivation and is not compatible\nneither with 2.0 nor with standard node.js `inherits`.\n\nIf you are using version ~1.0 and planning to switch to ~2.0, be\ncareful:\n\n* new version uses `super_` instead of `super` for referencing\n superclass\n* new version overwrites current prototype while old one preserves any\n existing fields on it\n# color [](https://travis-ci.org/Qix-/color)\n\n> JavaScript library for immutable color conversion and manipulation with support for CSS color strings.\n\n```js\nvar color = Color('#7743CE').alpha(0.5).lighten(0.5);\nconsole.log(color.hsl().string()); // 'hsla(262, 59%, 81%, 0.5)'\n\nconsole.log(color.cmyk().round().array()); // [ 16, 25, 0, 8, 0.5 ]\n\nconsole.log(color.ansi256().object()); // { ansi256: 183, alpha: 0.5 }\n```\n\n## Install\n```console\n$ npm install color\n```\n\n## Usage\n```js\nvar Color = require('color');\n```\n\n### Constructors\n```js\nvar color = Color('rgb(255, 255, 255)')\nvar color = Color({r: 255, g: 255, b: 255})\nvar color = Color.rgb(255, 255, 255)\nvar color = Color.rgb([255, 255, 255])\n```\n\nSet the values for individual channels with `alpha`, `red`, `green`, `blue`, `hue`, `saturationl` (hsl), `saturationv` (hsv), `lightness`, `whiteness`, `blackness`, `cyan`, `magenta`, `yellow`, `black`\n\nString constructors are handled by [color-string](https://www.npmjs.com/package/color-string)\n\n### Getters\n```js\ncolor.hsl();\n```\nConvert a color to a different space (`hsl()`, `cmyk()`, etc.).\n\n```js\ncolor.object(); // {r: 255, g: 255, b: 255}\n```\nGet a hash of the color value. Reflects the color's current model (see above).\n\n```js\ncolor.rgb().array() // [255, 255, 255]\n```\nGet an array of the values with `array()`. Reflects the color's current model (see above).\n\n```js\ncolor.rgbNumber() // 16777215 (0xffffff)\n```\nGet the rgb number value.\n\n```js\ncolor.hex() // 0xffffff\n```\nGet the hex value.\n\n```js\ncolor.red() // 255\n```\nGet the value for an individual channel.\n\n### CSS Strings\n```js\ncolor.hsl().string() // 'hsl(320, 50%, 100%)'\n```\n\nCalling `.string()` with a number rounds the numbers to that decimal place. It defaults to 1.\n\n### Luminosity\n```js\ncolor.luminosity(); // 0.412\n```\nThe [WCAG luminosity](http://www.w3.org/TR/WCAG20/#relativeluminancedef) of the color. 0 is black, 1 is white.\n\n```js\ncolor.contrast(Color(\"blue\")) // 12\n```\nThe [WCAG contrast ratio](http://www.w3.org/TR/WCAG20/#contrast-ratiodef) to another color, from 1 (same color) to 21 (contrast b/w white and black).\n\n```js\ncolor.isLight(); // true\ncolor.isDark(); // false\n```\nGet whether the color is \"light\" or \"dark\", useful for deciding text color.\n\n### Manipulation\n```js\ncolor.negate() // rgb(0, 100, 255) -> rgb(255, 155, 0)\n\ncolor.lighten(0.5) // hsl(100, 50%, 50%) -> hsl(100, 50%, 75%)\ncolor.darken(0.5) // hsl(100, 50%, 50%) -> hsl(100, 50%, 25%)\n\ncolor.saturate(0.5) // hsl(100, 50%, 50%) -> hsl(100, 75%, 50%)\ncolor.desaturate(0.5) // hsl(100, 50%, 50%) -> hsl(100, 25%, 50%)\ncolor.grayscale() // #5CBF54 -> #969696\n\ncolor.whiten(0.5) // hwb(100, 50%, 50%) -> hwb(100, 75%, 50%)\ncolor.blacken(0.5) // hwb(100, 50%, 50%) -> hwb(100, 50%, 75%)\n\ncolor.fade(0.5) // rgba(10, 10, 10, 0.8) -> rgba(10, 10, 10, 0.4)\ncolor.opaquer(0.5) // rgba(10, 10, 10, 0.8) -> rgba(10, 10, 10, 1.0)\n\ncolor.rotate(180) // hsl(60, 20%, 20%) -> hsl(240, 20%, 20%)\ncolor.rotate(-90) // hsl(60, 20%, 20%) -> hsl(330, 20%, 20%)\n\ncolor.mix(Color(\"yellow\")) // cyan -> rgb(128, 255, 128)\ncolor.mix(Color(\"yellow\"), 0.3) // cyan -> rgb(77, 255, 179)\n\n// chaining\ncolor.green(100).grayscale().lighten(0.6)\n```\n\n## Propers\nThe API was inspired by [color-js](https://github.com/brehaut/color-js). Manipulation functions by CSS tools like Sass, LESS, and Stylus.\n# Acorn\n\nA tiny, fast JavaScript parser written in JavaScript.\n\n## Community\n\nAcorn is open source software released under an\n[MIT license](https://github.com/acornjs/acorn/blob/master/acorn/LICENSE).\n\nYou are welcome to\n[report bugs](https://github.com/acornjs/acorn/issues) or create pull\nrequests on [github](https://github.com/acornjs/acorn). For questions\nand discussion, please use the\n[Tern discussion forum](https://discuss.ternjs.net).\n\n## Installation\n\nThe easiest way to install acorn is from [`npm`](https://www.npmjs.com/):\n\n```sh\nnpm install acorn\n```\n\nAlternately, you can download the source and build acorn yourself:\n\n```sh\ngit clone https://github.com/acornjs/acorn.git\ncd acorn\nnpm install\n```\n\n## Interface\n\n**parse**`(input, options)` is the main interface to the library. The\n`input` parameter is a string, `options` can be undefined or an object\nsetting some of the options listed below. The return value will be an\nabstract syntax tree object as specified by the [ESTree\nspec](https://github.com/estree/estree).\n\n```javascript\nlet acorn = require(\"acorn\");\nconsole.log(acorn.parse(\"1 + 1\"));\n```\n\nWhen encountering a syntax error, the parser will raise a\n`SyntaxError` object with a meaningful message. The error object will\nhave a `pos` property that indicates the string offset at which the\nerror occurred, and a `loc` object that contains a `{line, column}`\nobject referring to that same position.\n\nOptions can be provided by passing a second argument, which should be\nan object containing any of these fields:\n\n- **ecmaVersion**: Indicates the ECMAScript version to parse. Must be\n either 3, 5, 6 (2015), 7 (2016), 8 (2017), 9 (2018) or 10 (2019, partial\n support). This influences support for strict mode, the set of\n reserved words, and support for new syntax features. Default is 9.\n\n **NOTE**: Only 'stage 4' (finalized) ECMAScript features are being\n implemented by Acorn. Other proposed new features can be implemented\n through plugins.\n\n- **sourceType**: Indicate the mode the code should be parsed in. Can be\n either `\"script\"` or `\"module\"`. This influences global strict mode\n and parsing of `import` and `export` declarations.\n\n **NOTE**: If set to `\"module\"`, then static `import` / `export` syntax\n will be valid, even if `ecmaVersion` is less than 6.\n\n- **onInsertedSemicolon**: If given a callback, that callback will be\n called whenever a missing semicolon is inserted by the parser. The\n callback will be given the character offset of the point where the\n semicolon is inserted as argument, and if `locations` is on, also a\n `{line, column}` object representing this position.\n\n- **onTrailingComma**: Like `onInsertedSemicolon`, but for trailing\n commas.\n\n- **allowReserved**: If `false`, using a reserved word will generate\n an error. Defaults to `true` for `ecmaVersion` 3, `false` for higher\n versions. When given the value `\"never\"`, reserved words and\n keywords can also not be used as property names (as in Internet\n Explorer's old parser).\n\n- **allowReturnOutsideFunction**: By default, a return statement at\n the top level raises an error. Set this to `true` to accept such\n code.\n\n- **allowImportExportEverywhere**: By default, `import` and `export`\n declarations can only appear at a program's top level. Setting this\n option to `true` allows them anywhere where a statement is allowed.\n \n- **allowAwaitOutsideFunction**: By default, `await` expressions can\n only appear inside `async` functions. Setting this option to\n `true` allows to have top-level `await` expressions. They are\n still not allowed in non-`async` functions, though.\n\n- **allowHashBang**: When this is enabled (off by default), if the\n code starts with the characters `#!` (as in a shellscript), the\n first line will be treated as a comment.\n\n- **locations**: When `true`, each node has a `loc` object attached\n with `start` and `end` subobjects, each of which contains the\n one-based line and zero-based column numbers in `{line, column}`\n form. Default is `false`.\n\n- **onToken**: If a function is passed for this option, each found\n token will be passed in same format as tokens returned from\n `tokenizer().getToken()`.\n\n If array is passed, each found token is pushed to it.\n\n Note that you are not allowed to call the parser from the\n callback—that will corrupt its internal state.\n\n- **onComment**: If a function is passed for this option, whenever a\n comment is encountered the function will be called with the\n following parameters:\n\n - `block`: `true` if the comment is a block comment, false if it\n is a line comment.\n - `text`: The content of the comment.\n - `start`: Character offset of the start of the comment.\n - `end`: Character offset of the end of the comment.\n\n When the `locations` options is on, the `{line, column}` locations\n of the comment’s start and end are passed as two additional\n parameters.\n\n If array is passed for this option, each found comment is pushed\n to it as object in Esprima format:\n\n ```javascript\n {\n \"type\": \"Line\" | \"Block\",\n \"value\": \"comment text\",\n \"start\": Number,\n \"end\": Number,\n // If `locations` option is on:\n \"loc\": {\n \"start\": {line: Number, column: Number}\n \"end\": {line: Number, column: Number}\n },\n // If `ranges` option is on:\n \"range\": [Number, Number]\n }\n ```\n\n Note that you are not allowed to call the parser from the\n callback—that will corrupt its internal state.\n\n- **ranges**: Nodes have their start and end characters offsets\n recorded in `start` and `end` properties (directly on the node,\n rather than the `loc` object, which holds line/column data. To also\n add a\n [semi-standardized](https://bugzilla.mozilla.org/show_bug.cgi?id=745678)\n `range` property holding a `[start, end]` array with the same\n numbers, set the `ranges` option to `true`.\n\n- **program**: It is possible to parse multiple files into a single\n AST by passing the tree produced by parsing the first file as the\n `program` option in subsequent parses. This will add the toplevel\n forms of the parsed file to the \"Program\" (top) node of an existing\n parse tree.\n\n- **sourceFile**: When the `locations` option is `true`, you can pass\n this option to add a `source` attribute in every node’s `loc`\n object. Note that the contents of this option are not examined or\n processed in any way; you are free to use whatever format you\n choose.\n\n- **directSourceFile**: Like `sourceFile`, but a `sourceFile` property\n will be added (regardless of the `location` option) directly to the\n nodes, rather than the `loc` object.\n\n- **preserveParens**: If this option is `true`, parenthesized expressions\n are represented by (non-standard) `ParenthesizedExpression` nodes\n that have a single `expression` property containing the expression\n inside parentheses.\n\n**parseExpressionAt**`(input, offset, options)` will parse a single\nexpression in a string, and return its AST. It will not complain if\nthere is more of the string left after the expression.\n\n**tokenizer**`(input, options)` returns an object with a `getToken`\nmethod that can be called repeatedly to get the next token, a `{start,\nend, type, value}` object (with added `loc` property when the\n`locations` option is enabled and `range` property when the `ranges`\noption is enabled). When the token's type is `tokTypes.eof`, you\nshould stop calling the method, since it will keep returning that same\ntoken forever.\n\nIn ES6 environment, returned result can be used as any other\nprotocol-compliant iterable:\n\n```javascript\nfor (let token of acorn.tokenizer(str)) {\n // iterate over the tokens\n}\n\n// transform code to array of tokens:\nvar tokens = [...acorn.tokenizer(str)];\n```\n\n**tokTypes** holds an object mapping names to the token type objects\nthat end up in the `type` properties of tokens.\n\n**getLineInfo**`(input, offset)` can be used to get a `{line,\ncolumn}` object for a given program string and offset.\n\n### The `Parser` class\n\nInstances of the **`Parser`** class contain all the state and logic\nthat drives a parse. It has static methods `parse`,\n`parseExpressionAt`, and `tokenizer` that match the top-level\nfunctions by the same name.\n\nWhen extending the parser with plugins, you need to call these methods\non the extended version of the class. To extend a parser with plugins,\nyou can use its static `extend` method.\n\n```javascript\nvar acorn = require(\"acorn\");\nvar jsx = require(\"acorn-jsx\");\nvar JSXParser = acorn.Parser.extend(jsx());\nJSXParser.parse(\"foo(<bar/>)\");\n```\n\nThe `extend` method takes any number of plugin values, and returns a\nnew `Parser` class that includes the extra parser logic provided by\nthe plugins.\n\n## Command line interface\n\nThe `bin/acorn` utility can be used to parse a file from the command\nline. It accepts as arguments its input file and the following\noptions:\n\n- `--ecma3|--ecma5|--ecma6|--ecma7|--ecma8|--ecma9|--ecma10`: Sets the ECMAScript version\n to parse. Default is version 9.\n\n- `--module`: Sets the parsing mode to `\"module\"`. Is set to `\"script\"` otherwise.\n\n- `--locations`: Attaches a \"loc\" object to each node with \"start\" and\n \"end\" subobjects, each of which contains the one-based line and\n zero-based column numbers in `{line, column}` form.\n\n- `--allow-hash-bang`: If the code starts with the characters #! (as\n in a shellscript), the first line will be treated as a comment.\n\n- `--compact`: No whitespace is used in the AST output.\n\n- `--silent`: Do not output the AST, just return the exit status.\n\n- `--help`: Print the usage information and quit.\n\nThe utility spits out the syntax tree as JSON data.\n\n## Existing plugins\n\n - [`acorn-jsx`](https://github.com/RReverser/acorn-jsx): Parse [Facebook JSX syntax extensions](https://github.com/facebook/jsx)\n \nPlugins for ECMAScript proposals:\n \n - [`acorn-stage3`](https://github.com/acornjs/acorn-stage3): Parse most stage 3 proposals, bundling:\n - [`acorn-class-fields`](https://github.com/acornjs/acorn-class-fields): Parse [class fields proposal](https://github.com/tc39/proposal-class-fields)\n - [`acorn-import-meta`](https://github.com/acornjs/acorn-import-meta): Parse [import.meta proposal](https://github.com/tc39/proposal-import-meta)\n - [`acorn-numeric-separator`](https://github.com/acornjs/acorn-numeric-separator): Parse [numeric separator proposal](https://github.com/tc39/proposal-numeric-separator)\n - [`acorn-private-methods`](https://github.com/acornjs/acorn-private-methods): parse [private methods, getters and setters proposal](https://github.com/tc39/proposal-private-methods)n\n# emoji-regex [](https://travis-ci.org/mathiasbynens/emoji-regex)\n\n_emoji-regex_ offers a regular expression to match all emoji symbols (including textual representations of emoji) as per the Unicode Standard.\n\nThis repository contains a script that generates this regular expression based on [the data from Unicode v12](https://github.com/mathiasbynens/unicode-12.0.0). Because of this, the regular expression can easily be updated whenever new emoji are added to the Unicode standard.\n\n## Installation\n\nVia [npm](https://www.npmjs.com/):\n\n```bash\nnpm install emoji-regex\n```\n\nIn [Node.js](https://nodejs.org/):\n\n```js\nconst emojiRegex = require('emoji-regex');\n// Note: because the regular expression has the global flag set, this module\n// exports a function that returns the regex rather than exporting the regular\n// expression itself, to make it impossible to (accidentally) mutate the\n// original regular expression.\n\nconst text = `\n\\u{231A}: ⌚ default emoji presentation character (Emoji_Presentation)\n\\u{2194}\\u{FE0F}: ↔️ default text presentation character rendered as emoji\n\\u{1F469}: 👩 emoji modifier base (Emoji_Modifier_Base)\n\\u{1F469}\\u{1F3FF}: 👩🏿 emoji modifier base followed by a modifier\n`;\n\nconst regex = emojiRegex();\nlet match;\nwhile (match = regex.exec(text)) {\n const emoji = match[0];\n console.log(`Matched sequence ${ emoji } — code points: ${ [...emoji].length }`);\n}\n```\n\nConsole output:\n\n```\nMatched sequence ⌚ — code points: 1\nMatched sequence ⌚ — code points: 1\nMatched sequence ↔️ — code points: 2\nMatched sequence ↔️ — code points: 2\nMatched sequence 👩 — code points: 1\nMatched sequence 👩 — code points: 1\nMatched sequence 👩🏿 — code points: 2\nMatched sequence 👩🏿 — code points: 2\n```\n\nTo match emoji in their textual representation as well (i.e. emoji that are not `Emoji_Presentation` symbols and that aren’t forced to render as emoji by a variation selector), `require` the other regex:\n\n```js\nconst emojiRegex = require('emoji-regex/text.js');\n```\n\nAdditionally, in environments which support ES2015 Unicode escapes, you may `require` ES2015-style versions of the regexes:\n\n```js\nconst emojiRegex = require('emoji-regex/es2015/index.js');\nconst emojiRegexText = require('emoji-regex/es2015/text.js');\n```\n\n## Author\n\n| [](https://twitter.com/mathias \"Follow @mathias on Twitter\") |\n|---|\n| [Mathias Bynens](https://mathiasbynens.be/) |\n\n## License\n\n_emoji-regex_ is available under the [MIT](https://mths.be/mit) license.\n# path-parse [](https://travis-ci.org/jbgutierrez/path-parse)\n\n> Node.js [`path.parse(pathString)`](https://nodejs.org/api/path.html#path_path_parse_pathstring) [ponyfill](https://ponyfill.com).\n\n## Install\n\n```\n$ npm install --save path-parse\n```\n\n## Usage\n\n```js\nvar pathParse = require('path-parse');\n\npathParse('/home/user/dir/file.txt');\n//=> {\n// root : \"/\",\n// dir : \"/home/user/dir\",\n// base : \"file.txt\",\n// ext : \".txt\",\n// name : \"file\"\n// }\n```\n\n## API\n\nSee [`path.parse(pathString)`](https://nodejs.org/api/path.html#path_path_parse_pathstring) docs.\n\n### pathParse(path)\n\n### pathParse.posix(path)\n\nThe Posix specific version.\n\n### pathParse.win32(path)\n\nThe Windows specific version.\n\n## License\n\nMIT © [Javier Blanco](http://jbgutierrez.info)\n# assert-plus\n\nThis library is a super small wrapper over node's assert module that has two\nthings: (1) the ability to disable assertions with the environment variable\nNODE\\_NDEBUG, and (2) some API wrappers for argument testing. Like\n`assert.string(myArg, 'myArg')`. As a simple example, most of my code looks\nlike this:\n\n```javascript\n var assert = require('assert-plus');\n\n function fooAccount(options, callback) {\n assert.object(options, 'options');\n assert.number(options.id, 'options.id');\n assert.bool(options.isManager, 'options.isManager');\n assert.string(options.name, 'options.name');\n assert.arrayOfString(options.email, 'options.email');\n assert.func(callback, 'callback');\n\n // Do stuff\n callback(null, {});\n }\n```\n\n# API\n\nAll methods that *aren't* part of node's core assert API are simply assumed to\ntake an argument, and then a string 'name' that's not a message; `AssertionError`\nwill be thrown if the assertion fails with a message like:\n\n AssertionError: foo (string) is required\n at test (/home/mark/work/foo/foo.js:3:9)\n at Object.<anonymous> (/home/mark/work/foo/foo.js:15:1)\n at Module._compile (module.js:446:26)\n at Object..js (module.js:464:10)\n at Module.load (module.js:353:31)\n at Function._load (module.js:311:12)\n at Array.0 (module.js:484:10)\n at EventEmitter._tickCallback (node.js:190:38)\n\nfrom:\n\n```javascript\n function test(foo) {\n assert.string(foo, 'foo');\n }\n```\n\nThere you go. You can check that arrays are of a homogeneous type with `Arrayof$Type`:\n\n```javascript\n function test(foo) {\n assert.arrayOfString(foo, 'foo');\n }\n```\n\nYou can assert IFF an argument is not `undefined` (i.e., an optional arg):\n\n```javascript\n assert.optionalString(foo, 'foo');\n```\n\nLastly, you can opt-out of assertion checking altogether by setting the\nenvironment variable `NODE_NDEBUG=1`. This is pseudo-useful if you have\nlots of assertions, and don't want to pay `typeof ()` taxes to v8 in\nproduction. Be advised: The standard functions re-exported from `assert` are\nalso disabled in assert-plus if NDEBUG is specified. Using them directly from\nthe `assert` module avoids this behavior.\n\nThe complete list of APIs is:\n\n* assert.array\n* assert.bool\n* assert.buffer\n* assert.func\n* assert.number\n* assert.finite\n* assert.object\n* assert.string\n* assert.stream\n* assert.date\n* assert.regexp\n* assert.uuid\n* assert.arrayOfArray\n* assert.arrayOfBool\n* assert.arrayOfBuffer\n* assert.arrayOfFunc\n* assert.arrayOfNumber\n* assert.arrayOfFinite\n* assert.arrayOfObject\n* assert.arrayOfString\n* assert.arrayOfStream\n* assert.arrayOfDate\n* assert.arrayOfRegexp\n* assert.arrayOfUuid\n* assert.optionalArray\n* assert.optionalBool\n* assert.optionalBuffer\n* assert.optionalFunc\n* assert.optionalNumber\n* assert.optionalFinite\n* assert.optionalObject\n* assert.optionalString\n* assert.optionalStream\n* assert.optionalDate\n* assert.optionalRegexp\n* assert.optionalUuid\n* assert.optionalArrayOfArray\n* assert.optionalArrayOfBool\n* assert.optionalArrayOfBuffer\n* assert.optionalArrayOfFunc\n* assert.optionalArrayOfNumber\n* assert.optionalArrayOfFinite\n* assert.optionalArrayOfObject\n* assert.optionalArrayOfString\n* assert.optionalArrayOfStream\n* assert.optionalArrayOfDate\n* assert.optionalArrayOfRegexp\n* assert.optionalArrayOfUuid\n* assert.AssertionError\n* assert.fail\n* assert.ok\n* assert.equal\n* assert.notEqual\n* assert.deepEqual\n* assert.notDeepEqual\n* assert.strictEqual\n* assert.notStrictEqual\n* assert.throws\n* assert.doesNotThrow\n* assert.ifError\n\n# Installation\n\n npm install assert-plus\n\n## License\n\nThe MIT License (MIT)\nCopyright (c) 2012 Mark Cavage\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n## Bugs\n\nSee <https://github.com/mcavage/node-assert-plus/issues>.\n## getpass\n\nGet a password from the terminal. Sounds simple? Sounds like the `readline`\nmodule should be able to do it? NOPE.\n\n## Install and use it\n\n```bash\nnpm install --save getpass\n```\n\n```javascript\nconst mod_getpass = require('getpass');\n```\n\n## API\n\n### `mod_getpass.getPass([options, ]callback)`\n\nGets a password from the terminal. If available, this uses `/dev/tty` to avoid\ninterfering with any data being piped in or out of stdio.\n\nThis function prints a prompt (by default `Password:`) and then accepts input\nwithout echoing.\n\nParameters:\n\n * `options`, an Object, with properties:\n * `prompt`, an optional String\n * `callback`, a `Func(error, password)`, with arguments:\n * `error`, either `null` (no error) or an `Error` instance\n * `password`, a String\nsemver(1) -- The semantic versioner for npm\n===========================================\n\n## Install\n\n```bash\nnpm install --save semver\n````\n\n## Usage\n\nAs a node module:\n\n```js\nconst semver = require('semver')\n\nsemver.valid('1.2.3') // '1.2.3'\nsemver.valid('a.b.c') // null\nsemver.clean(' =v1.2.3 ') // '1.2.3'\nsemver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true\nsemver.gt('1.2.3', '9.8.7') // false\nsemver.lt('1.2.3', '9.8.7') // true\nsemver.minVersion('>=1.0.0') // '1.0.0'\nsemver.valid(semver.coerce('v2')) // '2.0.0'\nsemver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'\n```\n\nAs a command-line utility:\n\n```\n$ semver -h\n\nA JavaScript implementation of the https://semver.org/ specification\nCopyright Isaac Z. Schlueter\n\nUsage: semver [options] <version> [<version> [...]]\nPrints valid versions sorted by SemVer precedence\n\nOptions:\n-r --range <range>\n Print versions that match the specified range.\n\n-i --increment [<level>]\n Increment a version by the specified level. Level can\n be one of: major, minor, patch, premajor, preminor,\n prepatch, or prerelease. Default level is 'patch'.\n Only one version may be specified.\n\n--preid <identifier>\n Identifier to be used to prefix premajor, preminor,\n prepatch or prerelease version increments.\n\n-l --loose\n Interpret versions and ranges loosely\n\n-p --include-prerelease\n Always include prerelease versions in range matching\n\n-c --coerce\n Coerce a string into SemVer if possible\n (does not imply --loose)\n\nProgram exits successfully if any valid version satisfies\nall supplied ranges, and prints all satisfying versions.\n\nIf no satisfying versions are found, then exits failure.\n\nVersions are printed in ascending order, so supplying\nmultiple versions to the utility will just sort them.\n```\n\n## Versions\n\nA \"version\" is described by the `v2.0.0` specification found at\n<https://semver.org/>.\n\nA leading `\"=\"` or `\"v\"` character is stripped off and ignored.\n\n## Ranges\n\nA `version range` is a set of `comparators` which specify versions\nthat satisfy the range.\n\nA `comparator` is composed of an `operator` and a `version`. The set\nof primitive `operators` is:\n\n* `<` Less than\n* `<=` Less than or equal to\n* `>` Greater than\n* `>=` Greater than or equal to\n* `=` Equal. If no operator is specified, then equality is assumed,\n so this operator is optional, but MAY be included.\n\nFor example, the comparator `>=1.2.7` would match the versions\n`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6`\nor `1.1.0`.\n\nComparators can be joined by whitespace to form a `comparator set`,\nwhich is satisfied by the **intersection** of all of the comparators\nit includes.\n\nA range is composed of one or more comparator sets, joined by `||`. A\nversion matches a range if and only if every comparator in at least\none of the `||`-separated comparator sets is satisfied by the version.\n\nFor example, the range `>=1.2.7 <1.3.0` would match the versions\n`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`,\nor `1.1.0`.\n\nThe range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`,\n`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.\n\n### Prerelease Tags\n\nIf a version has a prerelease tag (for example, `1.2.3-alpha.3`) then\nit will only be allowed to satisfy comparator sets if at least one\ncomparator with the same `[major, minor, patch]` tuple also has a\nprerelease tag.\n\nFor example, the range `>1.2.3-alpha.3` would be allowed to match the\nversion `1.2.3-alpha.7`, but it would *not* be satisfied by\n`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically \"greater\nthan\" `1.2.3-alpha.3` according to the SemVer sort rules. The version\nrange only accepts prerelease tags on the `1.2.3` version. The\nversion `3.4.5` *would* satisfy the range, because it does not have a\nprerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.\n\nThe purpose for this behavior is twofold. First, prerelease versions\nfrequently are updated very quickly, and contain many breaking changes\nthat are (by the author's design) not yet fit for public consumption.\nTherefore, by default, they are excluded from range matching\nsemantics.\n\nSecond, a user who has opted into using a prerelease version has\nclearly indicated the intent to use *that specific* set of\nalpha/beta/rc versions. By including a prerelease tag in the range,\nthe user is indicating that they are aware of the risk. However, it\nis still not appropriate to assume that they have opted into taking a\nsimilar risk on the *next* set of prerelease versions.\n\nNote that this behavior can be suppressed (treating all prerelease\nversions as if they were normal versions, for the purpose of range\nmatching) by setting the `includePrerelease` flag on the options\nobject to any\n[functions](https://github.com/npm/node-semver#functions) that do\nrange matching.\n\n#### Prerelease Identifiers\n\nThe method `.inc` takes an additional `identifier` string argument that\nwill append the value of the string as a prerelease identifier:\n\n```javascript\nsemver.inc('1.2.3', 'prerelease', 'beta')\n// '1.2.4-beta.0'\n```\n\ncommand-line example:\n\n```bash\n$ semver 1.2.3 -i prerelease --preid beta\n1.2.4-beta.0\n```\n\nWhich then can be used to increment further:\n\n```bash\n$ semver 1.2.4-beta.0 -i prerelease\n1.2.4-beta.1\n```\n\n### Advanced Range Syntax\n\nAdvanced range syntax desugars to primitive comparators in\ndeterministic ways.\n\nAdvanced ranges may be combined in the same way as primitive\ncomparators using white space or `||`.\n\n#### Hyphen Ranges `X.Y.Z - A.B.C`\n\nSpecifies an inclusive set.\n\n* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`\n\nIf a partial version is provided as the first version in the inclusive\nrange, then the missing pieces are replaced with zeroes.\n\n* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`\n\nIf a partial version is provided as the second version in the\ninclusive range, then all versions that start with the supplied parts\nof the tuple are accepted, but nothing that would be greater than the\nprovided tuple parts.\n\n* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`\n* `1.2.3 - 2` := `>=1.2.3 <3.0.0`\n\n#### X-Ranges `1.2.x` `1.X` `1.2.*` `*`\n\nAny of `X`, `x`, or `*` may be used to \"stand in\" for one of the\nnumeric values in the `[major, minor, patch]` tuple.\n\n* `*` := `>=0.0.0` (Any version satisfies)\n* `1.x` := `>=1.0.0 <2.0.0` (Matching major version)\n* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)\n\nA partial version range is treated as an X-Range, so the special\ncharacter is in fact optional.\n\n* `\"\"` (empty string) := `*` := `>=0.0.0`\n* `1` := `1.x.x` := `>=1.0.0 <2.0.0`\n* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`\n\n#### Tilde Ranges `~1.2.3` `~1.2` `~1`\n\nAllows patch-level changes if a minor version is specified on the\ncomparator. Allows minor-level changes if not.\n\n* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`\n* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)\n* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)\n* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`\n* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)\n* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)\n* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n\n#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`\n\nAllows changes that do not modify the left-most non-zero digit in the\n`[major, minor, patch]` tuple. In other words, this allows patch and\nminor updates for versions `1.0.0` and above, patch updates for\nversions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`.\n\nMany authors treat a `0.x` version as if the `x` were the major\n\"breaking-change\" indicator.\n\nCaret ranges are ideal when an author may make breaking changes\nbetween `0.2.4` and `0.3.0` releases, which is a common practice.\nHowever, it presumes that there will *not* be breaking changes between\n`0.2.4` and `0.2.5`. It allows for changes that are presumed to be\nadditive (but non-breaking), according to commonly observed practices.\n\n* `^1.2.3` := `>=1.2.3 <2.0.0`\n* `^0.2.3` := `>=0.2.3 <0.3.0`\n* `^0.0.3` := `>=0.0.3 <0.0.4`\n* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the\n `0.0.3` version *only* will be allowed, if they are greater than or\n equal to `beta`. So, `0.0.3-pr.2` would be allowed.\n\nWhen parsing caret ranges, a missing `patch` value desugars to the\nnumber `0`, but will allow flexibility within that value, even if the\nmajor and minor versions are both `0`.\n\n* `^1.2.x` := `>=1.2.0 <2.0.0`\n* `^0.0.x` := `>=0.0.0 <0.1.0`\n* `^0.0` := `>=0.0.0 <0.1.0`\n\nA missing `minor` and `patch` values will desugar to zero, but also\nallow flexibility within those values, even if the major version is\nzero.\n\n* `^1.x` := `>=1.0.0 <2.0.0`\n* `^0.x` := `>=0.0.0 <1.0.0`\n\n### Range Grammar\n\nPutting all this together, here is a Backus-Naur grammar for ranges,\nfor the benefit of parser authors:\n\n```bnf\nrange-set ::= range ( logical-or range ) *\nlogical-or ::= ( ' ' ) * '||' ( ' ' ) *\nrange ::= hyphen | simple ( ' ' simple ) * | ''\nhyphen ::= partial ' - ' partial\nsimple ::= primitive | partial | tilde | caret\nprimitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial\npartial ::= xr ( '.' xr ( '.' xr qualifier ? )? )?\nxr ::= 'x' | 'X' | '*' | nr\nnr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *\ntilde ::= '~' partial\ncaret ::= '^' partial\nqualifier ::= ( '-' pre )? ( '+' build )?\npre ::= parts\nbuild ::= parts\nparts ::= part ( '.' part ) *\npart ::= nr | [-0-9A-Za-z]+\n```\n\n## Functions\n\nAll methods and classes take a final `options` object argument. All\noptions in this object are `false` by default. The options supported\nare:\n\n- `loose` Be more forgiving about not-quite-valid semver strings.\n (Any resulting output will always be 100% strict compliant, of\n course.) For backwards compatibility reasons, if the `options`\n argument is a boolean value instead of an object, it is interpreted\n to be the `loose` param.\n- `includePrerelease` Set to suppress the [default\n behavior](https://github.com/npm/node-semver#prerelease-tags) of\n excluding prerelease tagged versions from ranges unless they are\n explicitly opted into.\n\nStrict-mode Comparators and Ranges will be strict about the SemVer\nstrings that they parse.\n\n* `valid(v)`: Return the parsed version, or null if it's not valid.\n* `inc(v, release)`: Return the version incremented by the release\n type (`major`, `premajor`, `minor`, `preminor`, `patch`,\n `prepatch`, or `prerelease`), or null if it's not valid\n * `premajor` in one call will bump the version up to the next major\n version and down to a prerelease of that major version.\n `preminor`, and `prepatch` work the same way.\n * If called from a non-prerelease version, the `prerelease` will work the\n same as `prepatch`. It increments the patch version, then makes a\n prerelease. If the input version is already a prerelease it simply\n increments it.\n* `prerelease(v)`: Returns an array of prerelease components, or null\n if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]`\n* `major(v)`: Return the major version number.\n* `minor(v)`: Return the minor version number.\n* `patch(v)`: Return the patch version number.\n* `intersects(r1, r2, loose)`: Return true if the two supplied ranges\n or comparators intersect.\n* `parse(v)`: Attempt to parse a string as a semantic version, returning either\n a `SemVer` object or `null`.\n\n### Comparison\n\n* `gt(v1, v2)`: `v1 > v2`\n* `gte(v1, v2)`: `v1 >= v2`\n* `lt(v1, v2)`: `v1 < v2`\n* `lte(v1, v2)`: `v1 <= v2`\n* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent,\n even if they're not the exact same string. You already know how to\n compare strings.\n* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`.\n* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call\n the corresponding function above. `\"===\"` and `\"!==\"` do simple\n string comparison, but are included for completeness. Throws if an\n invalid comparison string is provided.\n* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if\n `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.\n* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions\n in descending order when passed to `Array.sort()`.\n* `diff(v1, v2)`: Returns difference between two versions by the release type\n (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`),\n or null if the versions are the same.\n\n### Comparators\n\n* `intersects(comparator)`: Return true if the comparators intersect\n\n### Ranges\n\n* `validRange(range)`: Return the valid range or null if it's not valid\n* `satisfies(version, range)`: Return true if the version satisfies the\n range.\n* `maxSatisfying(versions, range)`: Return the highest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minSatisfying(versions, range)`: Return the lowest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minVersion(range)`: Return the lowest version that can possibly match\n the given range.\n* `gtr(version, range)`: Return `true` if version is greater than all the\n versions possible in the range.\n* `ltr(version, range)`: Return `true` if version is less than all the\n versions possible in the range.\n* `outside(version, range, hilo)`: Return true if the version is outside\n the bounds of the range in either the high or low direction. The\n `hilo` argument must be either the string `'>'` or `'<'`. (This is\n the function called by `gtr` and `ltr`.)\n* `intersects(range)`: Return true if any of the ranges comparators intersect\n\nNote that, since ranges may be non-contiguous, a version might not be\ngreater than a range, less than a range, *or* satisfy a range! For\nexample, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9`\nuntil `2.0.0`, so the version `1.2.10` would not be greater than the\nrange (because `2.0.1` satisfies, which is higher), nor less than the\nrange (since `1.2.8` satisfies, which is lower), and it also does not\nsatisfy the range.\n\nIf you want to know if a version satisfies or does not satisfy a\nrange, use the `satisfies(version, range)` function.\n\n### Coercion\n\n* `coerce(version)`: Coerces a string to semver if possible\n\nThis aims to provide a very forgiving translation of a non-semver string to\nsemver. It looks for the first digit in a string, and consumes all\nremaining characters which satisfy at least a partial semver (e.g., `1`,\n`1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer\nversions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All\nsurrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes\n`3.4.0`). Only text which lacks digits will fail coercion (`version one`\nis not valid). The maximum length for any semver component considered for\ncoercion is 16 characters; longer components will be ignored\n(`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any\nsemver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value\ncomponents are invalid (`9999999999999999.4.7.4` is likely invalid).\n# is-data-descriptor [](https://www.npmjs.com/package/is-data-descriptor) [](https://npmjs.org/package/is-data-descriptor) [](https://npmjs.org/package/is-data-descriptor) [](https://travis-ci.org/jonschlinkert/is-data-descriptor)\n\n> Returns true if a value has the characteristics of a valid JavaScript data descriptor.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-data-descriptor\n```\n\n## Usage\n\n```js\nvar isDataDesc = require('is-data-descriptor');\n```\n\n## Examples\n\n`true` when the descriptor has valid properties with valid values.\n\n```js\n// `value` can be anything\nisDataDesc({value: 'foo'})\nisDataDesc({value: function() {}})\nisDataDesc({value: true})\n//=> true\n```\n\n`false` when not an object\n\n```js\nisDataDesc('a')\n//=> false\nisDataDesc(null)\n//=> false\nisDataDesc([])\n//=> false\n```\n\n`false` when the object has invalid properties\n\n```js\nisDataDesc({value: 'foo', bar: 'baz'})\n//=> false\nisDataDesc({value: 'foo', bar: 'baz'})\n//=> false\nisDataDesc({value: 'foo', get: function(){}})\n//=> false\nisDataDesc({get: function(){}, value: 'foo'})\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisDataDesc({value: 'foo', enumerable: 'foo'})\n//=> false\nisDataDesc({value: 'foo', configurable: 'foo'})\n//=> false\nisDataDesc({value: 'foo', writable: 'foo'})\n//=> false\n```\n\n## Valid properties\n\nThe only valid data descriptor properties are the following:\n\n* `configurable` (required)\n* `enumerable` (required)\n* `value` (optional)\n* `writable` (optional)\n\nTo be a valid data descriptor, either `value` or `writable` must be defined.\n\n**Invalid properties**\n\nA descriptor may have additional _invalid_ properties (an error will **not** be thrown).\n\n```js\nvar foo = {};\n\nObject.defineProperty(foo, 'bar', {\n enumerable: true,\n whatever: 'blah', // invalid, but doesn't cause an error\n get: function() {\n return 'baz';\n }\n});\n\nconsole.log(foo.bar);\n//=> 'baz'\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor \"Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\")\n* [is-data-descriptor](https://www.npmjs.com/package/is-data-descriptor): Returns true if a value has the characteristics of a valid JavaScript data descriptor. | [homepage](https://github.com/jonschlinkert/is-data-descriptor \"Returns true if a value has the characteristics of a valid JavaScript data descriptor.\")\n* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor \"Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 21 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [realityking](https://github.com/realityking) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 01, 2017._\n# color-convert\n\n[](https://travis-ci.org/Qix-/color-convert)\n\nColor-convert is a color conversion library for JavaScript and node.\nIt converts all ways between `rgb`, `hsl`, `hsv`, `hwb`, `cmyk`, `ansi`, `ansi16`, `hex` strings, and CSS `keyword`s (will round to closest):\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hsl(140, 200, 100); // [96, 48, 59]\nconvert.keyword.rgb('blue'); // [0, 0, 255]\n\nvar rgbChannels = convert.rgb.channels; // 3\nvar cmykChannels = convert.cmyk.channels; // 4\nvar ansiChannels = convert.ansi16.channels; // 1\n```\n\n# Install\n\n```console\n$ npm install color-convert\n```\n\n# API\n\nSimply get the property of the _from_ and _to_ conversion that you're looking for.\n\nAll functions have a rounded and unrounded variant. By default, return values are rounded. To get the unrounded (raw) results, simply tack on `.raw` to the function.\n\nAll 'from' functions have a hidden property called `.channels` that indicates the number of channels the function expects (not including alpha).\n\n```js\nvar convert = require('color-convert');\n\n// Hex to LAB\nconvert.hex.lab('DEADBF'); // [ 76, 21, -2 ]\nconvert.hex.lab.raw('DEADBF'); // [ 75.56213190997677, 20.653827952644754, -2.290532499330533 ]\n\n// RGB to CMYK\nconvert.rgb.cmyk(167, 255, 4); // [ 35, 0, 98, 0 ]\nconvert.rgb.cmyk.raw(167, 255, 4); // [ 34.509803921568626, 0, 98.43137254901961, 0 ]\n```\n\n### Arrays\nAll functions that accept multiple arguments also support passing an array.\n\nNote that this does **not** apply to functions that convert from a color that only requires one value (e.g. `keyword`, `ansi256`, `hex`, etc.)\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hex(123, 45, 67); // '7B2D43'\nconvert.rgb.hex([123, 45, 67]); // '7B2D43'\n```\n\n## Routing\n\nConversions that don't have an _explicitly_ defined conversion (in [conversions.js](conversions.js)), but can be converted by means of sub-conversions (e.g. XYZ -> **RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex).\n\nKeep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of \"direct\" (single-step) conversions, see [conversions.js](conversions.js).\n\n# Contribute\n\nIf there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.\n\n# License\nCopyright © 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE).\n# kind-of [](https://www.npmjs.com/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://travis-ci.org/jonschlinkert/kind-of)\n\n> Get the native type of a value.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save kind-of\n```\n\n## Install\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install kind-of --save\n```\n\n## Usage\n\n> es5, browser and es6 ready\n\n```js\nvar kindOf = require('kind-of');\n\nkindOf(undefined);\n//=> 'undefined'\n\nkindOf(null);\n//=> 'null'\n\nkindOf(true);\n//=> 'boolean'\n\nkindOf(false);\n//=> 'boolean'\n\nkindOf(new Boolean(true));\n//=> 'boolean'\n\nkindOf(new Buffer(''));\n//=> 'buffer'\n\nkindOf(42);\n//=> 'number'\n\nkindOf(new Number(42));\n//=> 'number'\n\nkindOf('str');\n//=> 'string'\n\nkindOf(new String('str'));\n//=> 'string'\n\nkindOf(arguments);\n//=> 'arguments'\n\nkindOf({});\n//=> 'object'\n\nkindOf(Object.create(null));\n//=> 'object'\n\nkindOf(new Test());\n//=> 'object'\n\nkindOf(new Date());\n//=> 'date'\n\nkindOf([]);\n//=> 'array'\n\nkindOf([1, 2, 3]);\n//=> 'array'\n\nkindOf(new Array());\n//=> 'array'\n\nkindOf(/foo/);\n//=> 'regexp'\n\nkindOf(new RegExp('foo'));\n//=> 'regexp'\n\nkindOf(function () {});\n//=> 'function'\n\nkindOf(function * () {});\n//=> 'function'\n\nkindOf(new Function());\n//=> 'function'\n\nkindOf(new Map());\n//=> 'map'\n\nkindOf(new WeakMap());\n//=> 'weakmap'\n\nkindOf(new Set());\n//=> 'set'\n\nkindOf(new WeakSet());\n//=> 'weakset'\n\nkindOf(Symbol('str'));\n//=> 'symbol'\n\nkindOf(new Int8Array());\n//=> 'int8array'\n\nkindOf(new Uint8Array());\n//=> 'uint8array'\n\nkindOf(new Uint8ClampedArray());\n//=> 'uint8clampedarray'\n\nkindOf(new Int16Array());\n//=> 'int16array'\n\nkindOf(new Uint16Array());\n//=> 'uint16array'\n\nkindOf(new Int32Array());\n//=> 'int32array'\n\nkindOf(new Uint32Array());\n//=> 'uint32array'\n\nkindOf(new Float32Array());\n//=> 'float32array'\n\nkindOf(new Float64Array());\n//=> 'float64array'\n```\n\n## Benchmarks\n\nBenchmarked against [typeof](http://github.com/CodingFu/typeof) and [type-of](https://github.com/ForbesLindesay/type-of).\nNote that performaces is slower for es6 features `Map`, `WeakMap`, `Set` and `WeakSet`.\n\n```bash\n#1: array\n current x 23,329,397 ops/sec ±0.82% (94 runs sampled)\n lib-type-of x 4,170,273 ops/sec ±0.55% (94 runs sampled)\n lib-typeof x 9,686,935 ops/sec ±0.59% (98 runs sampled)\n\n#2: boolean\n current x 27,197,115 ops/sec ±0.85% (94 runs sampled)\n lib-type-of x 3,145,791 ops/sec ±0.73% (97 runs sampled)\n lib-typeof x 9,199,562 ops/sec ±0.44% (99 runs sampled)\n\n#3: date\n current x 20,190,117 ops/sec ±0.86% (92 runs sampled)\n lib-type-of x 5,166,970 ops/sec ±0.74% (94 runs sampled)\n lib-typeof x 9,610,821 ops/sec ±0.50% (96 runs sampled)\n\n#4: function\n current x 23,855,460 ops/sec ±0.60% (97 runs sampled)\n lib-type-of x 5,667,740 ops/sec ±0.54% (100 runs sampled)\n lib-typeof x 10,010,644 ops/sec ±0.44% (100 runs sampled)\n\n#5: null\n current x 27,061,047 ops/sec ±0.97% (96 runs sampled)\n lib-type-of x 13,965,573 ops/sec ±0.62% (97 runs sampled)\n lib-typeof x 8,460,194 ops/sec ±0.61% (97 runs sampled)\n\n#6: number\n current x 25,075,682 ops/sec ±0.53% (99 runs sampled)\n lib-type-of x 2,266,405 ops/sec ±0.41% (98 runs sampled)\n lib-typeof x 9,821,481 ops/sec ±0.45% (99 runs sampled)\n\n#7: object\n current x 3,348,980 ops/sec ±0.49% (99 runs sampled)\n lib-type-of x 3,245,138 ops/sec ±0.60% (94 runs sampled)\n lib-typeof x 9,262,952 ops/sec ±0.59% (99 runs sampled)\n\n#8: regex\n current x 21,284,827 ops/sec ±0.72% (96 runs sampled)\n lib-type-of x 4,689,241 ops/sec ±0.43% (100 runs sampled)\n lib-typeof x 8,957,593 ops/sec ±0.62% (98 runs sampled)\n\n#9: string\n current x 25,379,234 ops/sec ±0.58% (96 runs sampled)\n lib-type-of x 3,635,148 ops/sec ±0.76% (93 runs sampled)\n lib-typeof x 9,494,134 ops/sec ±0.49% (98 runs sampled)\n\n#10: undef\n current x 27,459,221 ops/sec ±1.01% (93 runs sampled)\n lib-type-of x 14,360,433 ops/sec ±0.52% (99 runs sampled)\n lib-typeof x 23,202,868 ops/sec ±0.59% (94 runs sampled)\n\n```\n\n## Optimizations\n\nIn 7 out of 8 cases, this library is 2x-10x faster than other top libraries included in the benchmarks. There are a few things that lead to this performance advantage, none of them hard and fast rules, but all of them simple and repeatable in almost any code library:\n\n1. Optimize around the fastest and most common use cases first. Of course, this will change from project-to-project, but I took some time to understand how and why `typeof` checks were being used in my own libraries and other libraries I use a lot.\n2. Optimize around bottlenecks - In other words, the order in which conditionals are implemented is significant, because each check is only as fast as the failing checks that came before it. Here, the biggest bottleneck by far is checking for plain objects (an object that was created by the `Object` constructor). I opted to make this check happen by process of elimination rather than brute force up front (e.g. by using something like `val.constructor.name`), so that every other type check would not be penalized it.\n3. Don't do uneccessary processing - why do `.slice(8, -1).toLowerCase();` just to get the word `regex`? It's much faster to do `if (type === '[object RegExp]') return 'regex'`\n\n## About\n\n### Related projects\n\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [is-number](https://www.npmjs.com/package/is-number): Returns true if the value is a number. comprehensive tests. | [homepage](https://github.com/jonschlinkert/is-number \"Returns true if the value is a number. comprehensive tests.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 59 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [miguelmota](https://github.com/miguelmota) |\n| 1 | [dtothefp](https://github.com/dtothefp) |\n| 1 | [ksheedlo](https://github.com/ksheedlo) |\n| 1 | [pdehaan](https://github.com/pdehaan) |\n| 1 | [laggingreflex](https://github.com/laggingreflex) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 16, 2017._\n# AssemblyScript Loader\n\nA convenient loader for [AssemblyScript](https://assemblyscript.org) modules. Demangles module exports to a friendly object structure compatible with TypeScript definitions and provides useful utility to read/write data from/to memory.\n\n[Documentation](https://assemblyscript.org/loader.html)\nString.prototype.trimStart <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![Build Status][travis-svg]][travis-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\n[![browser support][testling-svg]][testling-url]\n\nAn ES2019-spec-compliant `String.prototype.trimStart` shim. Invoke its \"shim\" method to shim `String.prototype.trimStart` if it is unavailable.\n\nThis package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec](http://www.ecma-international.org/ecma-262/6.0/#sec-object.assign). In an ES6 environment, it will also work properly with `Symbol`s.\n\nMost common usage:\n```js\nvar trimStart = require('string.prototype.trimstart');\n\nassert(trimStart(' \\t\\na \\t\\n') === 'a \\t\\n');\n\nif (!String.prototype.trimStart) {\n\ttrimStart.shim();\n}\n\nassert(trimStart(' \\t\\na \\t\\n') === ' \\t\\na \\t\\n'.trimStart());\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[package-url]: https://npmjs.com/package/string.prototype.trimstart\n[npm-version-svg]: http://vb.teelaun.ch/es-shims/String.prototype.trimStart.svg\n[travis-svg]: https://travis-ci.org/es-shims/String.prototype.trimStart.svg\n[travis-url]: https://travis-ci.org/es-shims/String.prototype.trimStart\n[deps-svg]: https://david-dm.org/es-shims/String.prototype.trimStart.svg\n[deps-url]: https://david-dm.org/es-shims/String.prototype.trimStart\n[dev-deps-svg]: https://david-dm.org/es-shims/String.prototype.trimStart/dev-status.svg\n[dev-deps-url]: https://david-dm.org/es-shims/String.prototype.trimStart#info=devDependencies\n[testling-svg]: https://ci.testling.com/es-shims/String.prototype.trimStart.png\n[testling-url]: https://ci.testling.com/es-shims/String.prototype.trimStart\n[npm-badge-png]: https://nodei.co/npm/string.prototype.trimstart.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/string.prototype.trimstart.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/string.prototype.trimstart.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=string.prototype.trimstart\n# babel-types\n\n> This module contains methods for building ASTs manually and for checking the types of AST nodes.\n\n## Install\n\n```sh\nnpm install --save-dev babel-types\n```\n\n## API\n\n<!-- begin generated section -->\n\n### anyTypeAnnotation\n```javascript\nt.anyTypeAnnotation()\n```\n\nSee also `t.isAnyTypeAnnotation(node, opts)` and `t.assertAnyTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### arrayExpression\n```javascript\nt.arrayExpression(elements)\n```\n\nSee also `t.isArrayExpression(node, opts)` and `t.assertArrayExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `elements`: `Array<null | Expression | SpreadElement>` (default: `[]`)\n\n---\n\n### arrayPattern\n```javascript\nt.arrayPattern(elements, typeAnnotation)\n```\n\nSee also `t.isArrayPattern(node, opts)` and `t.assertArrayPattern(node, opts)`.\n\nAliases: `Pattern`, `LVal`\n\n - `elements`: `Array<Identifier | Pattern | RestElement>` (required)\n - `typeAnnotation` (required)\n - `decorators`: `Array<Decorator>` (default: `null`)\n\n---\n\n### arrayTypeAnnotation\n```javascript\nt.arrayTypeAnnotation(elementType)\n```\n\nSee also `t.isArrayTypeAnnotation(node, opts)` and `t.assertArrayTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `elementType` (required)\n\n---\n\n### arrowFunctionExpression\n```javascript\nt.arrowFunctionExpression(params, body, async)\n```\n\nSee also `t.isArrowFunctionExpression(node, opts)` and `t.assertArrowFunctionExpression(node, opts)`.\n\nAliases: `Scopable`, `Function`, `BlockParent`, `FunctionParent`, `Expression`, `Pureish`\n\n - `params`: `Array<LVal>` (required)\n - `body`: `BlockStatement | Expression` (required)\n - `async`: `boolean` (default: `false`)\n - `returnType` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### assignmentExpression\n```javascript\nt.assignmentExpression(operator, left, right)\n```\n\nSee also `t.isAssignmentExpression(node, opts)` and `t.assertAssignmentExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `operator`: `string` (required)\n - `left`: `LVal` (required)\n - `right`: `Expression` (required)\n\n---\n\n### assignmentPattern\n```javascript\nt.assignmentPattern(left, right)\n```\n\nSee also `t.isAssignmentPattern(node, opts)` and `t.assertAssignmentPattern(node, opts)`.\n\nAliases: `Pattern`, `LVal`\n\n - `left`: `Identifier` (required)\n - `right`: `Expression` (required)\n - `decorators`: `Array<Decorator>` (default: `null`)\n\n---\n\n### awaitExpression\n```javascript\nt.awaitExpression(argument)\n```\n\nSee also `t.isAwaitExpression(node, opts)` and `t.assertAwaitExpression(node, opts)`.\n\nAliases: `Expression`, `Terminatorless`\n\n - `argument`: `Expression` (required)\n\n---\n\n### binaryExpression\n```javascript\nt.binaryExpression(operator, left, right)\n```\n\nSee also `t.isBinaryExpression(node, opts)` and `t.assertBinaryExpression(node, opts)`.\n\nAliases: `Binary`, `Expression`\n\n - `operator`: `'+' | '-' | '/' | '%' | '*' | '**' | '&' | '|' | '>>' | '>>>' | '<<' | '^' | '==' | '===' | '!=' | '!==' | 'in' | 'instanceof' | '>' | '<' | '>=' | '<='` (required)\n - `left`: `Expression` (required)\n - `right`: `Expression` (required)\n\n---\n\n### bindExpression\n```javascript\nt.bindExpression(object, callee)\n```\n\nSee also `t.isBindExpression(node, opts)` and `t.assertBindExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `object` (required)\n - `callee` (required)\n\n---\n\n### blockStatement\n```javascript\nt.blockStatement(body, directives)\n```\n\nSee also `t.isBlockStatement(node, opts)` and `t.assertBlockStatement(node, opts)`.\n\nAliases: `Scopable`, `BlockParent`, `Block`, `Statement`\n\n - `body`: `Array<Statement>` (required)\n - `directives`: `Array<Directive>` (default: `[]`)\n\n---\n\n### booleanLiteral\n```javascript\nt.booleanLiteral(value)\n```\n\nSee also `t.isBooleanLiteral(node, opts)` and `t.assertBooleanLiteral(node, opts)`.\n\nAliases: `Expression`, `Pureish`, `Literal`, `Immutable`\n\n - `value`: `boolean` (required)\n\n---\n\n### booleanLiteralTypeAnnotation\n```javascript\nt.booleanLiteralTypeAnnotation()\n```\n\nSee also `t.isBooleanLiteralTypeAnnotation(node, opts)` and `t.assertBooleanLiteralTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n---\n\n### booleanTypeAnnotation\n```javascript\nt.booleanTypeAnnotation()\n```\n\nSee also `t.isBooleanTypeAnnotation(node, opts)` and `t.assertBooleanTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### breakStatement\n```javascript\nt.breakStatement(label)\n```\n\nSee also `t.isBreakStatement(node, opts)` and `t.assertBreakStatement(node, opts)`.\n\nAliases: `Statement`, `Terminatorless`, `CompletionStatement`\n\n - `label`: `Identifier` (default: `null`)\n\n---\n\n### callExpression\n```javascript\nt.callExpression(callee, arguments)\n```\n\nSee also `t.isCallExpression(node, opts)` and `t.assertCallExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `callee`: `Expression` (required)\n - `arguments`: `Array<Expression | SpreadElement>` (required)\n\n---\n\n### catchClause\n```javascript\nt.catchClause(param, body)\n```\n\nSee also `t.isCatchClause(node, opts)` and `t.assertCatchClause(node, opts)`.\n\nAliases: `Scopable`\n\n - `param`: `Identifier` (required)\n - `body`: `BlockStatement` (required)\n\n---\n\n### classBody\n```javascript\nt.classBody(body)\n```\n\nSee also `t.isClassBody(node, opts)` and `t.assertClassBody(node, opts)`.\n\n - `body`: `Array<ClassMethod | ClassProperty>` (required)\n\n---\n\n### classDeclaration\n```javascript\nt.classDeclaration(id, superClass, body, decorators)\n```\n\nSee also `t.isClassDeclaration(node, opts)` and `t.assertClassDeclaration(node, opts)`.\n\nAliases: `Scopable`, `Class`, `Statement`, `Declaration`, `Pureish`\n\n - `id`: `Identifier` (required)\n - `superClass`: `Expression` (default: `null`)\n - `body`: `ClassBody` (required)\n - `decorators`: `Array<Decorator>` (required)\n - `implements` (default: `null`)\n - `mixins` (default: `null`)\n - `superTypeParameters` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### classExpression\n```javascript\nt.classExpression(id, superClass, body, decorators)\n```\n\nSee also `t.isClassExpression(node, opts)` and `t.assertClassExpression(node, opts)`.\n\nAliases: `Scopable`, `Class`, `Expression`, `Pureish`\n\n - `id`: `Identifier` (default: `null`)\n - `superClass`: `Expression` (default: `null`)\n - `body`: `ClassBody` (required)\n - `decorators`: `Array<Decorator>` (required)\n - `implements` (default: `null`)\n - `mixins` (default: `null`)\n - `superTypeParameters` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### classImplements\n```javascript\nt.classImplements(id, typeParameters)\n```\n\nSee also `t.isClassImplements(node, opts)` and `t.assertClassImplements(node, opts)`.\n\nAliases: `Flow`\n\n - `id` (required)\n - `typeParameters` (required)\n\n---\n\n### classMethod\n```javascript\nt.classMethod(kind, key, params, body, computed, static)\n```\n\nSee also `t.isClassMethod(node, opts)` and `t.assertClassMethod(node, opts)`.\n\nAliases: `Function`, `Scopable`, `BlockParent`, `FunctionParent`, `Method`\n\n - `kind`: `\"get\" | \"set\" | \"method\" | \"constructor\"` (default: `'method'`)\n - `key`if computed then `Expression` else `Identifier | Literal` (required)\n - `params`: `Array<LVal>` (required)\n - `body`: `BlockStatement` (required)\n - `computed`: `boolean` (default: `false`)\n - `static`: `boolean` (default: `false`)\n - `async`: `boolean` (default: `false`)\n - `decorators` (default: `null`)\n - `generator`: `boolean` (default: `false`)\n - `returnType` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### classProperty\n```javascript\nt.classProperty(key, value, typeAnnotation, decorators, computed)\n```\n\nSee also `t.isClassProperty(node, opts)` and `t.assertClassProperty(node, opts)`.\n\nAliases: `Property`\n\n - `key` (required)\n - `value` (required)\n - `typeAnnotation` (required)\n - `decorators` (required)\n - `computed`: `boolean` (default: `false`)\n\n---\n\n### conditionalExpression\n```javascript\nt.conditionalExpression(test, consequent, alternate)\n```\n\nSee also `t.isConditionalExpression(node, opts)` and `t.assertConditionalExpression(node, opts)`.\n\nAliases: `Expression`, `Conditional`\n\n - `test`: `Expression` (required)\n - `consequent`: `Expression` (required)\n - `alternate`: `Expression` (required)\n\n---\n\n### continueStatement\n```javascript\nt.continueStatement(label)\n```\n\nSee also `t.isContinueStatement(node, opts)` and `t.assertContinueStatement(node, opts)`.\n\nAliases: `Statement`, `Terminatorless`, `CompletionStatement`\n\n - `label`: `Identifier` (default: `null`)\n\n---\n\n### debuggerStatement\n```javascript\nt.debuggerStatement()\n```\n\nSee also `t.isDebuggerStatement(node, opts)` and `t.assertDebuggerStatement(node, opts)`.\n\nAliases: `Statement`\n\n---\n\n### declareClass\n```javascript\nt.declareClass(id, typeParameters, extends, body)\n```\n\nSee also `t.isDeclareClass(node, opts)` and `t.assertDeclareClass(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `extends` (required)\n - `body` (required)\n\n---\n\n### declareExportDeclaration\n```javascript\nt.declareExportDeclaration(declaration, specifiers, source)\n```\n\nSee also `t.isDeclareExportDeclaration(node, opts)` and `t.assertDeclareExportDeclaration(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `declaration` (required)\n - `specifiers` (required)\n - `source` (required)\n\n---\n\n### declareFunction\n```javascript\nt.declareFunction(id)\n```\n\nSee also `t.isDeclareFunction(node, opts)` and `t.assertDeclareFunction(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n\n---\n\n### declareInterface\n```javascript\nt.declareInterface(id, typeParameters, extends, body)\n```\n\nSee also `t.isDeclareInterface(node, opts)` and `t.assertDeclareInterface(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `extends` (required)\n - `body` (required)\n\n---\n\n### declareModule\n```javascript\nt.declareModule(id, body)\n```\n\nSee also `t.isDeclareModule(node, opts)` and `t.assertDeclareModule(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `body` (required)\n\n---\n\n### declareModuleExports\n```javascript\nt.declareModuleExports(typeAnnotation)\n```\n\nSee also `t.isDeclareModuleExports(node, opts)` and `t.assertDeclareModuleExports(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `typeAnnotation` (required)\n\n---\n\n### declareOpaqueType\n```javascript\nt.declareOpaqueType(id, typeParameters, supertype)\n```\n\nSee also `t.isDeclareOpaqueType(node, opts)` and `t.assertDeclareOpaqueType(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `supertype` (required)\n\n---\n\n### declareTypeAlias\n```javascript\nt.declareTypeAlias(id, typeParameters, right)\n```\n\nSee also `t.isDeclareTypeAlias(node, opts)` and `t.assertDeclareTypeAlias(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `right` (required)\n\n---\n\n### declareVariable\n```javascript\nt.declareVariable(id)\n```\n\nSee also `t.isDeclareVariable(node, opts)` and `t.assertDeclareVariable(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n\n---\n\n### decorator\n```javascript\nt.decorator(expression)\n```\n\nSee also `t.isDecorator(node, opts)` and `t.assertDecorator(node, opts)`.\n\n - `expression`: `Expression` (required)\n\n---\n\n### directive\n```javascript\nt.directive(value)\n```\n\nSee also `t.isDirective(node, opts)` and `t.assertDirective(node, opts)`.\n\n - `value`: `DirectiveLiteral` (required)\n\n---\n\n### directiveLiteral\n```javascript\nt.directiveLiteral(value)\n```\n\nSee also `t.isDirectiveLiteral(node, opts)` and `t.assertDirectiveLiteral(node, opts)`.\n\n - `value`: `string` (required)\n\n---\n\n### doExpression\n```javascript\nt.doExpression(body)\n```\n\nSee also `t.isDoExpression(node, opts)` and `t.assertDoExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `body`: `BlockStatement` (required)\n\n---\n\n### doWhileStatement\n```javascript\nt.doWhileStatement(test, body)\n```\n\nSee also `t.isDoWhileStatement(node, opts)` and `t.assertDoWhileStatement(node, opts)`.\n\nAliases: `Statement`, `BlockParent`, `Loop`, `While`, `Scopable`\n\n - `test`: `Expression` (required)\n - `body`: `Statement` (required)\n\n---\n\n### emptyStatement\n```javascript\nt.emptyStatement()\n```\n\nSee also `t.isEmptyStatement(node, opts)` and `t.assertEmptyStatement(node, opts)`.\n\nAliases: `Statement`\n\n---\n\n### emptyTypeAnnotation\n```javascript\nt.emptyTypeAnnotation()\n```\n\nSee also `t.isEmptyTypeAnnotation(node, opts)` and `t.assertEmptyTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### existentialTypeParam\n```javascript\nt.existentialTypeParam()\n```\n\nSee also `t.isExistentialTypeParam(node, opts)` and `t.assertExistentialTypeParam(node, opts)`.\n\nAliases: `Flow`\n\n---\n\n### exportAllDeclaration\n```javascript\nt.exportAllDeclaration(source)\n```\n\nSee also `t.isExportAllDeclaration(node, opts)` and `t.assertExportAllDeclaration(node, opts)`.\n\nAliases: `Statement`, `Declaration`, `ModuleDeclaration`, `ExportDeclaration`\n\n - `source`: `StringLiteral` (required)\n\n---\n\n### exportDefaultDeclaration\n```javascript\nt.exportDefaultDeclaration(declaration)\n```\n\nSee also `t.isExportDefaultDeclaration(node, opts)` and `t.assertExportDefaultDeclaration(node, opts)`.\n\nAliases: `Statement`, `Declaration`, `ModuleDeclaration`, `ExportDeclaration`\n\n - `declaration`: `FunctionDeclaration | ClassDeclaration | Expression` (required)\n\n---\n\n### exportDefaultSpecifier\n```javascript\nt.exportDefaultSpecifier(exported)\n```\n\nSee also `t.isExportDefaultSpecifier(node, opts)` and `t.assertExportDefaultSpecifier(node, opts)`.\n\nAliases: `ModuleSpecifier`\n\n - `exported`: `Identifier` (required)\n\n---\n\n### exportNamedDeclaration\n```javascript\nt.exportNamedDeclaration(declaration, specifiers, source)\n```\n\nSee also `t.isExportNamedDeclaration(node, opts)` and `t.assertExportNamedDeclaration(node, opts)`.\n\nAliases: `Statement`, `Declaration`, `ModuleDeclaration`, `ExportDeclaration`\n\n - `declaration`: `Declaration` (default: `null`)\n - `specifiers`: `Array<ExportSpecifier>` (required)\n - `source`: `StringLiteral` (default: `null`)\n\n---\n\n### exportNamespaceSpecifier\n```javascript\nt.exportNamespaceSpecifier(exported)\n```\n\nSee also `t.isExportNamespaceSpecifier(node, opts)` and `t.assertExportNamespaceSpecifier(node, opts)`.\n\nAliases: `ModuleSpecifier`\n\n - `exported`: `Identifier` (required)\n\n---\n\n### exportSpecifier\n```javascript\nt.exportSpecifier(local, exported)\n```\n\nSee also `t.isExportSpecifier(node, opts)` and `t.assertExportSpecifier(node, opts)`.\n\nAliases: `ModuleSpecifier`\n\n - `local`: `Identifier` (required)\n - `exported`: `Identifier` (required)\n\n---\n\n### expressionStatement\n```javascript\nt.expressionStatement(expression)\n```\n\nSee also `t.isExpressionStatement(node, opts)` and `t.assertExpressionStatement(node, opts)`.\n\nAliases: `Statement`, `ExpressionWrapper`\n\n - `expression`: `Expression` (required)\n\n---\n\n### file\n```javascript\nt.file(program, comments, tokens)\n```\n\nSee also `t.isFile(node, opts)` and `t.assertFile(node, opts)`.\n\n - `program`: `Program` (required)\n - `comments` (required)\n - `tokens` (required)\n\n---\n\n### forAwaitStatement\n```javascript\nt.forAwaitStatement(left, right, body)\n```\n\nSee also `t.isForAwaitStatement(node, opts)` and `t.assertForAwaitStatement(node, opts)`.\n\nAliases: `Scopable`, `Statement`, `For`, `BlockParent`, `Loop`, `ForXStatement`\n\n - `left`: `VariableDeclaration | LVal` (required)\n - `right`: `Expression` (required)\n - `body`: `Statement` (required)\n\n---\n\n### forInStatement\n```javascript\nt.forInStatement(left, right, body)\n```\n\nSee also `t.isForInStatement(node, opts)` and `t.assertForInStatement(node, opts)`.\n\nAliases: `Scopable`, `Statement`, `For`, `BlockParent`, `Loop`, `ForXStatement`\n\n - `left`: `VariableDeclaration | LVal` (required)\n - `right`: `Expression` (required)\n - `body`: `Statement` (required)\n\n---\n\n### forOfStatement\n```javascript\nt.forOfStatement(left, right, body)\n```\n\nSee also `t.isForOfStatement(node, opts)` and `t.assertForOfStatement(node, opts)`.\n\nAliases: `Scopable`, `Statement`, `For`, `BlockParent`, `Loop`, `ForXStatement`\n\n - `left`: `VariableDeclaration | LVal` (required)\n - `right`: `Expression` (required)\n - `body`: `Statement` (required)\n\n---\n\n### forStatement\n```javascript\nt.forStatement(init, test, update, body)\n```\n\nSee also `t.isForStatement(node, opts)` and `t.assertForStatement(node, opts)`.\n\nAliases: `Scopable`, `Statement`, `For`, `BlockParent`, `Loop`\n\n - `init`: `VariableDeclaration | Expression` (default: `null`)\n - `test`: `Expression` (default: `null`)\n - `update`: `Expression` (default: `null`)\n - `body`: `Statement` (required)\n\n---\n\n### functionDeclaration\n```javascript\nt.functionDeclaration(id, params, body, generator, async)\n```\n\nSee also `t.isFunctionDeclaration(node, opts)` and `t.assertFunctionDeclaration(node, opts)`.\n\nAliases: `Scopable`, `Function`, `BlockParent`, `FunctionParent`, `Statement`, `Pureish`, `Declaration`\n\n - `id`: `Identifier` (required)\n - `params`: `Array<LVal>` (required)\n - `body`: `BlockStatement` (required)\n - `generator`: `boolean` (default: `false`)\n - `async`: `boolean` (default: `false`)\n - `returnType` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### functionExpression\n```javascript\nt.functionExpression(id, params, body, generator, async)\n```\n\nSee also `t.isFunctionExpression(node, opts)` and `t.assertFunctionExpression(node, opts)`.\n\nAliases: `Scopable`, `Function`, `BlockParent`, `FunctionParent`, `Expression`, `Pureish`\n\n - `id`: `Identifier` (default: `null`)\n - `params`: `Array<LVal>` (required)\n - `body`: `BlockStatement` (required)\n - `generator`: `boolean` (default: `false`)\n - `async`: `boolean` (default: `false`)\n - `returnType` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### functionTypeAnnotation\n```javascript\nt.functionTypeAnnotation(typeParameters, params, rest, returnType)\n```\n\nSee also `t.isFunctionTypeAnnotation(node, opts)` and `t.assertFunctionTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `typeParameters` (required)\n - `params` (required)\n - `rest` (required)\n - `returnType` (required)\n\n---\n\n### functionTypeParam\n```javascript\nt.functionTypeParam(name, typeAnnotation)\n```\n\nSee also `t.isFunctionTypeParam(node, opts)` and `t.assertFunctionTypeParam(node, opts)`.\n\nAliases: `Flow`\n\n - `name` (required)\n - `typeAnnotation` (required)\n\n---\n\n### genericTypeAnnotation\n```javascript\nt.genericTypeAnnotation(id, typeParameters)\n```\n\nSee also `t.isGenericTypeAnnotation(node, opts)` and `t.assertGenericTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `id` (required)\n - `typeParameters` (required)\n\n---\n\n### identifier\n```javascript\nt.identifier(name)\n```\n\nSee also `t.isIdentifier(node, opts)` and `t.assertIdentifier(node, opts)`.\n\nAliases: `Expression`, `LVal`\n\n - `name``string` (required)\n - `decorators`: `Array<Decorator>` (default: `null`)\n - `typeAnnotation` (default: `null`)\n\n---\n\n### ifStatement\n```javascript\nt.ifStatement(test, consequent, alternate)\n```\n\nSee also `t.isIfStatement(node, opts)` and `t.assertIfStatement(node, opts)`.\n\nAliases: `Statement`, `Conditional`\n\n - `test`: `Expression` (required)\n - `consequent`: `Statement` (required)\n - `alternate`: `Statement` (default: `null`)\n\n---\n\n### import\n```javascript\nt.import()\n```\n\nSee also `t.isImport(node, opts)` and `t.assertImport(node, opts)`.\n\nAliases: `Expression`\n\n---\n\n### importDeclaration\n```javascript\nt.importDeclaration(specifiers, source)\n```\n\nSee also `t.isImportDeclaration(node, opts)` and `t.assertImportDeclaration(node, opts)`.\n\nAliases: `Statement`, `Declaration`, `ModuleDeclaration`\n\n - `specifiers`: `Array<ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier>` (required)\n - `source`: `StringLiteral` (required)\n\n---\n\n### importDefaultSpecifier\n```javascript\nt.importDefaultSpecifier(local)\n```\n\nSee also `t.isImportDefaultSpecifier(node, opts)` and `t.assertImportDefaultSpecifier(node, opts)`.\n\nAliases: `ModuleSpecifier`\n\n - `local`: `Identifier` (required)\n\n---\n\n### importNamespaceSpecifier\n```javascript\nt.importNamespaceSpecifier(local)\n```\n\nSee also `t.isImportNamespaceSpecifier(node, opts)` and `t.assertImportNamespaceSpecifier(node, opts)`.\n\nAliases: `ModuleSpecifier`\n\n - `local`: `Identifier` (required)\n\n---\n\n### importSpecifier\n```javascript\nt.importSpecifier(local, imported)\n```\n\nSee also `t.isImportSpecifier(node, opts)` and `t.assertImportSpecifier(node, opts)`.\n\nAliases: `ModuleSpecifier`\n\n - `local`: `Identifier` (required)\n - `imported`: `Identifier` (required)\n - `importKind`: `null | 'type' | 'typeof'` (default: `null`)\n\n---\n\n### interfaceDeclaration\n```javascript\nt.interfaceDeclaration(id, typeParameters, extends, body)\n```\n\nSee also `t.isInterfaceDeclaration(node, opts)` and `t.assertInterfaceDeclaration(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `extends` (required)\n - `body` (required)\n\n---\n\n### interfaceExtends\n```javascript\nt.interfaceExtends(id, typeParameters)\n```\n\nSee also `t.isInterfaceExtends(node, opts)` and `t.assertInterfaceExtends(node, opts)`.\n\nAliases: `Flow`\n\n - `id` (required)\n - `typeParameters` (required)\n\n---\n\n### intersectionTypeAnnotation\n```javascript\nt.intersectionTypeAnnotation(types)\n```\n\nSee also `t.isIntersectionTypeAnnotation(node, opts)` and `t.assertIntersectionTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `types` (required)\n\n---\n\n### jSXAttribute\n```javascript\nt.jSXAttribute(name, value)\n```\n\nSee also `t.isJSXAttribute(node, opts)` and `t.assertJSXAttribute(node, opts)`.\n\nAliases: `JSX`, `Immutable`\n\n - `name`: `JSXIdentifier | JSXNamespacedName` (required)\n - `value`: `JSXElement | StringLiteral | JSXExpressionContainer` (default: `null`)\n\n---\n\n### jSXClosingElement\n```javascript\nt.jSXClosingElement(name)\n```\n\nSee also `t.isJSXClosingElement(node, opts)` and `t.assertJSXClosingElement(node, opts)`.\n\nAliases: `JSX`, `Immutable`\n\n - `name`: `JSXIdentifier | JSXMemberExpression` (required)\n\n---\n\n### jSXElement\n```javascript\nt.jSXElement(openingElement, closingElement, children, selfClosing)\n```\n\nSee also `t.isJSXElement(node, opts)` and `t.assertJSXElement(node, opts)`.\n\nAliases: `JSX`, `Immutable`, `Expression`\n\n - `openingElement`: `JSXOpeningElement` (required)\n - `closingElement`: `JSXClosingElement` (default: `null`)\n - `children`: `Array<JSXText | JSXExpressionContainer | JSXSpreadChild | JSXElement>` (required)\n - `selfClosing` (required)\n\n---\n\n### jSXEmptyExpression\n```javascript\nt.jSXEmptyExpression()\n```\n\nSee also `t.isJSXEmptyExpression(node, opts)` and `t.assertJSXEmptyExpression(node, opts)`.\n\nAliases: `JSX`, `Expression`\n\n---\n\n### jSXExpressionContainer\n```javascript\nt.jSXExpressionContainer(expression)\n```\n\nSee also `t.isJSXExpressionContainer(node, opts)` and `t.assertJSXExpressionContainer(node, opts)`.\n\nAliases: `JSX`, `Immutable`\n\n - `expression`: `Expression` (required)\n\n---\n\n### jSXIdentifier\n```javascript\nt.jSXIdentifier(name)\n```\n\nSee also `t.isJSXIdentifier(node, opts)` and `t.assertJSXIdentifier(node, opts)`.\n\nAliases: `JSX`, `Expression`\n\n - `name`: `string` (required)\n\n---\n\n### jSXMemberExpression\n```javascript\nt.jSXMemberExpression(object, property)\n```\n\nSee also `t.isJSXMemberExpression(node, opts)` and `t.assertJSXMemberExpression(node, opts)`.\n\nAliases: `JSX`, `Expression`\n\n - `object`: `JSXMemberExpression | JSXIdentifier` (required)\n - `property`: `JSXIdentifier` (required)\n\n---\n\n### jSXNamespacedName\n```javascript\nt.jSXNamespacedName(namespace, name)\n```\n\nSee also `t.isJSXNamespacedName(node, opts)` and `t.assertJSXNamespacedName(node, opts)`.\n\nAliases: `JSX`\n\n - `namespace`: `JSXIdentifier` (required)\n - `name`: `JSXIdentifier` (required)\n\n---\n\n### jSXOpeningElement\n```javascript\nt.jSXOpeningElement(name, attributes, selfClosing)\n```\n\nSee also `t.isJSXOpeningElement(node, opts)` and `t.assertJSXOpeningElement(node, opts)`.\n\nAliases: `JSX`, `Immutable`\n\n - `name`: `JSXIdentifier | JSXMemberExpression` (required)\n - `attributes`: `Array<JSXAttribute | JSXSpreadAttribute>` (required)\n - `selfClosing`: `boolean` (default: `false`)\n\n---\n\n### jSXSpreadAttribute\n```javascript\nt.jSXSpreadAttribute(argument)\n```\n\nSee also `t.isJSXSpreadAttribute(node, opts)` and `t.assertJSXSpreadAttribute(node, opts)`.\n\nAliases: `JSX`\n\n - `argument`: `Expression` (required)\n\n---\n\n### jSXSpreadChild\n```javascript\nt.jSXSpreadChild(expression)\n```\n\nSee also `t.isJSXSpreadChild(node, opts)` and `t.assertJSXSpreadChild(node, opts)`.\n\nAliases: `JSX`, `Immutable`\n\n - `expression`: `Expression` (required)\n\n---\n\n### jSXText\n```javascript\nt.jSXText(value)\n```\n\nSee also `t.isJSXText(node, opts)` and `t.assertJSXText(node, opts)`.\n\nAliases: `JSX`, `Immutable`\n\n - `value`: `string` (required)\n\n---\n\n### labeledStatement\n```javascript\nt.labeledStatement(label, body)\n```\n\nSee also `t.isLabeledStatement(node, opts)` and `t.assertLabeledStatement(node, opts)`.\n\nAliases: `Statement`\n\n - `label`: `Identifier` (required)\n - `body`: `Statement` (required)\n\n---\n\n### logicalExpression\n```javascript\nt.logicalExpression(operator, left, right)\n```\n\nSee also `t.isLogicalExpression(node, opts)` and `t.assertLogicalExpression(node, opts)`.\n\nAliases: `Binary`, `Expression`\n\n - `operator`: `'||' | '&&'` (required)\n - `left`: `Expression` (required)\n - `right`: `Expression` (required)\n\n---\n\n### memberExpression\n```javascript\nt.memberExpression(object, property, computed)\n```\n\nSee also `t.isMemberExpression(node, opts)` and `t.assertMemberExpression(node, opts)`.\n\nAliases: `Expression`, `LVal`\n\n - `object`: `Expression` (required)\n - `property`if computed then `Expression` else `Identifier` (required)\n - `computed`: `boolean` (default: `false`)\n\n---\n\n### metaProperty\n```javascript\nt.metaProperty(meta, property)\n```\n\nSee also `t.isMetaProperty(node, opts)` and `t.assertMetaProperty(node, opts)`.\n\nAliases: `Expression`\n\n - `meta`: `string` (required)\n - `property`: `string` (required)\n\n---\n\n### mixedTypeAnnotation\n```javascript\nt.mixedTypeAnnotation()\n```\n\nSee also `t.isMixedTypeAnnotation(node, opts)` and `t.assertMixedTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### newExpression\n```javascript\nt.newExpression(callee, arguments)\n```\n\nSee also `t.isNewExpression(node, opts)` and `t.assertNewExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `callee`: `Expression` (required)\n - `arguments`: `Array<Expression | SpreadElement>` (required)\n\n---\n\n### noop\n```javascript\nt.noop()\n```\n\nSee also `t.isNoop(node, opts)` and `t.assertNoop(node, opts)`.\n\n---\n\n### nullLiteral\n```javascript\nt.nullLiteral()\n```\n\nSee also `t.isNullLiteral(node, opts)` and `t.assertNullLiteral(node, opts)`.\n\nAliases: `Expression`, `Pureish`, `Literal`, `Immutable`\n\n---\n\n### nullLiteralTypeAnnotation\n```javascript\nt.nullLiteralTypeAnnotation()\n```\n\nSee also `t.isNullLiteralTypeAnnotation(node, opts)` and `t.assertNullLiteralTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### nullableTypeAnnotation\n```javascript\nt.nullableTypeAnnotation(typeAnnotation)\n```\n\nSee also `t.isNullableTypeAnnotation(node, opts)` and `t.assertNullableTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `typeAnnotation` (required)\n\n---\n\n### numberTypeAnnotation\n```javascript\nt.numberTypeAnnotation()\n```\n\nSee also `t.isNumberTypeAnnotation(node, opts)` and `t.assertNumberTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### numericLiteral\n```javascript\nt.numericLiteral(value)\n```\n\nSee also `t.isNumericLiteral(node, opts)` and `t.assertNumericLiteral(node, opts)`.\n\nAliases: `Expression`, `Pureish`, `Literal`, `Immutable`\n\n - `value`: `number` (required)\n\n---\n\n### numericLiteralTypeAnnotation\n```javascript\nt.numericLiteralTypeAnnotation()\n```\n\nSee also `t.isNumericLiteralTypeAnnotation(node, opts)` and `t.assertNumericLiteralTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n---\n\n### objectExpression\n```javascript\nt.objectExpression(properties)\n```\n\nSee also `t.isObjectExpression(node, opts)` and `t.assertObjectExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `properties`: `Array<ObjectMethod | ObjectProperty | SpreadProperty>` (required)\n\n---\n\n### objectMethod\n```javascript\nt.objectMethod(kind, key, params, body, computed)\n```\n\nSee also `t.isObjectMethod(node, opts)` and `t.assertObjectMethod(node, opts)`.\n\nAliases: `UserWhitespacable`, `Function`, `Scopable`, `BlockParent`, `FunctionParent`, `Method`, `ObjectMember`\n\n - `kind`: `\"method\" | \"get\" | \"set\"` (default: `'method'`)\n - `key`if computed then `Expression` else `Identifier | Literal` (required)\n - `params` (required)\n - `body`: `BlockStatement` (required)\n - `computed`: `boolean` (default: `false`)\n - `async`: `boolean` (default: `false`)\n - `decorators`: `Array<Decorator>` (default: `null`)\n - `generator`: `boolean` (default: `false`)\n - `returnType` (default: `null`)\n - `typeParameters` (default: `null`)\n\n---\n\n### objectPattern\n```javascript\nt.objectPattern(properties, typeAnnotation)\n```\n\nSee also `t.isObjectPattern(node, opts)` and `t.assertObjectPattern(node, opts)`.\n\nAliases: `Pattern`, `LVal`\n\n - `properties`: `Array<RestProperty | Property>` (required)\n - `typeAnnotation` (required)\n - `decorators`: `Array<Decorator>` (default: `null`)\n\n---\n\n### objectProperty\n```javascript\nt.objectProperty(key, value, computed, shorthand, decorators)\n```\n\nSee also `t.isObjectProperty(node, opts)` and `t.assertObjectProperty(node, opts)`.\n\nAliases: `UserWhitespacable`, `Property`, `ObjectMember`\n\n - `key`if computed then `Expression` else `Identifier | Literal` (required)\n - `value`: `Expression | Pattern | RestElement` (required)\n - `computed`: `boolean` (default: `false`)\n - `shorthand`: `boolean` (default: `false`)\n - `decorators`: `Array<Decorator>` (default: `null`)\n\n---\n\n### objectTypeAnnotation\n```javascript\nt.objectTypeAnnotation(properties, indexers, callProperties)\n```\n\nSee also `t.isObjectTypeAnnotation(node, opts)` and `t.assertObjectTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `properties` (required)\n - `indexers` (required)\n - `callProperties` (required)\n\n---\n\n### objectTypeCallProperty\n```javascript\nt.objectTypeCallProperty(value)\n```\n\nSee also `t.isObjectTypeCallProperty(node, opts)` and `t.assertObjectTypeCallProperty(node, opts)`.\n\nAliases: `Flow`, `UserWhitespacable`\n\n - `value` (required)\n\n---\n\n### objectTypeIndexer\n```javascript\nt.objectTypeIndexer(id, key, value)\n```\n\nSee also `t.isObjectTypeIndexer(node, opts)` and `t.assertObjectTypeIndexer(node, opts)`.\n\nAliases: `Flow`, `UserWhitespacable`\n\n - `id` (required)\n - `key` (required)\n - `value` (required)\n\n---\n\n### objectTypeProperty\n```javascript\nt.objectTypeProperty(key, value)\n```\n\nSee also `t.isObjectTypeProperty(node, opts)` and `t.assertObjectTypeProperty(node, opts)`.\n\nAliases: `Flow`, `UserWhitespacable`\n\n - `key` (required)\n - `value` (required)\n\n---\n\n### objectTypeSpreadProperty\n```javascript\nt.objectTypeSpreadProperty(argument)\n```\n\nSee also `t.isObjectTypeSpreadProperty(node, opts)` and `t.assertObjectTypeSpreadProperty(node, opts)`.\n\nAliases: `Flow`, `UserWhitespacable`\n\n - `argument` (required)\n\n---\n\n### opaqueType\n```javascript\nt.opaqueType(id, typeParameters, impltype, supertype)\n```\n\nSee also `t.isOpaqueType(node, opts)` and `t.assertOpaqueType(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `impltype` (required)\n - `supertype` (required)\n\n---\n\n### parenthesizedExpression\n```javascript\nt.parenthesizedExpression(expression)\n```\n\nSee also `t.isParenthesizedExpression(node, opts)` and `t.assertParenthesizedExpression(node, opts)`.\n\nAliases: `Expression`, `ExpressionWrapper`\n\n - `expression`: `Expression` (required)\n\n---\n\n### program\n```javascript\nt.program(body, directives)\n```\n\nSee also `t.isProgram(node, opts)` and `t.assertProgram(node, opts)`.\n\nAliases: `Scopable`, `BlockParent`, `Block`, `FunctionParent`\n\n - `body`: `Array<Statement>` (required)\n - `directives`: `Array<Directive>` (default: `[]`)\n\n---\n\n### qualifiedTypeIdentifier\n```javascript\nt.qualifiedTypeIdentifier(id, qualification)\n```\n\nSee also `t.isQualifiedTypeIdentifier(node, opts)` and `t.assertQualifiedTypeIdentifier(node, opts)`.\n\nAliases: `Flow`\n\n - `id` (required)\n - `qualification` (required)\n\n---\n\n### regExpLiteral\n```javascript\nt.regExpLiteral(pattern, flags)\n```\n\nSee also `t.isRegExpLiteral(node, opts)` and `t.assertRegExpLiteral(node, opts)`.\n\nAliases: `Expression`, `Literal`\n\n - `pattern`: `string` (required)\n - `flags`: `string` (default: `''`)\n\n---\n\n### restElement\n```javascript\nt.restElement(argument, typeAnnotation)\n```\n\nSee also `t.isRestElement(node, opts)` and `t.assertRestElement(node, opts)`.\n\nAliases: `LVal`\n\n - `argument`: `LVal` (required)\n - `typeAnnotation` (required)\n - `decorators`: `Array<Decorator>` (default: `null`)\n\n---\n\n### restProperty\n```javascript\nt.restProperty(argument)\n```\n\nSee also `t.isRestProperty(node, opts)` and `t.assertRestProperty(node, opts)`.\n\nAliases: `UnaryLike`\n\n - `argument`: `LVal` (required)\n\n---\n\n### returnStatement\n```javascript\nt.returnStatement(argument)\n```\n\nSee also `t.isReturnStatement(node, opts)` and `t.assertReturnStatement(node, opts)`.\n\nAliases: `Statement`, `Terminatorless`, `CompletionStatement`\n\n - `argument`: `Expression` (default: `null`)\n\n---\n\n### sequenceExpression\n```javascript\nt.sequenceExpression(expressions)\n```\n\nSee also `t.isSequenceExpression(node, opts)` and `t.assertSequenceExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `expressions`: `Array<Expression>` (required)\n\n---\n\n### spreadElement\n```javascript\nt.spreadElement(argument)\n```\n\nSee also `t.isSpreadElement(node, opts)` and `t.assertSpreadElement(node, opts)`.\n\nAliases: `UnaryLike`\n\n - `argument`: `Expression` (required)\n\n---\n\n### spreadProperty\n```javascript\nt.spreadProperty(argument)\n```\n\nSee also `t.isSpreadProperty(node, opts)` and `t.assertSpreadProperty(node, opts)`.\n\nAliases: `UnaryLike`\n\n - `argument`: `Expression` (required)\n\n---\n\n### stringLiteral\n```javascript\nt.stringLiteral(value)\n```\n\nSee also `t.isStringLiteral(node, opts)` and `t.assertStringLiteral(node, opts)`.\n\nAliases: `Expression`, `Pureish`, `Literal`, `Immutable`\n\n - `value`: `string` (required)\n\n---\n\n### stringLiteralTypeAnnotation\n```javascript\nt.stringLiteralTypeAnnotation()\n```\n\nSee also `t.isStringLiteralTypeAnnotation(node, opts)` and `t.assertStringLiteralTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n---\n\n### stringTypeAnnotation\n```javascript\nt.stringTypeAnnotation()\n```\n\nSee also `t.isStringTypeAnnotation(node, opts)` and `t.assertStringTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### super\n```javascript\nt.super()\n```\n\nSee also `t.isSuper(node, opts)` and `t.assertSuper(node, opts)`.\n\nAliases: `Expression`\n\n---\n\n### switchCase\n```javascript\nt.switchCase(test, consequent)\n```\n\nSee also `t.isSwitchCase(node, opts)` and `t.assertSwitchCase(node, opts)`.\n\n - `test`: `Expression` (default: `null`)\n - `consequent`: `Array<Statement>` (required)\n\n---\n\n### switchStatement\n```javascript\nt.switchStatement(discriminant, cases)\n```\n\nSee also `t.isSwitchStatement(node, opts)` and `t.assertSwitchStatement(node, opts)`.\n\nAliases: `Statement`, `BlockParent`, `Scopable`\n\n - `discriminant`: `Expression` (required)\n - `cases`: `Array<SwitchCase>` (required)\n\n---\n\n### taggedTemplateExpression\n```javascript\nt.taggedTemplateExpression(tag, quasi)\n```\n\nSee also `t.isTaggedTemplateExpression(node, opts)` and `t.assertTaggedTemplateExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `tag`: `Expression` (required)\n - `quasi`: `TemplateLiteral` (required)\n\n---\n\n### templateElement\n```javascript\nt.templateElement(value, tail)\n```\n\nSee also `t.isTemplateElement(node, opts)` and `t.assertTemplateElement(node, opts)`.\n\n - `value` (required)\n - `tail`: `boolean` (default: `false`)\n\n---\n\n### templateLiteral\n```javascript\nt.templateLiteral(quasis, expressions)\n```\n\nSee also `t.isTemplateLiteral(node, opts)` and `t.assertTemplateLiteral(node, opts)`.\n\nAliases: `Expression`, `Literal`\n\n - `quasis`: `Array<TemplateElement>` (required)\n - `expressions`: `Array<Expression>` (required)\n\n---\n\n### thisExpression\n```javascript\nt.thisExpression()\n```\n\nSee also `t.isThisExpression(node, opts)` and `t.assertThisExpression(node, opts)`.\n\nAliases: `Expression`\n\n---\n\n### thisTypeAnnotation\n```javascript\nt.thisTypeAnnotation()\n```\n\nSee also `t.isThisTypeAnnotation(node, opts)` and `t.assertThisTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### throwStatement\n```javascript\nt.throwStatement(argument)\n```\n\nSee also `t.isThrowStatement(node, opts)` and `t.assertThrowStatement(node, opts)`.\n\nAliases: `Statement`, `Terminatorless`, `CompletionStatement`\n\n - `argument`: `Expression` (required)\n\n---\n\n### tryStatement\n```javascript\nt.tryStatement(block, handler, finalizer)\n```\n\nSee also `t.isTryStatement(node, opts)` and `t.assertTryStatement(node, opts)`.\n\nAliases: `Statement`\n\n - `block` (required)\n - `handler` (default: `null`)\n - `finalizer`: `BlockStatement` (default: `null`)\n - `body`: `BlockStatement` (default: `null`)\n\n---\n\n### tupleTypeAnnotation\n```javascript\nt.tupleTypeAnnotation(types)\n```\n\nSee also `t.isTupleTypeAnnotation(node, opts)` and `t.assertTupleTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `types` (required)\n\n---\n\n### typeAlias\n```javascript\nt.typeAlias(id, typeParameters, right)\n```\n\nSee also `t.isTypeAlias(node, opts)` and `t.assertTypeAlias(node, opts)`.\n\nAliases: `Flow`, `FlowDeclaration`, `Statement`, `Declaration`\n\n - `id` (required)\n - `typeParameters` (required)\n - `right` (required)\n\n---\n\n### typeAnnotation\n```javascript\nt.typeAnnotation(typeAnnotation)\n```\n\nSee also `t.isTypeAnnotation(node, opts)` and `t.assertTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `typeAnnotation` (required)\n\n---\n\n### typeCastExpression\n```javascript\nt.typeCastExpression(expression, typeAnnotation)\n```\n\nSee also `t.isTypeCastExpression(node, opts)` and `t.assertTypeCastExpression(node, opts)`.\n\nAliases: `Flow`, `ExpressionWrapper`, `Expression`\n\n - `expression` (required)\n - `typeAnnotation` (required)\n\n---\n\n### typeParameter\n```javascript\nt.typeParameter(bound)\n```\n\nSee also `t.isTypeParameter(node, opts)` and `t.assertTypeParameter(node, opts)`.\n\nAliases: `Flow`\n\n - `bound` (required)\n\n---\n\n### typeParameterDeclaration\n```javascript\nt.typeParameterDeclaration(params)\n```\n\nSee also `t.isTypeParameterDeclaration(node, opts)` and `t.assertTypeParameterDeclaration(node, opts)`.\n\nAliases: `Flow`\n\n - `params` (required)\n\n---\n\n### typeParameterInstantiation\n```javascript\nt.typeParameterInstantiation(params)\n```\n\nSee also `t.isTypeParameterInstantiation(node, opts)` and `t.assertTypeParameterInstantiation(node, opts)`.\n\nAliases: `Flow`\n\n - `params` (required)\n\n---\n\n### typeofTypeAnnotation\n```javascript\nt.typeofTypeAnnotation(argument)\n```\n\nSee also `t.isTypeofTypeAnnotation(node, opts)` and `t.assertTypeofTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `argument` (required)\n\n---\n\n### unaryExpression\n```javascript\nt.unaryExpression(operator, argument, prefix)\n```\n\nSee also `t.isUnaryExpression(node, opts)` and `t.assertUnaryExpression(node, opts)`.\n\nAliases: `UnaryLike`, `Expression`\n\n - `operator`: `'void' | 'delete' | '!' | '+' | '-' | '++' | '--' | '~' | 'typeof'` (required)\n - `argument`: `Expression` (required)\n - `prefix`: `boolean` (default: `true`)\n\n---\n\n### unionTypeAnnotation\n```javascript\nt.unionTypeAnnotation(types)\n```\n\nSee also `t.isUnionTypeAnnotation(node, opts)` and `t.assertUnionTypeAnnotation(node, opts)`.\n\nAliases: `Flow`\n\n - `types` (required)\n\n---\n\n### updateExpression\n```javascript\nt.updateExpression(operator, argument, prefix)\n```\n\nSee also `t.isUpdateExpression(node, opts)` and `t.assertUpdateExpression(node, opts)`.\n\nAliases: `Expression`\n\n - `operator`: `'++' | '--'` (required)\n - `argument`: `Expression` (required)\n - `prefix`: `boolean` (default: `false`)\n\n---\n\n### variableDeclaration\n```javascript\nt.variableDeclaration(kind, declarations)\n```\n\nSee also `t.isVariableDeclaration(node, opts)` and `t.assertVariableDeclaration(node, opts)`.\n\nAliases: `Statement`, `Declaration`\n\n - `kind`: `\"var\" | \"let\" | \"const\"` (required)\n - `declarations`: `Array<VariableDeclarator>` (required)\n\n---\n\n### variableDeclarator\n```javascript\nt.variableDeclarator(id, init)\n```\n\nSee also `t.isVariableDeclarator(node, opts)` and `t.assertVariableDeclarator(node, opts)`.\n\n - `id`: `LVal` (required)\n - `init`: `Expression` (default: `null`)\n\n---\n\n### voidTypeAnnotation\n```javascript\nt.voidTypeAnnotation()\n```\n\nSee also `t.isVoidTypeAnnotation(node, opts)` and `t.assertVoidTypeAnnotation(node, opts)`.\n\nAliases: `Flow`, `FlowBaseAnnotation`\n\n---\n\n### whileStatement\n```javascript\nt.whileStatement(test, body)\n```\n\nSee also `t.isWhileStatement(node, opts)` and `t.assertWhileStatement(node, opts)`.\n\nAliases: `Statement`, `BlockParent`, `Loop`, `While`, `Scopable`\n\n - `test`: `Expression` (required)\n - `body`: `BlockStatement | Statement` (required)\n\n---\n\n### withStatement\n```javascript\nt.withStatement(object, body)\n```\n\nSee also `t.isWithStatement(node, opts)` and `t.assertWithStatement(node, opts)`.\n\nAliases: `Statement`\n\n - `object` (required)\n - `body`: `BlockStatement | Statement` (required)\n\n---\n\n### yieldExpression\n```javascript\nt.yieldExpression(argument, delegate)\n```\n\nSee also `t.isYieldExpression(node, opts)` and `t.assertYieldExpression(node, opts)`.\n\nAliases: `Expression`, `Terminatorless`\n\n - `argument`: `Expression` (default: `null`)\n - `delegate`: `boolean` (default: `false`)\n\n---\n\n<!-- end generated section -->\n# ws: a Node.js WebSocket library\n\n[](https://www.npmjs.com/package/ws)\n[](https://travis-ci.com/websockets/ws)\n[](https://ci.appveyor.com/project/lpinca/ws)\n[](https://coveralls.io/github/websockets/ws)\n\nws is a simple to use, blazing fast, and thoroughly tested WebSocket client and\nserver implementation.\n\nPasses the quite extensive Autobahn test suite: [server][server-report],\n[client][client-report].\n\n**Note**: This module does not work in the browser. The client in the docs is a\nreference to a back end with the role of a client in the WebSocket\ncommunication. Browser clients must use the native\n[`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)\nobject. To make the same code work seamlessly on Node.js and the browser, you\ncan use one of the many wrappers available on npm, like\n[isomorphic-ws](https://github.com/heineiuo/isomorphic-ws).\n\n## Table of Contents\n\n- [Protocol support](#protocol-support)\n- [Installing](#installing)\n - [Opt-in for performance and spec compliance](#opt-in-for-performance-and-spec-compliance)\n- [API docs](#api-docs)\n- [WebSocket compression](#websocket-compression)\n- [Usage examples](#usage-examples)\n - [Sending and receiving text data](#sending-and-receiving-text-data)\n - [Sending binary data](#sending-binary-data)\n - [Simple server](#simple-server)\n - [External HTTP/S server](#external-https-server)\n - [Multiple servers sharing a single HTTP/S server](#multiple-servers-sharing-a-single-https-server)\n - [Client authentication](#client-authentication)\n - [Server broadcast](#server-broadcast)\n - [echo.websocket.org demo](#echowebsocketorg-demo)\n - [Use the Node.js streams API](#use-the-nodejs-streams-api)\n - [Other examples](#other-examples)\n- [FAQ](#faq)\n - [How to get the IP address of the client?](#how-to-get-the-ip-address-of-the-client)\n - [How to detect and close broken connections?](#how-to-detect-and-close-broken-connections)\n - [How to connect via a proxy?](#how-to-connect-via-a-proxy)\n- [Changelog](#changelog)\n- [License](#license)\n\n## Protocol support\n\n- **HyBi drafts 07-12** (Use the option `protocolVersion: 8`)\n- **HyBi drafts 13-17** (Current default, alternatively option\n `protocolVersion: 13`)\n\n## Installing\n\n```\nnpm install ws\n```\n\n### Opt-in for performance and spec compliance\n\nThere are 2 optional modules that can be installed along side with the ws\nmodule. These modules are binary addons which improve certain operations.\nPrebuilt binaries are available for the most popular platforms so you don't\nnecessarily need to have a C++ compiler installed on your machine.\n\n- `npm install --save-optional bufferutil`: Allows to efficiently perform\n operations such as masking and unmasking the data payload of the WebSocket\n frames.\n- `npm install --save-optional utf-8-validate`: Allows to efficiently check if a\n message contains valid UTF-8 as required by the spec.\n\n## API docs\n\nSee [`/doc/ws.md`](./doc/ws.md) for Node.js-like documentation of ws classes and\nutility functions.\n\n## WebSocket compression\n\nws supports the [permessage-deflate extension][permessage-deflate] which enables\nthe client and server to negotiate a compression algorithm and its parameters,\nand then selectively apply it to the data payloads of each WebSocket message.\n\nThe extension is disabled by default on the server and enabled by default on the\nclient. It adds a significant overhead in terms of performance and memory\nconsumption so we suggest to enable it only if it is really needed.\n\nNote that Node.js has a variety of issues with high-performance compression,\nwhere increased concurrency, especially on Linux, can lead to [catastrophic\nmemory fragmentation][node-zlib-bug] and slow performance. If you intend to use\npermessage-deflate in production, it is worthwhile to set up a test\nrepresentative of your workload and ensure Node.js/zlib will handle it with\nacceptable performance and memory usage.\n\nTuning of permessage-deflate can be done via the options defined below. You can\nalso use `zlibDeflateOptions` and `zlibInflateOptions`, which is passed directly\ninto the creation of [raw deflate/inflate streams][node-zlib-deflaterawdocs].\n\nSee [the docs][ws-server-options] for more options.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({\n port: 8080,\n perMessageDeflate: {\n zlibDeflateOptions: {\n // See zlib defaults.\n chunkSize: 1024,\n memLevel: 7,\n level: 3\n },\n zlibInflateOptions: {\n chunkSize: 10 * 1024\n },\n // Other options settable:\n clientNoContextTakeover: true, // Defaults to negotiated value.\n serverNoContextTakeover: true, // Defaults to negotiated value.\n serverMaxWindowBits: 10, // Defaults to negotiated value.\n // Below options specified as default values.\n concurrencyLimit: 10, // Limits zlib concurrency for perf.\n threshold: 1024 // Size (in bytes) below which messages\n // should not be compressed.\n }\n});\n```\n\nThe client will only use the extension if it is supported and enabled on the\nserver. To always disable the extension on the client set the\n`perMessageDeflate` option to `false`.\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('ws://www.host.com/path', {\n perMessageDeflate: false\n});\n```\n\n## Usage examples\n\n### Sending and receiving text data\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('ws://www.host.com/path');\n\nws.on('open', function open() {\n ws.send('something');\n});\n\nws.on('message', function incoming(data) {\n console.log(data);\n});\n```\n\n### Sending binary data\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('ws://www.host.com/path');\n\nws.on('open', function open() {\n const array = new Float32Array(5);\n\n for (var i = 0; i < array.length; ++i) {\n array[i] = i / 2;\n }\n\n ws.send(array);\n});\n```\n\n### Simple server\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(message) {\n console.log('received: %s', message);\n });\n\n ws.send('something');\n});\n```\n\n### External HTTP/S server\n\n```js\nconst fs = require('fs');\nconst https = require('https');\nconst WebSocket = require('ws');\n\nconst server = https.createServer({\n cert: fs.readFileSync('/path/to/cert.pem'),\n key: fs.readFileSync('/path/to/key.pem')\n});\nconst wss = new WebSocket.Server({ server });\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(message) {\n console.log('received: %s', message);\n });\n\n ws.send('something');\n});\n\nserver.listen(8080);\n```\n\n### Multiple servers sharing a single HTTP/S server\n\n```js\nconst http = require('http');\nconst WebSocket = require('ws');\nconst url = require('url');\n\nconst server = http.createServer();\nconst wss1 = new WebSocket.Server({ noServer: true });\nconst wss2 = new WebSocket.Server({ noServer: true });\n\nwss1.on('connection', function connection(ws) {\n // ...\n});\n\nwss2.on('connection', function connection(ws) {\n // ...\n});\n\nserver.on('upgrade', function upgrade(request, socket, head) {\n const pathname = url.parse(request.url).pathname;\n\n if (pathname === '/foo') {\n wss1.handleUpgrade(request, socket, head, function done(ws) {\n wss1.emit('connection', ws, request);\n });\n } else if (pathname === '/bar') {\n wss2.handleUpgrade(request, socket, head, function done(ws) {\n wss2.emit('connection', ws, request);\n });\n } else {\n socket.destroy();\n }\n});\n\nserver.listen(8080);\n```\n\n### Client authentication\n\n```js\nconst http = require('http');\nconst WebSocket = require('ws');\n\nconst server = http.createServer();\nconst wss = new WebSocket.Server({ noServer: true });\n\nwss.on('connection', function connection(ws, request, client) {\n ws.on('message', function message(msg) {\n console.log(`Received message ${msg} from user ${client}`);\n });\n});\n\nserver.on('upgrade', function upgrade(request, socket, head) {\n // This function is not defined on purpose. Implement it with your own logic.\n authenticate(request, (err, client) => {\n if (err || !client) {\n socket.write('HTTP/1.1 401 Unauthorized\\r\\n\\r\\n');\n socket.destroy();\n return;\n }\n\n wss.handleUpgrade(request, socket, head, function done(ws) {\n wss.emit('connection', ws, request, client);\n });\n });\n});\n\nserver.listen(8080);\n```\n\nAlso see the provided [example][session-parse-example] using `express-session`.\n\n### Server broadcast\n\nA client WebSocket broadcasting to all connected WebSocket clients, including\nitself.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(data) {\n wss.clients.forEach(function each(client) {\n if (client.readyState === WebSocket.OPEN) {\n client.send(data);\n }\n });\n });\n});\n```\n\nA client WebSocket broadcasting to every other connected WebSocket clients,\nexcluding itself.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(data) {\n wss.clients.forEach(function each(client) {\n if (client !== ws && client.readyState === WebSocket.OPEN) {\n client.send(data);\n }\n });\n });\n});\n```\n\n### echo.websocket.org demo\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('wss://echo.websocket.org/', {\n origin: 'https://websocket.org'\n});\n\nws.on('open', function open() {\n console.log('connected');\n ws.send(Date.now());\n});\n\nws.on('close', function close() {\n console.log('disconnected');\n});\n\nws.on('message', function incoming(data) {\n console.log(`Roundtrip time: ${Date.now() - data} ms`);\n\n setTimeout(function timeout() {\n ws.send(Date.now());\n }, 500);\n});\n```\n\n### Use the Node.js streams API\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('wss://echo.websocket.org/', {\n origin: 'https://websocket.org'\n});\n\nconst duplex = WebSocket.createWebSocketStream(ws, { encoding: 'utf8' });\n\nduplex.pipe(process.stdout);\nprocess.stdin.pipe(duplex);\n```\n\n### Other examples\n\nFor a full example with a browser client communicating with a ws server, see the\nexamples folder.\n\nOtherwise, see the test cases.\n\n## FAQ\n\n### How to get the IP address of the client?\n\nThe remote IP address can be obtained from the raw socket.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws, req) {\n const ip = req.socket.remoteAddress;\n});\n```\n\nWhen the server runs behind a proxy like NGINX, the de-facto standard is to use\nthe `X-Forwarded-For` header.\n\n```js\nwss.on('connection', function connection(ws, req) {\n const ip = req.headers['x-forwarded-for'].split(/\\s*,\\s*/)[0];\n});\n```\n\n### How to detect and close broken connections?\n\nSometimes the link between the server and the client can be interrupted in a way\nthat keeps both the server and the client unaware of the broken state of the\nconnection (e.g. when pulling the cord).\n\nIn these cases ping messages can be used as a means to verify that the remote\nendpoint is still responsive.\n\n```js\nconst WebSocket = require('ws');\n\nfunction noop() {}\n\nfunction heartbeat() {\n this.isAlive = true;\n}\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n ws.isAlive = true;\n ws.on('pong', heartbeat);\n});\n\nconst interval = setInterval(function ping() {\n wss.clients.forEach(function each(ws) {\n if (ws.isAlive === false) return ws.terminate();\n\n ws.isAlive = false;\n ws.ping(noop);\n });\n}, 30000);\n\nwss.on('close', function close() {\n clearInterval(interval);\n});\n```\n\nPong messages are automatically sent in response to ping messages as required by\nthe spec.\n\nJust like the server example above your clients might as well lose connection\nwithout knowing it. You might want to add a ping listener on your clients to\nprevent that. A simple implementation would be:\n\n```js\nconst WebSocket = require('ws');\n\nfunction heartbeat() {\n clearTimeout(this.pingTimeout);\n\n // Use `WebSocket#terminate()`, which immediately destroys the connection,\n // instead of `WebSocket#close()`, which waits for the close timer.\n // Delay should be equal to the interval at which your server\n // sends out pings plus a conservative assumption of the latency.\n this.pingTimeout = setTimeout(() => {\n this.terminate();\n }, 30000 + 1000);\n}\n\nconst client = new WebSocket('wss://echo.websocket.org/');\n\nclient.on('open', heartbeat);\nclient.on('ping', heartbeat);\nclient.on('close', function clear() {\n clearTimeout(this.pingTimeout);\n});\n```\n\n### How to connect via a proxy?\n\nUse a custom `http.Agent` implementation like [https-proxy-agent][] or\n[socks-proxy-agent][].\n\n## Changelog\n\nWe're using the GitHub [releases][changelog] for changelog entries.\n\n## License\n\n[MIT](LICENSE)\n\n[changelog]: https://github.com/websockets/ws/releases\n[client-report]: http://websockets.github.io/ws/autobahn/clients/\n[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent\n[node-zlib-bug]: https://github.com/nodejs/node/issues/8871\n[node-zlib-deflaterawdocs]:\n https://nodejs.org/api/zlib.html#zlib_zlib_createdeflateraw_options\n[permessage-deflate]: https://tools.ietf.org/html/rfc7692\n[server-report]: http://websockets.github.io/ws/autobahn/servers/\n[session-parse-example]: ./examples/express-session-parse\n[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent\n[ws-server-options]:\n https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback\n# [postcss][postcss]-merge-longhand\n\n> Merge longhand properties into shorthand with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-merge-longhand) do:\n\n```\nnpm install postcss-merge-longhand --save\n```\n\n## Example\n\nMerge longhand properties into shorthand; works with `margin`, `padding` &\n`border`. For more examples see the [tests](src/__tests__/index.js).\n\n### Input\n\n```css\nh1 {\n margin-top: 10px;\n margin-right: 20px;\n margin-bottom: 10px;\n margin-left: 20px;\n}\n```\n\n### Output\n\n```css\nh1 {\n margin: 10px 20px;\n}\n```\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# is-number [](https://www.npmjs.com/package/is-number) [](https://npmjs.org/package/is-number) [](https://npmjs.org/package/is-number) [](https://travis-ci.org/jonschlinkert/is-number)\n\n> Returns true if the value is a finite number.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-number\n```\n\n## Why is this needed?\n\nIn JavaScript, it's not always as straightforward as it should be to reliably check if a value is a number. It's common for devs to use `+`, `-`, or `Number()` to cast a string value to a number (for example, when values are returned from user input, regex matches, parsers, etc). But there are many non-intuitive edge cases that yield unexpected results:\n\n```js\nconsole.log(+[]); //=> 0\nconsole.log(+''); //=> 0\nconsole.log(+' '); //=> 0\nconsole.log(typeof NaN); //=> 'number'\n```\n\nThis library offers a performant way to smooth out edge cases like these.\n\n## Usage\n\n```js\nconst isNumber = require('is-number');\n```\n\nSee the [tests](./test.js) for more examples.\n\n### true\n\n```js\nisNumber(5e3); // true\nisNumber(0xff); // true\nisNumber(-1.1); // true\nisNumber(0); // true\nisNumber(1); // true\nisNumber(1.1); // true\nisNumber(10); // true\nisNumber(10.10); // true\nisNumber(100); // true\nisNumber('-1.1'); // true\nisNumber('0'); // true\nisNumber('012'); // true\nisNumber('0xff'); // true\nisNumber('1'); // true\nisNumber('1.1'); // true\nisNumber('10'); // true\nisNumber('10.10'); // true\nisNumber('100'); // true\nisNumber('5e3'); // true\nisNumber(parseInt('012')); // true\nisNumber(parseFloat('012')); // true\n```\n\n### False\n\nEverything else is false, as you would expect:\n\n```js\nisNumber(Infinity); // false\nisNumber(NaN); // false\nisNumber(null); // false\nisNumber(undefined); // false\nisNumber(''); // false\nisNumber(' '); // false\nisNumber('foo'); // false\nisNumber([1]); // false\nisNumber([]); // false\nisNumber(function () {}); // false\nisNumber({}); // false\n```\n\n## Release history\n\n### 7.0.0\n\n* Refactor. Now uses `.isFinite` if it exists.\n* Performance is about the same as v6.0 when the value is a string or number. But it's now 3x-4x faster when the value is not a string or number.\n\n### 6.0.0\n\n* Optimizations, thanks to @benaadams.\n\n### 5.0.0\n\n**Breaking changes**\n\n* removed support for `instanceof Number` and `instanceof String`\n\n## Benchmarks\n\nAs with all benchmarks, take these with a grain of salt. See the [benchmarks](./benchmark/index.js) for more detail.\n\n```\n# all\nv7.0 x 413,222 ops/sec ±2.02% (86 runs sampled)\nv6.0 x 111,061 ops/sec ±1.29% (85 runs sampled)\nparseFloat x 317,596 ops/sec ±1.36% (86 runs sampled)\nfastest is 'v7.0'\n\n# string\nv7.0 x 3,054,496 ops/sec ±1.05% (89 runs sampled)\nv6.0 x 2,957,781 ops/sec ±0.98% (88 runs sampled)\nparseFloat x 3,071,060 ops/sec ±1.13% (88 runs sampled)\nfastest is 'parseFloat,v7.0'\n\n# number\nv7.0 x 3,146,895 ops/sec ±0.89% (89 runs sampled)\nv6.0 x 3,214,038 ops/sec ±1.07% (89 runs sampled)\nparseFloat x 3,077,588 ops/sec ±1.07% (87 runs sampled)\nfastest is 'v6.0'\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object \"Returns true if an object was created by the `Object` constructor.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 49 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 5 | [charlike-old](https://github.com/charlike-old) |\n| 1 | [benaadams](https://github.com/benaadams) |\n| 1 | [realityking](https://github.com/realityking) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 15, 2018._\nA JSON with color names and its values. Based on http://dev.w3.org/csswg/css-color/#named-colors.\n\n[](https://nodei.co/npm/color-name/)\n\n```js\nvar colors = require('color-name');\ncolors.red //[255,0,0]\n```\n\n<a href=\"LICENSE\"><img src=\"https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg\" width=\"120\"/></a>\ncommand-exists\n==============\n\nnode module to check if a command-line command exists\n\n## installation\n\n```bash\nnpm install command-exists\n```\n\n## usage\n\n### async\n\n```js\nvar commandExists = require('command-exists');\n\ncommandExists('ls', function(err, commandExists) {\n\n if(commandExists) {\n // proceed confidently knowing this command is available\n }\n\n});\n```\n### promise\n```js\nvar commandExists = require('command-exists');\n\n// invoked without a callback, it returns a promise\ncommandExists('ls')\n.then(function(command){\n // proceed\n}).catch(function(){\n // command doesn't exist\n});\n```\n\n### sync\n```js\nvar commandExistsSync = require('command-exists').sync;\n// returns true/false; doesn't throw\nif (commandExistsSync('ls')) {\n // proceed\n} else {\n // ...\n}\n\n```\n\n## changelog\n\n### v1.2.7\n\nRemoves unnecessary printed output on windows.\n\n### v1.2.6\n\nSmall bugfixes.\n\n### v1.2.5\n\nFix windows bug introduced in 1.2.4.\n\n### v1.2.4\n\nFix potential security issue.\n\n### v1.2.0\n\nAdd support for promises\n\n### v1.1.0\n\nAdd synchronous version\n\n### v1.0.2\n\nSupport for windows\n# istanbul-reports\n\n[](https://greenkeeper.io/)\n[](https://travis-ci.org/istanbuljs/istanbul-reports)\n\n- node.getRelativeName\n\n- context.getSource(filePath)\n- context.classForPercent(type, percent)\n- context.console.colorize(str, class)\n- context.writer\n- context.console.write\n- context.console.println\n<a href=\"http://promisesaplus.com/\">\n <img src=\"https://promises-aplus.github.io/promises-spec/assets/logo-small.png\" align=\"right\" alt=\"Promises/A+ logo\" />\n</a>\n\n# Request-Promise-Native\n\n[](https://gitter.im/request/request-promise?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://travis-ci.org/request/request-promise-native)\n[](https://coveralls.io/r/request/request-promise-native)\n[](https://david-dm.org/request/request-promise-native)\n[](https://snyk.io/test/npm/request-promise-native)\n\n# Deprecated!\n\nAs of Feb 11th 2020, [`request`](https://github.com/request/request) is fully deprecated. No new changes are expected to land. In fact, none have landed for some time. This package is also deprecated because it depends on `request`.\n\nFyi, here is the [reasoning of `request`'s deprecation](https://github.com/request/request/issues/3142) and a [list of alternative libraries](https://github.com/request/request/issues/3143).\n\n---\n\nThis package is similar to [`request-promise`](https://www.npmjs.com/package/request-promise) but uses native ES6+ promises.\n\nPlease refer to the [`request-promise` documentation](https://www.npmjs.com/package/request-promise). Everything applies to `request-promise-native` except the following:\n- Instead of using Bluebird promises this library uses native ES6+ promises.\n- Native ES6+ promises may have fewer features than Bluebird promises do. In particular, the `.finally(...)` method was not included until Node v10.\n\n## Installation\n\nThis module is installed via npm:\n\n```\nnpm install --save request\nnpm install --save request-promise-native\n```\n\n`request` is defined as a peer-dependency and thus has to be installed separately.\n\n## Migration from `request-promise` to `request-promise-native`\n\n1. Go through the [migration instructions](https://github.com/request/request-promise#migration-from-v3-to-v4) to upgrade to `request-promise` v4.\n2. Ensure that you don't use Bluebird-specific features on the promise returned by your request calls. In particular, you can't use `.finally(...)` anymore.\n3. You are done.\n\n## Contributing\n\nTo set up your development environment:\n\n1. clone the repo to your desktop,\n2. in the shell `cd` to the main folder,\n3. hit `npm install`,\n4. hit `npm install gulp -g` if you haven't installed gulp globally yet, and\n5. run `gulp dev`. (Or run `node ./node_modules/.bin/gulp dev` if you don't want to install gulp globally.)\n\n`gulp dev` watches all source files and if you save some changes it will lint the code and execute all tests. The test coverage report can be viewed from `./coverage/lcov-report/index.html`.\n\nIf you want to debug a test you should use `gulp test-without-coverage` to run all tests without obscuring the code by the test coverage instrumentation.\n\n## Change History\n\n- v1.0.9 (2020-07-21)\n - Security fix: bumped `request-promise-core` which bumps `lodash` to `^4.17.19` following [this advisory](https://www.npmjs.com/advisories/1523).\n- v1.0.8 (2019-11-03)\n - Security fix: bumped `request-promise-core` which bumps `lodash` to `^4.17.15`. See [vulnerabilty reports](https://snyk.io/vuln/search?q=lodash&type=npm).\n *(Thanks to @aw-davidson for reporting this in issue [#49](https://github.com/request/request-promise-native/issues/49).)*\n- v1.0.7 (2019-02-14)\n - Corrected mistakenly set `tough-cookie` version, now `^2.3.3`\n *(Thanks to @evocateur for pointing this out.)*\n - If you installed `request-promise-native@1.0.6` please make sure after the upgrade that `request` and `request-promise-native` use the same physical copy of `tough-cookie`.\n- v1.0.6 (2019-02-14)\n - Using stricter `tough-cookie@~2.3.3` to avoid installing `tough-cookie@3` which introduces breaking changes\n *(Thanks to @jasonmit for pull request [#33](https://github.com/request/request-promise-native/pull/33/))*\n - Security fix: bumped `lodash` to `^4.17.11`, see [vulnerabilty reports](https://snyk.io/vuln/search?q=lodash&type=npm)\n- v1.0.5 (2017-09-22)\n - Upgraded `tough-cookie` to a version without regex DoS vulnerability\n *(Thanks to @sophieklm for [pull request #13](https://github.com/request/request-promise-native/pull/13))*\n- v1.0.4 (2017-05-07)\n - Fix that allows to use `tough-cookie` for [cookie creation](https://github.com/request/request-promise#include-a-cookie)\n- v1.0.3 (2016-08-08)\n - Renamed internally used package `@request/promise-core` to `request-promise-core` because there where [too](https://github.com/request/request-promise/issues/137) [many](https://github.com/request/request-promise/issues/141) issues with the scoped package name\n- v1.0.2 (2016-07-18)\n - Fix for using with module bundlers like Webpack and Browserify\n- v1.0.1 (2016-07-17)\n - Fixed `@request/promise-core` version for safer versioning\n- v1.0.0 (2016-07-15)\n - Initial version similar to [`request-promise`](https://www.npmjs.com/package/request-promise) v4\n\n## License (ISC)\n\nIn case you never heard about the [ISC license](http://en.wikipedia.org/wiki/ISC_license) it is functionally equivalent to the MIT license.\n\nSee the [LICENSE file](LICENSE) for details.\n# jsdiff\n\n[](http://travis-ci.org/kpdecker/jsdiff)\n[](https://saucelabs.com/u/jsdiff)\n\nA javascript text differencing implementation.\n\nBased on the algorithm proposed in\n[\"An O(ND) Difference Algorithm and its Variations\" (Myers, 1986)](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.4.6927).\n\n## Installation\n```bash\nnpm install diff --save\n```\n\n## API\n\n* `JsDiff.diffChars(oldStr, newStr[, options])` - diffs two blocks of text, comparing character by character.\n\n Returns a list of change objects (See below).\n\n Options\n * `ignoreCase`: `true` to ignore casing difference. Defaults to `false`.\n\n* `JsDiff.diffWords(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, ignoring whitespace.\n\n Returns a list of change objects (See below).\n\n Options\n * `ignoreCase`: Same as in `diffChars`.\n\n* `JsDiff.diffWordsWithSpace(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, treating whitespace as significant.\n\n Returns a list of change objects (See below).\n\n* `JsDiff.diffLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line.\n\n Options\n * `ignoreWhitespace`: `true` to ignore leading and trailing whitespace. This is the same as `diffTrimmedLines`\n * `newlineIsToken`: `true` to treat newline characters as separate tokens. This allows for changes to the newline structure to occur independently of the line content and to be treated as such. In general this is the more human friendly form of `diffLines` and `diffLines` is better suited for patches and other computer friendly output.\n\n Returns a list of change objects (See below).\n\n* `JsDiff.diffTrimmedLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace.\n\n Returns a list of change objects (See below).\n\n* `JsDiff.diffSentences(oldStr, newStr[, options])` - diffs two blocks of text, comparing sentence by sentence.\n\n Returns a list of change objects (See below).\n\n* `JsDiff.diffCss(oldStr, newStr[, options])` - diffs two blocks of text, comparing CSS tokens.\n\n Returns a list of change objects (See below).\n\n* `JsDiff.diffJson(oldObj, newObj[, options])` - diffs two JSON objects, comparing the fields defined on each. The order of fields, etc does not matter in this comparison.\n\n Returns a list of change objects (See below).\n\n* `JsDiff.diffArrays(oldArr, newArr[, options])` - diffs two arrays, comparing each item for strict equality (===).\n\n Options\n * `comparator`: `function(left, right)` for custom equality checks\n\n Returns a list of change objects (See below).\n\n* `JsDiff.createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.\n\n Parameters:\n * `oldFileName` : String to be output in the filename section of the patch for the removals\n * `newFileName` : String to be output in the filename section of the patch for the additions\n * `oldStr` : Original string value\n * `newStr` : New string value\n * `oldHeader` : Additional information to include in the old file header\n * `newHeader` : Additional information to include in the new file header\n * `options` : An object with options. Currently, only `context` is supported and describes how many lines of context should be included.\n\n* `JsDiff.createPatch(fileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.\n\n Just like JsDiff.createTwoFilesPatch, but with oldFileName being equal to newFileName.\n\n* `JsDiff.structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options)` - returns an object with an array of hunk objects.\n\n This method is similar to createTwoFilesPatch, but returns a data structure\n suitable for further processing. Parameters are the same as createTwoFilesPatch. The data structure returned may look like this:\n\n ```js\n {\n oldFileName: 'oldfile', newFileName: 'newfile',\n oldHeader: 'header1', newHeader: 'header2',\n hunks: [{\n oldStart: 1, oldLines: 3, newStart: 1, newLines: 3,\n lines: [' line2', ' line3', '-line4', '+line5', '\\\\ No newline at end of file'],\n }]\n }\n ```\n\n* `JsDiff.applyPatch(source, patch[, options])` - applies a unified diff patch.\n\n Return a string containing new version of provided data. `patch` may be a string diff or the output from the `parsePatch` or `structuredPatch` methods.\n\n The optional `options` object may have the following keys:\n\n - `fuzzFactor`: Number of lines that are allowed to differ before rejecting a patch. Defaults to 0.\n - `compareLine(lineNumber, line, operation, patchContent)`: Callback used to compare to given lines to determine if they should be considered equal when patching. Defaults to strict equality but may be overridden to provide fuzzier comparison. Should return false if the lines should be rejected.\n\n* `JsDiff.applyPatches(patch, options)` - applies one or more patches.\n\n This method will iterate over the contents of the patch and apply to data provided through callbacks. The general flow for each patch index is:\n\n - `options.loadFile(index, callback)` is called. The caller should then load the contents of the file and then pass that to the `callback(err, data)` callback. Passing an `err` will terminate further patch execution.\n - `options.patched(index, content, callback)` is called once the patch has been applied. `content` will be the return value from `applyPatch`. When it's ready, the caller should call `callback(err)` callback. Passing an `err` will terminate further patch execution.\n\n Once all patches have been applied or an error occurs, the `options.complete(err)` callback is made.\n\n* `JsDiff.parsePatch(diffStr)` - Parses a patch into structured data\n\n Return a JSON object representation of the a patch, suitable for use with the `applyPatch` method. This parses to the same structure returned by `JsDiff.structuredPatch`.\n\n* `convertChangesToXML(changes)` - converts a list of changes to a serialized XML format\n\nAll methods above which accept the optional `callback` method will run in sync mode when that parameter is omitted and in async mode when supplied. This allows for larger diffs without blocking the event loop. This may be passed either directly as the final parameter or as the `callback` field in the `options` object.\n\n### Change Objects\nMany of the methods above return change objects. These objects consist of the following fields:\n\n* `value`: Text content\n* `added`: True if the value was inserted into the new string\n* `removed`: True if the value was removed from the old string\n\nNote that some cases may omit a particular flag field. Comparison on the flag fields should always be done in a truthy or falsy manner.\n\n## Examples\n\nBasic example in Node\n\n```js\nrequire('colors');\nvar jsdiff = require('diff');\n\nvar one = 'beep boop';\nvar other = 'beep boob blah';\n\nvar diff = jsdiff.diffChars(one, other);\n\ndiff.forEach(function(part){\n // green for additions, red for deletions\n // grey for common parts\n var color = part.added ? 'green' :\n part.removed ? 'red' : 'grey';\n process.stderr.write(part.value[color]);\n});\n\nconsole.log();\n```\nRunning the above program should yield\n\n<img src=\"images/node_example.png\" alt=\"Node Example\">\n\nBasic example in a web page\n\n```html\n<pre id=\"display\"></pre>\n<script src=\"diff.js\"></script>\n<script>\nvar one = 'beep boop',\n other = 'beep boob blah',\n color = '',\n span = null;\n\nvar diff = JsDiff.diffChars(one, other),\n display = document.getElementById('display'),\n fragment = document.createDocumentFragment();\n\ndiff.forEach(function(part){\n // green for additions, red for deletions\n // grey for common parts\n color = part.added ? 'green' :\n part.removed ? 'red' : 'grey';\n span = document.createElement('span');\n span.style.color = color;\n span.appendChild(document\n .createTextNode(part.value));\n fragment.appendChild(span);\n});\n\ndisplay.appendChild(fragment);\n</script>\n```\n\nOpen the above .html file in a browser and you should see\n\n<img src=\"images/web_example.png\" alt=\"Node Example\">\n\n**[Full online demo](http://kpdecker.github.com/jsdiff)**\n\n## Compatibility\n\n[](https://saucelabs.com/u/jsdiff)\n\njsdiff supports all ES3 environments with some known issues on IE8 and below. Under these browsers some diff algorithms such as word diff and others may fail due to lack of support for capturing groups in the `split` operation.\n\n## License\n\nSee [LICENSE](https://github.com/kpdecker/jsdiff/blob/master/LICENSE).\n# node-error-ex [](https://travis-ci.org/Qix-/node-error-ex) [](https://coveralls.io/r/Qix-/node-error-ex)\n> Easily subclass and customize new Error types\n\n## Examples\nTo include in your project:\n```javascript\nvar errorEx = require('error-ex');\n```\n\nTo create an error message type with a specific name (note, that `ErrorFn.name`\nwill not reflect this):\n```javascript\nvar JSONError = errorEx('JSONError');\n\nvar err = new JSONError('error');\nerr.name; //-> JSONError\nthrow err; //-> JSONError: error\n```\n\nTo add a stack line:\n```javascript\nvar JSONError = errorEx('JSONError', {fileName: errorEx.line('in %s')});\n\nvar err = new JSONError('error')\nerr.fileName = '/a/b/c/foo.json';\nthrow err; //-> (line 2)-> in /a/b/c/foo.json\n```\n\nTo append to the error message:\n```javascript\nvar JSONError = errorEx('JSONError', {fileName: errorEx.append('in %s')});\n\nvar err = new JSONError('error');\nerr.fileName = '/a/b/c/foo.json';\nthrow err; //-> JSONError: error in /a/b/c/foo.json\n```\n\n## API\n\n#### `errorEx([name], [properties])`\nCreates a new ErrorEx error type\n\n- `name`: the name of the new type (appears in the error message upon throw;\n defaults to `Error.name`)\n- `properties`: if supplied, used as a key/value dictionary of properties to\n use when building up the stack message. Keys are property names that are\n looked up on the error message, and then passed to function values.\n\t- `line`: if specified and is a function, return value is added as a stack\n entry (error-ex will indent for you). Passed the property value given\n the key.\n - `stack`: if specified and is a function, passed the value of the property\n using the key, and the raw stack lines as a second argument. Takes no\n return value (but the stack can be modified directly).\n - `message`: if specified and is a function, return value is used as new\n `.message` value upon get. Passed the property value of the property named\n by key, and the existing message is passed as the second argument as an\n array of lines (suitable for multi-line messages).\n\nReturns a constructor (Function) that can be used just like the regular Error\nconstructor.\n\n```javascript\nvar errorEx = require('error-ex');\n\nvar BasicError = errorEx();\n\nvar NamedError = errorEx('NamedError');\n\n// --\n\nvar AdvancedError = errorEx('AdvancedError', {\n\tfoo: {\n\t\tline: function (value, stack) {\n\t\t\tif (value) {\n\t\t\t\treturn 'bar ' + value;\n\t\t\t}\n\t\t\treturn null;\n\t\t}\n\t}\n}\n\nvar err = new AdvancedError('hello, world');\nerr.foo = 'baz';\nthrow err;\n\n/*\n\tAdvancedError: hello, world\n\t bar baz\n\t at tryReadme() (readme.js:20:1)\n*/\n```\n\n#### `errorEx.line(str)`\nCreates a stack line using a delimiter\n\n> This is a helper function. It is to be used in lieu of writing a value object\n> for `properties` values.\n\n- `str`: The string to create\n - Use the delimiter `%s` to specify where in the string the value should go\n\n```javascript\nvar errorEx = require('error-ex');\n\nvar FileError = errorEx('FileError', {fileName: errorEx.line('in %s')});\n\nvar err = new FileError('problem reading file');\nerr.fileName = '/a/b/c/d/foo.js';\nthrow err;\n\n/*\n\tFileError: problem reading file\n\t in /a/b/c/d/foo.js\n\t at tryReadme() (readme.js:7:1)\n*/\n```\n\n#### `errorEx.append(str)`\nAppends to the `error.message` string\n\n> This is a helper function. It is to be used in lieu of writing a value object\n> for `properties` values.\n\n- `str`: The string to append\n - Use the delimiter `%s` to specify where in the string the value should go\n\n```javascript\nvar errorEx = require('error-ex');\n\nvar SyntaxError = errorEx('SyntaxError', {fileName: errorEx.append('in %s')});\n\nvar err = new SyntaxError('improper indentation');\nerr.fileName = '/a/b/c/d/foo.js';\nthrow err;\n\n/*\n\tSyntaxError: improper indentation in /a/b/c/d/foo.js\n\t at tryReadme() (readme.js:7:1)\n*/\n```\n\n## License\nLicensed under the [MIT License](http://opensource.org/licenses/MIT).\nYou can find a copy of it in [LICENSE](LICENSE).\n# isStream\n\n[](http://travis-ci.org/rvagg/isstream)\n\n**Test if an object is a `Stream`**\n\n[](https://nodei.co/npm/isstream/)\n\nThe missing `Stream.isStream(obj)`: determine if an object is standard Node.js `Stream`. Works for Node-core `Stream` objects (for 0.8, 0.10, 0.11, and in theory, older and newer versions) and all versions of **[readable-stream](https://github.com/isaacs/readable-stream)**.\n\n## Usage:\n\n```js\nvar isStream = require('isstream')\nvar Stream = require('stream')\n\nisStream(new Stream()) // true\n\nisStream({}) // false\n\nisStream(new Stream.Readable()) // true\nisStream(new Stream.Writable()) // true\nisStream(new Stream.Duplex()) // true\nisStream(new Stream.Transform()) // true\nisStream(new Stream.PassThrough()) // true\n```\n\n## But wait! There's more!\n\nYou can also test for `isReadable(obj)`, `isWritable(obj)` and `isDuplex(obj)` to test for implementations of Streams2 (and Streams3) base classes.\n\n```js\nvar isReadable = require('isstream').isReadable\nvar isWritable = require('isstream').isWritable\nvar isDuplex = require('isstream').isDuplex\nvar Stream = require('stream')\n\nisReadable(new Stream()) // false\nisWritable(new Stream()) // false\nisDuplex(new Stream()) // false\n\nisReadable(new Stream.Readable()) // true\nisReadable(new Stream.Writable()) // false\nisReadable(new Stream.Duplex()) // true\nisReadable(new Stream.Transform()) // true\nisReadable(new Stream.PassThrough()) // true\n\nisWritable(new Stream.Readable()) // false\nisWritable(new Stream.Writable()) // true\nisWritable(new Stream.Duplex()) // true\nisWritable(new Stream.Transform()) // true\nisWritable(new Stream.PassThrough()) // true\n\nisDuplex(new Stream.Readable()) // false\nisDuplex(new Stream.Writable()) // false\nisDuplex(new Stream.Duplex()) // true\nisDuplex(new Stream.Transform()) // true\nisDuplex(new Stream.PassThrough()) // true\n```\n\n*Reminder: when implementing your own streams, please [use **readable-stream** rather than core streams](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).*\n\n## License\n\n**isStream** is Copyright (c) 2015 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.\n# create-hmac\n\n[](https://www.npmjs.org/package/create-hmac)\n[](https://travis-ci.org/crypto-browserify/createHmac)\n[](https://david-dm.org/crypto-browserify/createHmac#info=dependencies)\n\n[](https://github.com/feross/standard)\n\nNode style HMACs for use in the browser, with native HMAC functions in node. API is the same as HMACs in node:\n\n```js\nvar createHmac = require('create-hmac')\nvar hmac = createHmac('sha224', Buffer.from('secret key'))\nhmac.update('synchronous write') //optional encoding parameter\nhmac.digest() // synchronously get result with optional encoding parameter\n\nhmac.write('write to it as a stream')\nhmac.end() //remember it's a stream\nhmac.read() //only if you ended it as a stream though\n```\n[`core-js-compat` package](https://github.com/zloirock/core-js/tree/master/packages/core-js-compat) contains data about the necessity of [`core-js`](https://github.com/zloirock/core-js) modules and API for getting a list of required core-js modules by browserslist query.\n\n```js\nconst {\n list, // array of required modules\n targets, // object with targets for each module\n} = require('core-js-compat')({\n targets: '> 2.5%', // browserslist query or object of minimum environment versions to support\n filter: /^(es|web)\\./, // optional filter - string-prefix, regexp or list of modules\n version: '3.4', // used `core-js` version, by default - the latest\n});\n\nconsole.log(targets);\n/* =>\n{\n 'es.symbol.match-all': { ios: '12.2-12.4' },\n 'es.array.unscopables.flat': { ios: '12.2-12.4' },\n 'es.array.unscopables.flat-map': { ios: '12.2-12.4' },\n 'es.math.hypot': { chrome: '77' },\n 'es.promise.all-settled': { firefox: '69', ios: '12.2-12.4' },\n 'es.promise.finally': { ios: '12.2-12.4' },\n 'es.string.match-all': { chrome: '77', firefox: '69', ios: '12.2-12.4' },\n 'es.string.replace': { firefox: '69', ios: '12.2-12.4' },\n 'es.typed-array.float32-array': { ios: '12.2-12.4' },\n 'es.typed-array.float64-array': { ios: '12.2-12.4' },\n 'es.typed-array.int8-array': { ios: '12.2-12.4' },\n 'es.typed-array.int16-array': { ios: '12.2-12.4' },\n 'es.typed-array.int32-array': { ios: '12.2-12.4' },\n 'es.typed-array.uint8-array': { ios: '12.2-12.4' },\n 'es.typed-array.uint8-clamped-array': { ios: '12.2-12.4' },\n 'es.typed-array.uint16-array': { ios: '12.2-12.4' },\n 'es.typed-array.uint32-array': { ios: '12.2-12.4' },\n 'es.typed-array.from': { ios: '12.2-12.4' },\n 'es.typed-array.of': { ios: '12.2-12.4' },\n 'web.dom-collections.iterator': { ios: '12.2-12.4' },\n 'web.immediate': { chrome: '77', firefox: '69', ios: '12.2-12.4' },\n 'web.url': { ios: '12.2-12.4' },\n 'web.url.to-json': { ios: '12.2-12.4' },\n 'web.url-search-params': { ios: '12.2-12.4' }\n}\n*/\n```\n\nAdditional API:\n\n```js\n// equals of of the method from the example above\nrequire('core-js-compat/compat')({ targets, filter, version }); // => { list: Array<ModuleName>, targets: { [ModuleName]: { [EngineName]: EngineVersion } } }\n// or\nrequire('core-js-compat').compat({ targets, filter, version }); // => { list: Array<ModuleName>, targets: { [ModuleName]: { [EngineName]: EngineVersion } } }\n\n// full compat data:\nrequire('core-js-compat/data'); // => { [ModuleName]: { [EngineName]: EngineVersion } }\n// or\nrequire('core-js-compat').data; // => { [ModuleName]: { [EngineName]: EngineVersion } }\n\n// map of modules by `core-js` entry points:\nrequire('core-js-compat/entries'); // => { [EntryPoint]: Array<ModuleName> }\n// or\nrequire('core-js-compat').entries; // => { [EntryPoint]: Array<ModuleName> }\n\n// full list of modules:\nrequire('core-js-compat/modules'); // => Array<ModuleName>\n// or\nrequire('core-js-compat').modules; // => Array<ModuleName>\n\n// the subset of modules which available in the passed `core-js` version:\nrequire('core-js-compat/get-modules-list-for-target-version')('3.3'); // => Array<ModuleName>\n// or\nrequire('core-js-compat').getModulesListForTargetVersion('3.3'); // => Array<ModuleName>\n```\n\nIf you want to add new / update data about modules required for target engines, [follow this instruction](https://github.com/zloirock/core-js/blob/master/CONTRIBUTING.md#updating-core-js-compat-data).\n# babylon-walk\n\nLightweight AST traversal tools for [Babylon] ASTs.\n\nBabylon is the parser used by the [Babel] project, which supplies the wonderful [babel-traverse] module for walking Babylon ASTs. Problem is, babel-traverse is very heavyweight, as it is designed to supply utilities to make all sorts of AST transformations possible. For simple AST walking without transformation, babel-traverse brings a lot of overhead.\n\nThis module loosely implements the API of Acorn parser's [walk module], which is a lightweight AST walker for the ESTree AST format.\n\nIn my tests, babylon-walk's ancestor walker (the most complex walker provided by this module) is about 8 times faster than babel-traverse, if the visitors are cached and the same AST is used for all runs. It is about 16 times faster if a fresh AST is used every run.\n\n[](https://david-dm.org/pugjs/babylon-walk)\n[](https://www.npmjs.com/package/babylon-walk)\n\n[Babylon]: https://github.com/babel/babylon\n[Babel]: https://babeljs.io/\n[babel-traverse]: https://github.com/thejameskyle/babel-handbook/blob/master/translations/en/plugin-handbook.md#toc-babel-traverse\n[walk module]: https://github.com/ternjs/acorn#distwalkjs\n\n## Installation\n\n```sh\n$ npm install babylon-walk\n```\n\n## API\n\n```js\nvar walk = require('babylon-walk');\n```\n\n### walk.simple(node, visitors, state)\n\nDo a simple walk over the AST. `node` should be the AST node to walk, and `visitors` an object containing Babel [visitors]. Each visitor function will be called as `(node, state)`, where `node` is the AST node, and `state` is the same `state` passed to `walk.simple`.\n\nWhen `walk.simple` is called with a fresh set of visitors, it will first \"explode\" the visitors (e.g. expanding `Visitor(node, state) {}` to `Visitor() { enter(node, state) {} }`). This exploding process can take some time, so it is recommended to [cache your visitors] and communicate state leveraging the `state` parameter. (One difference between the linked article and babylon-walk is that the state is only accessible through the `state` variable, never as `this`.)\n\nAll [babel-types] aliases (e.g. `Expression`) and the union syntax (e.g. `'Identifier|AssignmentPattern'(node, state) {}`) work.\n\n### walk.ancestor(node, visitors, state)\n\nDo a simple walk over the AST, but memoizing the ancestors of the node and making them available to the visitors. `node` should be the AST node to walk, and `visitors` an object containing Babel [visitors]. Each visitor function will be called as `(node, state, ancestors)`, where `node` is the AST node, `state` is the same `state` passed to `walk.ancestor`, and `ancestors` is an array of ancestors to the node (with the outermost node being `[0]` and the current node being `[ancestors.length - 1]`). If `state` is not specified in the call to `walk.ancestor`, the `state` parameter will be set to `ancestors`.\n\nWhen `walk.ancestor` is called with a fresh set of visitors, it will first \"explode\" the visitors (e.g. expanding `Visitor(node, state) {}` to `Visitor() { enter(node, state) {} }`). This exploding process can take some time, so it is recommended to [cache your visitors] and communicate state leveraging the `state` parameter. (One difference between the linked article and babylon-walk is that the state is only accessible through the `state` variable, never as `this`.)\n\nAll [babel-types] aliases (e.g. `Expression`) and the union syntax (e.g. `'Identifier|AssignmentPattern'(node, state) {}`) work.\n\n### walk.recursive(node, visitors, state)\n\nDo a recursive walk over the AST, where the visitors are responsible for continuing the walk on the child nodes of their target node. `node` should be the AST node to walk, and `visitors` an object containing Babel [visitors]. Each visitor function will be called as `(node, state, c)`, where `node` is the AST node, `state` is the same `state` passed to `walk.recursive`, and `c` is a function that takes a single node as argument and continues walking _that_ node. If no visitor for a node is provided, the default walker algorithm will still be used.\n\nWhen `walk.recursive` is called with a fresh set of visitors, it will first \"explode\" the visitors (e.g. expanding `Visitor(node, state) {}` to `Visitor() { enter(node, state) {} }`). This exploding process can take some time, so it is recommended to [cache your visitors] and communicate state leveraging the `state` parameter. (One difference between the linked article and babylon-walk is that the state is only accessible through the `state` variable, never as `this`.)\n\nUnlike other babylon-walk walkers, `walk.recursive` does not call the `exit` visitor, only the `enter` (the default) visitor, of a specific node type.\n\nAll [babel-types] aliases (e.g. `Expression`) and the union syntax (e.g. `'Identifier|AssignmentPattern'(node, state) {}`) work.\n\nIn the following example, we are trying to count the number of functions in the outermost scope. This means, that we can simply walk all the statements and increment a counter if it is a function declaration or expression, and then stop walking. Note that we do not specify a visitor for the `Program` node, and the default algorithm for walking `Program` nodes is used (which is what we want). Also of note is how I bring the `visitors` object outside of `countFunctions` so that the object can be cached to improve performance.\n\n```js\nimport * as t from 'babel-types';\nimport {parse} from 'babylon';\n\nconst visitors = {\n Statement(node, state, c) {\n if (t.isVariableDeclaration(node)) {\n for (let declarator of node.declarations) {\n // Continue walking the declarator\n c(declarator);\n }\n } else if (t.isFunctionDeclaration(node)) {\n state.counter++;\n }\n },\n\n VariableDeclarator(node, state) {\n if (t.isFunction(node.init)) {\n state.counter++;\n }\n }\n};\n\nfunction countFunctions(node) {\n const state = {\n counter: 0\n };\n walk.recursive(node, visitors, state);\n return state.counter;\n}\n\nconst ast = parse(`\n // Counts\n var a = () => {};\n\n // Counts\n function b() {\n // Doesn't count\n function c() {\n }\n }\n\n // Counts\n const c = function d() {};\n`);\n\ncountFunctions(ast);\n// = 3\n```\n\n[babel-types]: https://github.com/babel/babel/tree/master/packages/babel-types\n[cache your visitors]: https://github.com/thejameskyle/babel-handbook/blob/master/translations/en/plugin-handbook.md#toc-optimizing-nested-visitors\n[visitors]: https://github.com/thejameskyle/babel-handbook/blob/master/translations/en/plugin-handbook.md#toc-visitors\n\n## Caveat\n\nFor those of you migrating from Acorn to Babylon, there are a few things to be aware of.\n\n1. The visitor caching suggestions do not apply to Acorn's walk module, but do for babylon-walk.\n\n2. babylon-walk does not provide any of the other functions Acorn's walk module provides (e.g. `make`, `findNode*`).\n\n3. babylon-walk does not use a `base` variable. The walker algorithm is the same as what babel-traverse uses.\n - That means certain nodes that are not walked by Acorn, such as the `property` property of a non-computed `MemberExpression`, are walked by babylon-walk.\n\n## License\n\n MIT\n# http-errors\n\n[![NPM Version][npm-version-image]][npm-url]\n[![NPM Downloads][npm-downloads-image]][node-url]\n[![Node.js Version][node-image]][node-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n\nCreate HTTP errors for Express, Koa, Connect, etc. with ease.\n\n## Install\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```bash\n$ npm install http-errors\n```\n\n## Example\n\n```js\nvar createError = require('http-errors')\nvar express = require('express')\nvar app = express()\n\napp.use(function (req, res, next) {\n if (!req.user) return next(createError(401, 'Please login to view this page.'))\n next()\n})\n```\n\n## API\n\nThis is the current API, currently extracted from Koa and subject to change.\n\n### Error Properties\n\n- `expose` - can be used to signal if `message` should be sent to the client,\n defaulting to `false` when `status` >= 500\n- `headers` - can be an object of header names to values to be sent to the\n client, defaulting to `undefined`. When defined, the key names should all\n be lower-cased\n- `message` - the traditional error message, which should be kept short and all\n single line\n- `status` - the status code of the error, mirroring `statusCode` for general\n compatibility\n- `statusCode` - the status code of the error, defaulting to `500`\n\n### createError([status], [message], [properties])\n\nCreate a new error object with the given message `msg`.\nThe error object inherits from `createError.HttpError`.\n\n<!-- eslint-disable no-undef, no-unused-vars -->\n\n```js\nvar err = createError(404, 'This video does not exist!')\n```\n\n- `status: 500` - the status code as a number\n- `message` - the message of the error, defaulting to node's text for that status code.\n- `properties` - custom properties to attach to the object\n\n### createError([status], [error], [properties])\n\nExtend the given `error` object with `createError.HttpError`\nproperties. This will not alter the inheritance of the given\n`error` object, and the modified `error` object is the\nreturn value.\n\n<!-- eslint-disable no-redeclare, no-undef, no-unused-vars -->\n\n```js\nfs.readFile('foo.txt', function (err, buf) {\n if (err) {\n if (err.code === 'ENOENT') {\n var httpError = createError(404, err, { expose: false })\n } else {\n var httpError = createError(500, err)\n }\n }\n})\n```\n\n- `status` - the status code as a number\n- `error` - the error object to extend\n- `properties` - custom properties to attach to the object\n\n### new createError\\[code || name\\](\\[msg]\\))\n\nCreate a new error object with the given message `msg`.\nThe error object inherits from `createError.HttpError`.\n\n<!-- eslint-disable no-undef, no-unused-vars -->\n\n```js\nvar err = new createError.NotFound()\n```\n\n- `code` - the status code as a number\n- `name` - the name of the error as a \"bumpy case\", i.e. `NotFound` or `InternalServerError`.\n\n#### List of all constructors\n\n|Status Code|Constructor Name |\n|-----------|-----------------------------|\n|400 |BadRequest |\n|401 |Unauthorized |\n|402 |PaymentRequired |\n|403 |Forbidden |\n|404 |NotFound |\n|405 |MethodNotAllowed |\n|406 |NotAcceptable |\n|407 |ProxyAuthenticationRequired |\n|408 |RequestTimeout |\n|409 |Conflict |\n|410 |Gone |\n|411 |LengthRequired |\n|412 |PreconditionFailed |\n|413 |PayloadTooLarge |\n|414 |URITooLong |\n|415 |UnsupportedMediaType |\n|416 |RangeNotSatisfiable |\n|417 |ExpectationFailed |\n|418 |ImATeapot |\n|421 |MisdirectedRequest |\n|422 |UnprocessableEntity |\n|423 |Locked |\n|424 |FailedDependency |\n|425 |UnorderedCollection |\n|426 |UpgradeRequired |\n|428 |PreconditionRequired |\n|429 |TooManyRequests |\n|431 |RequestHeaderFieldsTooLarge |\n|451 |UnavailableForLegalReasons |\n|500 |InternalServerError |\n|501 |NotImplemented |\n|502 |BadGateway |\n|503 |ServiceUnavailable |\n|504 |GatewayTimeout |\n|505 |HTTPVersionNotSupported |\n|506 |VariantAlsoNegotiates |\n|507 |InsufficientStorage |\n|508 |LoopDetected |\n|509 |BandwidthLimitExceeded |\n|510 |NotExtended |\n|511 |NetworkAuthenticationRequired|\n\n## License\n\n[MIT](LICENSE)\n\n[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/http-errors/master\n[coveralls-url]: https://coveralls.io/r/jshttp/http-errors?branch=master\n[node-image]: https://badgen.net/npm/node/http-errors\n[node-url]: https://nodejs.org/en/download\n[npm-downloads-image]: https://badgen.net/npm/dm/http-errors\n[npm-url]: https://npmjs.org/package/http-errors\n[npm-version-image]: https://badgen.net/npm/v/http-errors\n[travis-image]: https://badgen.net/travis/jshttp/http-errors/master\n[travis-url]: https://travis-ci.org/jshttp/http-errors\n# <img src=\"https://github.com/facebook/jest/blob/master/website/static/img/jest.png\" height=\"40\" align=\"right\" /> [Plug'n'Play](https://github.com/yarnpkg/rfcs/pull/101) resolver for Jest\n\n[](https://www.npmjs.com/package/jest-pnp-resolver)\n[](https://www.npmjs.com/package/jest-pnp-resolver)\n\n*This plugin is also available for Rollup ([rollup-plugin-pnp-resolve](https://github.com/arcanis/rollup-plugin-pnp-resolve)), TypeScript ([ts-pnp](https://github.com/arcanis/ts-pnp)), and Webpack ([pnp-webpack-plugin](https://github.com/arcanis/pnp-webpack-plugin))*\n\n## Installation\n\n```\nyarn add -D jest-pnp-resolver\n```\n\n## Usage\n\nAs of `jest@^24.4.0` you don't need to manually add this package anymore. The default resolver will already use PnP.\n\nSimply add the resolver to your configuration. For example, a minimal `jest.config.js` would be as such:\n\n```js\nmodule.exports = {\n resolver: require.resolve(`jest-pnp-resolver`)\n};\n```\n\n## License (MIT)\n\n> **Copyright © 2016 Maël Nison**\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# kind-of [](https://www.npmjs.com/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://travis-ci.org/jonschlinkert/kind-of)\n\n> Get the native type of a value.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save kind-of\n```\n\n## Install\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install kind-of --save\n```\n\n## Usage\n\n> es5, browser and es6 ready\n\n```js\nvar kindOf = require('kind-of');\n\nkindOf(undefined);\n//=> 'undefined'\n\nkindOf(null);\n//=> 'null'\n\nkindOf(true);\n//=> 'boolean'\n\nkindOf(false);\n//=> 'boolean'\n\nkindOf(new Boolean(true));\n//=> 'boolean'\n\nkindOf(new Buffer(''));\n//=> 'buffer'\n\nkindOf(42);\n//=> 'number'\n\nkindOf(new Number(42));\n//=> 'number'\n\nkindOf('str');\n//=> 'string'\n\nkindOf(new String('str'));\n//=> 'string'\n\nkindOf(arguments);\n//=> 'arguments'\n\nkindOf({});\n//=> 'object'\n\nkindOf(Object.create(null));\n//=> 'object'\n\nkindOf(new Test());\n//=> 'object'\n\nkindOf(new Date());\n//=> 'date'\n\nkindOf([]);\n//=> 'array'\n\nkindOf([1, 2, 3]);\n//=> 'array'\n\nkindOf(new Array());\n//=> 'array'\n\nkindOf(/foo/);\n//=> 'regexp'\n\nkindOf(new RegExp('foo'));\n//=> 'regexp'\n\nkindOf(function () {});\n//=> 'function'\n\nkindOf(function * () {});\n//=> 'function'\n\nkindOf(new Function());\n//=> 'function'\n\nkindOf(new Map());\n//=> 'map'\n\nkindOf(new WeakMap());\n//=> 'weakmap'\n\nkindOf(new Set());\n//=> 'set'\n\nkindOf(new WeakSet());\n//=> 'weakset'\n\nkindOf(Symbol('str'));\n//=> 'symbol'\n\nkindOf(new Int8Array());\n//=> 'int8array'\n\nkindOf(new Uint8Array());\n//=> 'uint8array'\n\nkindOf(new Uint8ClampedArray());\n//=> 'uint8clampedarray'\n\nkindOf(new Int16Array());\n//=> 'int16array'\n\nkindOf(new Uint16Array());\n//=> 'uint16array'\n\nkindOf(new Int32Array());\n//=> 'int32array'\n\nkindOf(new Uint32Array());\n//=> 'uint32array'\n\nkindOf(new Float32Array());\n//=> 'float32array'\n\nkindOf(new Float64Array());\n//=> 'float64array'\n```\n\n## Benchmarks\n\nBenchmarked against [typeof](http://github.com/CodingFu/typeof) and [type-of](https://github.com/ForbesLindesay/type-of).\nNote that performaces is slower for es6 features `Map`, `WeakMap`, `Set` and `WeakSet`.\n\n```bash\n#1: array\n current x 23,329,397 ops/sec ±0.82% (94 runs sampled)\n lib-type-of x 4,170,273 ops/sec ±0.55% (94 runs sampled)\n lib-typeof x 9,686,935 ops/sec ±0.59% (98 runs sampled)\n\n#2: boolean\n current x 27,197,115 ops/sec ±0.85% (94 runs sampled)\n lib-type-of x 3,145,791 ops/sec ±0.73% (97 runs sampled)\n lib-typeof x 9,199,562 ops/sec ±0.44% (99 runs sampled)\n\n#3: date\n current x 20,190,117 ops/sec ±0.86% (92 runs sampled)\n lib-type-of x 5,166,970 ops/sec ±0.74% (94 runs sampled)\n lib-typeof x 9,610,821 ops/sec ±0.50% (96 runs sampled)\n\n#4: function\n current x 23,855,460 ops/sec ±0.60% (97 runs sampled)\n lib-type-of x 5,667,740 ops/sec ±0.54% (100 runs sampled)\n lib-typeof x 10,010,644 ops/sec ±0.44% (100 runs sampled)\n\n#5: null\n current x 27,061,047 ops/sec ±0.97% (96 runs sampled)\n lib-type-of x 13,965,573 ops/sec ±0.62% (97 runs sampled)\n lib-typeof x 8,460,194 ops/sec ±0.61% (97 runs sampled)\n\n#6: number\n current x 25,075,682 ops/sec ±0.53% (99 runs sampled)\n lib-type-of x 2,266,405 ops/sec ±0.41% (98 runs sampled)\n lib-typeof x 9,821,481 ops/sec ±0.45% (99 runs sampled)\n\n#7: object\n current x 3,348,980 ops/sec ±0.49% (99 runs sampled)\n lib-type-of x 3,245,138 ops/sec ±0.60% (94 runs sampled)\n lib-typeof x 9,262,952 ops/sec ±0.59% (99 runs sampled)\n\n#8: regex\n current x 21,284,827 ops/sec ±0.72% (96 runs sampled)\n lib-type-of x 4,689,241 ops/sec ±0.43% (100 runs sampled)\n lib-typeof x 8,957,593 ops/sec ±0.62% (98 runs sampled)\n\n#9: string\n current x 25,379,234 ops/sec ±0.58% (96 runs sampled)\n lib-type-of x 3,635,148 ops/sec ±0.76% (93 runs sampled)\n lib-typeof x 9,494,134 ops/sec ±0.49% (98 runs sampled)\n\n#10: undef\n current x 27,459,221 ops/sec ±1.01% (93 runs sampled)\n lib-type-of x 14,360,433 ops/sec ±0.52% (99 runs sampled)\n lib-typeof x 23,202,868 ops/sec ±0.59% (94 runs sampled)\n\n```\n\n## Optimizations\n\nIn 7 out of 8 cases, this library is 2x-10x faster than other top libraries included in the benchmarks. There are a few things that lead to this performance advantage, none of them hard and fast rules, but all of them simple and repeatable in almost any code library:\n\n1. Optimize around the fastest and most common use cases first. Of course, this will change from project-to-project, but I took some time to understand how and why `typeof` checks were being used in my own libraries and other libraries I use a lot.\n2. Optimize around bottlenecks - In other words, the order in which conditionals are implemented is significant, because each check is only as fast as the failing checks that came before it. Here, the biggest bottleneck by far is checking for plain objects (an object that was created by the `Object` constructor). I opted to make this check happen by process of elimination rather than brute force up front (e.g. by using something like `val.constructor.name`), so that every other type check would not be penalized it.\n3. Don't do uneccessary processing - why do `.slice(8, -1).toLowerCase();` just to get the word `regex`? It's much faster to do `if (type === '[object RegExp]') return 'regex'`\n\n## About\n\n### Related projects\n\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [is-number](https://www.npmjs.com/package/is-number): Returns true if the value is a number. comprehensive tests. | [homepage](https://github.com/jonschlinkert/is-number \"Returns true if the value is a number. comprehensive tests.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 59 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [miguelmota](https://github.com/miguelmota) |\n| 1 | [dtothefp](https://github.com/dtothefp) |\n| 1 | [ksheedlo](https://github.com/ksheedlo) |\n| 1 | [pdehaan](https://github.com/pdehaan) |\n| 1 | [laggingreflex](https://github.com/laggingreflex) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 16, 2017._\n# cross-spawn\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url]\n\n[npm-url]:https://npmjs.org/package/cross-spawn\n[downloads-image]:https://img.shields.io/npm/dm/cross-spawn.svg\n[npm-image]:https://img.shields.io/npm/v/cross-spawn.svg\n[travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn\n[travis-image]:https://img.shields.io/travis/moxystudio/node-cross-spawn/master.svg\n[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn\n[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg\n[codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn\n[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg\n[david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn\n[david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg\n[david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev\n[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.svg\n\nA cross platform solution to node's spawn and spawnSync.\n\n## Installation\n\nNode.js version 8 and up:\n`$ npm install cross-spawn`\n\nNode.js version 7 and under:\n`$ npm install cross-spawn@6`\n\n## Why\n\nNode has issues when using spawn on Windows:\n\n- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318)\n- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix))\n- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367)\n- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`)\n- Has an [issue](https://github.com/moxystudio/node-cross-spawn/issues/82) with command shims (files in `node_modules/.bin/`), where arguments with quotes and parenthesis would result in [invalid syntax error](https://github.com/moxystudio/node-cross-spawn/blob/e77b8f22a416db46b6196767bcd35601d7e11d54/test/index.test.js#L149)\n- No `options.shell` support on node `<v4.8`\n\nAll these issues are handled correctly by `cross-spawn`.\nThere are some known modules, such as [win-spawn](https://github.com/ForbesLindesay/win-spawn), that try to solve this but they are either broken or provide faulty escaping of shell arguments.\n\n## Usage\n\nExactly the same way as node's [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) or [`spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options), so it's a drop in replacement.\n\n```js\nconst spawn = require('cross-spawn');\n\n// Spawn NPM asynchronously\nconst child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });\n\n// Spawn NPM synchronously\nconst result = spawn.sync('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });\n```\n\n## Caveats\n\n### Using `options.shell` as an alternative to `cross-spawn`\n\nStarting from node `v4.8`, `spawn` has a `shell` option that allows you run commands from within a shell. This new option solves\nthe [PATHEXT](https://github.com/joyent/node/issues/2318) issue but:\n\n- It's not supported in node `<v4.8`\n- You must manually escape the command and arguments which is very error prone, specially when passing user input\n- There are a lot of other unresolved issues from the [Why](#why) section that you must take into account\n\nIf you are using the `shell` option to spawn a command in a cross platform way, consider using `cross-spawn` instead. You have been warned.\n\n### `options.shell` support\n\nWhile `cross-spawn` adds support for `options.shell` in node `<v4.8`, all of its enhancements are disabled.\n\nThis mimics the Node.js behavior. More specifically, the command and its arguments will not be automatically escaped nor shebang support will be offered. This is by design because if you are using `options.shell` you are probably targeting a specific platform anyway and you don't want things to get into your way.\n\n### Shebangs support\n\nWhile `cross-spawn` handles shebangs on Windows, its support is limited. More specifically, it just supports `#!/usr/bin/env <program>` where `<program>` must not contain any arguments. \nIf you would like to have the shebang support improved, feel free to contribute via a pull-request.\n\nRemember to always test your code on Windows!\n\n## Tests\n\n`$ npm test` \n`$ npm test -- --watch` during development\n\n## License\n\nReleased under the [MIT License](https://www.opensource.org/licenses/mit-license.php).\n# encodeurl\n\n[![NPM Version][npm-image]][npm-url]\n[![NPM Downloads][downloads-image]][downloads-url]\n[![Node.js Version][node-version-image]][node-version-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n\nEncode a URL to a percent-encoded form, excluding already-encoded sequences\n\n## Installation\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```sh\n$ npm install encodeurl\n```\n\n## API\n\n```js\nvar encodeUrl = require('encodeurl')\n```\n\n### encodeUrl(url)\n\nEncode a URL to a percent-encoded form, excluding already-encoded sequences.\n\nThis function will take an already-encoded URL and encode all the non-URL\ncode points (as UTF-8 byte sequences). This function will not encode the\n\"%\" character unless it is not part of a valid sequence (`%20` will be\nleft as-is, but `%foo` will be encoded as `%25foo`).\n\nThis encode is meant to be \"safe\" and does not throw errors. It will try as\nhard as it can to properly encode the given URL, including replacing any raw,\nunpaired surrogate pairs with the Unicode replacement character prior to\nencoding.\n\nThis function is _similar_ to the intrinsic function `encodeURI`, except it\nwill not encode the `%` character if that is part of a valid sequence, will\nnot encode `[` and `]` (for IPv6 hostnames) and will replace raw, unpaired\nsurrogate pairs with the Unicode replacement character (instead of throwing).\n\n## Examples\n\n### Encode a URL containing user-controled data\n\n```js\nvar encodeUrl = require('encodeurl')\nvar escapeHtml = require('escape-html')\n\nhttp.createServer(function onRequest (req, res) {\n // get encoded form of inbound url\n var url = encodeUrl(req.url)\n\n // create html message\n var body = '<p>Location ' + escapeHtml(url) + ' not found</p>'\n\n // send a 404\n res.statusCode = 404\n res.setHeader('Content-Type', 'text/html; charset=UTF-8')\n res.setHeader('Content-Length', String(Buffer.byteLength(body, 'utf-8')))\n res.end(body, 'utf-8')\n})\n```\n\n### Encode a URL for use in a header field\n\n```js\nvar encodeUrl = require('encodeurl')\nvar escapeHtml = require('escape-html')\nvar url = require('url')\n\nhttp.createServer(function onRequest (req, res) {\n // parse inbound url\n var href = url.parse(req)\n\n // set new host for redirect\n href.host = 'localhost'\n href.protocol = 'https:'\n href.slashes = true\n\n // create location header\n var location = encodeUrl(url.format(href))\n\n // create html message\n var body = '<p>Redirecting to new site: ' + escapeHtml(location) + '</p>'\n\n // send a 301\n res.statusCode = 301\n res.setHeader('Content-Type', 'text/html; charset=UTF-8')\n res.setHeader('Content-Length', String(Buffer.byteLength(body, 'utf-8')))\n res.setHeader('Location', location)\n res.end(body, 'utf-8')\n})\n```\n\n## Testing\n\n```sh\n$ npm test\n$ npm run lint\n```\n\n## References\n\n- [RFC 3986: Uniform Resource Identifier (URI): Generic Syntax][rfc-3986]\n- [WHATWG URL Living Standard][whatwg-url]\n\n[rfc-3986]: https://tools.ietf.org/html/rfc3986\n[whatwg-url]: https://url.spec.whatwg.org/\n\n## License\n\n[MIT](LICENSE)\n\n[npm-image]: https://img.shields.io/npm/v/encodeurl.svg\n[npm-url]: https://npmjs.org/package/encodeurl\n[node-version-image]: https://img.shields.io/node/v/encodeurl.svg\n[node-version-url]: https://nodejs.org/en/download\n[travis-image]: https://img.shields.io/travis/pillarjs/encodeurl.svg\n[travis-url]: https://travis-ci.org/pillarjs/encodeurl\n[coveralls-image]: https://img.shields.io/coveralls/pillarjs/encodeurl.svg\n[coveralls-url]: https://coveralls.io/r/pillarjs/encodeurl?branch=master\n[downloads-image]: https://img.shields.io/npm/dm/encodeurl.svg\n[downloads-url]: https://npmjs.org/package/encodeurl\n<p align=\"center\">\n <img src=\"https://user-images.githubusercontent.com/13700/35731649-652807e8-080e-11e8-88fd-1b2f6d553b2d.png\" alt=\"Nodemon Logo\">\n</p>\n\n# nodemon\n\nnodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.\n\nnodemon does **not** require *any* additional changes to your code or method of development. nodemon is a replacement wrapper for `node`. To use `nodemon`, replace the word `node` on the command line when executing your script.\n\n[](https://npmjs.org/package/nodemon)\n[](https://travis-ci.org/remy/nodemon) [](#backers) [](#sponsors)\n\n# Installation\n\nEither through cloning with git or by using [npm](http://npmjs.org) (the recommended way):\n\n```bash\nnpm install -g nodemon\n```\n\nAnd nodemon will be installed globally to your system path.\n\nYou can also install nodemon as a development dependency:\n\n```bash\nnpm install --save-dev nodemon\n```\n\nWith a local installation, nodemon will not be available in your system path. Instead, the local installation of nodemon can be run by calling it from within an npm script (such as `npm start`) or using `npx nodemon`.\n\n# Usage\n\nnodemon wraps your application, so you can pass all the arguments you would normally pass to your app:\n\n```bash\nnodemon [your node app]\n```\n\nFor CLI options, use the `-h` (or `--help`) argument:\n\n```bash\nnodemon -h\n```\n\nUsing nodemon is simple, if my application accepted a host and port as the arguments, I would start it as so:\n\n```bash\nnodemon ./server.js localhost 8080\n```\n\nAny output from this script is prefixed with `[nodemon]`, otherwise all output from your application, errors included, will be echoed out as expected.\n\nIf no script is given, nodemon will test for a `package.json` file and if found, will run the file associated with the *main* property ([ref](https://github.com/remy/nodemon/issues/14)).\n\nYou can also pass the `inspect` flag to node through the command line as you would normally:\n\n```bash\nnodemon --inspect ./server.js 80\n```\n\nIf you have a `package.json` file for your app, you can omit the main script entirely and nodemon will read the `package.json` for the `main` property and use that value as the app.\n\nnodemon will also search for the `scripts.start` property in `package.json` (as of nodemon 1.1.x).\n\nAlso check out the [FAQ](https://github.com/remy/nodemon/blob/master/faq.md) or [issues](https://github.com/remy/nodemon/issues) for nodemon.\n\n## Automatic re-running\n\nnodemon was originally written to restart hanging processes such as web servers, but now supports apps that cleanly exit. If your script exits cleanly, nodemon will continue to monitor the directory (or directories) and restart the script if there are any changes.\n\n## Manual restarting\n\nWhilst nodemon is running, if you need to manually restart your application, instead of stopping and restart nodemon, you can type `rs` with a carriage return, and nodemon will restart your process.\n\n## Config files\n\nnodemon supports local and global configuration files. These are usually named `nodemon.json` and can be located in the current working directory or in your home directory. An alternative local configuration file can be specified with the `--config <file>` option.\n\nThe specificity is as follows, so that a command line argument will always override the config file settings:\n\n- command line arguments\n- local config\n- global config\n\nA config file can take any of the command line arguments as JSON key values, for example:\n\n```json\n{\n \"verbose\": true,\n \"ignore\": [\"*.test.js\", \"fixtures/*\"],\n \"execMap\": {\n \"rb\": \"ruby\",\n \"pde\": \"processing --sketch={{pwd}} --run\"\n }\n}\n```\n\nThe above `nodemon.json` file might be my global config so that I have support for ruby files and processing files, and I can run `nodemon demo.pde` and nodemon will automatically know how to run the script even though out of the box support for processing scripts.\n\nA further example of options can be seen in [sample-nodemon.md](https://github.com/remy/nodemon/blob/master/doc/sample-nodemon.md)\n\n### package.json\n\nIf you want to keep all your package configurations in one place, nodemon supports using `package.json` for configuration.\nSpecify the config in the same format as you would for a config file but under `nodemonConfig` in the `package.json` file, for example, take the following `package.json`:\n\n```json\n{\n \"name\": \"nodemon\",\n \"homepage\": \"http://nodemon.io\",\n \"...\": \"... other standard package.json values\",\n \"nodemonConfig\": {\n \"ignore\": [\"test/*\", \"docs/*\"],\n \"delay\": \"2500\"\n }\n}\n```\n\nNote that if you specify a `--config` file or provide a local `nodemon.json` any `package.json` config is ignored.\n\n*This section needs better documentation, but for now you can also see `nodemon --help config` ([also here](https://github.com/remy/nodemon/blob/master/doc/cli/config.txt))*.\n\n## Using nodemon as a module\n\nPlease see [doc/requireable.md](doc/requireable.md)\n\n## Using nodemon as child process\n\nPlease see [doc/events.md](doc/events.md#Using_nodemon_as_child_process)\n\n## Running non-node scripts\n\nnodemon can also be used to execute and monitor other programs. nodemon will read the file extension of the script being run and monitor that extension instead of `.js` if there's no `nodemon.json`:\n\n```bash\nnodemon --exec \"python -v\" ./app.py\n```\n\nNow nodemon will run `app.py` with python in verbose mode (note that if you're not passing args to the exec program, you don't need the quotes), and look for new or modified files with the `.py` extension.\n\n### Default executables\n\nUsing the `nodemon.json` config file, you can define your own default executables using the `execMap` property. This is particularly useful if you're working with a language that isn't supported by default by nodemon.\n\nTo add support for nodemon to know about the `.pl` extension (for Perl), the `nodemon.json` file would add:\n\n```json\n{\n \"execMap\": {\n \"pl\": \"perl\"\n }\n}\n```\n\nNow running the following, nodemon will know to use `perl` as the executable:\n\n```bash\nnodemon script.pl\n```\n\nIt's generally recommended to use the global `nodemon.json` to add your own `execMap` options. However, if there's a common default that's missing, this can be merged in to the project so that nodemon supports it by default, by changing [default.js](https://github.com/remy/nodemon/blob/master/lib/config/defaults.js) and sending a pull request.\n\n## Monitoring multiple directories\n\nBy default nodemon monitors the current working directory. If you want to take control of that option, use the `--watch` option to add specific paths:\n\n```bash\nnodemon --watch app --watch libs app/server.js\n```\n\nNow nodemon will only restart if there are changes in the `./app` or `./libs` directory. By default nodemon will traverse sub-directories, so there's no need in explicitly including sub-directories.\n\nDon't use unix globbing to pass multiple directories, e.g `--watch ./lib/*`, it won't work. You need a `--watch` flag per directory watched.\n\n## Specifying extension watch list\n\nBy default, nodemon looks for files with the `.js`, `.mjs`, `.coffee`, `.litcoffee`, and `.json` extensions. If you use the `--exec` option and monitor `app.py` nodemon will monitor files with the extension of `.py`. However, you can specify your own list with the `-e` (or `--ext`) switch like so:\n\n```bash\nnodemon -e js,pug\n```\n\nNow nodemon will restart on any changes to files in the directory (or subdirectories) with the extensions `.js`, `.pug`.\n\n## Ignoring files\n\nBy default, nodemon will only restart when a `.js` JavaScript file changes. In some cases you will want to ignore some specific files, directories or file patterns, to prevent nodemon from prematurely restarting your application.\n\nThis can be done via the command line:\n\n```bash\nnodemon --ignore lib/ --ignore tests/\n```\n\nOr specific files can be ignored:\n\n```bash\nnodemon --ignore lib/app.js\n```\n\nPatterns can also be ignored (but be sure to quote the arguments):\n\n```bash\nnodemon --ignore 'lib/*.js'\n```\n\nNote that by default, nodemon will ignore the `.git`, `node_modules`, `bower_components`, `.nyc_output`, `coverage` and `.sass-cache` directories and *add* your ignored patterns to the list. If you want to indeed watch a directory like `node_modules`, you need to [override the underlying default ignore rules](https://github.com/remy/nodemon/blob/master/faq.md#overriding-the-underlying-default-ignore-rules).\n\n## Application isn't restarting\n\nIn some networked environments (such as a container running nodemon reading across a mounted drive), you will need to use the `legacyWatch: true` which enables Chokidar's polling.\n\nVia the CLI, use either `--legacy-watch` or `-L` for short:\n\n```bash\nnodemon -L\n```\n\nThough this should be a last resort as it will poll every file it can find.\n\n## Delaying restarting\n\nIn some situations, you may want to wait until a number of files have changed. The timeout before checking for new file changes is 1 second. If you're uploading a number of files and it's taking some number of seconds, this could cause your app to restart multiple times unnecessarily.\n\nTo add an extra throttle, or delay restarting, use the `--delay` command:\n\n```bash\nnodemon --delay 10 server.js\n```\n\nFor more precision, milliseconds can be specified. Either as a float:\n\n```bash\nnodemon --delay 2.5 server.js\n```\n\nOr using the time specifier (ms):\n\n```bash\nnodemon --delay 2500ms server.js\n```\n\nThe delay figure is number of seconds (or milliseconds, if specified) to delay before restarting. So nodemon will only restart your app the given number of seconds after the *last* file change.\n\nIf you are setting this value in `nodemon.json`, the value will always be interpreted in milliseconds. E.g., the following are equivalent:\n\n```bash\nnodemon --delay 2.5\n\n{\n \"delay\": \"2500\"\n}\n```\n\n## Gracefully reloading down your script\n\nIt is possible to have nodemon send any signal that you specify to your application.\n\n```bash\nnodemon --signal SIGHUP server.js\n```\n\nYour application can handle the signal as follows.\n\n```js\nprocess.once(\"SIGHUP\", function () {\n reloadSomeConfiguration();\n})\n```\n\nPlease note that nodemon will send this signal to every process in the process tree.\n\nIf you are using `cluster`, then each workers (as well as the master) will receive the signal. If you wish to terminate all workers on receiving a `SIGHUP`, a common pattern is to catch the `SIGHUP` in the master, and forward `SIGTERM` to all workers, while ensuring that all workers ignore `SIGHUP`.\n\n```js\nif (cluster.isMaster) {\n process.on(\"SIGHUP\", function () {\n for (const worker of Object.values(cluster.workers)) {\n worker.process.kill(\"SIGTERM\");\n }\n });\n} else {\n process.on(\"SIGHUP\", function() {})\n}\n```\n\n## Controlling shutdown of your script\n\nnodemon sends a kill signal to your application when it sees a file update. If you need to clean up on shutdown inside your script you can capture the kill signal and handle it yourself.\n\nThe following example will listen once for the `SIGUSR2` signal (used by nodemon to restart), run the clean up process and then kill itself for nodemon to continue control:\n\n```js\nprocess.once('SIGUSR2', function () {\n gracefulShutdown(function () {\n process.kill(process.pid, 'SIGUSR2');\n });\n});\n```\n\nNote that the `process.kill` is *only* called once your shutdown jobs are complete. Hat tip to [Benjie Gillam](http://www.benjiegillam.com/2011/08/node-js-clean-restart-and-faster-development-with-nodemon/) for writing this technique up.\n\n## Triggering events when nodemon state changes\n\nIf you want growl like notifications when nodemon restarts or to trigger an action when an event happens, then you can either `require` nodemon or add event actions to your `nodemon.json` file.\n\nFor example, to trigger a notification on a Mac when nodemon restarts, `nodemon.json` looks like this:\n\n```json\n{\n \"events\": {\n \"restart\": \"osascript -e 'display notification \\\"app restarted\\\" with title \\\"nodemon\\\"'\"\n }\n}\n```\n\nA full list of available events is listed on the [event states wiki](https://github.com/remy/nodemon/wiki/Events#states). Note that you can bind to both states and messages.\n\n## Pipe output to somewhere else\n\n```js\nnodemon({\n script: ...,\n stdout: false // important: this tells nodemon not to output to console\n}).on('readable', function() { // the `readable` event indicates that data is ready to pick up\n this.stdout.pipe(fs.createWriteStream('output.txt'));\n this.stderr.pipe(fs.createWriteStream('err.txt'));\n});\n```\n\n## Using nodemon in your gulp workflow\n\nCheck out the [gulp-nodemon](https://github.com/JacksonGariety/gulp-nodemon) plugin to integrate nodemon with the rest of your project's gulp workflow.\n\n## Using nodemon in your Grunt workflow\n\nCheck out the [grunt-nodemon](https://github.com/ChrisWren/grunt-nodemon) plugin to integrate nodemon with the rest of your project's grunt workflow.\n\n## Pronunciation\n\n> nodemon, is it pronounced: node-mon, no-demon or node-e-mon (like pokémon)?\n\nWell...I've been asked this many times before. I like that I've been asked this before. There's been bets as to which one it actually is.\n\nThe answer is simple, but possibly frustrating. I'm not saying (how I pronounce it). It's up to you to call it as you like. All answers are correct :)\n\n## Design principles\n\n- Fewer flags is better\n- Works across all platforms\n- Fewer features\n- Let individuals build on top of nodemon\n- Offer all CLI functionality as an API\n- Contributions must have and pass tests\n\nNodemon is not perfect, and CLI arguments has sprawled beyond where I'm completely happy, but perhaps it can be reduced a little one day.\n\n## FAQ\n\nSee the [FAQ](https://github.com/remy/nodemon/blob/master/faq.md) and please add your own questions if you think they would help others.\n\n## Backers\n\nThank you to all [our backers](https://opencollective.com/nodemon#backer)! 🙏\n\n[](https://opencollective.com/nodemon#backers)\n\n## Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [Sponsor this project today ❤️](https://opencollective.com/nodemon#sponsor)\n\n[<img src=\"https://user-images.githubusercontent.com/13700/35731651-677aa3fc-080e-11e8-8580-75fa92db56ec.png\" width=\"200\">](https://sparkpo.st/nodemon)\n\n[<img src=\"https://user-images.githubusercontent.com/13700/35731622-421d4466-080e-11e8-8ddc-11c70e1cd79e.png\" width=\"200\">](https://mixmax.com)\n\n# License\n\nMIT [http://rem.mit-license.org](http://rem.mit-license.org)\n# json-parse-even-better-errors\n\n[`json-parse-even-better-errors`](https://github.com/npm/json-parse-even-better-errors)\nis a Node.js library for getting nicer errors out of `JSON.parse()`,\nincluding context and position of the parse errors.\n\nIt also preserves the newline and indentation styles of the JSON data, by\nputting them in the object or array in the `Symbol.for('indent')` and\n`Symbol.for('newline')` properties.\n\n## Install\n\n`$ npm install --save json-parse-even-better-errors`\n\n## Table of Contents\n\n* [Example](#example)\n* [Features](#features)\n* [Contributing](#contributing)\n* [API](#api)\n * [`parse`](#parse)\n\n### Example\n\n```javascript\nconst parseJson = require('json-parse-even-better-errors')\n\nparseJson('\"foo\"') // returns the string 'foo'\nparseJson('garbage') // more useful error message\nparseJson.noExceptions('garbage') // returns undefined\n```\n\n### Features\n\n* Like JSON.parse, but the errors are better.\n* Strips a leading byte-order-mark that you sometimes get reading files.\n* Has a `noExceptions` method that returns undefined rather than throwing.\n* Attaches the newline character(s) used to the `Symbol.for('newline')`\n property on objects and arrays.\n* Attaches the indentation character(s) used to the `Symbol.for('indent')`\n property on objects and arrays.\n\n## Indentation\n\nTo preserve indentation when the file is saved back to disk, use\n`data[Symbol.for('indent')]` as the third argument to `JSON.stringify`, and\nif you want to preserve windows `\\r\\n` newlines, replace the `\\n` chars in\nthe string with `data[Symbol.for('newline')]`.\n\nFor example:\n\n```js\nconst txt = await readFile('./package.json', 'utf8')\nconst data = parseJsonEvenBetterErrors(txt)\nconst indent = Symbol.for('indent')\nconst newline = Symbol.for('newline')\n// .. do some stuff to the data ..\nconst string = JSON.stringify(data, null, data[indent]) + '\\n'\nconst eolFixed = data[newline] === '\\n' ? string\n : string.replace(/\\n/g, data[newline])\nawait writeFile('./package.json', eolFixed)\n```\n\nIndentation is determined by looking at the whitespace between the initial\n`{` and `[` and the character that follows it. If you have lots of weird\ninconsistent indentation, then it won't track that or give you any way to\npreserve it. Whether this is a bug or a feature is debatable ;)\n\n### API\n\n#### <a name=\"parse\"></a> `parse(txt, reviver = null, context = 20)`\n\nWorks just like `JSON.parse`, but will include a bit more information when\nan error happens, and attaches a `Symbol.for('indent')` and\n`Symbol.for('newline')` on objects and arrays. This throws a\n`JSONParseError`.\n\n#### <a name=\"parse\"></a> `parse.noExceptions(txt, reviver = null)`\n\nWorks just like `JSON.parse`, but will return `undefined` rather than\nthrowing an error.\n\n#### <a name=\"jsonparseerror\"></a> `class JSONParseError(er, text, context = 20, caller = null)`\n\nExtends the JavaScript `SyntaxError` class to parse the message and provide\nbetter metadata.\n\nPass in the error thrown by the built-in `JSON.parse`, and the text being\nparsed, and it'll parse out the bits needed to be helpful.\n\n`context` defaults to 20.\n\nSet a `caller` function to trim internal implementation details out of the\nstack trace. When calling `parseJson`, this is set to the `parseJson`\nfunction. If not set, then the constructor defaults to itself, so the\nstack trace will point to the spot where you call `new JSONParseError`.\n# convert-source-map [](http://travis-ci.org/thlorenz/convert-source-map)\n\n<a href=\"https://www.patreon.com/bePatron?u=8663953\"><img alt=\"become a patron\" src=\"https://c5.patreon.com/external/logo/become_a_patron_button.png\" height=\"35px\"></a>\n\nConverts a source-map from/to different formats and allows adding/changing properties.\n\n```js\nvar convert = require('convert-source-map');\n\nvar json = convert\n .fromComment('//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVpbGQvZm9vLm1pbi5qcyIsInNvdXJjZXMiOlsic3JjL2Zvby5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSIsInNvdXJjZVJvb3QiOiIvIn0=')\n .toJSON();\n\nvar modified = convert\n .fromComment('//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVpbGQvZm9vLm1pbi5qcyIsInNvdXJjZXMiOlsic3JjL2Zvby5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSIsInNvdXJjZVJvb3QiOiIvIn0=')\n .setProperty('sources', [ 'SRC/FOO.JS' ])\n .toJSON();\n\nconsole.log(json);\nconsole.log(modified);\n```\n\n```json\n{\"version\":3,\"file\":\"build/foo.min.js\",\"sources\":[\"src/foo.js\"],\"names\":[],\"mappings\":\"AAAA\",\"sourceRoot\":\"/\"}\n{\"version\":3,\"file\":\"build/foo.min.js\",\"sources\":[\"SRC/FOO.JS\"],\"names\":[],\"mappings\":\"AAAA\",\"sourceRoot\":\"/\"}\n```\n\n## API\n\n### fromObject(obj)\n\nReturns source map converter from given object.\n\n### fromJSON(json)\n\nReturns source map converter from given json string.\n\n### fromBase64(base64)\n\nReturns source map converter from given base64 encoded json string.\n\n### fromComment(comment)\n\nReturns source map converter from given base64 encoded json string prefixed with `//# sourceMappingURL=...`.\n\n### fromMapFileComment(comment, mapFileDir)\n\nReturns source map converter from given `filename` by parsing `//# sourceMappingURL=filename`.\n\n`filename` must point to a file that is found inside the `mapFileDir`. Most tools store this file right next to the\ngenerated file, i.e. the one containing the source map.\n\n### fromSource(source)\n\nFinds last sourcemap comment in file and returns source map converter or returns null if no source map comment was found.\n\n### fromMapFileSource(source, mapFileDir)\n\nFinds last sourcemap comment in file and returns source map converter or returns null if no source map comment was\nfound.\n\nThe sourcemap will be read from the map file found by parsing `# sourceMappingURL=file` comment. For more info see\nfromMapFileComment.\n\n### toObject()\n\nReturns a copy of the underlying source map.\n\n### toJSON([space])\n\nConverts source map to json string. If `space` is given (optional), this will be passed to\n[JSON.stringify](https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/JSON/stringify) when the\nJSON string is generated.\n\n### toBase64()\n\nConverts source map to base64 encoded json string.\n\n### toComment([options])\n\nConverts source map to an inline comment that can be appended to the source-file.\n\nBy default, the comment is formatted like: `//# sourceMappingURL=...`, which you would\nnormally see in a JS source file.\n\nWhen `options.multiline == true`, the comment is formatted like: `/*# sourceMappingURL=... */`, which you would find in a CSS source file.\n\n### addProperty(key, value)\n\nAdds given property to the source map. Throws an error if property already exists.\n\n### setProperty(key, value)\n\nSets given property to the source map. If property doesn't exist it is added, otherwise its value is updated.\n\n### getProperty(key)\n\nGets given property of the source map.\n\n### removeComments(src)\n\nReturns `src` with all source map comments removed\n\n### removeMapFileComments(src)\n\nReturns `src` with all source map comments pointing to map files removed.\n\n### commentRegex\n\nProvides __a fresh__ RegExp each time it is accessed. Can be used to find source map comments.\n\n### mapFileCommentRegex\n\nProvides __a fresh__ RegExp each time it is accessed. Can be used to find source map comments pointing to map files.\n\n### generateMapFileComment(file, [options])\n\nReturns a comment that links to an external source map via `file`.\n\nBy default, the comment is formatted like: `//# sourceMappingURL=...`, which you would normally see in a JS source file.\n\nWhen `options.multiline == true`, the comment is formatted like: `/*# sourceMappingURL=... */`, which you would find in a CSS source file.\n\n[](https://bitdeli.com/free \"Bitdeli Badge\")\n# regjsgen [![Build status][travis-ci-img]][travis-ci] [![Code coverage status][codecov-img]][codecov]\n\nGenerate regular expressions from [regjsparser][regjsparser]’s AST.\n\n## Installation\n\n```sh\nnpm i regjsgen\n```\n\n## API\n\n### `regjsgen.generate(ast)`\n\nThis function accepts an abstract syntax tree representing a regular expression (see [regjsparser][regjsparser]), and returns the generated regular expression string.\n\n```js\nconst regjsparser = require('regjsparser');\nconst regjsgen = require('regjsgen');\n\n// Generate an AST with `regjsparser`.\nlet ast = regjsparser.parse(regex);\n\n// Modify AST\n// …\n\n// Generate `RegExp` string with `regjsgen`.\nlet regex = regjsgen.generate(ast);\n```\n\n## Support\n\nTested in Node.js 0.10, 0.12, 4, 6, 8, 10, 12 and 14.<br>\nCompatible with regjsparser v0.6.4’s AST.\n\n[travis-ci]: https://travis-ci.org/bnjmnt4n/regjsgen\n[travis-ci-img]: https://travis-ci.org/bnjmnt4n/regjsgen.svg?branch=master\n[codecov]: https://codecov.io/gh/bnjmnt4n/regjsgen\n[codecov-img]: https://codecov.io/gh/bnjmnt4n/regjsgen/branch/master/graph/badge.svg\n[regjsparser]: https://github.com/jviereck/regjsparser\n# ci-info\n\nGet details about the current Continuous Integration environment.\n\nPlease [open an\nissue](https://github.com/watson/ci-info/issues/new?template=ci-server-not-detected.md)\nif your CI server isn't properly detected :)\n\n[](https://www.npmjs.com/package/ci-info)\n[](https://travis-ci.org/watson/ci-info)\n[](https://github.com/feross/standard)\n\n## Installation\n\n```bash\nnpm install ci-info --save\n```\n\n## Usage\n\n```js\nvar ci = require('ci-info')\n\nif (ci.isCI) {\n console.log('The name of the CI server is:', ci.name)\n} else {\n console.log('This program is not running on a CI server')\n}\n```\n\n## Supported CI tools\n\nOfficially supported CI servers:\n\n| Name | Constant | isPR |\n|------|----------|------|\n| [AWS CodeBuild](https://aws.amazon.com/codebuild/) | `ci.CODEBUILD` | 🚫 |\n| [AppVeyor](http://www.appveyor.com) | `ci.APPVEYOR` | ✅ |\n| [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) | `ci.AZURE_PIPELINES` | ✅ |\n| [Bamboo](https://www.atlassian.com/software/bamboo) by Atlassian | `ci.BAMBOO` | 🚫 |\n| [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines) | `ci.BITBUCKET` | ✅ |\n| [Bitrise](https://www.bitrise.io/) | `ci.BITRISE` | ✅ |\n| [Buddy](https://buddy.works/) | `ci.BUDDY` | ✅ |\n| [Buildkite](https://buildkite.com) | `ci.BUILDKITE` | ✅ |\n| [CircleCI](http://circleci.com) | `ci.CIRCLE` | ✅ |\n| [Cirrus CI](https://cirrus-ci.org) | `ci.CIRRUS` | ✅ |\n| [Codeship](https://codeship.com) | `ci.CODESHIP` | 🚫 |\n| [Drone](https://drone.io) | `ci.DRONE` | ✅ |\n| [dsari](https://github.com/rfinnie/dsari) | `ci.DSARI` | 🚫 |\n| [GitLab CI](https://about.gitlab.com/gitlab-ci/) | `ci.GITLAB` | 🚫 |\n| [GoCD](https://www.go.cd/) | `ci.GOCD` | 🚫 |\n| [Hudson](http://hudson-ci.org) | `ci.HUDSON` | 🚫 |\n| [Jenkins CI](https://jenkins-ci.org) | `ci.JENKINS` | ✅ |\n| [Magnum CI](https://magnum-ci.com) | `ci.MAGNUM` | 🚫 |\n| [Netlify CI](https://www.netlify.com/) | `ci.NETLIFY` | ✅ |\n| [Sail CI](https://sail.ci/) | `ci.SAIL` | ✅ |\n| [Semaphore](https://semaphoreci.com) | `ci.SEMAPHORE` | ✅ |\n| [Shippable](https://www.shippable.com/) | `ci.SHIPPABLE` | ✅ |\n| [Solano CI](https://www.solanolabs.com/) | `ci.SOLANO` | ✅ |\n| [Strider CD](https://strider-cd.github.io/) | `ci.STRIDER` | 🚫 |\n| [TaskCluster](http://docs.taskcluster.net) | `ci.TASKCLUSTER` | 🚫 |\n| [TeamCity](https://www.jetbrains.com/teamcity/) by JetBrains | `ci.TEAMCITY` | 🚫 |\n| [Travis CI](http://travis-ci.org) | `ci.TRAVIS` | ✅ |\n\n## API\n\n### `ci.name`\n\nReturns a string containing name of the CI server the code is running on.\nIf CI server is not detected, it returns `null`.\n\nDon't depend on the value of this string not to change for a specific\nvendor. If you find your self writing `ci.name === 'Travis CI'`, you\nmost likely want to use `ci.TRAVIS` instead.\n\n### `ci.isCI`\n\nReturns a boolean. Will be `true` if the code is running on a CI server,\notherwise `false`.\n\nSome CI servers not listed here might still trigger the `ci.isCI`\nboolean to be set to `true` if they use certain vendor neutral\nenvironment variables. In those cases `ci.name` will be `null` and no\nvendor specific boolean will be set to `true`.\n\n### `ci.isPR`\n\nReturns a boolean if PR detection is supported for the current CI server. Will\nbe `true` if a PR is being tested, otherwise `false`. If PR detection is\nnot supported for the current CI server, the value will be `null`.\n\n### `ci.<VENDOR-CONSTANT>`\n\nA vendor specific boolean constant is exposed for each support CI\nvendor. A constant will be `true` if the code is determined to run on\nthe given CI server, otherwise `false`.\n\nExamples of vendor constants are `ci.TRAVIS` or `ci.APPVEYOR`. For a\ncomplete list, see the support table above.\n\nDeprecated vendor constants that will be removed in the next major\nrelease:\n\n- `ci.TDDIUM` (Solano CI) This have been renamed `ci.SOLANO`\n\n## License\n\n[MIT](LICENSE)\n# debug\n[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers)\n[](#sponsors)\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nA tiny JavaScript debugging utility modelled after Node.js core's debugging\ntechnique. Works in Node.js and web browsers.\n\n## Installation\n\n```bash\n$ npm install debug\n```\n\n## Usage\n\n`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.\n\nExample [_app.js_](./examples/node/app.js):\n\n```js\nvar debug = require('debug')('http')\n , http = require('http')\n , name = 'My App';\n\n// fake app\n\ndebug('booting %o', name);\n\nhttp.createServer(function(req, res){\n debug(req.method + ' ' + req.url);\n res.end('hello\\n');\n}).listen(3000, function(){\n debug('listening');\n});\n\n// fake worker of some kind\n\nrequire('./worker');\n```\n\nExample [_worker.js_](./examples/node/worker.js):\n\n```js\nvar a = require('debug')('worker:a')\n , b = require('debug')('worker:b');\n\nfunction work() {\n a('doing lots of uninteresting work');\n setTimeout(work, Math.random() * 1000);\n}\n\nwork();\n\nfunction workb() {\n b('doing some work');\n setTimeout(workb, Math.random() * 2000);\n}\n\nworkb();\n```\n\nThe `DEBUG` environment variable is then used to enable these based on space or\ncomma-delimited names.\n\nHere are some examples:\n\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 04 pm\" src=\"https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 38 pm\" src=\"https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 25 pm\" src=\"https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png\">\n\n#### Windows command prompt notes\n\n##### CMD\n\nOn Windows the environment variable is set using the `set` command.\n\n```cmd\nset DEBUG=*,-not_this\n```\n\nExample:\n\n```cmd\nset DEBUG=* & node app.js\n```\n\n##### PowerShell (VS Code default)\n\nPowerShell uses different syntax to set environment variables.\n\n```cmd\n$env:DEBUG = \"*,-not_this\"\n```\n\nExample:\n\n```cmd\n$env:DEBUG='app';node app.js\n```\n\nThen, run the program to be debugged as usual.\n\nnpm script example:\n```js\n \"windowsDebug\": \"@powershell -Command $env:DEBUG='*';node app.js\",\n```\n\n## Namespace Colors\n\nEvery debug instance has a color generated for it based on its namespace name.\nThis helps when visually parsing the debug output to identify which debug instance\na debug line belongs to.\n\n#### Node.js\n\nIn Node.js, colors are enabled when stderr is a TTY. You also _should_ install\nthe [`supports-color`](https://npmjs.org/supports-color) module alongside debug,\notherwise debug will only use a small handful of basic colors.\n\n<img width=\"521\" src=\"https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png\">\n\n#### Web Browser\n\nColors are also enabled on \"Web Inspectors\" that understand the `%c` formatting\noption. These are WebKit web inspectors, Firefox ([since version\n31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))\nand the Firebug plugin for Firefox (any version).\n\n<img width=\"524\" src=\"https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png\">\n\n## Millisecond diff\n\nWhen actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the \"+NNNms\" will show you how much time was spent between calls.\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nWhen stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png\">\n\n## Conventions\n\nIf you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use \":\" to separate features. For example \"bodyParser\" from Connect would then be \"connect:bodyParser\". If you append a \"*\" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.\n\n## Wildcards\n\nThe `*` character may be used as a wildcard. Suppose for example your library has\ndebuggers named \"connect:bodyParser\", \"connect:compress\", \"connect:session\",\ninstead of listing all three with\n`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do\n`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.\n\nYou can also exclude specific debuggers by prefixing them with a \"-\" character.\nFor example, `DEBUG=*,-connect:*` would include all debuggers except those\nstarting with \"connect:\".\n\n## Environment Variables\n\nWhen running through Node.js, you can set a few environment variables that will\nchange the behavior of the debug logging:\n\n| Name | Purpose |\n|-----------|-------------------------------------------------|\n| `DEBUG` | Enables/disables specific debugging namespaces. |\n| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |\n| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |\n| `DEBUG_DEPTH` | Object inspection depth. |\n| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |\n\n__Note:__ The environment variables beginning with `DEBUG_` end up being\nconverted into an Options object that gets used with `%o`/`%O` formatters.\nSee the Node.js documentation for\n[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)\nfor the complete list.\n\n## Formatters\n\nDebug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.\nBelow are the officially supported formatters:\n\n| Formatter | Representation |\n|-----------|----------------|\n| `%O` | Pretty-print an Object on multiple lines. |\n| `%o` | Pretty-print an Object all on a single line. |\n| `%s` | String. |\n| `%d` | Number (both integer and float). |\n| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |\n| `%%` | Single percent sign ('%'). This does not consume an argument. |\n\n### Custom formatters\n\nYou can add custom formatters by extending the `debug.formatters` object.\nFor example, if you wanted to add support for rendering a Buffer as hex with\n`%h`, you could do something like:\n\n```js\nconst createDebug = require('debug')\ncreateDebug.formatters.h = (v) => {\n return v.toString('hex')\n}\n\n// …elsewhere\nconst debug = createDebug('foo')\ndebug('this is hex: %h', new Buffer('hello world'))\n// foo this is hex: 68656c6c6f20776f726c6421 +0ms\n```\n\n## Browser Support\n\nYou can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),\nor just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),\nif you don't want to build it yourself.\n\nDebug's enable state is currently persisted by `localStorage`.\nConsider the situation shown below where you have `worker:a` and `worker:b`,\nand wish to debug both. You can enable this using `localStorage.debug`:\n\n```js\nlocalStorage.debug = 'worker:*'\n```\n\nAnd then refresh the page.\n\n```js\na = debug('worker:a');\nb = debug('worker:b');\n\nsetInterval(function(){\n a('doing some work');\n}, 1000);\n\nsetInterval(function(){\n b('doing some work');\n}, 1200);\n```\n\n## Output streams\n\n By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:\n\nExample [_stdout.js_](./examples/node/stdout.js):\n\n```js\nvar debug = require('debug');\nvar error = debug('app:error');\n\n// by default stderr is used\nerror('goes to stderr!');\n\nvar log = debug('app:log');\n// set this namespace to log via console.log\nlog.log = console.log.bind(console); // don't forget to bind to console!\nlog('goes to stdout');\nerror('still goes to stderr!');\n\n// set all output to go via console.info\n// overrides all per-namespace log settings\ndebug.log = console.info.bind(console);\nerror('now goes to stdout via console.info');\nlog('still goes to stdout, but via console.info now');\n```\n\n## Extend\nYou can simply extend debugger \n```js\nconst log = require('debug')('auth');\n\n//creates new debug instance with extended namespace\nconst logSign = log.extend('sign');\nconst logLogin = log.extend('login');\n\nlog('hello'); // auth hello\nlogSign('hello'); //auth:sign hello\nlogLogin('hello'); //auth:login hello\n```\n\n## Set dynamically\n\nYou can also enable debug dynamically by calling the `enable()` method :\n\n```js\nlet debug = require('debug');\n\nconsole.log(1, debug.enabled('test'));\n\ndebug.enable('test');\nconsole.log(2, debug.enabled('test'));\n\ndebug.disable();\nconsole.log(3, debug.enabled('test'));\n\n```\n\nprint : \n```\n1 false\n2 true\n3 false\n```\n\nUsage : \n`enable(namespaces)` \n`namespaces` can include modes separated by a colon and wildcards.\n \nNote that calling `enable()` completely overrides previously set DEBUG variable : \n\n```\n$ DEBUG=foo node -e 'var dbg = require(\"debug\"); dbg.enable(\"bar\"); console.log(dbg.enabled(\"foo\"))'\n=> false\n```\n\n## Checking whether a debug target is enabled\n\nAfter you've created a debug instance, you can determine whether or not it is\nenabled by checking the `enabled` property:\n\n```javascript\nconst debug = require('debug')('http');\n\nif (debug.enabled) {\n // do stuff...\n}\n```\n\nYou can also manually toggle this property to force the debug instance to be\nenabled or disabled.\n\n## Authors\n\n - TJ Holowaychuk\n - Nathan Rajlich\n - Andrew Rhyne\n\n## Backers\n\nSupport us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]\n\n<a href=\"https://opencollective.com/debug/backer/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/29/avatar.svg\"></a>\n\n## Sponsors\n\nBecome a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]\n\n<a href=\"https://opencollective.com/debug/sponsor/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/29/avatar.svg\"></a>\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# create-hash\n\n[](https://travis-ci.org/crypto-browserify/createHash)\n\nNode style hashes for use in the browser, with native hash functions in node.\n\nAPI is the same as hashes in node:\n```js\nvar createHash = require('create-hash')\nvar hash = createHash('sha224')\nhash.update('synchronous write') // optional encoding parameter\nhash.digest() // synchronously get result with optional encoding parameter\n\nhash.write('write to it as a stream')\nhash.end() // remember it's a stream\nhash.read() // only if you ended it as a stream though\n```\n\nTo get the JavaScript version even in node do `require('create-hash/browser')`\naws4\n----\n\n[](https://travis-ci.org/github/mhart/aws4)\n\nA small utility to sign vanilla Node.js http(s) request options using Amazon's\n[AWS Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\n\nIf you want to sign and send AWS requests in a modern browser, or an environment like [Cloudflare Workers](https://developers.cloudflare.com/workers/), then check out [aws4fetch](https://github.com/mhart/aws4fetch) – otherwise you can also bundle this library for use [in older browsers](./browser).\n\nThe only AWS service that *doesn't* support v4 as of 2020-05-22 is\n[SimpleDB](https://docs.aws.amazon.com/AmazonSimpleDB/latest/DeveloperGuide/SDB_API.html)\n(it only supports [AWS Signature Version 2](https://github.com/mhart/aws2)).\n\nIt also provides defaults for a number of core AWS headers and\nrequest parameters, making it very easy to query AWS services, or\nbuild out a fully-featured AWS library.\n\nExample\n-------\n\n```javascript\nvar https = require('https')\nvar aws4 = require('aws4')\n\n// to illustrate usage, we'll create a utility function to request and pipe to stdout\nfunction request(opts) { https.request(opts, function(res) { res.pipe(process.stdout) }).end(opts.body || '') }\n\n// aws4 will sign an options object as you'd pass to http.request, with an AWS service and region\nvar opts = { host: 'my-bucket.s3.us-west-1.amazonaws.com', path: '/my-object', service: 's3', region: 'us-west-1' }\n\n// aws4.sign() will sign and modify these options, ready to pass to http.request\naws4.sign(opts, { accessKeyId: '', secretAccessKey: '' })\n\n// or it can get credentials from process.env.AWS_ACCESS_KEY_ID, etc\naws4.sign(opts)\n\n// for most AWS services, aws4 can figure out the service and region if you pass a host\nopts = { host: 'my-bucket.s3.us-west-1.amazonaws.com', path: '/my-object' }\n\n// usually it will add/modify request headers, but you can also sign the query:\nopts = { host: 'my-bucket.s3.amazonaws.com', path: '/?X-Amz-Expires=12345', signQuery: true }\n\n// and for services with simple hosts, aws4 can infer the host from service and region:\nopts = { service: 'sqs', region: 'us-east-1', path: '/?Action=ListQueues' }\n\n// and if you're using us-east-1, it's the default:\nopts = { service: 'sqs', path: '/?Action=ListQueues' }\n\naws4.sign(opts)\nconsole.log(opts)\n/*\n{\n host: 'sqs.us-east-1.amazonaws.com',\n path: '/?Action=ListQueues',\n headers: {\n Host: 'sqs.us-east-1.amazonaws.com',\n 'X-Amz-Date': '20121226T061030Z',\n Authorization: 'AWS4-HMAC-SHA256 Credential=ABCDEF/20121226/us-east-1/sqs/aws4_request, ...'\n }\n}\n*/\n\n// we can now use this to query AWS\nrequest(opts)\n/*\n<?xml version=\"1.0\"?>\n<ListQueuesResponse xmlns=\"https://queue.amazonaws.com/doc/2012-11-05/\">\n...\n*/\n\n// aws4 can infer the HTTP method if a body is passed in\n// method will be POST and Content-Type: 'application/x-www-form-urlencoded; charset=utf-8'\nrequest(aws4.sign({ service: 'iam', body: 'Action=ListGroups&Version=2010-05-08' }))\n/*\n<ListGroupsResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n...\n*/\n\n// you can specify any custom option or header as per usual\nrequest(aws4.sign({\n service: 'dynamodb',\n region: 'ap-southeast-2',\n method: 'POST',\n path: '/',\n headers: {\n 'Content-Type': 'application/x-amz-json-1.0',\n 'X-Amz-Target': 'DynamoDB_20120810.ListTables'\n },\n body: '{}'\n}))\n/*\n{\"TableNames\":[]}\n...\n*/\n\n// The raw RequestSigner can be used to generate CodeCommit Git passwords\nvar signer = new aws4.RequestSigner({\n service: 'codecommit',\n host: 'git-codecommit.us-east-1.amazonaws.com',\n method: 'GIT',\n path: '/v1/repos/MyAwesomeRepo',\n})\nvar password = signer.getDateTime() + 'Z' + signer.signature()\n\n// see example.js for examples with other services\n```\n\nAPI\n---\n\n### aws4.sign(requestOptions, [credentials])\n\nCalculates and populates any necessary AWS headers and/or request\noptions on `requestOptions`. Returns `requestOptions` as a convenience for chaining.\n\n`requestOptions` is an object holding the same options that the Node.js\n[http.request](https://nodejs.org/docs/latest/api/http.html#http_http_request_options_callback)\nfunction takes.\n\nThe following properties of `requestOptions` are used in the signing or\npopulated if they don't already exist:\n\n- `hostname` or `host` (will try to be determined from `service` and `region` if not given)\n- `method` (will use `'GET'` if not given or `'POST'` if there is a `body`)\n- `path` (will use `'/'` if not given)\n- `body` (will use `''` if not given)\n- `service` (will try to be calculated from `hostname` or `host` if not given)\n- `region` (will try to be calculated from `hostname` or `host` or use `'us-east-1'` if not given)\n- `signQuery` (to sign the query instead of adding an `Authorization` header, defaults to false)\n- `headers['Host']` (will use `hostname` or `host` or be calculated if not given)\n- `headers['Content-Type']` (will use `'application/x-www-form-urlencoded; charset=utf-8'`\n if not given and there is a `body`)\n- `headers['Date']` (used to calculate the signature date if given, otherwise `new Date` is used)\n\nYour AWS credentials (which can be found in your\n[AWS console](https://portal.aws.amazon.com/gp/aws/securityCredentials))\ncan be specified in one of two ways:\n\n- As the second argument, like this:\n\n```javascript\naws4.sign(requestOptions, {\n secretAccessKey: \"<your-secret-access-key>\",\n accessKeyId: \"<your-access-key-id>\",\n sessionToken: \"<your-session-token>\"\n})\n```\n\n- From `process.env`, such as this:\n\n```\nexport AWS_ACCESS_KEY_ID=\"<your-access-key-id>\"\nexport AWS_SECRET_ACCESS_KEY=\"<your-secret-access-key>\"\nexport AWS_SESSION_TOKEN=\"<your-session-token>\"\n```\n\n(will also use `AWS_ACCESS_KEY` and `AWS_SECRET_KEY` if available)\n\nThe `sessionToken` property and `AWS_SESSION_TOKEN` environment variable are optional for signing\nwith [IAM STS temporary credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).\n\nInstallation\n------------\n\nWith [npm](https://www.npmjs.com/) do:\n\n```\nnpm install aws4\n```\n\nCan also be used [in the browser](./browser).\n\nThanks\n------\n\nThanks to [@jed](https://github.com/jed) for his\n[dynamo-client](https://github.com/jed/dynamo-client) lib where I first\ncommitted and subsequently extracted this code.\n\nAlso thanks to the\n[official Node.js AWS SDK](https://github.com/aws/aws-sdk-js) for giving\nme a start on implementing the v4 signature.\n# lodash v4.17.20\n\nThe [Lodash](https://lodash.com/) library exported as [Node.js](https://nodejs.org/) modules.\n\n## Installation\n\nUsing npm:\n```shell\n$ npm i -g npm\n$ npm i --save lodash\n```\n\nIn Node.js:\n```js\n// Load the full build.\nvar _ = require('lodash');\n// Load the core build.\nvar _ = require('lodash/core');\n// Load the FP build for immutable auto-curried iteratee-first data-last methods.\nvar fp = require('lodash/fp');\n\n// Load method categories.\nvar array = require('lodash/array');\nvar object = require('lodash/fp/object');\n\n// Cherry-pick methods for smaller browserify/rollup/webpack bundles.\nvar at = require('lodash/at');\nvar curryN = require('lodash/fp/curryN');\n```\n\nSee the [package source](https://github.com/lodash/lodash/tree/4.17.20-npm) for more details.\n\n**Note:**<br>\nInstall [n_](https://www.npmjs.com/package/n_) for Lodash use in the Node.js < 6 REPL.\n\n## Support\n\nTested in Chrome 74-75, Firefox 66-67, IE 11, Edge 18, Safari 11-12, & Node.js 8-12.<br>\nAutomated [browser](https://saucelabs.com/u/lodash) & [CI](https://travis-ci.org/lodash/lodash/) test runs are available.\n# es-abstract <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![Build Status][travis-svg]][travis-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\n[![browser support][testling-svg]][testling-url]\n\nECMAScript spec abstract operations.\nWhen different versions of the spec conflict, the default export will be the latest version of the abstract operation.\nAll abstract operations will also be available under an `es5`/`es2015`/`es2016`/`es2017`/`es2018`/`es2019` entry point, and exported property, if you require a specific version.\n\n## Example\n\n```js\nvar ES = require('es-abstract');\nvar assert = require('assert');\n\nassert(ES.isCallable(function () {}));\nassert(!ES.isCallable(/a/g));\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n## Security\n\nPlease email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report.\n\n[package-url]: https://npmjs.org/package/es-abstract\n[npm-version-svg]: http://versionbadg.es/ljharb/es-abstract.svg\n[travis-svg]: https://travis-ci.org/ljharb/es-abstract.svg\n[travis-url]: https://travis-ci.org/ljharb/es-abstract\n[deps-svg]: https://david-dm.org/ljharb/es-abstract.svg\n[deps-url]: https://david-dm.org/ljharb/es-abstract\n[dev-deps-svg]: https://david-dm.org/ljharb/es-abstract/dev-status.svg\n[dev-deps-url]: https://david-dm.org/ljharb/es-abstract#info=devDependencies\n[testling-svg]: https://ci.testling.com/ljharb/es-abstract.png\n[testling-url]: https://ci.testling.com/ljharb/es-abstract\n[npm-badge-png]: https://nodei.co/npm/es-abstract.png?downloads=true&stars=true\n[license-image]: https://img.shields.io/npm/l/es-abstract.svg\n[license-url]: LICENSE\n[downloads-image]: https://img.shields.io/npm/dm/es-abstract.svg\n[downloads-url]: https://npm-stat.com/charts.html?package=es-abstract\n# sha.js\n[](https://www.npmjs.org/package/sha.js)\n[](https://travis-ci.org/crypto-browserify/sha.js)\n[](https://david-dm.org/crypto-browserify/sha.js#info=dependencies)\n\n[](https://github.com/feross/standard)\n\nNode style `SHA` on pure JavaScript.\n\n```js\nvar shajs = require('sha.js')\n\nconsole.log(shajs('sha256').update('42').digest('hex'))\n// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049\nconsole.log(new shajs.sha256().update('42').digest('hex'))\n// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049\n\nvar sha256stream = shajs('sha256')\nsha256stream.end('42')\nconsole.log(sha256stream.read().toString('hex'))\n// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049\n```\n\n## supported hashes\n`sha.js` currently implements:\n\n - SHA (SHA-0) -- **legacy, do not use in new systems**\n - SHA-1 -- **legacy, do not use in new systems**\n - SHA-224\n - SHA-256\n - SHA-384\n - SHA-512\n\n## Not an actual stream\nNote, this doesn't actually implement a stream, but wrapping this in a stream is trivial.\nIt does update incrementally, so you can hash things larger than RAM, as it uses a constant amount of memory (except when using base64 or utf8 encoding, see code comments).\n\n## Acknowledgements\nThis work is derived from Paul Johnston's [A JavaScript implementation of the Secure Hash Algorithm](http://pajhome.org.uk/crypt/md5/sha1.html).\n\n## LICENSE [MIT](LICENSE)\ntunnel-agent\n============\n\nHTTP proxy tunneling agent. Formerly part of mikeal/request, now a standalone module.\n# tr46.js\n\n> An implementation of the [Unicode TR46 specification](http://unicode.org/reports/tr46/).\n\n## Installation\n\n[Node.js](http://nodejs.org) `>= 6` is required. To install, type this at the command line:\n```shell\nnpm install tr46\n```\n\n## API\n\n### `toASCII(domainName[, options])`\n\nConverts a string of Unicode symbols to a case-folded Punycode string of ASCII symbols.\n\nAvailable options:\n* [`checkBidi`](#checkBidi)\n* [`checkHyphens`](#checkHyphens)\n* [`checkJoiners`](#checkJoiners)\n* [`processingOption`](#processingOption)\n* [`useSTD3ASCIIRules`](#useSTD3ASCIIRules)\n* [`verifyDNSLength`](#verifyDNSLength)\n\n### `toUnicode(domainName[, options])`\n\nConverts a case-folded Punycode string of ASCII symbols to a string of Unicode symbols.\n\nAvailable options:\n* [`checkBidi`](#checkBidi)\n* [`checkHyphens`](#checkHyphens)\n* [`checkJoiners`](#checkJoiners)\n* [`useSTD3ASCIIRules`](#useSTD3ASCIIRules)\n\n## Options\n\n### `checkBidi`\nType: `Boolean` \nDefault value: `false` \nWhen set to `true`, any bi-directional text within the input will be checked for validation.\n\n### `checkHyphens`\nType: `Boolean` \nDefault value: `false` \nWhen set to `true`, the positions of any hyphen characters within the input will be checked for validation.\n\n### `checkJoiners`\nType: `Boolean` \nDefault value: `false` \nWhen set to `true`, any word joiner characters within the input will be checked for validation.\n\n### `processingOption`\nType: `String` \nDefault value: `\"nontransitional\"` \nWhen set to `\"transitional\"`, symbols within the input will be validated according to the older IDNA2003 protocol. When set to `\"nontransitional\"`, the current IDNA2008 protocol will be used.\n\n### `useSTD3ASCIIRules`\nType: `Boolean` \nDefault value: `false` \nWhen set to `true`, input will be validated according to [STD3 Rules](http://unicode.org/reports/tr46/#STD3_Rules).\n\n### `verifyDNSLength`\nType: `Boolean` \nDefault value: `false` \nWhen set to `true`, the length of each DNS label within the input will be checked for validation.\n# hmac-drbg\n[](http://travis-ci.org/indutny/hmac-drbg)\n[](http://badge.fury.io/js/hmac-drbg)\n\nJS-only implementation of [HMAC DRBG][0].\n\n## Usage\n\n```js\nconst DRBG = require('hmac-drbg');\nconst hash = require('hash.js');\n\nconst d = new DRBG({\n hash: hash.sha256,\n entropy: '0123456789abcdef',\n nonce: '0123456789abcdef',\n pers: '0123456789abcdef' /* or `null` */\n});\n\nd.generate(32, 'hex');\n```\n\n#### LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2017.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: http://csrc.nist.gov/groups/ST/toolkit/documents/rng/HashBlockCipherDRBG.pdf\n# PurgeCSS\n\n\n\n\n\n\n\n\n<p align=\"center\">\n\t<img src=\"https://i.imgur.com/UEiUiJ0.png\" height=\"200\" width=\"200\" alt=\"PurgeCSS logo\"/>\n</p>\n\n## What is PurgeCSS?\n\nWhen you are building a website, chances are that you are using a css framework like Bootstrap, Materializecss, Foundation, etc... But you will only use a small set of the framework and a lot of unused css styles will be included.\n\nThis is where PurgeCSS comes into play. PurgeCSS analyzes your content and your css files. Then it matches the selectors used in your files with the one in your content files. It removes unused selectors from your css, resulting in smaller css files.\n\n## Version 1\n\nIf you are looking for [PurgeCSS 1](https://github.com/FullHuman/purgecss/tree/v1), the documentation is [here](https://v1.purgecss.com)\n\n## Documentation\n\nYou can find the PurgeCSS documentation on [this website](https://purgecss.com).\n\n### Table of Contents\n\n#### PurgeCSS\n\n- [Configuration](https://purgecss.com/configuration.html)\n- [Command Line Interface](https://purgecss.com/CLI.html)\n- [Programmatic API](https://purgecss.com/api.html)\n- [Whitelisting](https://purgecss.com/whitelisting.html)\n- [Extractors](https://purgecss.com/extractors.html)\n- [Comparison](https://purgecss.com/comparison.html)\n\n#### Plugins\n\n- [PostCSS](https://purgecss.com/plugins/postcss.html)\n- [Webpack](https://purgecss.com/plugins/webpack.html)\n- [Gulp](https://purgecss.com/plugins/gulp.html)\n- [Grunt](https://purgecss.com/plugins/grunt.html)\n- [Gatsby](https://purgecss.com/plugins/gatsby.html)\n\n#### Guides\n\n- [Vue.js](https://purgecss.com/guides/vue.html)\n- [Nuxt.js](https://purgecss.com/guides/nuxt.html)\n- [React.js](https://purgecss.com/guides/react.html)\n- [Next.js](https://purgecss.com/guides/next.html)\n- [Razzle](https://purgecss.com/guides/razzle.html)\n\n## Getting Started\n\n#### Installation\n\n```\nnpm i --save-dev purgecss\n```\n\n## Usage\n\n```js\nimport PurgeCSS from 'purgecss'\nconst purgeCSSResults = await new Purgecss().purge({\n content: ['**/*.html'],\n css: ['**/*.css']\n})\n```\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](./../../CONTRIBUTING.md) for details on our code of\nconduct, and the process for submitting pull requests to us.\n\n## Versioning\n\nPurgeCSS use [SemVer](http://semver.org/) for versioning.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](./../../LICENSE) file\nfor details.\n#define-properties <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![Build Status][travis-svg]][travis-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\n[![browser support][testling-svg]][testling-url]\n\nDefine multiple non-enumerable properties at once. Uses `Object.defineProperty` when available; falls back to standard assignment in older engines.\nExisting properties are not overridden. Accepts a map of property names to a predicate that, when true, force-overrides.\n\n## Example\n\n```js\nvar define = require('define-properties');\nvar assert = require('assert');\n\nvar obj = define({ a: 1, b: 2 }, {\n\ta: 10,\n\tb: 20,\n\tc: 30\n});\nassert(obj.a === 1);\nassert(obj.b === 2);\nassert(obj.c === 30);\nif (define.supportsDescriptors) {\n\tassert.deepEqual(Object.keys(obj), ['a', 'b']);\n\tassert.deepEqual(Object.getOwnPropertyDescriptor(obj, 'c'), {\n\t\tconfigurable: true,\n\t\tenumerable: false,\n\t\tvalue: 30,\n\t\twritable: false\n\t});\n}\n```\n\nThen, with predicates:\n```js\nvar define = require('define-properties');\nvar assert = require('assert');\n\nvar obj = define({ a: 1, b: 2, c: 3 }, {\n\ta: 10,\n\tb: 20,\n\tc: 30\n}, {\n\ta: function () { return false; },\n\tb: function () { return true; }\n});\nassert(obj.a === 1);\nassert(obj.b === 20);\nassert(obj.c === 3);\nif (define.supportsDescriptors) {\n\tassert.deepEqual(Object.keys(obj), ['a', 'c']);\n\tassert.deepEqual(Object.getOwnPropertyDescriptor(obj, 'b'), {\n\t\tconfigurable: true,\n\t\tenumerable: false,\n\t\tvalue: 20,\n\t\twritable: false\n\t});\n}\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[package-url]: https://npmjs.org/package/define-properties\n[npm-version-svg]: http://versionbadg.es/ljharb/define-properties.svg\n[travis-svg]: https://travis-ci.org/ljharb/define-properties.svg\n[travis-url]: https://travis-ci.org/ljharb/define-properties\n[deps-svg]: https://david-dm.org/ljharb/define-properties.svg\n[deps-url]: https://david-dm.org/ljharb/define-properties\n[dev-deps-svg]: https://david-dm.org/ljharb/define-properties/dev-status.svg\n[dev-deps-url]: https://david-dm.org/ljharb/define-properties#info=devDependencies\n[testling-svg]: https://ci.testling.com/ljharb/define-properties.png\n[testling-url]: https://ci.testling.com/ljharb/define-properties\n[npm-badge-png]: https://nodei.co/npm/define-properties.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/define-properties.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/define-properties.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=define-properties\n# is-extendable [](https://www.npmjs.com/package/is-extendable) [](https://npmjs.org/package/is-extendable) [](https://npmjs.org/package/is-extendable) [](https://travis-ci.org/jonschlinkert/is-extendable)\n\n> Returns true if a value is a plain object, array or function.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-extendable\n```\n\n## Usage\n\n```js\nvar isExtendable = require('is-extendable');\n```\n\nReturns true if the value is any of the following:\n\n* array\n* plain object\n* function\n\n## Notes\n\nAll objects in JavaScript can have keys, but it's a pain to check for this, since we ether need to verify that the value is not `null` or `undefined` and:\n\n* the value is not a primitive, or\n* that the object is a plain object, function or array\n\nAlso note that an `extendable` object is not the same as an [extensible object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/isExtensible), which is one that (in es6) is not sealed, frozen, or marked as non-extensible using `preventExtensions`.\n\n## Release history\n\n### v1.0.0 - 2017/07/20\n\n**Breaking changes**\n\n* No longer considers date, regex or error objects to be extendable\n\n## About\n\n### Related projects\n\n* [assign-deep](https://www.npmjs.com/package/assign-deep): Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… [more](https://github.com/jonschlinkert/assign-deep) | [homepage](https://github.com/jonschlinkert/assign-deep \"Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target (first) object.\")\n* [is-equal-shallow](https://www.npmjs.com/package/is-equal-shallow): Does a shallow comparison of two objects, returning false if the keys or values differ. | [homepage](https://github.com/jonschlinkert/is-equal-shallow \"Does a shallow comparison of two objects, returning false if the keys or values differ.\")\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object \"Returns true if an object was created by the `Object` constructor.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 20, 2017._\n# clone\n\n[](http://travis-ci.org/pvorb/node-clone)\n\n[](http://npm-stat.com/charts.html?package=clone)\n\noffers foolproof _deep cloning_ of objects, arrays, numbers, strings etc. in JavaScript.\n\n## Installation\n\n npm install clone\n\n(It also works with browserify, ender or standalone.)\n\n## Example\n\n~~~ javascript\nvar clone = require('clone');\n\nvar a, b;\n\na = { foo: { bar: 'baz' } }; // initial value of a\n\nb = clone(a); // clone a -> b\na.foo.bar = 'foo'; // change a\n\nconsole.log(a); // show a\nconsole.log(b); // show b\n~~~\n\nThis will print:\n\n~~~ javascript\n{ foo: { bar: 'foo' } }\n{ foo: { bar: 'baz' } }\n~~~\n\n**clone** masters cloning simple objects (even with custom prototype), arrays,\nDate objects, and RegExp objects. Everything is cloned recursively, so that you\ncan clone dates in arrays in objects, for example.\n\n## API\n\n`clone(val, circular, depth)`\n\n * `val` -- the value that you want to clone, any type allowed\n * `circular` -- boolean\n\n Call `clone` with `circular` set to `false` if you are certain that `obj`\n contains no circular references. This will give better performance if needed.\n There is no error if `undefined` or `null` is passed as `obj`.\n * `depth` -- depth to which the object is to be cloned (optional,\n defaults to infinity)\n\n`clone.clonePrototype(obj)`\n\n * `obj` -- the object that you want to clone\n\nDoes a prototype clone as\n[described by Oran Looney](http://oranlooney.com/functional-javascript/).\n\n## Circular References\n\n~~~ javascript\nvar a, b;\n\na = { hello: 'world' };\n\na.myself = a;\nb = clone(a);\n\nconsole.log(b);\n~~~\n\nThis will print:\n\n~~~ javascript\n{ hello: \"world\", myself: [Circular] }\n~~~\n\nSo, `b.myself` points to `b`, not `a`. Neat!\n\n## Test\n\n npm test\n\n## Caveat\n\nSome special objects like a socket or `process.stdout`/`stderr` are known to not\nbe cloneable. If you find other objects that cannot be cloned, please [open an\nissue](https://github.com/pvorb/node-clone/issues/new).\n\n## Bugs and Issues\n\nIf you encounter any bugs or issues, feel free to [open an issue at\ngithub](https://github.com/pvorb/node-clone/issues) or send me an email to\n<paul@vorba.ch>. I also always like to hear from you, if you’re using my code.\n\n## License\n\nCopyright © 2011-2015 [Paul Vorbach](http://paul.vorba.ch/) and\n[contributors](https://github.com/pvorb/node-clone/graphs/contributors).\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the “Software”), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n## HIDAPI library for Windows, Linux, FreeBSD and macOS\n\n| CI instance | Status |\n|----------------------|--------|\n| `macOS master` | [](https://travis-ci.org/libusb/hidapi) |\n| `Windows master` | [](https://ci.appveyor.com/project/Youw/hidapi/branch/master) |\n| `Linux/BSD, last build (branch/PR)` | [](https://builds.sr.ht/~qbicz/hidapi?) |\n\nHIDAPI is a multi-platform library which allows an application to interface\nwith USB and Bluetooth HID-Class devices on Windows, Linux, FreeBSD, and macOS.\nHIDAPI can be either built as a shared library (`.so`, `.dll` or `.dylib`) or\ncan be embedded directly into a target application by adding a single source\nfile (per platform) and a single header.\n\nHIDAPI library was originally developed by Alan Ott ([signal11](https://github.com/signal11)).\n\nIt was moved to [libusb/hidapi](https://github.com/libusb/hidapi) on June 4th, 2019, in order to merge important bugfixes and continue development of the library.\n\n## Table of Contents\n\n* [About](#about)\n* [What Does the API Look Like?](#what-does-the-api-look-like)\n* [License](#license)\n* [Download](#download)\n* [Build Instructions](#build-instructions)\n * [Prerequisites](#prerequisites)\n * [Linux](#linux)\n * [FreeBSD](#freebsd)\n * [Mac](#mac)\n * [Windows](#windows)\n * [Building HIDAPI into a shared library on Unix Platforms](#building-hidapi-into-a-shared-library-on-unix-platforms)\n * [Building the manual way on Unix platforms](#building-the-manual-way-on-unix-platforms)\n * [Building on Windows](#building-on-windows)\n* [Cross Compiling](#cross-compiling)\n * [Prerequisites](#prerequisites-1)\n * [Building HIDAPI](#building-hidapi)\n\n## About\n\nHIDAPI has five back-ends:\n* Windows (using `hid.dll`)\n* Linux/hidraw (using the Kernel's hidraw driver)\n* Linux/libusb (using libusb-1.0)\n* FreeBSD (using libusb-1.0)\n* Mac (using IOHidManager)\n\nOn Linux, either the hidraw or the libusb back-end can be used. There are\ntradeoffs, and the functionality supported is slightly different.\n\n__Linux/hidraw__ (`linux/hid.c`):\n\nThis back-end uses the hidraw interface in the Linux kernel, and supports\nboth USB and Bluetooth HID devices. It requires kernel version at least 2.6.39\nto build. In addition, it will only communicate with devices which have hidraw\nnodes associated with them.\nKeyboards, mice, and some other devices which are blacklisted from having\nhidraw nodes will not work. Fortunately, for nearly all the uses of hidraw,\nthis is not a problem.\n\n__Linux/FreeBSD/libusb__ (`libusb/hid.c`):\n\nThis back-end uses libusb-1.0 to communicate directly to a USB device. This\nback-end will of course not work with Bluetooth devices.\n\nHIDAPI also comes with a Test GUI. The Test GUI is cross-platform and uses\nFox Toolkit <http://www.fox-toolkit.org>. It will build on every platform\nwhich HIDAPI supports. Since it relies on a 3rd party library, building it\nis optional but recommended because it is so useful when debugging hardware.\n\n## What Does the API Look Like?\nThe API provides the most commonly used HID functions including sending\nand receiving of input, output, and feature reports. The sample program,\nwhich communicates with a heavily hacked up version of the Microchip USB\nGeneric HID sample looks like this (with error checking removed for\nsimplicity):\n\n**Warning: Only run the code you understand, and only when it conforms to the\ndevice spec. Writing data at random to your HID devices can break them.**\n\n```c\n#ifdef WIN32\n#include <windows.h>\n#endif\n#include <stdio.h>\n#include <stdlib.h>\n#include \"hidapi.h\"\n\n#define MAX_STR 255\n\nint main(int argc, char* argv[])\n{\n\tint res;\n\tunsigned char buf[65];\n\twchar_t wstr[MAX_STR];\n\thid_device *handle;\n\tint i;\n\n\t// Initialize the hidapi library\n\tres = hid_init();\n\n\t// Open the device using the VID, PID,\n\t// and optionally the Serial number.\n\thandle = hid_open(0x4d8, 0x3f, NULL);\n\n\t// Read the Manufacturer String\n\tres = hid_get_manufacturer_string(handle, wstr, MAX_STR);\n\twprintf(L\"Manufacturer String: %s\\n\", wstr);\n\n\t// Read the Product String\n\tres = hid_get_product_string(handle, wstr, MAX_STR);\n\twprintf(L\"Product String: %s\\n\", wstr);\n\n\t// Read the Serial Number String\n\tres = hid_get_serial_number_string(handle, wstr, MAX_STR);\n\twprintf(L\"Serial Number String: (%d) %s\\n\", wstr[0], wstr);\n\n\t// Read Indexed String 1\n\tres = hid_get_indexed_string(handle, 1, wstr, MAX_STR);\n\twprintf(L\"Indexed String 1: %s\\n\", wstr);\n\n\t// Toggle LED (cmd 0x80). The first byte is the report number (0x0).\n\tbuf[0] = 0x0;\n\tbuf[1] = 0x80;\n\tres = hid_write(handle, buf, 65);\n\n\t// Request state (cmd 0x81). The first byte is the report number (0x0).\n\tbuf[0] = 0x0;\n\tbuf[1] = 0x81;\n\tres = hid_write(handle, buf, 65);\n\n\t// Read requested state\n\tres = hid_read(handle, buf, 65);\n\n\t// Print out the returned buffer.\n\tfor (i = 0; i < 4; i++)\n\t\tprintf(\"buf[%d]: %d\\n\", i, buf[i]);\n\n\t// Close the device\n\thid_close(handle);\n\n\t// Finalize the hidapi library\n\tres = hid_exit();\n\n\treturn 0;\n}\n```\n\nYou can also use [hidtest/test.c](hidtest/test.c)\nas a starting point for your applications.\n\n## License\nHIDAPI may be used by one of three licenses as outlined in [LICENSE.txt](LICENSE.txt).\n\n## Download\nHIDAPI can be downloaded from GitHub\n```sh\ngit clone git://github.com/libusb/hidapi.git\n```\n\n## Build Instructions\n\nThis section is long. Don't be put off by this. It's not long because it's\ncomplicated to build HIDAPI; it's quite the opposite. This section is long\nbecause of the flexibility of HIDAPI and the large number of ways in which\nit can be built and used. You will likely pick a single build method.\n\nHIDAPI can be built in several different ways. If you elect to build a\nshared library, you will need to build it from the HIDAPI source\ndistribution. If you choose instead to embed HIDAPI directly into your\napplication, you can skip the building and look at the provided platform\nMakefiles for guidance. These platform Makefiles are located in `linux/`,\n`libusb/`, `mac/` and `windows/` and are called `Makefile-manual`. In addition,\nVisual Studio projects are provided. Even if you're going to embed HIDAPI\ninto your project, it is still beneficial to build the example programs.\n\n### Prerequisites:\n\n#### Linux:\nOn Linux, you will need to install development packages for libudev,\nlibusb and optionally Fox-toolkit (for the test GUI). On\nDebian/Ubuntu systems these can be installed by running:\n```sh\nsudo apt-get install libudev-dev libusb-1.0-0-dev libfox-1.6-dev\n```\n\nIf you downloaded the source directly from the git repository (using\ngit clone), you'll need Autotools:\n```sh\nsudo apt-get install autotools-dev autoconf automake libtool\n```\n\n#### FreeBSD:\nOn FreeBSD you will need to install GNU make, libiconv, and\noptionally Fox-Toolkit (for the test GUI). This is done by running\nthe following:\n```sh\npkg_add -r gmake libiconv fox16\n```\n\nIf you downloaded the source directly from the git repository (using\ngit clone), you'll need Autotools:\n```sh\npkg_add -r autotools\n```\n\n#### Mac:\nOn Mac, you will need to install Fox-Toolkit if you wish to build\nthe Test GUI. There are two ways to do this, and each has a slight\ncomplication. Which method you use depends on your use case.\n\nIf you wish to build the Test GUI just for your own testing on your\nown computer, then the easiest method is to install Fox-Toolkit\nusing ports:\n```sh\nsudo port install fox\n```\n\nIf you wish to build the TestGUI app bundle to redistribute to\nothers, you will need to install Fox-toolkit from source. This is\nbecause the version of fox that gets installed using ports uses the\nports X11 libraries which are not compatible with the Apple X11\nlibraries. If you install Fox with ports and then try to distribute\nyour built app bundle, it will simply fail to run on other systems.\nTo install Fox-Toolkit manually, download the source package from\n<http://www.fox-toolkit.org>, extract it, and run the following from\nwithin the extracted source:\n```sh\n./configure && make && make install\n```\n\n#### Windows:\nOn Windows, if you want to build the test GUI, you will need to get\nthe `hidapi-externals.zip` package from the download site. This\ncontains pre-built binaries for Fox-toolkit. Extract\n`hidapi-externals.zip` just outside of hidapi, so that\nhidapi-externals and hidapi are on the same level, as shown:\n```\n Parent_Folder\n |\n +hidapi\n +hidapi-externals\n```\nAgain, this step is not required if you do not wish to build the\ntest GUI.\n\n### Building HIDAPI into a shared library on Unix Platforms:\n\nOn Unix-like systems such as Linux, FreeBSD, macOS, and even Windows, using\nMinGW or Cygwin, the easiest way to build a standard system-installed shared\nlibrary is to use the GNU Autotools build system. If you checked out the\nsource from the git repository, run the following:\n\n```sh\n./bootstrap\n./configure\nmake\nmake install # as root, or using sudo\n```\n\nIf you downloaded a source package (i.e.: if you did not run git clone), you\ncan skip the `./bootstrap` step.\n\n`./configure` can take several arguments which control the build. The two most\nlikely to be used are:\n```sh\n\t--enable-testgui\n\t\tEnable build of the Test GUI. This requires Fox toolkit to\n\t\tbe installed. Instructions for installing Fox-Toolkit on\n\t\teach platform are in the Prerequisites section above.\n\n\t--prefix=/usr\n\t\tSpecify where you want the output headers and libraries to\n\t\tbe installed. The example above will put the headers in\n\t\t/usr/include and the binaries in /usr/lib. The default is to\n\t\tinstall into /usr/local which is fine on most systems.\n```\n### Building the manual way on Unix platforms:\n\nManual Makefiles are provided mostly to give the user and idea what it takes\nto build a program which embeds HIDAPI directly inside of it. These should\nreally be used as examples only. If you want to build a system-wide shared\nlibrary, use the Autotools method described above.\n\nTo build HIDAPI using the manual Makefiles, change to the directory\nof your platform and run make. For example, on Linux run:\n```sh\ncd linux/\nmake -f Makefile-manual\n```\n\nTo build the Test GUI using the manual makefiles:\n```sh\ncd testgui/\nmake -f Makefile-manual\n```\n\n### Building on Windows:\n\nTo build the HIDAPI DLL on Windows using Visual Studio, build the `.sln` file\nin the `windows/` directory.\n\nTo build the Test GUI on windows using Visual Studio, build the `.sln` file in\nthe `testgui/` directory.\n\nTo build HIDAPI using MinGW or Cygwin using Autotools, use the instructions\nin the section [Building HIDAPI into a shared library on Unix Platforms](#building-hidapi-into-a-shared-library-on-unix-platforms)\nabove. Note that building the Test GUI with MinGW or Cygwin will\nrequire the Windows procedure in the [Prerequisites](#prerequisites-1) section\nabove (i.e.: `hidapi-externals.zip`).\n\nTo build HIDAPI using MinGW using the Manual Makefiles, see the section\n[Building the manual way on Unix platforms](#building-the-manual-way-on-unix-platforms)\nabove.\n\nHIDAPI can also be built using the Windows DDK (now also called the Windows\nDriver Kit or WDK). This method was originally required for the HIDAPI build\nbut not anymore. However, some users still prefer this method. It is not as\nwell supported anymore but should still work. Patches are welcome if it does\nnot. To build using the DDK:\n\n 1. Install the Windows Driver Kit (WDK) from Microsoft.\n 2. From the Start menu, in the Windows Driver Kits folder, select Build\n Environments, then your operating system, then the x86 Free Build\n Environment (or one that is appropriate for your system).\n 3. From the console, change directory to the `windows/ddk_build/` directory,\n which is part of the HIDAPI distribution.\n 4. Type build.\n 5. You can find the output files (DLL and LIB) in a subdirectory created\n by the build system which is appropriate for your environment. On\n Windows XP, this directory is `objfre_wxp_x86/i386`.\n\n## Cross Compiling\n\nThis section talks about cross compiling HIDAPI for Linux using Autotools.\nThis is useful for using HIDAPI on embedded Linux targets. These\ninstructions assume the most raw kind of embedded Linux build, where all\nprerequisites will need to be built first. This process will of course vary\nbased on your embedded Linux build system if you are using one, such as\nOpenEmbedded or Buildroot.\n\nFor the purpose of this section, it will be assumed that the following\nenvironment variables are exported.\n```sh\n$ export STAGING=$HOME/out\n$ export HOST=arm-linux\n```\n\n`STAGING` and `HOST` can be modified to suit your setup.\n\n### Prerequisites\n\nNote that the build of libudev is the very basic configuration.\n\nBuild libusb. From the libusb source directory, run:\n```sh\n./configure --host=$HOST --prefix=$STAGING\nmake\nmake install\n```\n\nBuild libudev. From the libudev source directory, run:\n```sh\n./configure --disable-gudev --disable-introspection --disable-hwdb \\\n\t --host=$HOST --prefix=$STAGING\nmake\nmake install\n```\n\n### Building HIDAPI\n\nBuild HIDAPI:\n```\nPKG_CONFIG_DIR= \\\nPKG_CONFIG_LIBDIR=$STAGING/lib/pkgconfig:$STAGING/share/pkgconfig \\\nPKG_CONFIG_SYSROOT_DIR=$STAGING \\\n./configure --host=$HOST --prefix=$STAGING\n```\n# CSSStyleDeclaration\n\nA Node JS implementation of the CSS Object Model [CSSStyleDeclaration interface](https://www.w3.org/TR/cssom-1/#the-cssstyledeclaration-interface).\n\n[](https://www.npmjs.com/package/cssstyle) [](https://travis-ci.org/jsdom/cssstyle) [](https://codecov.io/gh/jsdom/cssstyle)\n\n---\n\n#### Background\n\nThis package is an extension of the CSSStyleDeclaration class in Nikita Vasilyev's [CSSOM](https://github.com/NV/CSSOM) with added support for CSS 2 & 3 properties. The primary use case is for testing browser code in a Node environment. \n\nIt was originally created by Chad Walker, it is now maintaind by Jon Sakas and other open source contributors.\n\nBug reports and pull requests are welcome.\nglob-parent [](https://travis-ci.org/es128/glob-parent) [](https://coveralls.io/r/es128/glob-parent?branch=master)\n======\nJavascript module to extract the non-magic parent path from a glob string.\n\n[](https://nodei.co/npm/glob-parent/)\n[](https://nodei.co/npm-dl/glob-parent/)\n\nUsage\n-----\n```sh\nnpm install glob-parent --save\n```\n\n**Examples**\n\n```js\nvar globParent = require('glob-parent');\n\nglobParent('path/to/*.js'); // 'path/to'\nglobParent('/root/path/to/*.js'); // '/root/path/to'\nglobParent('/*.js'); // '/'\nglobParent('*.js'); // '.'\nglobParent('**/*.js'); // '.'\nglobParent('path/{to,from}'); // 'path'\nglobParent('path/!(to|from)'); // 'path'\nglobParent('path/?(to|from)'); // 'path'\nglobParent('path/+(to|from)'); // 'path'\nglobParent('path/*(to|from)'); // 'path'\nglobParent('path/@(to|from)'); // 'path'\nglobParent('path/**/*'); // 'path'\n\n// if provided a non-glob path, returns the nearest dir\nglobParent('path/foo/bar.js'); // 'path/foo'\nglobParent('path/foo/'); // 'path/foo'\nglobParent('path/foo'); // 'path' (see issue #3 for details)\n```\n\n## Escaping\n\nThe following characters have special significance in glob patterns and must be escaped if you want them to be treated as regular path characters:\n\n- `?` (question mark)\n- `*` (star)\n- `|` (pipe)\n- `(` (opening parenthesis)\n- `)` (closing parenthesis)\n- `{` (opening curly brace)\n- `}` (closing curly brace)\n- `[` (opening bracket)\n- `]` (closing bracket)\n\n**Example**\n\n```js\nglobParent('foo/[bar]/') // 'foo'\nglobParent('foo/\\\\[bar]/') // 'foo/[bar]'\n```\n\n## Limitations\n\n#### Braces & Brackets\nThis library attempts a quick and imperfect method of determining which path\nparts have glob magic without fully parsing/lexing the pattern. There are some\nadvanced use cases that can trip it up, such as nested braces where the outer\npair is escaped and the inner one contains a path separator. If you find\nyourself in the unlikely circumstance of being affected by this or need to\nensure higher-fidelity glob handling in your library, it is recommended that you\npre-process your input with [expand-braces] and/or [expand-brackets].\n\n#### Windows\nBackslashes are not valid path separators for globs. If a path with backslashes\nis provided anyway, for simple cases, glob-parent will replace the path\nseparator for you and return the non-glob parent path (now with\nforward-slashes, which are still valid as Windows path separators).\n\nThis cannot be used in conjunction with escape characters.\n\n```js\n// BAD\nglobParent('C:\\\\Program Files \\\\(x86\\\\)\\\\*.ext') // 'C:/Program Files /(x86/)'\n\n// GOOD\nglobParent('C:/Program Files\\\\(x86\\\\)/*.ext') // 'C:/Program Files (x86)'\n```\n\nIf you are using escape characters for a pattern without path parts (i.e.\nrelative to `cwd`), prefix with `./` to avoid confusing glob-parent.\n\n```js\n// BAD\nglobParent('foo \\\\[bar]') // 'foo '\nglobParent('foo \\\\[bar]*') // 'foo '\n\n// GOOD\nglobParent('./foo \\\\[bar]') // 'foo [bar]'\nglobParent('./foo \\\\[bar]*') // '.'\n```\n\nChange Log\n----------\n[See release notes page on GitHub](https://github.com/es128/glob-parent/releases)\n\nLicense\n-------\n[ISC](https://raw.github.com/es128/glob-parent/master/LICENSE)\n\n[expand-braces]: https://github.com/jonschlinkert/expand-braces\n[expand-brackets]: https://github.com/jonschlinkert/expand-brackets\n# abbrev-js\n\nJust like [ruby's Abbrev](http://apidock.com/ruby/Abbrev).\n\nUsage:\n\n var abbrev = require(\"abbrev\");\n abbrev(\"foo\", \"fool\", \"folding\", \"flop\");\n \n // returns:\n { fl: 'flop'\n , flo: 'flop'\n , flop: 'flop'\n , fol: 'folding'\n , fold: 'folding'\n , foldi: 'folding'\n , foldin: 'folding'\n , folding: 'folding'\n , foo: 'foo'\n , fool: 'fool'\n }\n\nThis is handy for command-line scripts, or other cases where you want to be able to accept shorthands.\n# color-convert\n\n[](https://travis-ci.org/Qix-/color-convert)\n\nColor-convert is a color conversion library for JavaScript and node.\nIt converts all ways between `rgb`, `hsl`, `hsv`, `hwb`, `cmyk`, `ansi`, `ansi16`, `hex` strings, and CSS `keyword`s (will round to closest):\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hsl(140, 200, 100); // [96, 48, 59]\nconvert.keyword.rgb('blue'); // [0, 0, 255]\n\nvar rgbChannels = convert.rgb.channels; // 3\nvar cmykChannels = convert.cmyk.channels; // 4\nvar ansiChannels = convert.ansi16.channels; // 1\n```\n\n# Install\n\n```console\n$ npm install color-convert\n```\n\n# API\n\nSimply get the property of the _from_ and _to_ conversion that you're looking for.\n\nAll functions have a rounded and unrounded variant. By default, return values are rounded. To get the unrounded (raw) results, simply tack on `.raw` to the function.\n\nAll 'from' functions have a hidden property called `.channels` that indicates the number of channels the function expects (not including alpha).\n\n```js\nvar convert = require('color-convert');\n\n// Hex to LAB\nconvert.hex.lab('DEADBF'); // [ 76, 21, -2 ]\nconvert.hex.lab.raw('DEADBF'); // [ 75.56213190997677, 20.653827952644754, -2.290532499330533 ]\n\n// RGB to CMYK\nconvert.rgb.cmyk(167, 255, 4); // [ 35, 0, 98, 0 ]\nconvert.rgb.cmyk.raw(167, 255, 4); // [ 34.509803921568626, 0, 98.43137254901961, 0 ]\n```\n\n### Arrays\nAll functions that accept multiple arguments also support passing an array.\n\nNote that this does **not** apply to functions that convert from a color that only requires one value (e.g. `keyword`, `ansi256`, `hex`, etc.)\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hex(123, 45, 67); // '7B2D43'\nconvert.rgb.hex([123, 45, 67]); // '7B2D43'\n```\n\n## Routing\n\nConversions that don't have an _explicitly_ defined conversion (in [conversions.js](conversions.js)), but can be converted by means of sub-conversions (e.g. XYZ -> **RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex).\n\nKeep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of \"direct\" (single-step) conversions, see [conversions.js](conversions.js).\n\n# Contribute\n\nIf there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.\n\n# License\nCopyright © 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE).\n# Pirates [![Version][version-badge]][npm-link] [![Build Status][build-badge]][build-link] [![Coverage][codecov-badge]][codecov-link] [![Commitizen friendly][cz-badge]][cz-link] [![semantic-release][sr-badge]][sr-link] [![MIT License][license-badge]][license-link]\n\n### Properly hijack require\n\n[version-badge]: \thttps://img.shields.io/npm/v/pirates.svg \"npm version\"\n[downloads-badge]: https://img.shields.io/npm/dm/pirates.svg \"npm downloads\"\n[npm-link]: http://npm.im/pirates \"npm\"\n\n[codecov-badge]: https://img.shields.io/codecov/c/github/ariporad/pirates/master.svg?style=flat \"codecov\"\n[codecov-link]: https://codecov.io/gh/ariporad/pirates \"codecov\"\n\n[license-badge]: https://img.shields.io/npm/l/express.svg \"MIT License\"\n[license-link]: http://ariporad.mit-license.org \"MIT License\"\n\n[build-badge]: https://travis-ci.org/ariporad/pirates.svg \"Travis CI Build Status\"\n[build-link]: https://travis-ci.org/ariporad/pirates \"Travis CI Build Status\"\n\n[cz-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg \"Commitizen friendly\"\n[cz-link]: http://commitizen.github.io/cz-cli/ \"Commitizen friendly\"\n\n[sr-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[sr-link]: https://github.com/semantic-release/semantic-release\n\n## Why?\n\nTwo reasons:\n1. Babel and istanbul were breaking each other.\n2. Everyone seemed to re-invent the wheel on this, and everyone wanted a solution that was DRY, simple, easy to use,\nand made everything Just Work™, while allowing multiple require hooks, in a fashion similar to calling `super`.\n\nFor some context, see [the Babel issue thread][] which started this all, then [the nyc issue thread][], where\ndiscussion was moved (as we began to discuss just using the code nyc had developed), and finally to [#1][issue-1]\nwhere discussion was finally moved.\n\n[the Babel issue thread]: https://github.com/babel/babel/pull/3062 \"Babel Issue Thread\"\n[the nyc issue thread]: https://github.com/bcoe/nyc/issues/70 \"NYC Issue Thread\"\n[issue-1]: https://github.com/ariporad/pirates/issues/1 \"Issue #1\"\n\n## Installation\n\n npm install --save pirates\n\n## Usage\n\nUsing pirates is really easy:\n```javascript\n// my-module/register.js\nconst addHook = require('pirates').addHook;\n// Or if you use ES modules\n// import { addHook } from 'pirates';\n\nfunction matcher(filename) {\n // Here, you can inspect the filename to determine if it should be hooked or\n // not. Just return a truthy/falsey. Files in node_modules are automatically ignored, \n // unless otherwise specified in options (see below).\n\n // TODO: Implement your logic here\n return true;\n}\n\nconst revert = addHook(\n (code, filename) => code.replace('@@foo', 'console.log(\\'foo\\');'), \n { exts: ['.js'], matcher }\n);\n\n// And later, if you want to un-hook require, you can just do:\nrevert();\n```\n\n## API\n\n### pirates.addHook(hook, [opts={ [matcher: true], [exts: ['.js']], [ignoreNodeModules: true] }]);\nAdd a require hook. `hook` must be a function that takes `(code, filename)`, and returns the modified code. `opts` is\nan optional options object. Available options are: `matcher`, which is a function that accepts a filename, and\nreturns a truthy value if the file should be hooked (defaults to a function that always returns true), falsey if\notherwise; `exts`, which is an array of extensions to hook, they should begin with `.` (defaults to `['.js']`);\n`ignoreNodeModules`, if true, any file in a `node_modules` folder wont be hooked (the matcher also wont be called),\nif false, then the matcher will be called for any files in `node_modules` (defaults to true).\n\n## Projects that use Pirates\n\nSee the [wiki page](https://github.com/ariporad/pirates/wiki/Projects-using-Pirates). If you add Pirates to your project,\n(And you should! It works best if everyone uses it. Then we can have a happy world full of happy require hooks!), please\nadd yourself to the wiki.\n\n## License\n\n[MIT](http://ariporad.mit-license.org)\n# postcss-selector-parser [](https://travis-ci.org/postcss/postcss-selector-parser)\n\n> Selector parser with built in methods for working with selector strings.\n\n## Install\n\nWith [npm](https://npmjs.com/package/postcss-selector-parser) do:\n\n```\nnpm install postcss-selector-parser\n```\n\n## Quick Start\n\n```js\nconst parser = require('postcss-selector-parser');\nconst transform = selectors => {\n selectors.walk(selector => {\n // do something with the selector\n console.log(String(selector))\n });\n};\n\nconst transformed = parser(transform).processSync('h1, h2, h3');\n```\n\nTo normalize selector whitespace:\n\n```js\nconst parser = require('postcss-selector-parser');\nconst normalized = parser().processSync('h1, h2, h3', {lossless: false});\n// -> h1,h2,h3\n```\n\nAsync support is provided through `parser.process` and will resolve a Promise\nwith the resulting selector string.\n\n## API\n\nPlease see [API.md](API.md).\n\n## Credits\n\n* Huge thanks to Andrey Sitnik (@ai) for work on PostCSS which helped\n accelerate this module's development.\n\n## License\n\nMIT\n# os-browserify\n\nThe [os](https://nodejs.org/api/os.html) module from node.js, but for browsers.\n\nWhen you `require('os')` in [browserify](http://github.com/substack/node-browserify), this module will be loaded.\n# extglob [](https://www.npmjs.com/package/extglob) [](https://npmjs.org/package/extglob) [](https://npmjs.org/package/extglob) [](https://travis-ci.org/micromatch/extglob) [](https://ci.appveyor.com/project/micromatch/extglob)\n\n> Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save extglob\n```\n\n* Convert an extglob string to a regex-compatible string.\n* More complete (and correct) support than [minimatch](https://github.com/isaacs/minimatch) (minimatch fails a large percentage of the extglob tests)\n* Handles [negation patterns](#extglob-patterns)\n* Handles [nested patterns](#extglob-patterns)\n* Organized code base, easy to maintain and make changes when edge cases arise\n* As you can see by the [benchmarks](#benchmarks), extglob doesn't pay with speed for it's completeness, accuracy and quality.\n\n**Heads up!**: This library only supports extglobs, to handle full glob patterns and other extended globbing features use [micromatch](https://github.com/jonschlinkert/micromatch) instead.\n\n## Usage\n\nThe main export is a function that takes a string and options, and returns an object with the parsed AST and the compiled `.output`, which is a regex-compatible string that can be used for matching.\n\n```js\nvar extglob = require('extglob');\nconsole.log(extglob('!(xyz)*.js'));\n```\n\n## Extglob cheatsheet\n\nExtended globbing patterns can be defined as follows (as described by the [bash man page](https://www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html)):\n\n| **pattern** | **regex equivalent** | **description** | \n| --- | --- | --- |\n| `?(pattern-list)` | `(...|...)?` | Matches zero or one occurrence of the given pattern(s) |\n| `*(pattern-list)` | `(...|...)*` | Matches zero or more occurrences of the given pattern(s) |\n| `+(pattern-list)` | `(...|...)+` | Matches one or more occurrences of the given pattern(s) |\n| `@(pattern-list)` | `(...|...)` <sup class=\"footnote-ref\"><a href=\"#fn1\" id=\"fnref1\">[1]</a></sup> | Matches one of the given pattern(s) |\n| `!(pattern-list)` | N/A | Matches anything except one of the given pattern(s) |\n\n## API\n\n### [extglob](index.js#L36)\n\nConvert the given `extglob` pattern into a regex-compatible string. Returns an object with the compiled result and the parsed AST.\n\n**Params**\n\n* `pattern` **{String}**\n* `options` **{Object}**\n* `returns` **{String}**\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nconsole.log(extglob('*.!(*a)'));\n//=> '(?!\\\\.)[^/]*?\\\\.(?!(?!\\\\.)[^/]*?a\\\\b).*?'\n```\n\n### [.match](index.js#L56)\n\nTakes an array of strings and an extglob pattern and returns a new array that contains only the strings that match the pattern.\n\n**Params**\n\n* `list` **{Array}**: Array of strings to match\n* `pattern` **{String}**: Extglob pattern\n* `options` **{Object}**\n* `returns` **{Array}**: Returns an array of matches\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nconsole.log(extglob.match(['a.a', 'a.b', 'a.c'], '*.!(*a)'));\n//=> ['a.b', 'a.c']\n```\n\n### [.isMatch](index.js#L111)\n\nReturns true if the specified `string` matches the given extglob `pattern`.\n\n**Params**\n\n* `string` **{String}**: String to match\n* `pattern` **{String}**: Extglob pattern\n* `options` **{String}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nvar extglob = require('extglob');\n\nconsole.log(extglob.isMatch('a.a', '*.!(*a)'));\n//=> false\nconsole.log(extglob.isMatch('a.b', '*.!(*a)'));\n//=> true\n```\n\n### [.contains](index.js#L150)\n\nReturns true if the given `string` contains the given pattern. Similar to `.isMatch` but the pattern can match any part of the string.\n\n**Params**\n\n* `str` **{String}**: The string to match.\n* `pattern` **{String}**: Glob pattern to use for matching.\n* `options` **{Object}**\n* `returns` **{Boolean}**: Returns true if the patter matches any part of `str`.\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nconsole.log(extglob.contains('aa/bb/cc', '*b'));\n//=> true\nconsole.log(extglob.contains('aa/bb/cc', '*d'));\n//=> false\n```\n\n### [.matcher](index.js#L184)\n\nTakes an extglob pattern and returns a matcher function. The returned function takes the string to match as its only argument.\n\n**Params**\n\n* `pattern` **{String}**: Extglob pattern\n* `options` **{String}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nvar isMatch = extglob.matcher('*.!(*a)');\n\nconsole.log(isMatch('a.a'));\n//=> false\nconsole.log(isMatch('a.b'));\n//=> true\n```\n\n### [.create](index.js#L214)\n\nConvert the given `extglob` pattern into a regex-compatible string. Returns an object with the compiled result and the parsed AST.\n\n**Params**\n\n* `str` **{String}**\n* `options` **{Object}**\n* `returns` **{String}**\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nconsole.log(extglob.create('*.!(*a)').output);\n//=> '(?!\\\\.)[^/]*?\\\\.(?!(?!\\\\.)[^/]*?a\\\\b).*?'\n```\n\n### [.capture](index.js#L248)\n\nReturns an array of matches captured by `pattern` in `string`, or `null` if the pattern did not match.\n\n**Params**\n\n* `pattern` **{String}**: Glob pattern to use for matching.\n* `string` **{String}**: String to match\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns an array of captures if the string matches the glob pattern, otherwise `null`.\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nextglob.capture(pattern, string[, options]);\n\nconsole.log(extglob.capture('test/*.js', 'test/foo.js'));\n//=> ['foo']\nconsole.log(extglob.capture('test/*.js', 'foo/bar.css'));\n//=> null\n```\n\n### [.makeRe](index.js#L281)\n\nCreate a regular expression from the given `pattern` and `options`.\n\n**Params**\n\n* `pattern` **{String}**: The pattern to convert to regex.\n* `options` **{Object}**\n* `returns` **{RegExp}**\n\n**Example**\n\n```js\nvar extglob = require('extglob');\nvar re = extglob.makeRe('*.!(*a)');\nconsole.log(re);\n//=> /^[^\\/]*?\\.(?![^\\/]*?a)[^\\/]*?$/\n```\n\n## Options\n\nAvailable options are based on the options from Bash (and the option names used in bash).\n\n### options.nullglob\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\nWhen enabled, the pattern itself will be returned when no matches are found.\n\n### options.nonull\n\nAlias for [options.nullglob](#optionsnullglob), included for parity with minimatch.\n\n### options.cache\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\nFunctions are memoized based on the given glob patterns and options. Disable memoization by setting `options.cache` to false.\n\n### options.failglob\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\nThrow an error is no matches are found.\n\n## Benchmarks\n\nLast run on December 21, 2017\n\n```sh\n# negation-nested (49 bytes)\n extglob x 2,228,255 ops/sec ±0.98% (89 runs sampled)\n minimatch x 207,875 ops/sec ±0.61% (91 runs sampled)\n\n fastest is extglob (by 1072% avg)\n\n# negation-simple (43 bytes)\n extglob x 2,205,668 ops/sec ±1.00% (91 runs sampled)\n minimatch x 311,923 ops/sec ±1.25% (91 runs sampled)\n\n fastest is extglob (by 707% avg)\n\n# range-false (57 bytes)\n extglob x 2,263,877 ops/sec ±0.40% (94 runs sampled)\n minimatch x 271,372 ops/sec ±1.02% (91 runs sampled)\n\n fastest is extglob (by 834% avg)\n\n# range-true (56 bytes)\n extglob x 2,161,891 ops/sec ±0.41% (92 runs sampled)\n minimatch x 268,265 ops/sec ±1.17% (91 runs sampled)\n\n fastest is extglob (by 806% avg)\n\n# star-simple (46 bytes)\n extglob x 2,211,081 ops/sec ±0.49% (92 runs sampled)\n minimatch x 343,319 ops/sec ±0.59% (91 runs sampled)\n\n fastest is extglob (by 644% avg)\n\n```\n\n## Differences from Bash\n\nThis library has complete parity with Bash 4.3 with only a couple of minor differences.\n\n* In some cases Bash returns true if the given string \"contains\" the pattern, whereas this library returns true if the string is an exact match for the pattern. You can relax this by setting `options.contains` to true.\n* This library is more accurate than Bash and thus does not fail some of the tests that Bash 4.3 still lists as failing in their unit tests\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [braces](https://www.npmjs.com/package/braces): Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support… [more](https://github.com/micromatch/braces) | [homepage](https://github.com/micromatch/braces \"Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support for the Bash 4.3 braces specification, without sacrificing speed.\")\n* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets \"Expand POSIX bracket expressions (character classes) in glob patterns.\")\n* [expand-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. Used… [more](https://github.com/jonschlinkert/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range \"Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. Used by [micromatch].\")\n* [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or `step` to… [more](https://github.com/jonschlinkert/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range \"Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 49 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [isiahmeadows](https://github.com/isiahmeadows) |\n| 1 | [doowb](https://github.com/doowb) |\n| 1 | [devongovett](https://github.com/devongovett) |\n| 1 | [mjbvz](https://github.com/mjbvz) |\n| 1 | [shinnn](https://github.com/shinnn) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on December 21, 2017._\n\n<hr class=\"footnotes-sep\">\n<section class=\"footnotes\">\n<ol class=\"footnotes-list\">\n<li id=\"fn1\" class=\"footnote-item\">`@` isn \"'t a RegEx character.\" <a href=\"#fnref1\" class=\"footnote-backref\">↩</a>\n\n</li>\n</ol>\n</section>\n[](https://www.npmjs.com/package/esprima)\n[](https://www.npmjs.com/package/esprima)\n[](https://travis-ci.org/jquery/esprima)\n[](https://codecov.io/github/jquery/esprima)\n\n**Esprima** ([esprima.org](http://esprima.org), BSD license) is a high performance,\nstandard-compliant [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm)\nparser written in ECMAScript (also popularly known as\n[JavaScript](https://en.wikipedia.org/wiki/JavaScript)).\nEsprima is created and maintained by [Ariya Hidayat](https://twitter.com/ariyahidayat),\nwith the help of [many contributors](https://github.com/jquery/esprima/contributors).\n\n### Features\n\n- Full support for ECMAScript 2017 ([ECMA-262 8th Edition](http://www.ecma-international.org/publications/standards/Ecma-262.htm))\n- Sensible [syntax tree format](https://github.com/estree/estree/blob/master/es5.md) as standardized by [ESTree project](https://github.com/estree/estree)\n- Experimental support for [JSX](https://facebook.github.io/jsx/), a syntax extension for [React](https://facebook.github.io/react/)\n- Optional tracking of syntax node location (index-based and line-column)\n- [Heavily tested](http://esprima.org/test/ci.html) (~1500 [unit tests](https://github.com/jquery/esprima/tree/master/test/fixtures) with [full code coverage](https://codecov.io/github/jquery/esprima))\n\n### API\n\nEsprima can be used to perform [lexical analysis](https://en.wikipedia.org/wiki/Lexical_analysis) (tokenization) or [syntactic analysis](https://en.wikipedia.org/wiki/Parsing) (parsing) of a JavaScript program.\n\nA simple example on Node.js REPL:\n\n```javascript\n> var esprima = require('esprima');\n> var program = 'const answer = 42';\n\n> esprima.tokenize(program);\n[ { type: 'Keyword', value: 'const' },\n { type: 'Identifier', value: 'answer' },\n { type: 'Punctuator', value: '=' },\n { type: 'Numeric', value: '42' } ]\n \n> esprima.parseScript(program);\n{ type: 'Program',\n body:\n [ { type: 'VariableDeclaration',\n declarations: [Object],\n kind: 'const' } ],\n sourceType: 'script' }\n```\n\nFor more information, please read the [complete documentation](http://esprima.org/doc).\n## Stable\n\nA stable array sort, because `Array#sort()` is not guaranteed stable.\n\nMIT licensed.\n\n[](http://travis-ci.org/Two-Screen/stable)\n\n[](http://ci.testling.com/Two-Screen/stable)\n\n#### From npm\n\nInstall with:\n\n```sh\nnpm install stable\n```\n\nThen use it in Node.js or some other CommonJS environment as:\n\n```js\nconst stable = require('stable')\n```\n\n#### From the browser\n\nInclude [`stable.js`] or the minified version [`stable.min.js`]\nin your page, then call `stable()`.\n\n [`stable.js`]: https://raw.github.com/Two-Screen/stable/master/stable.js\n [`stable.min.js`]: https://raw.github.com/Two-Screen/stable/master/stable.min.js\n\n#### Usage\n\nThe default sort is, as with `Array#sort`, lexicographical:\n\n```js\nstable(['foo', 'bar', 'baz']) // => ['bar', 'baz', 'foo']\nstable([10, 1, 5]) // => [1, 10, 5]\n```\n\nUnlike `Array#sort`, the default sort is **NOT** in-place. To do an in-place\nsort, use `stable.inplace`, which otherwise works the same:\n\n```js\nconst arr = [10, 1, 5]\nstable(arr) === arr // => false\nstable.inplace(arr) === arr // => true\n```\n\nA comparator function can be specified:\n\n```js\n// Regular sort() compatible comparator, that returns a number.\n// This demonstrates the default behavior.\nconst lexCmp = (a, b) => String(a).localeCompare(b)\nstable(['foo', 'bar', 'baz'], lexCmp) // => ['bar', 'baz', 'foo']\n\n// Boolean comparator. Sorts `b` before `a` if true.\n// This demonstrates a simple way to sort numerically.\nconst greaterThan = (a, b) => a > b\nstable([10, 1, 5], greaterThan) // => [1, 5, 10]\n```\n\n#### License\n\nCopyright (C) 2018 Angry Bytes and contributors.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n# arr-union [](https://www.npmjs.com/package/arr-union) [](https://travis-ci.org/jonschlinkert/arr-union)\n\n> Combines a list of arrays, returning a single array with unique values, using strict equality for comparisons.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm i arr-union --save\n```\n\n## Benchmarks\n\nThis library is **10-20 times faster** and more performant than [array-union](https://github.com/sindresorhus/array-union).\n\nSee the [benchmarks](./benchmark).\n\n```sh\n#1: five-arrays\n array-union x 511,121 ops/sec ±0.80% (96 runs sampled)\n arr-union x 5,716,039 ops/sec ±0.86% (93 runs sampled)\n\n#2: ten-arrays\n array-union x 245,196 ops/sec ±0.69% (94 runs sampled)\n arr-union x 1,850,786 ops/sec ±0.84% (97 runs sampled)\n\n#3: two-arrays\n array-union x 563,869 ops/sec ±0.97% (94 runs sampled)\n arr-union x 9,602,852 ops/sec ±0.87% (92 runs sampled)\n```\n\n## Usage\n\n```js\nvar union = require('arr-union');\n\nunion(['a'], ['b', 'c'], ['d', 'e', 'f']);\n//=> ['a', 'b', 'c', 'd', 'e', 'f']\n```\n\nReturns only unique elements:\n\n```js\nunion(['a', 'a'], ['b', 'c']);\n//=> ['a', 'b', 'c']\n```\n\n## Related projects\n\n* [arr-diff](https://www.npmjs.com/package/arr-diff): Returns an array with only the unique values from the first array, by excluding all… [more](https://www.npmjs.com/package/arr-diff) | [homepage](https://github.com/jonschlinkert/arr-diff)\n* [arr-filter](https://www.npmjs.com/package/arr-filter): Faster alternative to javascript's native filter method. | [homepage](https://github.com/jonschlinkert/arr-filter)\n* [arr-flatten](https://www.npmjs.com/package/arr-flatten): Recursively flatten an array or arrays. This is the fastest implementation of array flatten. | [homepage](https://github.com/jonschlinkert/arr-flatten)\n* [arr-map](https://www.npmjs.com/package/arr-map): Faster, node.js focused alternative to JavaScript's native array map. | [homepage](https://github.com/jonschlinkert/arr-map)\n* [arr-pluck](https://www.npmjs.com/package/arr-pluck): Retrieves the value of a specified property from all elements in the collection. | [homepage](https://github.com/jonschlinkert/arr-pluck)\n* [arr-reduce](https://www.npmjs.com/package/arr-reduce): Fast array reduce that also loops over sparse elements. | [homepage](https://github.com/jonschlinkert/arr-reduce)\n* [array-unique](https://www.npmjs.com/package/array-unique): Return an array free of duplicate values. Fastest ES5 implementation. | [homepage](https://github.com/jonschlinkert/array-unique)\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/arr-union/issues/new).\n\n## Building docs\n\nGenerate readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm i verb && npm run docs\n```\n\nOr, if [verb](https://github.com/verbose/verb) is installed globally:\n\n```sh\n$ verb\n```\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)\nReleased under the [MIT license](https://github.com/jonschlinkert/arr-union/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on February 23, 2016._\n# call-me-maybe [](https://travis-ci.org/limulus/call-me-maybe)\n\nLet your JS API users either give you a callback or receive a promise.\n\n## Usage\n\n```javascript\nvar maybe = require(\"call-me-maybe\")\n\nmodule.exports = function asyncFunc (cb) {\n return maybe(cb, new Promise(function(resolve, reject) {\n // ...\n }))\n}\n```\n\n## API\n\n### maybe(cb, promise)\n\nIf the callback `cb` is truthy, returns `undefined` and will call `cb` when `promise` is settled. The parameters passed to `cb` are standard error-first:\n\n - If `promise` is fulfilled, then it is called with the result of the promise: `cb(null, result)`\n - If `promise` is rejected, then it is called with the rejection error: `cb(err)`\n\nIf `cb` is falsey, then `promise` is retuned.\n# Web IDL Type Conversions on JavaScript Values\n\nThis package implements, in JavaScript, the algorithms to convert a given JavaScript value according to a given [Web IDL](http://heycam.github.io/webidl/) [type](http://heycam.github.io/webidl/#idl-types).\n\nThe goal is that you should be able to write code like\n\n```js\n\"use strict\";\nconst conversions = require(\"webidl-conversions\");\n\nfunction doStuff(x, y) {\n x = conversions[\"boolean\"](x);\n y = conversions[\"unsigned long\"](y);\n // actual algorithm code here\n}\n```\n\nand your function `doStuff` will behave the same as a Web IDL operation declared as\n\n```webidl\nvoid doStuff(boolean x, unsigned long y);\n```\n\n## API\n\nThis package's main module's default export is an object with a variety of methods, each corresponding to a different Web IDL type. Each method, when invoked on a JavaScript value, will give back the new JavaScript value that results after passing through the Web IDL conversion rules. (See below for more details on what that means.) Alternately, the method could throw an error, if the Web IDL algorithm is specified to do so: for example `conversions[\"float\"](NaN)` [will throw a `TypeError`](http://heycam.github.io/webidl/#es-float).\n\nEach method also accepts a second, optional, parameter for miscellaneous options. For conversion methods that throw errors, a string option `{ context }` may be provided to provide more information in the error message. (For example, `conversions[\"float\"](NaN, { context: \"Argument 1 of Interface's operation\" })` will throw an error with message `\"Argument 1 of Interface's operation is not a finite floating-point value.\"`) Specific conversions may also accept other options, the details of which can be found below.\n\n## Conversions implemented\n\nConversions for all of the basic types from the Web IDL specification are implemented:\n\n- [`any`](https://heycam.github.io/webidl/#es-any)\n- [`void`](https://heycam.github.io/webidl/#es-void)\n- [`boolean`](https://heycam.github.io/webidl/#es-boolean)\n- [Integer types](https://heycam.github.io/webidl/#es-integer-types), which can additionally be provided the boolean options `{ clamp, enforceRange }` as a second parameter\n- [`float`](https://heycam.github.io/webidl/#es-float), [`unrestricted float`](https://heycam.github.io/webidl/#es-unrestricted-float)\n- [`double`](https://heycam.github.io/webidl/#es-double), [`unrestricted double`](https://heycam.github.io/webidl/#es-unrestricted-double)\n- [`DOMString`](https://heycam.github.io/webidl/#es-DOMString), which can additionally be provided the boolean option `{ treatNullAsEmptyString }` as a second parameter\n- [`ByteString`](https://heycam.github.io/webidl/#es-ByteString), [`USVString`](https://heycam.github.io/webidl/#es-USVString)\n- [`object`](https://heycam.github.io/webidl/#es-object)\n- [`Error`](https://heycam.github.io/webidl/#es-Error)\n- [Buffer source types](https://heycam.github.io/webidl/#es-buffer-source-types)\n\nAdditionally, for convenience, the following derived type definitions are implemented:\n\n- [`ArrayBufferView`](https://heycam.github.io/webidl/#ArrayBufferView)\n- [`BufferSource`](https://heycam.github.io/webidl/#BufferSource)\n- [`DOMTimeStamp`](https://heycam.github.io/webidl/#DOMTimeStamp)\n- [`Function`](https://heycam.github.io/webidl/#Function)\n- [`VoidFunction`](https://heycam.github.io/webidl/#VoidFunction) (although it will not censor the return type)\n\nDerived types, such as nullable types, promise types, sequences, records, etc. are not handled by this library. You may wish to investigate the [webidl2js](https://github.com/jsdom/webidl2js) project.\n\n### A note on the `long long` types\n\nThe `long long` and `unsigned long long` Web IDL types can hold values that cannot be stored in JavaScript numbers, so the conversion is imperfect. For example, converting the JavaScript number `18446744073709552000` to a Web IDL `long long` is supposed to produce the Web IDL value `-18446744073709551232`. Since we are representing our Web IDL values in JavaScript, we can't represent `-18446744073709551232`, so we instead the best we could do is `-18446744073709552000` as the output.\n\nThis library actually doesn't even get that far. Producing those results would require doing accurate modular arithmetic on 64-bit intermediate values, but JavaScript does not make this easy. We could pull in a big-integer library as a dependency, but in lieu of that, we for now have decided to just produce inaccurate results if you pass in numbers that are not strictly between `Number.MIN_SAFE_INTEGER` and `Number.MAX_SAFE_INTEGER`.\n\n## Background\n\nWhat's actually going on here, conceptually, is pretty weird. Let's try to explain.\n\nWeb IDL, as part of its madness-inducing design, has its own type system. When people write algorithms in web platform specs, they usually operate on Web IDL values, i.e. instances of Web IDL types. For example, if they were specifying the algorithm for our `doStuff` operation above, they would treat `x` as a Web IDL value of [Web IDL type `boolean`](http://heycam.github.io/webidl/#idl-boolean). Crucially, they would _not_ treat `x` as a JavaScript variable whose value is either the JavaScript `true` or `false`. They're instead working in a different type system altogether, with its own rules.\n\nSeparately from its type system, Web IDL defines a [\"binding\"](http://heycam.github.io/webidl/#ecmascript-binding) of the type system into JavaScript. This contains rules like: when you pass a JavaScript value to the JavaScript method that manifests a given Web IDL operation, how does that get converted into a Web IDL value? For example, a JavaScript `true` passed in the position of a Web IDL `boolean` argument becomes a Web IDL `true`. But, a JavaScript `true` passed in the position of a [Web IDL `unsigned long`](http://heycam.github.io/webidl/#idl-unsigned-long) becomes a Web IDL `1`. And so on.\n\nFinally, we have the actual implementation code. This is usually C++, although these days [some smart people are using Rust](https://github.com/servo/servo). The implementation, of course, has its own type system. So when they implement the Web IDL algorithms, they don't actually use Web IDL values, since those aren't \"real\" outside of specs. Instead, implementations apply the Web IDL binding rules in such a way as to convert incoming JavaScript values into C++ values. For example, if code in the browser called `doStuff(true, true)`, then the implementation code would eventually receive a C++ `bool` containing `true` and a C++ `uint32_t` containing `1`.\n\nThe upside of all this is that implementations can abstract all the conversion logic away, letting Web IDL handle it, and focus on implementing the relevant methods in C++ with values of the correct type already provided. That is payoff of Web IDL, in a nutshell.\n\nAnd getting to that payoff is the goal of _this_ project—but for JavaScript implementations, instead of C++ ones. That is, this library is designed to make it easier for JavaScript developers to write functions that behave like a given Web IDL operation. So conceptually, the conversion pipeline, which in its general form is JavaScript values ↦ Web IDL values ↦ implementation-language values, in this case becomes JavaScript values ↦ Web IDL values ↦ JavaScript values. And that intermediate step is where all the logic is performed: a JavaScript `true` becomes a Web IDL `1` in an unsigned long context, which then becomes a JavaScript `1`.\n\n## Don't use this\n\nSeriously, why would you ever use this? You really shouldn't. Web IDL is … strange, and you shouldn't be emulating its semantics. If you're looking for a generic argument-processing library, you should find one with better rules than those from Web IDL. In general, your JavaScript should not be trying to become more like Web IDL; if anything, we should fix Web IDL to make it more like JavaScript.\n\nThe _only_ people who should use this are those trying to create faithful implementations (or polyfills) of web platform interfaces defined in Web IDL. Its main consumer is the [jsdom](https://github.com/tmpvar/jsdom) project.\n# graceful-fs\n\ngraceful-fs functions as a drop-in replacement for the fs module,\nmaking various improvements.\n\nThe improvements are meant to normalize behavior across different\nplatforms and environments, and to make filesystem access more\nresilient to errors.\n\n## Improvements over [fs module](https://nodejs.org/api/fs.html)\n\n* Queues up `open` and `readdir` calls, and retries them once\n something closes if there is an EMFILE error from too many file\n descriptors.\n* fixes `lchmod` for Node versions prior to 0.6.2.\n* implements `fs.lutimes` if possible. Otherwise it becomes a noop.\n* ignores `EINVAL` and `EPERM` errors in `chown`, `fchown` or\n `lchown` if the user isn't root.\n* makes `lchmod` and `lchown` become noops, if not available.\n* retries reading a file if `read` results in EAGAIN error.\n\nOn Windows, it retries renaming a file for up to one second if `EACCESS`\nor `EPERM` error occurs, likely because antivirus software has locked\nthe directory.\n\n## USAGE\n\n```javascript\n// use just like fs\nvar fs = require('graceful-fs')\n\n// now go and do stuff with it...\nfs.readFileSync('some-file-or-whatever')\n```\n\n## Global Patching\n\nIf you want to patch the global fs module (or any other fs-like\nmodule) you can do this:\n\n```javascript\n// Make sure to read the caveat below.\nvar realFs = require('fs')\nvar gracefulFs = require('graceful-fs')\ngracefulFs.gracefulify(realFs)\n```\n\nThis should only ever be done at the top-level application layer, in\norder to delay on EMFILE errors from any fs-using dependencies. You\nshould **not** do this in a library, because it can cause unexpected\ndelays in other parts of the program.\n\n## Changes\n\nThis module is fairly stable at this point, and used by a lot of\nthings. That being said, because it implements a subtle behavior\nchange in a core part of the node API, even modest changes can be\nextremely breaking, and the versioning is thus biased towards\nbumping the major when in doubt.\n\nThe main change between major versions has been switching between\nproviding a fully-patched `fs` module vs monkey-patching the node core\nbuiltin, and the approach by which a non-monkey-patched `fs` was\ncreated.\n\nThe goal is to trade `EMFILE` errors for slower fs operations. So, if\nyou try to open a zillion files, rather than crashing, `open`\noperations will be queued up and wait for something else to `close`.\n\nThere are advantages to each approach. Monkey-patching the fs means\nthat no `EMFILE` errors can possibly occur anywhere in your\napplication, because everything is using the same core `fs` module,\nwhich is patched. However, it can also obviously cause undesirable\nside-effects, especially if the module is loaded multiple times.\n\nImplementing a separate-but-identical patched `fs` module is more\nsurgical (and doesn't run the risk of patching multiple times), but\nalso imposes the challenge of keeping in sync with the core module.\n\nThe current approach loads the `fs` module, and then creates a\nlookalike object that has all the same methods, except a few that are\npatched. It is safe to use in all versions of Node from 0.8 through\n7.0.\n\n### v4\n\n* Do not monkey-patch the fs module. This module may now be used as a\n drop-in dep, and users can opt into monkey-patching the fs builtin\n if their app requires it.\n\n### v3\n\n* Monkey-patch fs, because the eval approach no longer works on recent\n node.\n* fixed possible type-error throw if rename fails on windows\n* verify that we *never* get EMFILE errors\n* Ignore ENOSYS from chmod/chown\n* clarify that graceful-fs must be used as a drop-in\n\n### v2.1.0\n\n* Use eval rather than monkey-patching fs.\n* readdir: Always sort the results\n* win32: requeue a file if error has an OK status\n\n### v2.0\n\n* A return to monkey patching\n* wrap process.cwd\n\n### v1.1\n\n* wrap readFile\n* Wrap fs.writeFile.\n* readdir protection\n* Don't clobber the fs builtin\n* Handle fs.read EAGAIN errors by trying again\n* Expose the curOpen counter\n* No-op lchown/lchmod if not implemented\n* fs.rename patch only for win32\n* Patch fs.rename to handle AV software on Windows\n* Close #4 Chown should not fail on einval or eperm if non-root\n* Fix isaacs/fstream#1 Only wrap fs one time\n* Fix #3 Start at 1024 max files, then back off on EMFILE\n* lutimes that doens't blow up on Linux\n* A full on-rewrite using a queue instead of just swallowing the EMFILE error\n* Wrap Read/Write streams as well\n\n### 1.0\n\n* Update engines for node 0.6\n* Be lstat-graceful on Windows\n* first\n# minipass\n\nA _very_ minimal implementation of a [PassThrough\nstream](https://nodejs.org/api/stream.html#stream_class_stream_passthrough)\n\n[It's very\nfast](https://docs.google.com/spreadsheets/d/1oObKSrVwLX_7Ut4Z6g3fZW-AX1j1-k6w-cDsrkaSbHM/edit#gid=0)\nfor objects, strings, and buffers.\n\nSupports pipe()ing (including multi-pipe() and backpressure transmission),\nbuffering data until either a `data` event handler or `pipe()` is added (so\nyou don't lose the first chunk), and most other cases where PassThrough is\na good idea.\n\nThere is a `read()` method, but it's much more efficient to consume data\nfrom this stream via `'data'` events or by calling `pipe()` into some other\nstream. Calling `read()` requires the buffer to be flattened in some\ncases, which requires copying memory.\n\nThere is also no `unpipe()` method. Once you start piping, there is no\nstopping it!\n\nIf you set `objectMode: true` in the options, then whatever is written will\nbe emitted. Otherwise, it'll do a minimal amount of Buffer copying to\nensure proper Streams semantics when `read(n)` is called.\n\n`objectMode` can also be set by doing `stream.objectMode = true`, or by\nwriting any non-string/non-buffer data. `objectMode` cannot be set to\nfalse once it is set.\n\nThis is not a `through` or `through2` stream. It doesn't transform the\ndata, it just passes it right through. If you want to transform the data,\nextend the class, and override the `write()` method. Once you're done\ntransforming the data however you want, call `super.write()` with the\ntransform output.\n\nFor some examples of streams that extend Minipass in various ways, check\nout:\n\n- [minizlib](http://npm.im/minizlib)\n- [fs-minipass](http://npm.im/fs-minipass)\n- [tar](http://npm.im/tar)\n- [minipass-collect](http://npm.im/minipass-collect)\n- [minipass-flush](http://npm.im/minipass-flush)\n- [minipass-pipeline](http://npm.im/minipass-pipeline)\n- [tap](http://npm.im/tap)\n- [tap-parser](http://npm.im/tap)\n- [treport](http://npm.im/tap)\n- [minipass-fetch](http://npm.im/minipass-fetch)\n- [pacote](http://npm.im/pacote)\n- [make-fetch-happen](http://npm.im/make-fetch-happen)\n- [cacache](http://npm.im/cacache)\n- [ssri](http://npm.im/ssri)\n- [npm-registry-fetch](http://npm.im/npm-registry-fetch)\n- [minipass-json-stream](http://npm.im/minipass-json-stream)\n- [minipass-sized](http://npm.im/minipass-sized)\n\n## Differences from Node.js Streams\n\nThere are several things that make Minipass streams different from (and in\nsome ways superior to) Node.js core streams.\n\nPlease read these caveats if you are familiar with noode-core streams and\nintend to use Minipass streams in your programs.\n\n### Timing\n\nMinipass streams are designed to support synchronous use-cases. Thus, data\nis emitted as soon as it is available, always. It is buffered until read,\nbut no longer. Another way to look at it is that Minipass streams are\nexactly as synchronous as the logic that writes into them.\n\nThis can be surprising if your code relies on `PassThrough.write()` always\nproviding data on the next tick rather than the current one, or being able\nto call `resume()` and not have the entire buffer disappear immediately.\n\nHowever, without this synchronicity guarantee, there would be no way for\nMinipass to achieve the speeds it does, or support the synchronous use\ncases that it does. Simply put, waiting takes time.\n\nThis non-deferring approach makes Minipass streams much easier to reason\nabout, especially in the context of Promises and other flow-control\nmechanisms.\n\n### No High/Low Water Marks\n\nNode.js core streams will optimistically fill up a buffer, returning `true`\non all writes until the limit is hit, even if the data has nowhere to go.\nThen, they will not attempt to draw more data in until the buffer size dips\nbelow a minimum value.\n\nMinipass streams are much simpler. The `write()` method will return `true`\nif the data has somewhere to go (which is to say, given the timing\nguarantees, that the data is already there by the time `write()` returns).\n\nIf the data has nowhere to go, then `write()` returns false, and the data\nsits in a buffer, to be drained out immediately as soon as anyone consumes\nit.\n\n### Hazards of Buffering (or: Why Minipass Is So Fast)\n\nSince data written to a Minipass stream is immediately written all the way\nthrough the pipeline, and `write()` always returns true/false based on\nwhether the data was fully flushed, backpressure is communicated\nimmediately to the upstream caller. This minimizes buffering.\n\nConsider this case:\n\n```js\nconst {PassThrough} = require('stream')\nconst p1 = new PassThrough({ highWaterMark: 1024 })\nconst p2 = new PassThrough({ highWaterMark: 1024 })\nconst p3 = new PassThrough({ highWaterMark: 1024 })\nconst p4 = new PassThrough({ highWaterMark: 1024 })\n\np1.pipe(p2).pipe(p3).pipe(p4)\np4.on('data', () => console.log('made it through'))\n\n// this returns false and buffers, then writes to p2 on next tick (1)\n// p2 returns false and buffers, pausing p1, then writes to p3 on next tick (2)\n// p3 returns false and buffers, pausing p2, then writes to p4 on next tick (3)\n// p4 returns false and buffers, pausing p3, then emits 'data' and 'drain'\n// on next tick (4)\n// p3 sees p4's 'drain' event, and calls resume(), emitting 'resume' and\n// 'drain' on next tick (5)\n// p2 sees p3's 'drain', calls resume(), emits 'resume' and 'drain' on next tick (6)\n// p1 sees p2's 'drain', calls resume(), emits 'resume' and 'drain' on next\n// tick (7)\n\np1.write(Buffer.alloc(2048)) // returns false\n```\n\nAlong the way, the data was buffered and deferred at each stage, and\nmultiple event deferrals happened, for an unblocked pipeline where it was\nperfectly safe to write all the way through!\n\nFurthermore, setting a `highWaterMark` of `1024` might lead someone reading\nthe code to think an advisory maximum of 1KiB is being set for the\npipeline. However, the actual advisory buffering level is the _sum_ of\n`highWaterMark` values, since each one has its own bucket.\n\nConsider the Minipass case:\n\n```js\nconst m1 = new Minipass()\nconst m2 = new Minipass()\nconst m3 = new Minipass()\nconst m4 = new Minipass()\n\nm1.pipe(m2).pipe(m3).pipe(m4)\nm4.on('data', () => console.log('made it through'))\n\n// m1 is flowing, so it writes the data to m2 immediately\n// m2 is flowing, so it writes the data to m3 immediately\n// m3 is flowing, so it writes the data to m4 immediately\n// m4 is flowing, so it fires the 'data' event immediately, returns true\n// m4's write returned true, so m3 is still flowing, returns true\n// m3's write returned true, so m2 is still flowing, returns true\n// m2's write returned true, so m1 is still flowing, returns true\n// No event deferrals or buffering along the way!\n\nm1.write(Buffer.alloc(2048)) // returns true\n```\n\nIt is extremely unlikely that you _don't_ want to buffer any data written,\nor _ever_ buffer data that can be flushed all the way through. Neither\nnode-core streams nor Minipass ever fail to buffer written data, but\nnode-core streams do a lot of unnecessary buffering and pausing.\n\nAs always, the faster implementation is the one that does less stuff and\nwaits less time to do it.\n\n### Immediately emit `end` for empty streams (when not paused)\n\nIf a stream is not paused, and `end()` is called before writing any data\ninto it, then it will emit `end` immediately.\n\nIf you have logic that occurs on the `end` event which you don't want to\npotentially happen immediately (for example, closing file descriptors,\nmoving on to the next entry in an archive parse stream, etc.) then be sure\nto call `stream.pause()` on creation, and then `stream.resume()` once you\nare ready to respond to the `end` event.\n\n### Emit `end` When Asked\n\nOne hazard of immediately emitting `'end'` is that you may not yet have had\na chance to add a listener. In order to avoid this hazard, Minipass\nstreams safely re-emit the `'end'` event if a new listener is added after\n`'end'` has been emitted.\n\nIe, if you do `stream.on('end', someFunction)`, and the stream has already\nemitted `end`, then it will call the handler right away. (You can think of\nthis somewhat like attaching a new `.then(fn)` to a previously-resolved\nPromise.)\n\nTo prevent calling handlers multiple times who would not expect multiple\nends to occur, all listeners are removed from the `'end'` event whenever it\nis emitted.\n\n### Impact of \"immediate flow\" on Tee-streams\n\nA \"tee stream\" is a stream piping to multiple destinations:\n\n```js\nconst tee = new Minipass()\nt.pipe(dest1)\nt.pipe(dest2)\nt.write('foo') // goes to both destinations\n```\n\nSince Minipass streams _immediately_ process any pending data through the\npipeline when a new pipe destination is added, this can have surprising\neffects, especially when a stream comes in from some other function and may\nor may not have data in its buffer.\n\n```js\n// WARNING! WILL LOSE DATA!\nconst src = new Minipass()\nsrc.write('foo')\nsrc.pipe(dest1) // 'foo' chunk flows to dest1 immediately, and is gone\nsrc.pipe(dest2) // gets nothing!\n```\n\nThe solution is to create a dedicated tee-stream junction that pipes to\nboth locations, and then pipe to _that_ instead.\n\n```js\n// Safe example: tee to both places\nconst src = new Minipass()\nsrc.write('foo')\nconst tee = new Minipass()\ntee.pipe(dest1)\ntee.pipe(dest2)\nsrc.pipe(tee) // tee gets 'foo', pipes to both locations\n```\n\nThe same caveat applies to `on('data')` event listeners. The first one\nadded will _immediately_ receive all of the data, leaving nothing for the\nsecond:\n\n```js\n// WARNING! WILL LOSE DATA!\nconst src = new Minipass()\nsrc.write('foo')\nsrc.on('data', handler1) // receives 'foo' right away\nsrc.on('data', handler2) // nothing to see here!\n```\n\nUsing a dedicated tee-stream can be used in this case as well:\n\n```js\n// Safe example: tee to both data handlers\nconst src = new Minipass()\nsrc.write('foo')\nconst tee = new Minipass()\ntee.on('data', handler1)\ntee.on('data', handler2)\nsrc.pipe(tee)\n```\n\n## USAGE\n\nIt's a stream! Use it like a stream and it'll most likely do what you\nwant.\n\n```js\nconst Minipass = require('minipass')\nconst mp = new Minipass(options) // optional: { encoding, objectMode }\nmp.write('foo')\nmp.pipe(someOtherStream)\nmp.end('bar')\n```\n\n### OPTIONS\n\n* `encoding` How would you like the data coming _out_ of the stream to be\n encoded? Accepts any values that can be passed to `Buffer.toString()`.\n* `objectMode` Emit data exactly as it comes in. This will be flipped on\n by default if you write() something other than a string or Buffer at any\n point. Setting `objectMode: true` will prevent setting any encoding\n value.\n\n### API\n\nImplements the user-facing portions of Node.js's `Readable` and `Writable`\nstreams.\n\n### Methods\n\n* `write(chunk, [encoding], [callback])` - Put data in. (Note that, in the\n base Minipass class, the same data will come out.) Returns `false` if\n the stream will buffer the next write, or true if it's still in \"flowing\"\n mode.\n* `end([chunk, [encoding]], [callback])` - Signal that you have no more\n data to write. This will queue an `end` event to be fired when all the\n data has been consumed.\n* `setEncoding(encoding)` - Set the encoding for data coming of the stream.\n This can only be done once.\n* `pause()` - No more data for a while, please. This also prevents `end`\n from being emitted for empty streams until the stream is resumed.\n* `resume()` - Resume the stream. If there's data in the buffer, it is all\n discarded. Any buffered events are immediately emitted.\n* `pipe(dest)` - Send all output to the stream provided. There is no way\n to unpipe. When data is emitted, it is immediately written to any and\n all pipe destinations.\n* `on(ev, fn)`, `emit(ev, fn)` - Minipass streams are EventEmitters. Some\n events are given special treatment, however. (See below under \"events\".)\n* `promise()` - Returns a Promise that resolves when the stream emits\n `end`, or rejects if the stream emits `error`.\n* `collect()` - Return a Promise that resolves on `end` with an array\n containing each chunk of data that was emitted, or rejects if the stream\n emits `error`. Note that this consumes the stream data.\n* `concat()` - Same as `collect()`, but concatenates the data into a single\n Buffer object. Will reject the returned promise if the stream is in\n objectMode, or if it goes into objectMode by the end of the data.\n* `read(n)` - Consume `n` bytes of data out of the buffer. If `n` is not\n provided, then consume all of it. If `n` bytes are not available, then\n it returns null. **Note** consuming streams in this way is less\n efficient, and can lead to unnecessary Buffer copying.\n* `destroy([er])` - Destroy the stream. If an error is provided, then an\n `'error'` event is emitted. If the stream has a `close()` method, and\n has not emitted a `'close'` event yet, then `stream.close()` will be\n called. Any Promises returned by `.promise()`, `.collect()` or\n `.concat()` will be rejected. After being destroyed, writing to the\n stream will emit an error. No more data will be emitted if the stream is\n destroyed, even if it was previously buffered.\n\n### Properties\n\n* `bufferLength` Read-only. Total number of bytes buffered, or in the case\n of objectMode, the total number of objects.\n* `encoding` The encoding that has been set. (Setting this is equivalent\n to calling `setEncoding(enc)` and has the same prohibition against\n setting multiple times.)\n* `flowing` Read-only. Boolean indicating whether a chunk written to the\n stream will be immediately emitted.\n* `emittedEnd` Read-only. Boolean indicating whether the end-ish events\n (ie, `end`, `prefinish`, `finish`) have been emitted. Note that\n listening on any end-ish event will immediateyl re-emit it if it has\n already been emitted.\n* `writable` Whether the stream is writable. Default `true`. Set to\n `false` when `end()`\n* `readable` Whether the stream is readable. Default `true`.\n* `buffer` A [yallist](http://npm.im/yallist) linked list of chunks written\n to the stream that have not yet been emitted. (It's probably a bad idea\n to mess with this.)\n* `pipes` A [yallist](http://npm.im/yallist) linked list of streams that\n this stream is piping into. (It's probably a bad idea to mess with\n this.)\n* `destroyed` A getter that indicates whether the stream was destroyed.\n* `paused` True if the stream has been explicitly paused, otherwise false.\n* `objectMode` Indicates whether the stream is in `objectMode`. Once set\n to `true`, it cannot be set to `false`.\n\n### Events\n\n* `data` Emitted when there's data to read. Argument is the data to read.\n This is never emitted while not flowing. If a listener is attached, that\n will resume the stream.\n* `end` Emitted when there's no more data to read. This will be emitted\n immediately for empty streams when `end()` is called. If a listener is\n attached, and `end` was already emitted, then it will be emitted again.\n All listeners are removed when `end` is emitted.\n* `prefinish` An end-ish event that follows the same logic as `end` and is\n emitted in the same conditions where `end` is emitted. Emitted after\n `'end'`.\n* `finish` An end-ish event that follows the same logic as `end` and is\n emitted in the same conditions where `end` is emitted. Emitted after\n `'prefinish'`.\n* `close` An indication that an underlying resource has been released.\n Minipass does not emit this event, but will defer it until after `end`\n has been emitted, since it throws off some stream libraries otherwise.\n* `drain` Emitted when the internal buffer empties, and it is again\n suitable to `write()` into the stream.\n* `readable` Emitted when data is buffered and ready to be read by a\n consumer.\n* `resume` Emitted when stream changes state from buffering to flowing\n mode. (Ie, when `resume` is called, `pipe` is called, or a `data` event\n listener is added.)\n\n### Static Methods\n\n* `Minipass.isStream(stream)` Returns `true` if the argument is a stream,\n and false otherwise. To be considered a stream, the object must be\n either an instance of Minipass, or an EventEmitter that has either a\n `pipe()` method, or both `write()` and `end()` methods. (Pretty much any\n stream in node-land will return `true` for this.)\n\n## EXAMPLES\n\nHere are some examples of things you can do with Minipass streams.\n\n### simple \"are you done yet\" promise\n\n```js\nmp.promise().then(() => {\n // stream is finished\n}, er => {\n // stream emitted an error\n})\n```\n\n### collecting\n\n```js\nmp.collect().then(all => {\n // all is an array of all the data emitted\n // encoding is supported in this case, so\n // so the result will be a collection of strings if\n // an encoding is specified, or buffers/objects if not.\n //\n // In an async function, you may do\n // const data = await stream.collect()\n})\n```\n\n### collecting into a single blob\n\nThis is a bit slower because it concatenates the data into one chunk for\nyou, but if you're going to do it yourself anyway, it's convenient this\nway:\n\n```js\nmp.concat().then(onebigchunk => {\n // onebigchunk is a string if the stream\n // had an encoding set, or a buffer otherwise.\n})\n```\n\n### iteration\n\nYou can iterate over streams synchronously or asynchronously in platforms\nthat support it.\n\nSynchronous iteration will end when the currently available data is\nconsumed, even if the `end` event has not been reached. In string and\nbuffer mode, the data is concatenated, so unless multiple writes are\noccurring in the same tick as the `read()`, sync iteration loops will\ngenerally only have a single iteration.\n\nTo consume chunks in this way exactly as they have been written, with no\nflattening, create the stream with the `{ objectMode: true }` option.\n\n```js\nconst mp = new Minipass({ objectMode: true })\nmp.write('a')\nmp.write('b')\nfor (let letter of mp) {\n console.log(letter) // a, b\n}\nmp.write('c')\nmp.write('d')\nfor (let letter of mp) {\n console.log(letter) // c, d\n}\nmp.write('e')\nmp.end()\nfor (let letter of mp) {\n console.log(letter) // e\n}\nfor (let letter of mp) {\n console.log(letter) // nothing\n}\n```\n\nAsynchronous iteration will continue until the end event is reached,\nconsuming all of the data.\n\n```js\nconst mp = new Minipass({ encoding: 'utf8' })\n\n// some source of some data\nlet i = 5\nconst inter = setInterval(() => {\n if (i --> 0)\n mp.write(Buffer.from('foo\\n', 'utf8'))\n else {\n mp.end()\n clearInterval(inter)\n }\n}, 100)\n\n// consume the data with asynchronous iteration\nasync function consume () {\n for await (let chunk of mp) {\n console.log(chunk)\n }\n return 'ok'\n}\n\nconsume().then(res => console.log(res))\n// logs `foo\\n` 5 times, and then `ok`\n```\n\n### subclass that `console.log()`s everything written into it\n\n```js\nclass Logger extends Minipass {\n write (chunk, encoding, callback) {\n console.log('WRITE', chunk, encoding)\n return super.write(chunk, encoding, callback)\n }\n end (chunk, encoding, callback) {\n console.log('END', chunk, encoding)\n return super.end(chunk, encoding, callback)\n }\n}\n\nsomeSource.pipe(new Logger()).pipe(someDest)\n```\n\n### same thing, but using an inline anonymous class\n\n```js\n// js classes are fun\nsomeSource\n .pipe(new (class extends Minipass {\n emit (ev, ...data) {\n // let's also log events, because debugging some weird thing\n console.log('EMIT', ev)\n return super.emit(ev, ...data)\n }\n write (chunk, encoding, callback) {\n console.log('WRITE', chunk, encoding)\n return super.write(chunk, encoding, callback)\n }\n end (chunk, encoding, callback) {\n console.log('END', chunk, encoding)\n return super.end(chunk, encoding, callback)\n }\n }))\n .pipe(someDest)\n```\n\n### subclass that defers 'end' for some reason\n\n```js\nclass SlowEnd extends Minipass {\n emit (ev, ...args) {\n if (ev === 'end') {\n console.log('going to end, hold on a sec')\n setTimeout(() => {\n console.log('ok, ready to end now')\n super.emit('end', ...args)\n }, 100)\n } else {\n return super.emit(ev, ...args)\n }\n }\n}\n```\n\n### transform that creates newline-delimited JSON\n\n```js\nclass NDJSONEncode extends Minipass {\n write (obj, cb) {\n try {\n // JSON.stringify can throw, emit an error on that\n return super.write(JSON.stringify(obj) + '\\n', 'utf8', cb)\n } catch (er) {\n this.emit('error', er)\n }\n }\n end (obj, cb) {\n if (typeof obj === 'function') {\n cb = obj\n obj = undefined\n }\n if (obj !== undefined) {\n this.write(obj)\n }\n return super.end(cb)\n }\n}\n```\n\n### transform that parses newline-delimited JSON\n\n```js\nclass NDJSONDecode extends Minipass {\n constructor (options) {\n // always be in object mode, as far as Minipass is concerned\n super({ objectMode: true })\n this._jsonBuffer = ''\n }\n write (chunk, encoding, cb) {\n if (typeof chunk === 'string' &&\n typeof encoding === 'string' &&\n encoding !== 'utf8') {\n chunk = Buffer.from(chunk, encoding).toString()\n } else if (Buffer.isBuffer(chunk))\n chunk = chunk.toString()\n }\n if (typeof encoding === 'function') {\n cb = encoding\n }\n const jsonData = (this._jsonBuffer + chunk).split('\\n')\n this._jsonBuffer = jsonData.pop()\n for (let i = 0; i < jsonData.length; i++) {\n let parsed\n try {\n super.write(parsed)\n } catch (er) {\n this.emit('error', er)\n continue\n }\n }\n if (cb)\n cb()\n }\n}\n```\n# define-property [](https://www.npmjs.com/package/define-property) [](https://npmjs.org/package/define-property) [](https://npmjs.org/package/define-property) [](https://travis-ci.org/jonschlinkert/define-property)\n\n> Define a non-enumerable property on an object.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save define-property\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add define-property\n```\n\n## Usage\n\n**Params**\n\n* `obj`: The object on which to define the property.\n* `prop`: The name of the property to be defined or modified.\n* `descriptor`: The descriptor for the property being defined or modified.\n\n```js\nvar define = require('define-property');\nvar obj = {};\ndefine(obj, 'foo', function(val) {\n return val.toUpperCase();\n});\n\nconsole.log(obj);\n//=> {}\n\nconsole.log(obj.foo('bar'));\n//=> 'BAR'\n```\n\n**get/set**\n\n```js\ndefine(obj, 'foo', {\n get: function() {},\n set: function() {}\n});\n```\n\n## About\n\n### Related projects\n\n* [assign-deep](https://www.npmjs.com/package/assign-deep): Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… [more](https://github.com/jonschlinkert/assign-deep) | [homepage](https://github.com/jonschlinkert/assign-deep \"Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target (first) object.\")\n* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow \"Extend an object with the properties of additional objects. node.js/javascript util.\")\n* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep \"Recursively merge values in a javascript object.\")\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep \"Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 20, 2017._\n<h1 align=\"center\">\n\t<img width=\"250\" src=\"https://rawgit.com/lukechilds/keyv/master/media/logo.svg\" alt=\"keyv\">\n\t<br>\n\t<br>\n</h1>\n\n> Simple key-value storage with support for multiple backends\n\n[](https://travis-ci.org/lukechilds/keyv)\n[](https://coveralls.io/github/lukechilds/keyv?branch=master)\n[](https://www.npmjs.com/package/keyv)\n[](https://www.npmjs.com/package/keyv)\n\nKeyv provides a consistent interface for key-value storage across multiple backends via storage adapters. It supports TTL based expiry, making it suitable as a cache or a persistent key-value store.\n\n## Features\n\nThere are a few existing modules similar to Keyv, however Keyv is different because it:\n\n- Isn't bloated\n- Has a simple Promise based API\n- Suitable as a TTL based cache or persistent key-value store\n- [Easily embeddable](#add-cache-support-to-your-module) inside another module\n- Works with any storage that implements the [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) API\n- Handles all JSON types plus `Buffer`\n- Supports namespaces\n- Wide range of [**efficient, well tested**](#official-storage-adapters) storage adapters\n- Connection errors are passed through (db failures won't kill your app)\n- Supports the current active LTS version of Node.js or higher\n\n## Usage\n\nInstall Keyv.\n\n```\nnpm install --save keyv\n```\n\nBy default everything is stored in memory, you can optionally also install a storage adapter.\n\n```\nnpm install --save @keyv/redis\nnpm install --save @keyv/mongo\nnpm install --save @keyv/sqlite\nnpm install --save @keyv/postgres\nnpm install --save @keyv/mysql\n```\n\nCreate a new Keyv instance, passing your connection string if applicable. Keyv will automatically load the correct storage adapter.\n\n```js\nconst Keyv = require('keyv');\n\n// One of the following\nconst keyv = new Keyv();\nconst keyv = new Keyv('redis://user:pass@localhost:6379');\nconst keyv = new Keyv('mongodb://user:pass@localhost:27017/dbname');\nconst keyv = new Keyv('sqlite://path/to/database.sqlite');\nconst keyv = new Keyv('postgresql://user:pass@localhost:5432/dbname');\nconst keyv = new Keyv('mysql://user:pass@localhost:3306/dbname');\n\n// Handle DB connection errors\nkeyv.on('error', err => console.log('Connection Error', err));\n\nawait keyv.set('foo', 'expires in 1 second', 1000); // true\nawait keyv.set('foo', 'never expires'); // true\nawait keyv.get('foo'); // 'never expires'\nawait keyv.delete('foo'); // true\nawait keyv.clear(); // undefined\n```\n\n### Namespaces\n\nYou can namespace your Keyv instance to avoid key collisions and allow you to clear only a certain namespace while using the same database.\n\n```js\nconst users = new Keyv('redis://user:pass@localhost:6379', { namespace: 'users' });\nconst cache = new Keyv('redis://user:pass@localhost:6379', { namespace: 'cache' });\n\nawait users.set('foo', 'users'); // true\nawait cache.set('foo', 'cache'); // true\nawait users.get('foo'); // 'users'\nawait cache.get('foo'); // 'cache'\nawait users.clear(); // undefined\nawait users.get('foo'); // undefined\nawait cache.get('foo'); // 'cache'\n```\n\n### Custom Serializers\n\nKeyv uses [`json-buffer`](https://github.com/dominictarr/json-buffer) for data serialization to ensure consistency across different backends.\n\nYou can optionally provide your own serialization functions to support extra data types or to serialize to something other than JSON.\n\n```js\nconst keyv = new Keyv({ serialize: JSON.stringify, deserialize: JSON.parse });\n```\n\n**Warning:** Using custom serializers means you lose any guarantee of data consistency. You should do extensive testing with your serialisation functions and chosen storage engine.\n\n## Official Storage Adapters\n\nThe official storage adapters are covered by [over 150 integration tests](https://travis-ci.org/lukechilds/keyv/jobs/260418145) to guarantee consistent behaviour. They are lightweight, efficient wrappers over the DB clients making use of indexes and native TTLs where available.\n\nDatabase | Adapter | Native TTL | Status\n---|---|---|---\nRedis | [@keyv/redis](https://github.com/lukechilds/keyv-redis) | Yes | [](https://travis-ci.org/lukechilds/keyv-redis) [](https://coveralls.io/github/lukechilds/keyv-redis?branch=master)\nMongoDB | [@keyv/mongo](https://github.com/lukechilds/keyv-mongo) | Yes | [](https://travis-ci.org/lukechilds/keyv-mongo) [](https://coveralls.io/github/lukechilds/keyv-mongo?branch=master)\nSQLite | [@keyv/sqlite](https://github.com/lukechilds/keyv-sqlite) | No | [](https://travis-ci.org/lukechilds/keyv-sqlite) [](https://coveralls.io/github/lukechilds/keyv-sqlite?branch=master)\nPostgreSQL | [@keyv/postgres](https://github.com/lukechilds/keyv-postgres) | No | [](https://travis-ci.org/lukechildskeyv-postgreskeyv) [](https://coveralls.io/github/lukechilds/keyv-postgres?branch=master)\nMySQL | [@keyv/mysql](https://github.com/lukechilds/keyv-mysql) | No | [](https://travis-ci.org/lukechilds/keyv-mysql) [](https://coveralls.io/github/lukechilds/keyv-mysql?branch=master)\n\n## Third-party Storage Adapters\n\nYou can also use third-party storage adapters or build your own. Keyv will wrap these storage adapters in TTL functionality and handle complex types internally.\n\n```js\nconst Keyv = require('keyv');\nconst myAdapter = require('./my-storage-adapter');\n\nconst keyv = new Keyv({ store: myAdapter });\n```\n\nAny store that follows the [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) api will work.\n\n```js\nnew Keyv({ store: new Map() });\n```\n\nFor example, [`quick-lru`](https://github.com/sindresorhus/quick-lru) is a completely unrelated module that implements the Map API.\n\n```js\nconst Keyv = require('keyv');\nconst QuickLRU = require('quick-lru');\n\nconst lru = new QuickLRU({ maxSize: 1000 });\nconst keyv = new Keyv({ store: lru });\n```\n\nThe following are third-party storage adapters compatible with Keyv:\n\n- [quick-lru](https://github.com/sindresorhus/quick-lru) - Simple \"Least Recently Used\" (LRU) cache\n- [keyv-file](https://github.com/zaaack/keyv-file) - File system storage adapter for Keyv\n- [keyv-dynamodb](https://www.npmjs.com/package/keyv-dynamodb) - DynamoDB storage adapter for Keyv\n\n## Add Cache Support to your Module\n\nKeyv is designed to be easily embedded into other modules to add cache support. The recommended pattern is to expose a `cache` option in your modules options which is passed through to Keyv. Caching will work in memory by default and users have the option to also install a Keyv storage adapter and pass in a connection string, or any other storage that implements the `Map` API.\n\nYou should also set a namespace for your module so you can safely call `.clear()` without clearing unrelated app data.\n\nInside your module:\n\n```js\nclass AwesomeModule {\n\tconstructor(opts) {\n\t\tthis.cache = new Keyv({\n\t\t\turi: typeof opts.cache === 'string' && opts.cache,\n\t\t\tstore: typeof opts.cache !== 'string' && opts.cache,\n\t\t\tnamespace: 'awesome-module'\n\t\t});\n\t}\n}\n```\n\nNow it can be consumed like this:\n\n```js\nconst AwesomeModule = require('awesome-module');\n\n// Caches stuff in memory by default\nconst awesomeModule = new AwesomeModule();\n\n// After npm install --save keyv-redis\nconst awesomeModule = new AwesomeModule({ cache: 'redis://localhost' });\n\n// Some third-party module that implements the Map API\nconst awesomeModule = new AwesomeModule({ cache: some3rdPartyStore });\n```\n\n## API\n\n### new Keyv([uri], [options])\n\nReturns a new Keyv instance.\n\nThe Keyv instance is also an `EventEmitter` that will emit an `'error'` event if the storage adapter connection fails.\n\n### uri\n\nType: `String`<br>\nDefault: `undefined`\n\nThe connection string URI.\n\nMerged into the options object as options.uri.\n\n### options\n\nType: `Object`\n\nThe options object is also passed through to the storage adapter. Check your storage adapter docs for any extra options.\n\n#### options.namespace\n\nType: `String`<br>\nDefault: `'keyv'`\n\nNamespace for the current instance.\n\n#### options.ttl\n\nType: `Number`<br>\nDefault: `undefined`\n\nDefault TTL. Can be overridden by specififying a TTL on `.set()`.\n\n#### options.serialize\n\nType: `Function`<br>\nDefault: `JSONB.stringify`\n\nA custom serialization function.\n\n#### options.deserialize\n\nType: `Function`<br>\nDefault: `JSONB.parse`\n\nA custom deserialization function.\n\n#### options.store\n\nType: `Storage adapter instance`<br>\nDefault: `new Map()`\n\nThe storage adapter instance to be used by Keyv.\n\n#### options.adapter\n\nType: `String`<br>\nDefault: `undefined`\n\nSpecify an adapter to use. e.g `'redis'` or `'mongodb'`.\n\n### Instance\n\nKeys must always be strings. Values can be of any type.\n\n#### .set(key, value, [ttl])\n\nSet a value.\n\nBy default keys are persistent. You can set an expiry TTL in milliseconds.\n\nReturns `true`.\n\n#### .get(key)\n\nReturns the value.\n\n#### .delete(key)\n\nDeletes an entry.\n\nReturns `true` if the key existed, `false` if not.\n\n#### .clear()\n\nDelete all entries in the current namespace.\n\nReturns `undefined`.\n\n## License\n\nMIT © Luke Childs\n# kind-of [](https://www.npmjs.com/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://travis-ci.org/jonschlinkert/kind-of)\n\n> Get the native type of a value.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save kind-of\n```\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install kind-of --save\n```\n\n## Why use this?\n\n1. [it's fast](#benchmarks) | [optimizations](#optimizations)\n2. [better type checking](#better-type-checking)\n\n## Usage\n\n> es5, browser and es6 ready\n\n```js\nvar kindOf = require('kind-of');\n\nkindOf(undefined);\n//=> 'undefined'\n\nkindOf(null);\n//=> 'null'\n\nkindOf(true);\n//=> 'boolean'\n\nkindOf(false);\n//=> 'boolean'\n\nkindOf(new Boolean(true));\n//=> 'boolean'\n\nkindOf(new Buffer(''));\n//=> 'buffer'\n\nkindOf(42);\n//=> 'number'\n\nkindOf(new Number(42));\n//=> 'number'\n\nkindOf('str');\n//=> 'string'\n\nkindOf(new String('str'));\n//=> 'string'\n\nkindOf(arguments);\n//=> 'arguments'\n\nkindOf({});\n//=> 'object'\n\nkindOf(Object.create(null));\n//=> 'object'\n\nkindOf(new Test());\n//=> 'object'\n\nkindOf(new Date());\n//=> 'date'\n\nkindOf([]);\n//=> 'array'\n\nkindOf([1, 2, 3]);\n//=> 'array'\n\nkindOf(new Array());\n//=> 'array'\n\nkindOf(/foo/);\n//=> 'regexp'\n\nkindOf(new RegExp('foo'));\n//=> 'regexp'\n\nkindOf(function () {});\n//=> 'function'\n\nkindOf(function * () {});\n//=> 'function'\n\nkindOf(new Function());\n//=> 'function'\n\nkindOf(new Map());\n//=> 'map'\n\nkindOf(new WeakMap());\n//=> 'weakmap'\n\nkindOf(new Set());\n//=> 'set'\n\nkindOf(new WeakSet());\n//=> 'weakset'\n\nkindOf(Symbol('str'));\n//=> 'symbol'\n\nkindOf(new Int8Array());\n//=> 'int8array'\n\nkindOf(new Uint8Array());\n//=> 'uint8array'\n\nkindOf(new Uint8ClampedArray());\n//=> 'uint8clampedarray'\n\nkindOf(new Int16Array());\n//=> 'int16array'\n\nkindOf(new Uint16Array());\n//=> 'uint16array'\n\nkindOf(new Int32Array());\n//=> 'int32array'\n\nkindOf(new Uint32Array());\n//=> 'uint32array'\n\nkindOf(new Float32Array());\n//=> 'float32array'\n\nkindOf(new Float64Array());\n//=> 'float64array'\n```\n\n## Release history\n\n### v4.0.0\n\n**Added**\n\n* `promise` support\n\n### v5.0.0\n\n**Added**\n\n* `Set Iterator` and `Map Iterator` support\n\n**Fixed**\n\n* Now returns `generatorfunction` for generator functions\n\n## Benchmarks\n\nBenchmarked against [typeof](http://github.com/CodingFu/typeof) and [type-of](https://github.com/ForbesLindesay/type-of).\nNote that performaces is slower for es6 features `Map`, `WeakMap`, `Set` and `WeakSet`.\n\n```bash\n#1: array\n current x 23,329,397 ops/sec ±0.82% (94 runs sampled)\n lib-type-of x 4,170,273 ops/sec ±0.55% (94 runs sampled)\n lib-typeof x 9,686,935 ops/sec ±0.59% (98 runs sampled)\n\n#2: boolean\n current x 27,197,115 ops/sec ±0.85% (94 runs sampled)\n lib-type-of x 3,145,791 ops/sec ±0.73% (97 runs sampled)\n lib-typeof x 9,199,562 ops/sec ±0.44% (99 runs sampled)\n\n#3: date\n current x 20,190,117 ops/sec ±0.86% (92 runs sampled)\n lib-type-of x 5,166,970 ops/sec ±0.74% (94 runs sampled)\n lib-typeof x 9,610,821 ops/sec ±0.50% (96 runs sampled)\n\n#4: function\n current x 23,855,460 ops/sec ±0.60% (97 runs sampled)\n lib-type-of x 5,667,740 ops/sec ±0.54% (100 runs sampled)\n lib-typeof x 10,010,644 ops/sec ±0.44% (100 runs sampled)\n\n#5: null\n current x 27,061,047 ops/sec ±0.97% (96 runs sampled)\n lib-type-of x 13,965,573 ops/sec ±0.62% (97 runs sampled)\n lib-typeof x 8,460,194 ops/sec ±0.61% (97 runs sampled)\n\n#6: number\n current x 25,075,682 ops/sec ±0.53% (99 runs sampled)\n lib-type-of x 2,266,405 ops/sec ±0.41% (98 runs sampled)\n lib-typeof x 9,821,481 ops/sec ±0.45% (99 runs sampled)\n\n#7: object\n current x 3,348,980 ops/sec ±0.49% (99 runs sampled)\n lib-type-of x 3,245,138 ops/sec ±0.60% (94 runs sampled)\n lib-typeof x 9,262,952 ops/sec ±0.59% (99 runs sampled)\n\n#8: regex\n current x 21,284,827 ops/sec ±0.72% (96 runs sampled)\n lib-type-of x 4,689,241 ops/sec ±0.43% (100 runs sampled)\n lib-typeof x 8,957,593 ops/sec ±0.62% (98 runs sampled)\n\n#9: string\n current x 25,379,234 ops/sec ±0.58% (96 runs sampled)\n lib-type-of x 3,635,148 ops/sec ±0.76% (93 runs sampled)\n lib-typeof x 9,494,134 ops/sec ±0.49% (98 runs sampled)\n\n#10: undef\n current x 27,459,221 ops/sec ±1.01% (93 runs sampled)\n lib-type-of x 14,360,433 ops/sec ±0.52% (99 runs sampled)\n lib-typeof x 23,202,868 ops/sec ±0.59% (94 runs sampled)\n\n```\n\n## Optimizations\n\nIn 7 out of 8 cases, this library is 2x-10x faster than other top libraries included in the benchmarks. There are a few things that lead to this performance advantage, none of them hard and fast rules, but all of them simple and repeatable in almost any code library:\n\n1. Optimize around the fastest and most common use cases first. Of course, this will change from project-to-project, but I took some time to understand how and why `typeof` checks were being used in my own libraries and other libraries I use a lot.\n2. Optimize around bottlenecks - In other words, the order in which conditionals are implemented is significant, because each check is only as fast as the failing checks that came before it. Here, the biggest bottleneck by far is checking for plain objects (an object that was created by the `Object` constructor). I opted to make this check happen by process of elimination rather than brute force up front (e.g. by using something like `val.constructor.name`), so that every other type check would not be penalized it.\n3. Don't do uneccessary processing - why do `.slice(8, -1).toLowerCase();` just to get the word `regex`? It's much faster to do `if (type === '[object RegExp]') return 'regex'`\n4. There is no reason to make the code in a microlib as terse as possible, just to win points for making it shorter. It's always better to favor performant code over terse code. You will always only be using a single `require()` statement to use the library anyway, regardless of how the code is written.\n\n## Better type checking\n\nkind-of is more correct than other type checking libs I've looked at. For example, here are some differing results from other popular libs:\n\n### [typeof](https://github.com/CodingFu/typeof) lib\n\nIncorrectly tests instances of custom constructors (pretty common):\n\n```js\nvar typeOf = require('typeof');\nfunction Test() {}\nconsole.log(typeOf(new Test()));\n//=> 'test'\n```\n\nReturns `object` instead of `arguments`:\n\n```js\nfunction foo() {\n console.log(typeOf(arguments)) //=> 'object'\n}\nfoo();\n```\n\n### [type-of](https://github.com/ForbesLindesay/type-of) lib\n\nIncorrectly returns `object` for generator functions, buffers, `Map`, `Set`, `WeakMap` and `WeakSet`:\n\n```js\nfunction * foo() {}\nconsole.log(typeOf(foo));\n//=> 'object'\nconsole.log(typeOf(new Buffer('')));\n//=> 'object'\nconsole.log(typeOf(new Map()));\n//=> 'object'\nconsole.log(typeOf(new Set()));\n//=> 'object'\nconsole.log(typeOf(new WeakMap()));\n//=> 'object'\nconsole.log(typeOf(new WeakSet()));\n//=> 'object'\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n<details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n<details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n<details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [is-number](https://www.npmjs.com/package/is-number): Returns true if the value is a number. comprehensive tests. | [homepage](https://github.com/jonschlinkert/is-number \"Returns true if the value is a number. comprehensive tests.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 82 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 3 | [aretecode](https://github.com/aretecode) |\n| 2 | [miguelmota](https://github.com/miguelmota) |\n| 1 | [dtothefp](https://github.com/dtothefp) |\n| 1 | [ksheedlo](https://github.com/ksheedlo) |\n| 1 | [pdehaan](https://github.com/pdehaan) |\n| 1 | [laggingreflex](https://github.com/laggingreflex) |\n| 1 | [charlike](https://github.com/charlike) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 13, 2017._\n# is-descriptor [](https://www.npmjs.com/package/is-descriptor) [](https://npmjs.org/package/is-descriptor) [](https://npmjs.org/package/is-descriptor) [](https://travis-ci.org/jonschlinkert/is-descriptor)\n\n> Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-descriptor\n```\n\n## Usage\n\n```js\nvar isDescriptor = require('is-descriptor');\n\nisDescriptor({value: 'foo'})\n//=> true\nisDescriptor({get: function(){}, set: function(){}})\n//=> true\nisDescriptor({get: 'foo', set: function(){}})\n//=> false\n```\n\nYou may also check for a descriptor by passing an object as the first argument and property name (`string`) as the second argument.\n\n```js\nvar obj = {};\nobj.foo = 'abc';\n\nObject.defineProperty(obj, 'bar', {\n value: 'xyz'\n});\n\nisDescriptor(obj, 'foo');\n//=> true\nisDescriptor(obj, 'bar');\n//=> true\n```\n\n## Examples\n\n### value type\n\n`false` when not an object\n\n```js\nisDescriptor('a');\n//=> false\nisDescriptor(null);\n//=> false\nisDescriptor([]);\n//=> false\n```\n\n### data descriptor\n\n`true` when the object has valid properties with valid values.\n\n```js\nisDescriptor({value: 'foo'});\n//=> true\nisDescriptor({value: noop});\n//=> true\n```\n\n`false` when the object has invalid properties\n\n```js\nisDescriptor({value: 'foo', bar: 'baz'});\n//=> false\nisDescriptor({value: 'foo', bar: 'baz'});\n//=> false\nisDescriptor({value: 'foo', get: noop});\n//=> false\nisDescriptor({get: noop, value: noop});\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisDescriptor({value: 'foo', enumerable: 'foo'});\n//=> false\nisDescriptor({value: 'foo', configurable: 'foo'});\n//=> false\nisDescriptor({value: 'foo', writable: 'foo'});\n//=> false\n```\n\n### accessor descriptor\n\n`true` when the object has valid properties with valid values.\n\n```js\nisDescriptor({get: noop, set: noop});\n//=> true\nisDescriptor({get: noop});\n//=> true\nisDescriptor({set: noop});\n//=> true\n```\n\n`false` when the object has invalid properties\n\n```js\nisDescriptor({get: noop, set: noop, bar: 'baz'});\n//=> false\nisDescriptor({get: noop, writable: true});\n//=> false\nisDescriptor({get: noop, value: true});\n//=> false\n```\n\n`false` when an accessor is not a function\n\n```js\nisDescriptor({get: noop, set: 'baz'});\n//=> false\nisDescriptor({get: 'foo', set: noop});\n//=> false\nisDescriptor({get: 'foo', bar: 'baz'});\n//=> false\nisDescriptor({get: 'foo', set: 'baz'});\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisDescriptor({get: noop, set: noop, enumerable: 'foo'});\n//=> false\nisDescriptor({set: noop, configurable: 'foo'});\n//=> false\nisDescriptor({get: noop, configurable: 'foo'});\n//=> false\n```\n\n## About\n\n### Related projects\n\n* [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor \"Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\")\n* [is-data-descriptor](https://www.npmjs.com/package/is-data-descriptor): Returns true if a value has the characteristics of a valid JavaScript data descriptor. | [homepage](https://github.com/jonschlinkert/is-data-descriptor \"Returns true if a value has the characteristics of a valid JavaScript data descriptor.\")\n* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor \"Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 24 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 1 | [doowb](https://github.com/doowb) |\n| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 22, 2017._\nnode-asn1 is a library for encoding and decoding ASN.1 datatypes in pure JS.\nCurrently BER encoding is supported; at some point I'll likely have to do DER.\n\n## Usage\n\nMostly, if you're *actually* needing to read and write ASN.1, you probably don't\nneed this readme to explain what and why. If you have no idea what ASN.1 is,\nsee this: ftp://ftp.rsa.com/pub/pkcs/ascii/layman.asc\n\nThe source is pretty much self-explanatory, and has read/write methods for the\ncommon types out there.\n\n### Decoding\n\nThe following reads an ASN.1 sequence with a boolean.\n\n var Ber = require('asn1').Ber;\n\n var reader = new Ber.Reader(Buffer.from([0x30, 0x03, 0x01, 0x01, 0xff]));\n\n reader.readSequence();\n console.log('Sequence len: ' + reader.length);\n if (reader.peek() === Ber.Boolean)\n console.log(reader.readBoolean());\n\n### Encoding\n\nThe following generates the same payload as above.\n\n var Ber = require('asn1').Ber;\n\n var writer = new Ber.Writer();\n\n writer.startSequence();\n writer.writeBoolean(true);\n writer.endSequence();\n\n console.log(writer.buffer);\n\n## Installation\n\n npm install asn1\n\n## License\n\nMIT.\n\n## Bugs\n\nSee <https://github.com/joyent/node-asn1/issues>.\n# UnCSS\n\n[](https://www.npmjs.com/package/uncss)\n[](https://travis-ci.org/uncss/uncss)\n[](https://ci.appveyor.com/project/uncss/uncss/branch/master)\n[](https://coveralls.io/r/uncss/uncss?branch=master)\n[](https://david-dm.org/uncss/uncss)\n[](https://david-dm.org/uncss/uncss?type=dev)\n\nUnCSS is a tool that removes unused CSS from your stylesheets.\nIt works across multiple files and supports Javascript-injected CSS.\n\n## How\n\nThe process by which UnCSS removes the unused rules is as follows:\n\n1. The HTML files are loaded by [jsdom](https://github.com/tmpvar/jsdom) and JavaScript is executed.\n2. All the stylesheets are parsed by [PostCSS](https://github.com/postcss/postcss).\n3. `document.querySelector` filters out selectors that are not found in the HTML files.\n4. The remaining rules are converted back to CSS.\n\n**Please note:**\n\n- UnCSS cannot be run on non-HTML pages, such as templates or PHP files. If you need to run UnCSS against your templates, you should probably generate example HTML pages from your templates, and run uncss on those generated files; or run a live local dev server, and point uncss at that.\n- UnCSS only runs the Javascript that is run on page load. It does not (and cannot) handle Javascript that runs on user interactions like button clicks. You must use the `ignore` option to preserve classes that are added by Javascript on user interaction.\n\n## Installation\n\n```shell\nnpm install -g uncss\n```\n\n## Usage\n\n### Online Server\n\n- [https://uncss-online.com/](https://uncss-online.com/) - Unofficial server, very convenient for testing or one-off usage!\n\n### Within Node.js\n\n```js\nvar uncss = require('uncss');\n\nvar files = ['my', 'array', 'of', 'HTML', 'files', 'or', 'http://urls.com'],\n options = {\n banner : false,\n csspath : '../public/css/',\n htmlroot : 'public',\n ignore : ['#added_at_runtime', /test\\-[0-9]+/],\n ignoreSheets : [/fonts.googleapis/],\n inject : function(window) { window.document.querySelector('html').classList.add('no-csscalc', 'csscalc'); },\n jsdom : {\n userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X)',\n },\n media : ['(min-width: 700px) handheld and (orientation: landscape)'],\n raw : 'h1 { color: green }',\n report : false,\n strictSSL : true,\n stylesheets : ['lib/bootstrap/dist/css/bootstrap.css', 'src/public/css/main.css'],\n timeout : 1000,\n uncssrc : '.uncssrc',\n userAgent : 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X)',\n };\n\nuncss(files, options, function (error, output) {\n console.log(output);\n});\n\n/* Look Ma, no options! */\nuncss(files, function (error, output) {\n console.log(output);\n});\n\n/* Specifying raw HTML */\nvar rawHtml = '...';\n\nuncss(rawHtml, options, function (error, output) {\n console.log(output);\n});\n```\n\n### At build-time\n\nUnCSS can also be used in conjunction with other JavaScript build systems, such as [Grunt](https://github.com/gruntjs/grunt), [Broccoli](https://github.com/broccolijs/broccoli#readme) or [Gulp](https://github.com/gulpjs/gulp)!\n\n- [grunt-uncss](https://github.com/uncss/grunt-uncss) – Thanks to [@addyosmani](https://github.com/addyosmani)\n- [gulp-uncss](https://github.com/ben-eb/gulp-uncss) – Thanks to [@ben-eb](https://github.com/ben-eb)\n- [broccoli-uncss](https://github.com/sindresorhus/broccoli-uncss) - Thanks to [@sindresorhus](https://github.com/sindresorhus)\n\n### From the command line\n\n```txt\nUsage: uncss [options] <file or URL, ...>\n e.g. uncss https://getbootstrap.com/docs/3.3/examples/jumbotron/ > stylesheet.css\n\nOptions:\n\n -h, --help output usage information\n -V, --version output the version number\n -i, --ignore <selector, ...> Do not remove given selectors\n -m, --media <media_query, ...> Process additional media queries\n -C, --csspath <path> Relative path where the CSS files are located\n -s, --stylesheets <file, ...> Specify additional stylesheets to process\n -S, --ignoreSheets <selector, ...> Do not include specified stylesheets\n -r, --raw <string> Pass in a raw string of CSS\n -t, --timeout <milliseconds> Wait for JS evaluation\n -H, --htmlroot <folder> Absolute paths' root location\n -u, --uncssrc <file> Load these options from <file>\n -n, --noBanner Disable banner\n -a, --userAgent <string> Use a custom user agent string\n -I, --inject <file> Path to javascript file to be executed before uncss runs\n -o, --output <file> Path to write resulting CSS to\n```\n\n**Note that you can pass both local file paths (which are processed by [glob](https://github.com/isaacs/node-glob)) and URLs to the program.**\n\n- **banner** (boolean, default: `true`): Whether a banner should be prepended before each file block in the processed CSS.\n\n- **csspath** (string): Path where the CSS files are related to the HTML files. By default, UnCSS uses the path specified in the `<link rel=\"stylesheet\" href=\"path/to/file.css\"/>`.\n\n- **htmlroot** (string): Where the project root is. Useful for example if you have HTML that references _local_ files with root-relative URLs, i.e. `href=\"/css/style.css\"`.\n\n- **ignore** (string[]): provide a list of selectors that should not be removed by UnCSS. For example, styles added by user interaction with the page (hover, click), since those are not detectable by UnCSS yet. Both literal names and regex patterns are recognized. Otherwise, you can add a comment before specific selectors:\n\n ```css\n /* uncss:ignore */\n .selector1 {\n /* this rule will be ignored */\n }\n\n .selector2 {\n /* this will NOT be ignored */\n }\n\n /* uncss:ignore start */\n\n /* all rules in here will be ignored */\n\n /* uncss:ignore end */\n ```\n\n- **ignoreSheets** (string[] | RegExp[]): Do not process these stylesheets, e.g. Google fonts. Accepts strings or regex patterns.\n\n- **inject** (string / function(window)): Path to a local javascript file which is executed before uncss runs. A function can also be passed directly in.\n\n Example inject.js file\n\n ```js\n 'use strict';\n\n module.exports = function(window) {\n window.document.querySelector('html').classList.add('no-csscalc', 'csscalc');\n };\n ```\n\n Example of passing inject as a function\n\n ```js\n {\n inject: function(window){\n window.document.querySelector('html').classList.add('no-csscalc', 'csscalc');\n }\n }\n ```\n\n- **jsdom** (object) (Supported only by API): Supply the options used to create the JSDOM pages ([https://github.com/jsdom/jsdom](https://github.com/jsdom/jsdom)). At the moment, `config.resources` is not yet supported.\n\n- **media** (string[]): By default UnCSS processes only stylesheets with media query `_all_`, `_screen_`, and those without one. Specify here which others to include.\n\n- **raw** (string): Give the task a raw string of CSS in addition to the existing stylesheet options; useful in scripting when your CSS hasn't yet been written to disk.\n\n- **report** (boolean, default: `true`): Return the report object in callback.\n\n- **strictSSL** (boolean, default: `true`): Disable SSL verification when retrieving html source\n\n- **stylesheets** (string[]): Use these stylesheets instead of those extracted from the HTML files. Prepend paths with the `file://` protocol to force use of local stylesheets, otherwise paths will be resolved as a browser would for an anchor tag `href` on the HTML page.\n\n- **timeout** (number): Specify how long to wait for the JS to be loaded.\n\n- **uncssrc** (string): Load all options from a JSON file. Regular expressions for the `ignore` and `ignoreSheets` options should be wrapped in quotation marks.\n\n Example uncssrc file:\n\n ```json\n {\n \"ignore\": [\n \".unused\",\n \"/^#js/\"\n ],\n \"stylesheets\": [\n \"css/override.css\"\n ]\n }\n ```\n\n- **userAgent** (String, default: `'uncss'`): The user agent string that jsdom should send when requesting pages. May be useful when loading markup from services which use user agent based device detection to serve custom markup to mobile devices. Defaults to `uncss`.\n\n### As a PostCSS Plugin\n\nUnCSS can be used as a [PostCSS](https://github.com/postcss/postcss) Plugin.\n\n```js\npostcss([ require('uncss').postcssPlugin ]);\n```\n\nSee [PostCSS docs](https://github.com/postcss/postcss) for examples for your environment.\n\n**Note:** Depending on your environment, you might not be able to use uncss as a PostCSS plugin since the plugin is not directly exported. In such cases, use the wrapper library [postcss-uncss](https://github.com/RyanZim/postcss-uncss).\n\n#### Options\n\n- **html** (string[]): provide a list of html files to parse for selectors and elements. Usage of [globs](https://github.com/isaacs/node-glob) is allowed.\n\n- **ignore** (string[] | RegExp[]): provide a list of selectors that should not be removed by UnCSS. For example, styles added by user interaction with the page (hover, click), since those are not detectable by UnCSS yet. Both literal names and regex patterns are recognized. Otherwise, you can add a comment before specific selectors in your CSS:\n\n ```css\n /* uncss:ignore */\n .selector1 {\n /* this rule will be ignored */\n }\n\n .selector2 {\n /* this will NOT be ignored */\n }\n ```\n\n##### Example Configuration\n\n```js\n{\n html: ['index.html', 'about.html', 'team/*.html'],\n ignore: ['.fade']\n}\n```\n\n## License\n\nCopyright (c) 2019 Giacomo Martino. See the [LICENSE](/LICENSE.md) file for license rights and limitations (MIT).\n# levenary\n\n[](https://www.npmjs.com/package/levenary)\n[](https://github.com/tanhauhau/levenary/actions)\n\n> Given a string, A and an array of strings XS, return the string X from XS whose Levenshtein distance from A is minimal.\n\n## Install\n\n```\n$ npm install levenary\n```\n\n## Usage\n\n```js\nimport levenary from 'levenary';\n\nlevenary('cat', ['cow', 'dog', 'pig']);\n//=> 'cow'\n```\n\n## Why `levenary`?\n1. Based on [leven](https://github.com/sindresorhus/leven), the fastest JS implementation of the [Levenshtein distance algorithm](https://en.wikipedia.org/wiki/Levenshtein_distance)\n1. Only 1 API. Simple and clean. If you want more, please use [didyoumean2](https://www.npmjs.com/package/didyoumean2).\n1. [Flow](http://flow.org/) and [TypeScript](http://typescriptlang.org/) support.\n\n## Benchmark\n\n```\n$ npm run bench\n```\n\n```\n 311,915 op/s » levenary\n 74,030 op/s » didyoumean\n 141,423 op/s » didyoumean2\n```\n# registry-auth-token\n\n[](http://browsenpm.org/package/registry-auth-token)[](https://travis-ci.org/rexxars/registry-auth-token)\n\nGet the auth token set for an npm registry from `.npmrc`. Also allows fetching the configured registry URL for a given npm scope.\n\n## Installing\n\n```\nnpm install --save registry-auth-token\n```\n\n## Usage\n\nReturns an object containing `token` and `type`, or `undefined` if no token can be found. `type` can be either `Bearer` or `Basic`.\n\n```js\nvar getAuthToken = require('registry-auth-token')\nvar getRegistryUrl = require('registry-auth-token/registry-url')\n\n// Get auth token and type for default `registry` set in `.npmrc`\nconsole.log(getAuthToken()) // {token: 'someToken', type: 'Bearer'}\n\n// Get auth token for a specific registry URL\nconsole.log(getAuthToken('//registry.foo.bar'))\n\n// Find the registry auth token for a given URL (with deep path):\n// If registry is at `//some.host/registry`\n// URL passed is `//some.host/registry/deep/path`\n// Will find token the closest matching path; `//some.host/registry`\nconsole.log(getAuthToken('//some.host/registry/deep/path', {recursive: true}))\n\n// Find the configured registry url for scope `@foobar`.\n// Falls back to the global registry if not defined.\nconsole.log(getRegistryUrl('@foobar'))\n\n// Use the npm config that is passed in\nconsole.log(getRegistryUrl('http://registry.foobar.eu/', {\n npmrc: {\n 'registry': 'http://registry.foobar.eu/',\n '//registry.foobar.eu/:_authToken': 'qar'\n }\n}))\n```\n\n## Return value\n\n```js\n// If auth info can be found:\n{token: 'someToken', type: 'Bearer'}\n\n// Or:\n{token: 'someOtherToken', type: 'Basic'}\n\n// Or, if nothing is found:\nundefined\n```\n\n## Security\n\nPlease be careful when using this. Leaking your auth token is dangerous.\n\n## License\n\nMIT-licensed. See LICENSE.\n# BSER Binary Serialization\n\nBSER is a binary serialization scheme that can be used as an alternative to JSON.\nBSER uses a framed encoding that makes it simpler to use to stream a sequence of\nencoded values.\n\nIt is intended to be used for local-IPC only and strings are represented as binary\nwith no specific encoding; this matches the convention employed by most operating\nsystem filename storage.\n\nFor more details about the serialization scheme see\n[Watchman's docs](https://facebook.github.io/watchman/docs/bser.html).\n\n## API\n\n```js\nvar bser = require('bser');\n```\n\n### bser.loadFromBuffer\n\nThe is the synchronous decoder; given an input string or buffer,\ndecodes a single value and returns it. Throws an error if the\ninput is invalid.\n\n```js\nvar obj = bser.loadFromBuffer(buf);\n```\n\n### bser.dumpToBuffer\n\nSynchronously encodes a value as BSER.\n\n```js\nvar encoded = bser.dumpToBuffer(['hello']);\nconsole.log(bser.loadFromBuffer(encoded)); // ['hello']\n```\n\n### BunserBuf\n\nThe asynchronous decoder API is implemented in the BunserBuf object.\nYou may incrementally append data to this object and it will emit the\ndecoded values via its `value` event.\n\n```js\nvar bunser = new bser.BunserBuf();\n\nbunser.on('value', function(obj) {\n console.log(obj);\n});\n```\n\nThen in your socket `data` event:\n\n```js\nbunser.append(buf);\n```\n\n## Example\n\nRead BSER from socket:\n\n```js\nvar bunser = new bser.BunserBuf();\n\nbunser.on('value', function(obj) {\n console.log('data from socket', obj);\n});\n\nvar socket = net.connect('/socket');\n\nsocket.on('data', function(buf) {\n bunser.append(buf);\n});\n```\n\nWrite BSER to socket:\n\n```js\nsocket.write(bser.dumpToBuffer(obj));\n```\n# json-schema-traverse\nTraverse JSON Schema passing each schema object to callback\n\n[](https://travis-ci.org/epoberezkin/json-schema-traverse)\n[](https://www.npmjs.com/package/json-schema-traverse)\n[](https://coveralls.io/github/epoberezkin/json-schema-traverse?branch=master)\n\n## Install\n\n```\nnpm install json-schema-traverse\n```\n\n## Usage\n\n```javascript\nconst traverse = require('json-schema-traverse');\nconst schema = {\n properties: {\n foo: {type: 'string'},\n bar: {type: 'integer'}\n }\n};\n\ntraverse(schema, {cb});\n// cb is called 3 times with:\n// 1. root schema\n// 2. {type: 'string'}\n// 3. {type: 'integer'}\n\n// Or:\n\ntraverse(schema, {cb: {pre, post}});\n// pre is called 3 times with:\n// 1. root schema\n// 2. {type: 'string'}\n// 3. {type: 'integer'}\n//\n// post is called 3 times with:\n// 1. {type: 'string'}\n// 2. {type: 'integer'}\n// 3. root schema\n\n```\n\nCallback function `cb` is called for each schema object (not including draft-06 boolean schemas), including the root schema, in pre-order traversal. Schema references ($ref) are not resolved, they are passed as is. Alternatively, you can pass a `{pre, post}` object as `cb`, and then `pre` will be called before traversing child elements, and `post` will be called after all child elements have been traversed.\n\nCallback is passed these parameters:\n\n- _schema_: the current schema object\n- _JSON pointer_: from the root schema to the current schema object\n- _root schema_: the schema passed to `traverse` object\n- _parent JSON pointer_: from the root schema to the parent schema object (see below)\n- _parent keyword_: the keyword inside which this schema appears (e.g. `properties`, `anyOf`, etc.)\n- _parent schema_: not necessarily parent object/array; in the example above the parent schema for `{type: 'string'}` is the root schema\n- _index/property_: index or property name in the array/object containing multiple schemas; in the example above for `{type: 'string'}` the property name is `'foo'`\n\n## Traverse objects in all unknown keywords\n\n```javascript\nconst traverse = require('json-schema-traverse');\nconst schema = {\n mySchema: {\n minimum: 1,\n maximum: 2\n }\n};\n\ntraverse(schema, {allKeys: true, cb});\n// cb is called 2 times with:\n// 1. root schema\n// 2. mySchema\n```\n\nWithout option `allKeys: true` callback will be called only with root schema.\n\n## License\n\n[MIT](https://github.com/epoberezkin/json-schema-traverse/blob/master/LICENSE)\naws-sign\n========\n\nAWS signing. Originally pulled from LearnBoost/knox, maintained as vendor in request, now a standalone module.\n# jest-docblock\n\n`jest-docblock` is a package that can extract and parse a specially-formatted comment called a \"docblock\" at the top of a file.\n\nA docblock looks like this:\n\n```js\n/**\n * Stuff goes here!\n */\n```\n\nDocblocks can contain pragmas, which are words prefixed by `@`:\n\n```js\n/**\n * Pragma incoming!\n *\n * @flow\n */\n```\n\nPragmas can also take arguments:\n\n```js\n/**\n * Check this out:\n *\n * @myPragma it is so cool\n */\n```\n\n`jest-docblock` can:\n\n- extract the docblock from some code as a string\n- parse a docblock string's pragmas into an object\n- print an object and some comments back to a string\n\n## Installation\n\n```sh\n# with yarn\n$ yarn add jest-docblock\n# with npm\n$ npm install jest-docblock\n```\n\n## Usage\n\n```js\nconst code = `\n/**\n * Everything is awesome!\n *\n * @everything is:awesome\n * @flow\n */\n\n export const everything = Object.create(null);\n export default function isAwesome(something) {\n return something === everything;\n }\n`;\n\nconst {\n extract,\n strip,\n parse,\n parseWithComments,\n print,\n} = require('jest-docblock');\n\nconst docblock = extract(code);\nconsole.log(docblock); // \"/**\\n * Everything is awesome!\\n * \\n * @everything is:awesome\\n * @flow\\n */\"\n\nconst stripped = strip(code);\nconsole.log(stripped); // \"export const everything = Object.create(null);\\n export default function isAwesome(something) {\\n return something === everything;\\n }\"\n\nconst pragmas = parse(docblock);\nconsole.log(pragmas); // { everything: \"is:awesome\", flow: \"\" }\n\nconst parsed = parseWithComments(docblock);\nconsole.log(parsed); // { comments: \"Everything is awesome!\", pragmas: { everything: \"is:awesome\", flow: \"\" } }\n\nconsole.log(print({pragmas, comments: 'hi!'})); // /**\\n * hi!\\n *\\n * @everything is:awesome\\n * @flow\\n */;\n```\n\n## API Documentation\n\n### `extract(contents: string): string`\n\nExtracts a docblock from some file contents. Returns the docblock contained in `contents`. If `contents` did not contain a docblock, it will return the empty string (`\"\"`).\n\n### `strip(contents: string): string`\n\nStrips the top docblock from a file and return the result. If a file does not have a docblock at the top, then return the file unchanged.\n\n### `parse(docblock: string): {[key: string]: string | string[] }`\n\nParses the pragmas in a docblock string into an object whose keys are the pragma tags and whose values are the arguments to those pragmas.\n\n### `parseWithComments(docblock: string): { comments: string, pragmas: {[key: string]: string | string[]} }`\n\nSimilar to `parse` except this method also returns the comments from the docblock. Useful when used with `print()`.\n\n### `print({ comments?: string, pragmas?: {[key: string]: string | string[]} }): string`\n\nPrints an object of key-value pairs back into a docblock. If `comments` are provided, they will be positioned on the top of the docblock.\n# y18n\n\n[![Build Status][travis-image]][travis-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n[![NPM version][npm-image]][npm-url]\n[![js-standard-style][standard-image]][standard-url]\n[](https://conventionalcommits.org)\n\nThe bare-bones internationalization library used by yargs.\n\nInspired by [i18n](https://www.npmjs.com/package/i18n).\n\n## Examples\n\n_simple string translation:_\n\n```js\nvar __ = require('y18n').__\n\nconsole.log(__('my awesome string %s', 'foo'))\n```\n\noutput:\n\n`my awesome string foo`\n\n_using tagged template literals_\n\n```js\nvar __ = require('y18n').__\nvar str = 'foo'\n\nconsole.log(__`my awesome string ${str}`)\n```\n\noutput:\n\n`my awesome string foo`\n\n_pluralization support:_\n\n```js\nvar __n = require('y18n').__n\n\nconsole.log(__n('one fish %s', '%d fishes %s', 2, 'foo'))\n```\n\noutput:\n\n`2 fishes foo`\n\n## JSON Language Files\n\nThe JSON language files should be stored in a `./locales` folder.\nFile names correspond to locales, e.g., `en.json`, `pirate.json`.\n\nWhen strings are observed for the first time they will be\nadded to the JSON file corresponding to the current locale.\n\n## Methods\n\n### require('y18n')(config)\n\nCreate an instance of y18n with the config provided, options include:\n\n* `directory`: the locale directory, default `./locales`.\n* `updateFiles`: should newly observed strings be updated in file, default `true`.\n* `locale`: what locale should be used.\n* `fallbackToLanguage`: should fallback to a language-only file (e.g. `en.json`)\n be allowed if a file matching the locale does not exist (e.g. `en_US.json`),\n default `true`.\n\n### y18n.\\_\\_(str, arg, arg, arg)\n\nPrint a localized string, `%s` will be replaced with `arg`s.\n\nThis function can also be used as a tag for a template literal. You can use it\nlike this: <code>__`hello ${'world'}`</code>. This will be equivalent to\n`__('hello %s', 'world')`.\n\n### y18n.\\_\\_n(singularString, pluralString, count, arg, arg, arg)\n\nPrint a localized string with appropriate pluralization. If `%d` is provided\nin the string, the `count` will replace this placeholder.\n\n### y18n.setLocale(str)\n\nSet the current locale being used.\n\n### y18n.getLocale()\n\nWhat locale is currently being used?\n\n### y18n.updateLocale(obj)\n\nUpdate the current locale with the key value pairs in `obj`.\n\n## License\n\nISC\n\n[travis-url]: https://travis-ci.org/yargs/y18n\n[travis-image]: https://img.shields.io/travis/yargs/y18n.svg\n[coveralls-url]: https://coveralls.io/github/yargs/y18n\n[coveralls-image]: https://img.shields.io/coveralls/yargs/y18n.svg\n[npm-url]: https://npmjs.org/package/y18n\n[npm-image]: https://img.shields.io/npm/v/y18n.svg\n[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n[standard-url]: https://github.com/feross/standard\n# readable-stream\n\n***Node-core v8.11.1 streams for userland*** [](https://travis-ci.org/nodejs/readable-stream)\n\n[](https://nodei.co/npm/readable-stream/)\n[](https://nodei.co/npm/readable-stream/)\n\n[](https://saucelabs.com/u/readable-stream)\n\n```bash\nnpm install --save readable-stream\n```\n\n***Node-core streams for userland***\n\nThis package is a mirror of the Streams2 and Streams3 implementations in\nNode-core.\n\nFull documentation may be found on the [Node.js website](https://nodejs.org/dist/v8.11.1/docs/api/stream.html).\n\nIf you want to guarantee a stable streams base, regardless of what version of\nNode you, or the users of your libraries are using, use **readable-stream** *only* and avoid the *\"stream\"* module in Node-core, for background see [this blogpost](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).\n\nAs of version 2.0.0 **readable-stream** uses semantic versioning.\n\n# Streams Working Group\n\n`readable-stream` is maintained by the Streams Working Group, which\noversees the development and maintenance of the Streams API within\nNode.js. The responsibilities of the Streams Working Group include:\n\n* Addressing stream issues on the Node.js issue tracker.\n* Authoring and editing stream documentation within the Node.js project.\n* Reviewing changes to stream subclasses within the Node.js project.\n* Redirecting changes to streams from the Node.js project to this\n project.\n* Assisting in the implementation of stream providers within Node.js.\n* Recommending versions of `readable-stream` to be included in Node.js.\n* Messaging about the future of streams to give the community advance\n notice of changes.\n\n<a name=\"members\"></a>\n## Team Members\n\n* **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) <christopher.s.dickinson@gmail.com>\n - Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B\n* **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) <calvin.metcalf@gmail.com>\n - Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242\n* **Rod Vagg** ([@rvagg](https://github.com/rvagg)) <rod@vagg.org>\n - Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D\n* **Sam Newman** ([@sonewman](https://github.com/sonewman)) <newmansam@outlook.com>\n* **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) <mathiasbuus@gmail.com>\n* **Domenic Denicola** ([@domenic](https://github.com/domenic)) <d@domenic.me>\n* **Matteo Collina** ([@mcollina](https://github.com/mcollina)) <matteo.collina@gmail.com>\n - Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E\n* **Irina Shestak** ([@lrlna](https://github.com/lrlna)) <shestak.irina@gmail.com>\nemail-addresses.js\n==================\n\nAn RFC 5322 email address parser.\n\nv 3.1.0\n\nWhat?\n-----\nWant to see if something could be an email address? Want to grab the display name or just the address out of a string? Put your regexes down and use this parser!\n\nThis library does not validate email addresses - we can't really do that without sending an email. However, it attempts to parse addresses using the (fairly liberal) grammar specified in RFC 5322. You can use this to check if user input looks like an email address.\n\nNote carefully though - this parser supports all features of RFC 5322, which means that `\"Bob Example\" <bob@example.com>`\nis a valid email address. If you just want to validate the `bob@example.com` part, that is RFC 5321, for which you want\nto use something like node-address-rfc2821.\n\nWhy use this?\n-------------\nUse this library because you can be sure it really respects the RFC:\n - The functions in the recursive decent parser match up with the productions in the RFC\n - The productions from the RFC are written above each function for easy verification\n - Tests include all of the test cases from the [is_email](https://github.com/dominicsayers/isemail) project, which are extensive\n\nInstallation\n------------\nnpm install email-addresses\n\nExample\n-------\n\n```\n$ node\n> addrs = require(\"email-addresses\")\n{ [Function: parse5322]\n parseOneAddress: [Function: parseOneAddressSimple],\n parseAddressList: [Function: parseAddressListSimple] }\n> addrs.parseOneAddress('\"Jack Bowman\" <jack@fogcreek.com>')\n{ parts:\n { name: [Object],\n address: [Object],\n local: [Object],\n domain: [Object] },\n name: 'Jack Bowman',\n address: 'jack@fogcreek.com',\n local: 'jack',\n domain: 'fogcreek.com' }\n> addrs.parseAddressList('jack@fogcreek.com, Bob <bob@example.com>')\n[ { parts:\n { name: null,\n address: [Object],\n local: [Object],\n domain: [Object] },\n name: null,\n address: 'jack@fogcreek.com',\n local: 'jack',\n domain: 'fogcreek.com' },\n { parts:\n { name: [Object],\n address: [Object],\n local: [Object],\n domain: [Object] },\n name: 'Bob',\n address: 'bob@example.com',\n local: 'bob',\n domain: 'example.com' } ]\n> addrs(\"jack@fogcreek.com\")\n{ ast:\n { name: 'address-list',\n tokens: 'jack@fogcreek.com',\n semantic: 'jack@fogcreek.com',\n children: [ [Object] ] },\n addresses:\n [ { node: [Object],\n parts: [Object],\n name: null,\n address: 'jack@fogcreek.com',\n local: 'jack',\n domain: 'fogcreek.com' } ] }\n> addrs(\"bogus\")\nnull\n```\n\nAPI\n---\n\n`obj = addrs(opts)`\n===================\n\nCall the module directly as a function to get access to the AST. Returns null for a failed parse (an invalid\naddress).\n\nOptions:\n\n* `string` - An email address to parse. Parses as `address-list`, a list of email addresses separated by commas.\n* `object` with the following keys:\n * `input` - An email address to parse. Required.\n * `rfc6532` - Enable rfc6532 support (unicode in email addresses). Default: `false`.\n * `partial` - Allow a failed parse to return the AST it managed to produce so far. Default: `false`.\n * `simple` - Return just the address or addresses parsed. Default: `false`.\n * `strict` - Turn off features of RFC 5322 marked \"Obsolete\". Default: `false`.\n * `rejectTLD` - Require at least one `.` in domain names. Default: `false`.\n * `startAt` - Start the parser at one of `address-list`, `from`, `sender`, `reply-to`. Default: `address-list`.\n\nReturns an object with the following properties:\n\n* `ast` - the full AST of the parse.\n* `addresses` - array of addresses found. Each has the following properties:\n * `parts` - components of the AST that make up the address.\n * `type` - The type of the node, e.g. `mailbox`, `address`, `group`.\n * `name` - The extracted name from the email. e.g. parsing `\"Bob\" <bob@example.com>` will give `Bob` for the `name`.\n * `address` - The full email address. e.g. parsing the above will give `bob@example.com` for the `address`.\n * `local` - The local part. e.g. parsing the above will give `bob` for `local`.\n * `domain` - The domain part. e.g. parsing the above will give `example.com` for `domain`.\n\nNote if `simple` is set, the return will be an array of addresses rather than the object above.\n\nNote that addresses can contain a `group` address, which in contrast to the `address` objects\nwill simply contain two properties: a `name` and `addresses` which is an array of the addresses in\nthe group. You can identify groups because they will have a `type` of `group`. A group looks\nsomething like this: `Managing Partners:ben@example.com,carol@example.com;`\n\n`obj = addrs.parseOneAddress(opts)`\n===================================\n\nParse a single email address.\n\nOperates similarly to `addrs(opts)`, with the exception that `rfc6532` and `simple` default to `true`.\n\nReturns a single address object as described above. If you set `simple: false` the returned object\nincludes a `node` object that contains the AST for the address.\n\n`obj = addrs.parseAddressList(opts)`\n====================================\n\nParse a list of email addresses separated by comma.\n\nOperates similarly to `addrs(opts)`, with the exception that `rfc6532` and `simple` default to `true`.\n\nReturns a list of address objects as described above. If you set `simple: false` each address will\ninclude a `node` object that containst the AST for the address.\n\n`obj = addrs.parseFrom(opts)`\n=============================\n\nParse an email header \"From:\" address (specified as mailbox-list or address-list).\n\nOperates similarly to `addrs(opts)`, with the exception that `rfc6532` and `simple` default to `true`.\n\nReturns a list of address objects as described above. If you set `simple: false` each address will\ninclude a `node` object that containst the AST for the address.\n\n`obj = addrs.parseSender(opts)`\n===============================\n\nParse an email header \"Sender:\" address (specified as mailbox or address).\n\nOperates similarly to `addrs(opts)`, with the exception that `rfc6532` and `simple` default to `true`.\n\nReturns a single address object as described above. If you set `simple: false` the returned object\nincludes a `node` object that contains the AST for the address.\n\n`obj = addrs.parseReplyTo(opts)`\n================================\n\nParse an email header \"Reply-To:\" address (specified as address-list).\n\nOperates identically to `addrs.parseAddressList(opts)`.\n\nUsage\n-----\nIf you want to simply check whether an address or address list parses, you'll want to call the following functions and check whether the results are null or not: ```parseOneAddress``` for a single address and ```parseAddressList``` for multiple addresses.\n\nIf you want to examine the parsed address, for example to extract a name or address, you have some options. The object returned by ```parseOneAddress``` has four helper values on it: ```name```, ```address```, ```local```, and ```domain```. See the example above to understand is actually returned. (These are equivalent to ```parts.name.semantic```, ```parts.address.semantic```, etc.) These values try to be smart about collapsing whitespace, quotations, and excluding RFC 5322 comments. If you desire, you can also obtain the raw parsed tokens or semantic tokens for those fields. The ```parts``` value is an object referencing nodes in the AST generated. Nodes in the AST have two values of interest here, ```tokens``` and ```semantic```.\n\n```\n> a = addrs.parseOneAddress('Jack Bowman <jack@fogcreek.com >')\n> a.parts.name.tokens\n'Jack Bowman '\n> a.name\n'Jack Bowman'\n> a.parts.name.semantic\n'Jack Bowman '\n> a.parts.address.tokens\n'jack@fogcreek.com '\n> a.address\n'jack@fogcreek.com'\n> a.parts.address.semantic\n'jack@fogcreek.com'\n```\n\nIf you need to, you can inspect the AST directly. The entire AST is returned when calling the module's function.\n\nReferences\n----------\n - http://tools.ietf.org/html/rfc5322\n - https://tools.ietf.org/html/rfc6532\n - https://tools.ietf.org/html/rfc6854\n - http://code.google.com/p/isemail/\n\nProps\n-----\nMany thanks to [Dominic Sayers](https://github.com/dominicsayers) and his documentation and tests\nfor the [is_email](https://github.com/dominicsayers/isemail) function which helped greatly in writing this parser.\n\nLicense\n-------\nLicensed under the MIT License. See the LICENSE file.\n# define-property [](http://badge.fury.io/js/define-property)\n\n> Define a non-enumerable property on an object.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i define-property --save\n```\n\n## Usage\n\n**Params**\n\n* `obj`: The object on which to define the property.\n* `prop`: The name of the property to be defined or modified.\n* `descriptor`: The descriptor for the property being defined or modified.\n\n```js\nvar define = require('define-property');\nvar obj = {};\ndefine(obj, 'foo', function(val) {\n return val.toUpperCase();\n});\n\nconsole.log(obj);\n//=> {}\n\nconsole.log(obj.foo('bar'));\n//=> 'BAR'\n```\n\n**get/set**\n\n```js\ndefine(obj, 'foo', {\n get: function() {},\n set: function() {}\n});\n```\n\n## Related projects\n\n* [delegate-object](https://www.npmjs.com/package/delegate-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/delegate-object) | [homepage](https://github.com/doowb/delegate-object)\n* [forward-object](https://www.npmjs.com/package/forward-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/forward-object) | [homepage](https://github.com/doowb/forward-object)\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)\n* [mixin-object](https://www.npmjs.com/package/mixin-object): Mixin the own and inherited properties of other objects onto the first object. Pass an… [more](https://www.npmjs.com/package/mixin-object) | [homepage](https://github.com/jonschlinkert/mixin-object)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/define-property/issues/new).\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 31, 2015._\n# Polyfill for `Object.setPrototypeOf`\n\n[](https://npmjs.org/package/setprototypeof)\n[](https://npmjs.org/package/setprototypeof)\n[](https://github.com/standard/standard)\n\nA simple cross platform implementation to set the prototype of an instianted object. Supports all modern browsers and at least back to IE8.\n\n## Usage:\n\n```\n$ npm install --save setprototypeof\n```\n\n```javascript\nvar setPrototypeOf = require('setprototypeof')\n\nvar obj = {}\nsetPrototypeOf(obj, {\n foo: function () {\n return 'bar'\n }\n})\nobj.foo() // bar\n```\n\nTypeScript is also supported:\n\n```typescript\nimport setPrototypeOf = require('setprototypeof')\n```\n# fastparse\n\nA very simple and stupid parser, based on a statemachine and regular expressions.\n\nIt's not intended for complex languages. It's intended to easily write a simple parser for a simple language.\n\n## Usage\n\nPass a description of statemachine to the constructor. The description must be in this form:\n\n``` javascript\nnew Parser(description)\n\ndescription is {\n\t// The key is the name of the state\n\t// The value is an object containing possible transitions\n\t\"state-name\": {\n\t\t// The key is a regular expression\n\t\t// If the regular expression matches the transition is executed\n\t\t// The value can be \"true\", a other state name or a function\n\n\t\t\"a\": true,\n\t\t// true will make the parser stay in the current state\n\t\t\n\t\t\"b\": \"other-state-name\",\n\t\t// a string will make the parser transit to a new state\n\t\t\n\t\t\"[cde]\": function(match, index, matchLength) {\n\t\t\t// \"match\" will be the matched string\n\t\t\t// \"index\" will be the position in the complete string\n\t\t\t// \"matchLength\" will be \"match.length\"\n\t\t\t\n\t\t\t// \"this\" will be the \"context\" passed to the \"parse\" method\"\n\t\t\t\n\t\t\t// A new state name (string) can be returned\n\t\t\treturn \"other-state-name\";\n\t\t},\n\t\t\n\t\t\"([0-9]+)(\\\\.[0-9]+)?\": function(match, first, second, index, matchLength) {\n\t\t\t// groups can be used in the regular expression\n\t\t\t// they will match to arguments \"first\", \"second\"\n\t\t},\n\t\t\n\t\t// the parser stops when it cannot match the string anymore\n\t\t\n\t\t// order of keys is the order in which regular expressions are matched\n\t\t// if the javascript runtime preserves the order of keys in an object\n\t\t// (this is not standardized, but it's a de-facto standard)\n\t}\n}\n```\n\nThe statemachine is compiled down to a single regular expression per state. So basically the parsing work is delegated to the (native) regular expression logic of the javascript runtime.\n\n``` javascript\nParser.prototype.parse(initialState: String, parsedString: String, context: Object)\n```\n\n`initialState`: state where the parser starts to parse.\n\n`parsedString`: the string which should be parsed.\n\n`context`: an object which can be used to save state and results. Available as `this` in transition functions.\n\nreturns `context`\n\n## Example\n\n``` javascript\nvar Parser = require(\"fastparse\");\n\n// A simple parser that extracts @licence ... from comments in a JS file\nvar parser = new Parser({\n\t// The \"source\" state\n\t\"source\": {\n\t\t// matches comment start\n\t\t\"/\\\\*\": \"comment\",\n\t\t\"//\": \"linecomment\",\n\t\t\n\t\t// this would be necessary for a complex language like JS\n\t\t// but omitted here for simplicity\n\t\t// \"\\\"\": \"string1\",\n\t\t// \"\\'\": \"string2\",\n\t\t// \"\\/\": \"regexp\"\n\t\t\n\t},\n\t// The \"comment\" state\n\t\"comment\": {\n\t\t\"\\\\*/\": \"source\",\n\t\t\"@licen[cs]e\\\\s((?:[^*\\n]|\\\\*+[^*/\\n])*)\": function(match, licenseText) {\n\t\t\tthis.licences.push(licenseText.trim());\n\t\t}\n\t},\n\t// The \"linecomment\" state\n\t\"linecomment\": {\n\t\t\"\\n\": \"source\",\n\t\t\"@licen[cs]e\\\\s(.*)\": function(match, licenseText) {\n\t\t\tthis.licences.push(licenseText.trim());\n\t\t}\n\t}\n});\n\nvar licences = parser.parse(\"source\", sourceCode, { licences: [] }).licences;\n\nconsole.log(licences);\n```\n\n## License\n\nMIT (http://www.opensource.org/licenses/mit-license.php)\n# readable-stream\n\n***Node.js core streams for userland*** [](https://travis-ci.com/nodejs/readable-stream)\n\n[](https://nodei.co/npm/readable-stream/)\n[](https://nodei.co/npm/readable-stream/)\n\n[](https://saucelabs.com/u/readabe-stream)\n\n```bash\nnpm install --save readable-stream\n```\n\nThis package is a mirror of the streams implementations in Node.js.\n\nFull documentation may be found on the [Node.js website](https://nodejs.org/dist/v10.19.0/docs/api/stream.html).\n\nIf you want to guarantee a stable streams base, regardless of what version of\nNode you, or the users of your libraries are using, use **readable-stream** *only* and avoid the *\"stream\"* module in Node-core, for background see [this blogpost](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).\n\nAs of version 2.0.0 **readable-stream** uses semantic versioning.\n\n## Version 3.x.x\n\nv3.x.x of `readable-stream` is a cut from Node 10. This version supports Node 6, 8, and 10, as well as evergreen browsers, IE 11 and latest Safari. The breaking changes introduced by v3 are composed by the combined breaking changes in [Node v9](https://nodejs.org/en/blog/release/v9.0.0/) and [Node v10](https://nodejs.org/en/blog/release/v10.0.0/), as follows:\n\n1. Error codes: https://github.com/nodejs/node/pull/13310,\n https://github.com/nodejs/node/pull/13291,\n https://github.com/nodejs/node/pull/16589,\n https://github.com/nodejs/node/pull/15042,\n https://github.com/nodejs/node/pull/15665,\n https://github.com/nodejs/readable-stream/pull/344\n2. 'readable' have precedence over flowing\n https://github.com/nodejs/node/pull/18994\n3. make virtual methods errors consistent\n https://github.com/nodejs/node/pull/18813\n4. updated streams error handling\n https://github.com/nodejs/node/pull/18438\n5. writable.end should return this.\n https://github.com/nodejs/node/pull/18780\n6. readable continues to read when push('')\n https://github.com/nodejs/node/pull/18211\n7. add custom inspect to BufferList\n https://github.com/nodejs/node/pull/17907\n8. always defer 'readable' with nextTick\n https://github.com/nodejs/node/pull/17979\n\n## Version 2.x.x\nv2.x.x of `readable-stream` is a cut of the stream module from Node 8 (there have been no semver-major changes from Node 4 to 8). This version supports all Node.js versions from 0.8, as well as evergreen browsers and IE 10 & 11.\n\n### Big Thanks\n\nCross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs][sauce]\n\n# Usage\n\nYou can swap your `require('stream')` with `require('readable-stream')`\nwithout any changes, if you are just using one of the main classes and\nfunctions.\n\n```js\nconst {\n Readable,\n Writable,\n Transform,\n Duplex,\n pipeline,\n finished\n} = require('readable-stream')\n````\n\nNote that `require('stream')` will return `Stream`, while\n`require('readable-stream')` will return `Readable`. We discourage using\nwhatever is exported directly, but rather use one of the properties as\nshown in the example above.\n\n# Streams Working Group\n\n`readable-stream` is maintained by the Streams Working Group, which\noversees the development and maintenance of the Streams API within\nNode.js. The responsibilities of the Streams Working Group include:\n\n* Addressing stream issues on the Node.js issue tracker.\n* Authoring and editing stream documentation within the Node.js project.\n* Reviewing changes to stream subclasses within the Node.js project.\n* Redirecting changes to streams from the Node.js project to this\n project.\n* Assisting in the implementation of stream providers within Node.js.\n* Recommending versions of `readable-stream` to be included in Node.js.\n* Messaging about the future of streams to give the community advance\n notice of changes.\n\n<a name=\"members\"></a>\n## Team Members\n\n* **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) <calvin.metcalf@gmail.com>\n - Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242\n* **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) <mathiasbuus@gmail.com>\n* **Matteo Collina** ([@mcollina](https://github.com/mcollina)) <matteo.collina@gmail.com>\n - Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E\n* **Irina Shestak** ([@lrlna](https://github.com/lrlna)) <shestak.irina@gmail.com>\n* **Yoshua Wyuts** ([@yoshuawuyts](https://github.com/yoshuawuyts)) <yoshuawuyts@gmail.com>\n\n[sauce]: https://saucelabs.com\n# CSSStyleDeclaration\n\n[](https://www.npmjs.com/package/cssstyle) [](https://travis-ci.org/jsakas/CSSStyleDeclaration)\n\nCSSStyleDeclaration is a work-a-like to the CSSStyleDeclaration class in Nikita Vasilyev's [CSSOM](https://github.com/NV/CSSOM). I made it so that when using [jQuery in node](https://github.com/tmtk75/node-jquery) setting css attributes via $.fn.css() would work. node-jquery uses [jsdom](https://github.com/tmpvar/jsdom) to create a DOM to use in node. jsdom uses CSSOM for styling, and CSSOM's implementation of the [CSSStyleDeclaration](http://www.w3.org/TR/DOM-Level-2-Style/css.html#CSS-CSSStyleDeclaration) doesn't support [CSS2Properties](http://www.w3.org/TR/DOM-Level-2-Style/css.html#CSS-CSS2Properties), which is how jQuery's [$.fn.css()](http://api.jquery.com/css/) operates.\n\n### Why not just issue a pull request?\n\nWell, NV wants to keep CSSOM fast (which I can appreciate) and CSS2Properties aren't required by the standard (though every browser has the interface). So I figured the path of least resistance would be to just modify this one class, publish it as a node module (that requires CSSOM) and then make a pull request of jsdom to use it.\n\n### How do I test this code?\n\n`npm test` should do the trick, assuming you have the dev dependencies installed:\n\n```\n$ npm test\n\ntests\n✔ Verify Has Properties\n✔ Verify Has Functions\n✔ Verify Has Special Properties\n✔ Test From Style String\n✔ Test From Properties\n✔ Test Shorthand Properties\n✔ Test width and height Properties and null and empty strings\n✔ Test Implicit Properties\n```\n# browserify-aes\n[](https://travis-ci.org/crypto-browserify/browserify-aes)\n\nNode style aes for use in the browser.\nImplements:\n\n - createCipher\n - createCipheriv\n - createDecipher\n - createDecipheriv\n - getCiphers\n\nIn node.js, the `crypto` implementation is used, in browsers it falls back to a pure JavaScript implementation.\n\nMuch of this library has been taken from the aes implementation in [triplesec](https://github.com/keybase/triplesec), a partial derivation of [crypto-js](https://code.google.com/p/crypto-js/).\n\n`EVP_BytesToKey` is a straight up port of the same function from OpenSSL as there is literally no documenation on it beyond it using 'undocumented extensions' for longer keys.\n\n## LICENSE [MIT](LICENSE)\n# js-sha256\n[](https://travis-ci.org/emn178/js-sha256)\n[](https://coveralls.io/r/emn178/js-sha256?branch=master)\n[](https://cdnjs.com/libraries/js-sha256/) \n[](https://nodei.co/npm/js-sha256/) \nA simple SHA-256 / SHA-224 hash function for JavaScript supports UTF-8 encoding.\n\n## Demo\n[SHA256 Online](http://emn178.github.io/online-tools/sha256.html) \n[SHA224 Online](http://emn178.github.io/online-tools/sha224.html) \n\n## Download\n[Compress](https://raw.github.com/emn178/js-sha256/master/build/sha256.min.js) \n[Uncompress](https://raw.github.com/emn178/js-sha256/master/src/sha256.js)\n\n## Installation\nYou can also install js-sha256 by using Bower.\n\n bower install js-sha256\n\nFor node.js, you can use this command to install:\n\n npm install js-sha256\n\n## Usage\nYou could use like this:\n```JavaScript\nsha256('Message to hash');\nsha224('Message to hash');\n\nvar hash = sha256.create();\nhash.update('Message to hash');\nhash.hex();\n\nvar hash2 = sha256.update('Message to hash');\nhash2.update('Message2 to hash');\nhash2.array();\n\n// HMAC\nsha256.hmac('key', 'Message to hash');\nsha224.hmac('key', 'Message to hash');\n\nvar hash = sha256.hmac.create('key');\nhash.update('Message to hash');\nhash.hex();\n\nvar hash2 = sha256.hmac.update('key', 'Message to hash');\nhash2.update('Message2 to hash');\nhash2.array();\n```\nIf you use node.js, you should require the module first:\n```JavaScript\nvar sha256 = require('js-sha256');\n```\nor \n```JavaScript\nvar sha256 = require('js-sha256').sha256;\nvar sha224 = require('js-sha256').sha224;\n```\nIt supports AMD:\n```JavaScript\nrequire(['your/path/sha256.js'], function(sha256) {\n// ...\n});\n```\nor TypeScript\n```TypeScript\nimport { sha256, sha224 } from 'js-sha256';\n```\n## Example\n```JavaScript\nsha256(''); // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\nsha256('The quick brown fox jumps over the lazy dog'); // d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592\nsha256('The quick brown fox jumps over the lazy dog.'); // ef537f25c895bfa782526529a9b63d97aa631564d5d789c2b765448c8635fb6c\nsha224(''); // d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f\nsha224('The quick brown fox jumps over the lazy dog'); // 730e109bd7a8a32b1cb9d9a09aa2325d2430587ddbc0c38bad911525\nsha224('The quick brown fox jumps over the lazy dog.'); // 619cba8e8e05826e9b8c519c0a5c68f4fb653e8a3d8aa04bb2c8cd4c\n\n// It also supports UTF-8 encoding\nsha256('中文'); // 72726d8818f693066ceb69afa364218b692e62ea92b385782363780f47529c21\nsha224('中文'); // dfbab71afdf54388af4d55f8bd3de8c9b15e0eb916bf9125f4a959d4\n\n// It also supports byte `Array`, `Uint8Array`, `ArrayBuffer` input\nsha256([]); // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\nsha256(new Uint8Array([211, 212])); // 182889f925ae4e5cc37118ded6ed87f7bdc7cab5ec5e78faef2e50048999473f\n\n// Different output\nsha256(''); // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\nsha256.hex(''); // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\nsha256.array(''); // [227, 176, 196, 66, 152, 252, 28, 20, 154, 251, 244, 200, 153, 111, 185, 36, 39, 174, 65, 228, 100, 155, 147, 76, 164, 149, 153, 27, 120, 82, 184, 85]\nsha256.digest(''); // [227, 176, 196, 66, 152, 252, 28, 20, 154, 251, 244, 200, 153, 111, 185, 36, 39, 174, 65, 228, 100, 155, 147, 76, 164, 149, 153, 27, 120, 82, 184, 85]\nsha256.arrayBuffer(''); // ArrayBuffer\n```\n\n## License\nThe project is released under the [MIT license](http://www.opensource.org/licenses/MIT).\n\n## Contact\nThe project's website is located at https://github.com/emn178/js-sha256 \nAuthor: Chen, Yi-Cyuan (emn178@gmail.com)\n# define-property [](http://badge.fury.io/js/define-property)\n\n> Define a non-enumerable property on an object.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i define-property --save\n```\n\n## Usage\n\n**Params**\n\n* `obj`: The object on which to define the property.\n* `prop`: The name of the property to be defined or modified.\n* `descriptor`: The descriptor for the property being defined or modified.\n\n```js\nvar define = require('define-property');\nvar obj = {};\ndefine(obj, 'foo', function(val) {\n return val.toUpperCase();\n});\n\nconsole.log(obj);\n//=> {}\n\nconsole.log(obj.foo('bar'));\n//=> 'BAR'\n```\n\n**get/set**\n\n```js\ndefine(obj, 'foo', {\n get: function() {},\n set: function() {}\n});\n```\n\n## Related projects\n\n* [delegate-object](https://www.npmjs.com/package/delegate-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/delegate-object) | [homepage](https://github.com/doowb/delegate-object)\n* [forward-object](https://www.npmjs.com/package/forward-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/forward-object) | [homepage](https://github.com/doowb/forward-object)\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)\n* [mixin-object](https://www.npmjs.com/package/mixin-object): Mixin the own and inherited properties of other objects onto the first object. Pass an… [more](https://www.npmjs.com/package/mixin-object) | [homepage](https://github.com/jonschlinkert/mixin-object)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/define-property/issues/new).\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 31, 2015._\n[![NPM][npm]][npm-url]\n[![Deps][deps]][deps-url]\n[![Tests][build]][build-url]\n[![Coverage][cover]][cover-url]\n[![Standard Code Style][code-style]][code-style-url]\n[![Chat][chat]][chat-url]\n\n# PostHTML <img align=\"right\" width=\"220\" height=\"200\" title=\"PostHTML\" src=\"http://posthtml.github.io/posthtml/logo.svg\">\n\nPostHTML is a tool for transforming HTML/XML with JS plugins. PostHTML itself is very small. It includes only a HTML parser, a HTML node tree API and a node tree stringifier.\n\nAll HTML transformations are made by plugins. And these plugins are just small plain JS functions, which receive a HTML node tree, transform it, and return a modified tree.\n\nFor more detailed information about PostHTML in general take a look at the [docs][docs].\n\n### Dependencies\n\n| Name | Status | Description |\n|:----:|:------:|:-----------:|\n|[posthtml-parser][parser]|[![npm][parser-badge]][parser-npm]| Parser HTML/XML to PostHTMLTree |\n|[posthtml-render][render]|[![npm][render-badge]][render-npm]| Render PostHTMLTree to HTML/XML |\n\n[docs]: https://github.com/posthtml/posthtml/blob/master/docs\n\n[parser]: https://github.com/posthtml/posthtml-parser\n[parser-badge]: https://img.shields.io/npm/v/posthtml-parser.svg\n[parser-npm]: https://npmjs.com/package/posthtml-parser\n\n[render]: https://github.com/posthtml/posthtml-render\n[render-badge]: https://img.shields.io/npm/v/posthtml-render.svg\n[render-npm]: https://npmjs.com/package/posthtml-render\n\n## Install\n\n```bash\nnpm i -D posthtml\n```\n\n## Usage\n\n### API\n\n**Sync**\n\n```js\nimport posthtml from 'posthtml'\n\nconst html = `\n <component>\n <title>Super Title</title>\n <text>Awesome Text</text>\n </component>\n`\n\nconst result = posthtml()\n .use(require('posthtml-custom-elements')())\n .process(html, { sync: true })\n .html\n\nconsole.log(result)\n```\n\n```html\n<div class=\"component\">\n <div class=\"title\">Super Title</div>\n <div class=\"text\">Awesome Text</div>\n</div>\n```\n\n> :warning: Async Plugins can't be used in sync mode and will throw an Error. It's recommended to use PostHTML asynchronously whenever possible.\n\n**Async**\n\n```js\nimport posthtml from 'posthtml'\n\nconst html = `\n <html>\n <body>\n <p class=\"wow\">OMG</p>\n </body>\n </html>\n`\n\nposthtml(\n [\n require('posthtml-to-svg-tags')(),\n require('posthtml-extend-attrs')({\n attrsTree: {\n '.wow' : {\n id: 'wow_id',\n fill: '#4A83B4',\n 'fill-rule': 'evenodd',\n 'font-family': 'Verdana'\n }\n }\n })\n ])\n .process(html/*, options */)\n .then((result) => console.log(result.html))\n```\n\n```html\n<svg xmlns=\"http://www.w3.org/2000/svg\">\n <text\n class=\"wow\"\n id=\"wow_id\"\n fill=\"#4A83B4\"\n fill-rule=\"evenodd\" font-family=\"Verdana\">\n OMG\n </text>\n</svg>\n```\n\n**Directives**\n\n```js\nimport posthtml from 'posthtml'\n\nconst php = `\n <component>\n <title><?php echo $title; ?></title>\n <text><?php echo $article; ?></text>\n </component>\n`\n\nconst result = posthtml()\n .use(require('posthtml-custom-elements')())\n .process(html, {\n directives: [\n { name: '?php', start: '<', end: '>' }\n ]\n })\n .html\n\nconsole.log(result)\n```\n\n```html\n<div class=\"component\">\n <div class=\"title\"><?php echo $title; ?></div>\n <div class=\"text\"><?php echo $article; ?></div>\n</div>\n```\n\n### [CLI](https://npmjs.com/package/posthtml-cli)\n\n```bash\nnpm i posthtml-cli\n```\n\n```json\n\"scripts\": {\n \"posthtml\": \"posthtml -o output.html -i input.html -c config.json\"\n}\n```\n\n```bash\nnpm run posthtml\n```\n\n### [Gulp](https://gulpjs.com)\n\n```bash\nnpm i -D gulp-posthtml\n```\n\n```js\nimport tap from 'gulp-tap'\nimport posthtml from 'gulp-posthtml'\nimport { task, src, dest } from 'gulp'\n\ntask('html', () => {\n let path\n\n const plugins = [ require('posthtml-include')({ root: `${path}` }) ]\n const options = {}\n\n src('src/**/*.html')\n .pipe(tap((file) => path = file.path))\n .pipe(posthtml(plugins, options))\n .pipe(dest('build/'))\n})\n```\n\nCheck [project-stub](https://github.com/posthtml/project-stub) for an example with Gulp\n\n### [Grunt](https://gruntjs.com)\n\n```bash\nnpm i -D grunt-posthtml\n```\n\n```js\nposthtml: {\n options: {\n use: [\n require('posthtml-doctype')({ doctype: 'HTML 5' }),\n require('posthtml-include')({ root: './', encoding: 'utf-8' })\n ]\n },\n build: {\n files: [\n {\n dot: true,\n cwd: 'html/',\n src: ['*.html'],\n dest: 'tmp/',\n expand: true,\n }\n ]\n }\n}\n```\n\n### [Webpack](https://webpack.js.org)\n\n```bash\nnpm i -D html-loader posthtml-loader\n```\n\n#### v1.x\n\n**webpack.config.js**\n\n```js\nconst config = {\n module: {\n loaders: [\n {\n test: /\\.html$/,\n loader: 'html!posthtml'\n }\n ]\n },\n posthtml: (ctx) => ({\n parser: require('posthtml-pug'),\n plugins: [\n require('posthtml-bem')()\n ]\n })\n}\n\nexport default config\n```\n\n#### v2.x\n\n**webpack.config.js**\n\n```js\nimport { LoaderOptionsPlugin } from 'webpack'\n\nconst config = {\n module: {\n rules: [\n {\n test: /\\.html$/,\n use: [\n {\n loader: 'html-loader',\n options: { minimize: true }\n },\n {\n loader: 'posthtml-loader'\n }\n ]\n }\n ]\n },\n plugins: [\n new LoaderOptionsPlugin({\n options: {\n posthtml(ctx) {\n return {\n parser: require('posthtml-pug'),\n plugins: [\n require('posthtml-bem')()\n ]\n }\n }\n }\n })\n ]\n}\n\nexport default config\n```\n\n### [Rollup](https://rollupjs.org/)\n\n```bash\n$ npm i rollup-plugin-posthtml -D\n# or\n$ npm i rollup-plugin-posthtml-template -D\n```\n\n```js\nimport { join } from 'path';\n\nimport posthtml from 'rollup-plugin-posthtml-template';\n// or\n// import posthtml from 'rollup-plugin-posthtml';\n\nimport sugarml from 'posthtml-sugarml'; // npm i posthtml-sugarml -D\nimport include from 'posthtml-include'; // npm i posthtml-include -D\n\nexport default {\n entry: join(__dirname, 'main.js'),\n dest: join(__dirname, 'bundle.js'),\n format: 'iife',\n plugins: [\n posthtml({\n parser: sugarml(),\n plugins: [include()],\n template: true // only rollup-plugin-posthtml-template\n })\n ]\n};\n```\n\n## Parser\n\n```js\nimport pug from 'posthtml-pug'\n\nposthtml().process(html, { parser: pug(options) }).then((result) => result.html)\n```\n\n| Name |Status|Description|\n|:-----|:-----|:----------|\n|[posthtml-pug][pug]|[![npm][pug-badge]][pug-npm]|Pug Parser|\n|[sugarml][sugar]|[![npm][sugar-badge]][sugar-npm]|SugarML Parser|\n\n[pug]: https://github.com/posthtml/posthtml-pug\n[pug-badge]: https://img.shields.io/npm/v/posthtml-pug.svg\n[pug-npm]: https://npmjs.com/package/posthtml-pug\n\n[sugar]: https://github.com/posthtml/sugarml\n[sugar-badge]: https://img.shields.io/npm/v/sugarml.svg\n[sugar-npm]: https://npmjs.com/package/sugarml\n\n## [Plugins](http://maltsev.github.io/posthtml-plugins)\n\nIn case you want to develop your own plugin, we recommend using [posthtml-plugin-boilerplate][plugin] for getting started.\n\n[plugin]: https://github.com/posthtml/posthtml-plugin-boilerplate\n\n#### TEXT\n\n| Name |Status|Description|\n|:-----|:-----|:----------|\n|[posthtml-md][md]|[![npm][md-badge]][md-npm]|Easily use context-sensitive markdown within HTML|\n|[posthtml-lorem][lorem]|[![npm][lorem-badge]][lorem-npm]|Add lorem ipsum placeholder text to any document|\n|[posthtml-retext][text]|[![npm][text-badge]][text-npm]|Extensible system for analysing and manipulating natural language|\n|[prevent-widows][prevent-widows]|[![npm][prevent-widows-badge]][prevent-widows-npm]|Prevent widows from appearing at the end of paragraphs|\n\n[md]: https://github.com/jonathantneal/posthtml-md\n[md-badge]: https://img.shields.io/npm/v/posthtml-md.svg\n[md-npm]: https://npmjs.com/package/posthtml-md\n\n[text]: https://github.com/voischev/posthtml-retext\n[text-badge]: https://img.shields.io/npm/v/posthtml-retext.svg\n[text-npm]: https://npmjs.com/package/posthtml-retext\n\n[lorem]: https://github.com/jonathantneal/posthtml-lorem\n[lorem-badge]: https://img.shields.io/npm/v/posthtml-lorem.svg\n[lorem-npm]: https://npmjs.com/package/posthtml-lorem\n\n[prevent-widows]: https://github.com/bashaus/prevent-widows\n[prevent-widows-badge]: https://img.shields.io/npm/v/prevent-widows.svg\n[prevent-widows-npm]: https://npmjs.com/package/prevent-widows\n\n#### HTML\n\n|Name|Status|Description|\n|:---|:----:|:----------|\n|[posthtml-doctype][doctype]|[![npm][doctype-badge]][doctype-npm]|Set !DOCTYPE|\n|[posthtml-head-elements][head]|[![npm][head-badge]][head-npm]|Include head elements from JSON file|\n|[posthtml-include][include]|[![npm][include-badge]][include-npm]|Include HTML|\n|[posthtml-modules][modules]|[![npm][modules-badge]][modules-npm]|Include and process HTML|\n|[posthtml-extend][extend]|[![npm][extend-badge]][extend-npm]|Extend Layout (Pug-like)|\n|[posthtml-extend-attrs][attrs]|[![npm][attrs-badge]][attrs-npm]|Extend Attrs|\n|[posthtml-expressions][exp]|[![npm][exp-badge]][exp-npm]|Template Expressions|\n|[posthtml-inline-assets][assets]|[![npm][assets-badge]][assets-npm]|Inline external scripts, styles, and images|\n|[posthtml-static-react][react]|[![npm][react-badge]][react-npm]| Render custom elements as static React components|\n|[posthtml-custom-elements][elem]|[![npm][elem-badge]][elem-npm]|Use custom elements|\n|[posthtml-web-component][web]|[![npm][web-badge]][web-npm]|Web Component server-side rendering, Component as a Service (CaaS)|\n|[posthtml-spaceless][spaceless]|[![npm][spaceless-badge]][spaceless-npm]|Remove whitespace between HTML tags|\n|[posthtml-cache][cache]|[![npm][cache-badge]][cache-npm]|Add a nanoid to links in you tags|\n|[posthtml-highlight][highlight]|[![npm][highlight-badge]][highlight-npm]|Syntax highlight code elements|\n|[posthtml-pseudo][pseudo]|[![npm][pseudo-badge]][pseudo-npm]|Add pseudo selector class names to elements|\n\n[cache]: https://github.com/posthtml/posthtml-cache\n[cache-badge]: https://img.shields.io/npm/v/posthtml-cache.svg\n[cache-npm]: https://npmjs.com/package/posthtml-cache\n\n[spaceless]: https://github.com/posthtml/posthtml-spaceless\n[spaceless-badge]: https://img.shields.io/npm/v/posthtml-spaceless.svg\n[spaceless-npm]: https://npmjs.com/package/posthtml-spaceless\n\n[doctype]: https://github.com/posthtml/posthtml-doctype\n[doctype-badge]: https://img.shields.io/npm/v/posthtml-doctype.svg\n[doctype-npm]: https://npmjs.com/package/posthtml-doctype\n\n[head]: https://github.com/TCotton/posthtml-head-elements\n[head-badge]: https://img.shields.io/npm/v/posthtml-head-elements.svg\n[head-npm]: https://npmjs.com/package/posthtml-head-elements\n\n[include]: https://github.com/posthtml/posthtml-include\n[include-badge]: https://img.shields.io/npm/v/posthtml-include.svg\n[include-npm]: https://npmjs.com/package/posthtml-include\n\n[modules]: https://github.com/posthtml/posthtml-modules\n[modules-badge]: https://img.shields.io/npm/v/posthtml-modules.svg\n[modules-npm]: https://npmjs.com/package/posthtml-modules\n\n[content]: https://github.com/posthtml/posthtml-content\n[content-badge]: https://img.shields.io/npm/v/posthtml-content.svg\n[content-npm]: https://npmjs.com/package/posthtml-content\n\n[exp]: https://github.com/posthtml/posthtml-exp\n[exp-badge]: https://img.shields.io/npm/v/posthtml-exp.svg\n[exp-npm]: https://npmjs.com/package/posthtml-exp\n\n[extend]: https://github.com/posthtml/posthtml-extend\n[extend-badge]: https://img.shields.io/npm/v/posthtml-extend.svg\n[extend-npm]: https://npmjs.com/package/posthtml-extend\n\n[attrs]: https://github.com/theprotein/posthtml-extend-attrs\n[attrs-badge]: https://img.shields.io/npm/v/posthtml-extend-attrs.svg\n[attrs-npm]: https://npmjs.com/package/posthtml-extend-attrs\n\n[assets]: https://github.com/jonathantneal/posthtml-inline-assets\n[assets-badge]: https://img.shields.io/npm/v/posthtml-inline-assets.svg\n[assets-npm]: https://npmjs.com/package/posthtml-inline-assets\n\n[elem]: https://github.com/posthtml/posthtml-custom-elements\n[elem-badge]: https://img.shields.io/npm/v/posthtml-custom-elements.svg\n[elem-npm]: https://npmjs.com/package/posthtml-custom-elements\n\n[web]: https://github.com/island205/posthtml-web-component\n[web-badge]: https://img.shields.io/npm/v/posthtml-web-component.svg\n[web-npm]: https://npmjs.com/package/posthtml-web-components\n\n[prefix]: https://github.com/stevenbenisek/posthtml-prefix-class\n[prefix-badge]: https://img.shields.io/npm/v/posthtml-prefix-class.svg\n[prefix-npm]: https://npmjs.com/package/posthtml-prefix-class\n\n[react]: https://github.com/rasmusfl0e/posthtml-static-react\n[react-badge]: https://img.shields.io/npm/v/posthtml-static-react.svg\n[react-npm]: https://npmjs.com/package/posthtml-static-react\n\n[highlight]: https://github.com/caseyWebb/posthtml-highlight\n[highlight-badge]: https://img.shields.io/npm/v/posthtml-highlight.svg\n[highlight-npm]: https://npmjs.com/package/posthtml-highlight\n\n[pseudo]: https://github.com/kevinkace/posthtml-pseudo\n[pseudo-badge]: https://img.shields.io/npm/v/posthtml-pseudo.svg\n[pseudo-npm]: https://npmjs.com/package/posthtml-pseudo\n\n#### CSS\n\n|Name|Status|Description|\n|:---|:-----|:----------|\n|[posthtml-bem][bem]|[![npm][bem-badge]][bem-npm]|Support BEM naming in html structure|\n|[posthtml-postcss][css]|[![npm][css-badge]][css-npm]|Use [PostCSS][css-gh] in HTML document|\n|[posthtml-px2rem][px2rem]|[![npm][px2rem-badge]][px2rem-npm]|Change px to rem in Inline CSS|\n|[posthtml-css-modules][css-modules]|[![npm][css-modules-badge]][css-modules-npm]|Use CSS modules in HTML|\n|[posthtml-postcss-modules][postcss-modules]|[![npm][postcss-modules-badge]][postcss-modules-npm]|CSS Modules in html|\n|[posthtml-classes][classes]|[![npm][classes-badge]][classes-npm]|Get a list of classes from HTML|\n|[posthtml-prefix-class][prefix]|[![npm][prefix-badge]][prefix-npm]|Prefix class names\n|[posthtml-modular-css][modular]|[![npm][modular-badge]][modular-npm]|Make CSS modular|\n|[posthtml-inline-css][in]|[![npm][in-badge]][in-npm]|CSS Inliner|\n|[posthtml-collect-styles][collect-styles]|[![npm][collect-styles-badge]][collect-styles-npm]|Collect styles from html and put it in the head|\n|[posthtml-collect-inline-styles][collect]|[![npm][collect-badge]][collect-npm]|Collect inline styles and insert to head tag|\n|[posthtml-style-to-file][style]|[![npm][style-badge]][style-npm]| Save HTML style nodes and attributes to CSS file|\n|[posthtml-color-shorthand-hex-to-six-digit][hex]|[![npm][hex-badge]][hex-npm]|Enforce all hex color codes to be 6-char long|\n|[posthtml-minify-classnames][minify]|[![npm][minify-badge]][minify-npm]|Rewrites classnames and ids inside of html and css files to reduce file size.|\n\n[bem]: https://github.com/rajdee/posthtml-bem\n[bem-badge]: https://img.shields.io/npm/v/posthtml-bem.svg\n[bem-npm]: https://npmjs.com/package/posthtml-bem\n\n[css]: https://github.com/posthtml/posthtml-postcss\n[css-badge]: https://img.shields.io/npm/v/posthtml-postcss.svg\n[css-npm]: https://npmjs.com/package/posthtml-postcss\n[css-gh]: https://github.com/postcss/postcss\n\n[postcss-modules]: https://github.com/posthtml/posthtml-postcss-modules\n[postcss-modules-badge]: https://img.shields.io/npm/v/posthtml-postcss-modules.svg\n[postcss-modules-npm]: https://npmjs.com/package/posthtml-postcss-modules\n\n[css-modules]: https://github.com/posthtml/posthtml-css-modules\n[css-modules-badge]: https://img.shields.io/npm/v/posthtml-css-modules.svg\n[css-modules-npm]: https://npmjs.com/package/posthtml-css-modules\n\n[collect-styles]: https://github.com/posthtml/posthtml-collect-styles\n[collect-styles-badge]: https://img.shields.io/npm/v/posthtml-collect-styles.svg\n[collect-styles-npm]: https://npmjs.com/package/posthtml-collect-styles\n\n[collect]: https://github.com/totora0155/posthtml-collect-inline-styles\n[collect-badge]: https://img.shields.io/npm/v/posthtml-collect-inline-styles.svg\n[collect-npm]: https://npmjs.com/package/posthtml-collect-inline-styles\n\n[px2rem]: https://github.com/weixin/posthtml-px2rem\n[px2rem-badge]: https://img.shields.io/npm/v/posthtml-px2rem.svg\n[px2rem-npm]: https://npmjs.com/package/posthtml-px2rem\n\n[classes]: https://github.com/rajdee/posthtml-classes\n[classes-badge]: https://img.shields.io/npm/v/posthtml-classes.svg\n[classes-npm]: https://npmjs.com/package/posthtml-classes\n\n[prefix]: https://github.com/stevenbenisek/posthtml-prefix-class\n[prefix-badge]: https://img.shields.io/npm/v/posthtml-prefix-class.svg\n[prefix-npm]: https://npmjs.com/package/posthtml-prefix-class\n\n[modular]: https://github.com/admdh/posthtml-modular-css\n[modular-badge]: https://img.shields.io/npm/v/posthtml-modular-css.svg\n[modular-npm]: https://npmjs.com/package/posthtml-modular-css\n\n[in]: https://github.com/posthtml/posthtml-inline-css\n[in-badge]: https://img.shields.io/npm/v/posthtml-inline-css.svg\n[in-npm]: https://npmjs.com/package/posthtml-inline-css\n\n[style]: https://github.com/posthtml/posthtml-style-to-file\n[style-badge]: https://img.shields.io/npm/v/posthtml-style-to-file.svg\n[style-npm]: https://npmjs.com/package/posthtml-style-to-file\n\n[hex]: https://github.com/posthtml/posthtml-color-shorthand-hex-to-six-digit\n[hex-badge]: https://img.shields.io/npm/v/posthtml-color-shorthand-hex-to-six-digit.svg\n[hex-npm]: https://npmjs.com/package/posthtml-color-shorthand-hex-to-six-digit\n\n[minify]: https://github.com/simonlc/posthtml-minify-classnames\n[minify-badge]: https://img.shields.io/npm/v/posthtml-minify-classnames.svg\n[minify-npm]: https://npmjs.com/package/posthtml-minify-classnames\n\n#### IMG & SVG\n\n|Name|Status|Description|\n|:---|:-----|:----------|\n|[posthtml-img-autosize][img]|[![npm][img-badge]][img-npm]|Auto setting the width and height of \\<img\\>|\n|[posthtml-to-svg-tags][svg]|[![npm][svg-badge]][svg-npm]|Convert html tags to svg equals|\n|[posthtml-webp][webp]|[![npm][webp-badge]][webp-npm]|Add WebP support for images|\n|[posthtml-favicons][favicons]|[![npm][favicons-badge]][favicons-npm]|Generate Favicons and add related tags|\n\n[img]: https://github.com/posthtml/posthtml-img-autosize\n[img-badge]: https://img.shields.io/npm/v/posthtml-img-autosize.svg\n[img-npm]: https://npmjs.com/package/posthtml-img-autosize\n\n[svg]: https://github.com/theprotein/posthtml-to-svg-tags\n[svg-badge]: https://img.shields.io/npm/v/posthtml-to-svg-tags.svg\n[svg-npm]: https://npmjs.com/package/posthtml-to-svg-tags\n\n[webp]: https://github.com/posthtml/posthtml-webp\n[webp-badge]: https://img.shields.io/npm/v/posthtml-webp.svg\n[webp-npm]: https://npmjs.com/package/posthtml-webp\n\n[favicons]: https://github.com/mohsen1/posthtml-favicons\n[favicons-badge]: https://img.shields.io/npm/v/posthtml-favicons.svg\n[favicons-npm]: https://www.npmjs.com/package/posthtml-favicons\n\n#### Accessibility\n\n|Name|Status|Description|\n|:---|:-----|:----------|\n|[posthtml-aria-tabs][aria]|[![npm][aria-badge]][aria-npm]|Write accessible tabs with minimal markup|\n|[posthtml-alt-always][alt]|[![npm][alt-badge]][alt-npm]|Always add alt attribute for images that don't have it|\n|[posthtml-schemas][schemas]|[![npm][schemas-badge]][schemas-npm]| Add microdata to your HTML|\n\n[alt]: https://github.com/ismamz/posthtml-alt-always\n[alt-badge]: https://img.shields.io/npm/v/posthtml-alt-always.svg\n[alt-npm]: https://npmjs.com/package/posthtml-alt-always\n\n[aria]: https://github.com/jonathantneal/posthtml-aria-tabs\n[aria-badge]: https://img.shields.io/npm/v/posthtml-aria-tabs.svg\n[aria-npm]: https://npmjs.com/package/posthtml-aria-tabs\n\n[schemas]: https://github.com/jonathantneal/posthtml-schemas\n[schemas-badge]: https://img.shields.io/npm/v/posthtml-schemas.svg\n[schemas-npm]: https://npmjs.com/package/posthtml-schemas\n\n#### Optimization\n\n|Name|Status|Description|\n|:---|:-----|:----------|\n|[posthtml-shorten][shorten]|[![npm][shorten-badge]][shorten-npm]|Shorten URLs in HTML|\n|[posthtml-uglify][uglify]|[![npm][uglify-badge]][uglify-npm]|Shorten CSS in HTML|\n|[posthtml-minifier][minifier]|[![npm][minifier-badge]][minifier-npm]|Minify HTML|\n|[posthtml-remove-attributes][remove]|[![npm][remove-badge]][remove-npm]|Remove attributes unconditionally or with content match|\n|[posthtml-remove-tags][remove-tags]|[![npm][remove-tags-badge]][remove-tags-npm]|Remove tags with content match|\n|[posthtml-remove-duplicates][remove-duplicates]|[![npm][remove-duplicates-badge]][remove-duplicates-npm]|Remove duplicate elements from your html|\n|[posthtml-transformer][transform]|[![npm][transform-badge]][transform-npm]|Process HTML by directives in node attrs, such as inline scripts and styles, remove useless tags, concat scripts and styles etc.|\n|[htmlnano][nano]|[![npm][nano-badge]][nano-npm]|HTML Minifier|\n|[posthtml-link-noreferrer][noreferrer]|[![npm][noreferrer-badge]][noreferrer-npm]|Add `rel=\"noopener\"` and `rel=\"noreferrer\"` to all links that contain the attribute `target=\"_blank\"` |\n|[posthtml-lazyload][lazyload]|[![npm][lazyload-badge]][lazyload-npm]|Add native lazyload attribute|\n\n[remove]: https://github.com/princed/posthtml-remove-attributes\n[remove-badge]: https://img.shields.io/npm/v/posthtml-remove-attributes.svg\n[remove-npm]: https://npmjs.com/package/posthtml-remove-attributes\n\n[remove-tags]: https://github.com/posthtml/posthtml-remove-tags\n[remove-tags-badge]: https://img.shields.io/npm/v/posthtml-remove-tags.svg\n[remove-tags-npm]: https://npmjs.com/package/posthtml-remove-tags\n\n[remove-duplicates]: https://github.com/canvaskisa/posthtml-remove-duplicates\n[remove-duplicates-badge]: https://img.shields.io/npm/v/posthtml-remove-duplicates.svg\n[remove-duplicates-npm]: https://npmjs.com/package/posthtml-remove-duplicates\n\n[minifier]: https://github.com/Rebelmail/posthtml-minifier\n[minifier-badge]: https://img.shields.io/npm/v/posthtml-minifier.svg\n[minifier-npm]: https://npmjs.com/package/posthtml-minifier\n\n[shorten]: https://github.com/Rebelmail/posthtml-shorten\n[shorten-badge]: https://img.shields.io/npm/v/posthtml-shorten.svg\n[shorten-npm]: https://npmjs.com/package/posthtml-shorten\n\n[uglify]: https://github.com/Rebelmail/posthtml-uglify\n[uglify-badge]: https://img.shields.io/npm/v/posthtml-uglify.svg\n[uglify-npm]: https://npmjs.com/package/posthtml-uglify\n\n[nano]: https://github.com/maltsev/htmlnano\n[nano-badge]: https://img.shields.io/npm/v/htmlnano.svg\n[nano-npm]: https://npmjs.com/package/htmlnano\n\n[transform]: https://github.com/flashlizi/posthtml-transformer\n[transform-badge]: https://img.shields.io/npm/v/posthtml-transformer.svg\n[transform-npm]: https://npmjs.com/package/posthtml-transformer\n\n[noreferrer]: https://github.com/webistomin/posthtml-link-noreferrer\n[noreferrer-badge]: https://img.shields.io/npm/v/posthtml-link-noreferrer.svg\n[noreferrer-npm]: https://www.npmjs.com/package/posthtml-link-noreferrer\n\n[lazyload]: https://github.com/webistomin/posthtml-lazyload\n[lazyload-badge]: https://img.shields.io/npm/v/posthtml-link-noreferrer.svg\n[lazyload-npm]: https://www.npmjs.com/package/posthtml-lazyload\n\n#### Workflow\n\n|Name|Status|Description|\n|:---|:-----|:----------|\n|[posthtml-load-plugins][plugins]|[![npm][plugins-badge]][plugins-npm]|Autoload Plugins\n|[posthtml-load-options][options]|[![npm][options-badge]][options-npm]|Autoload Options (Parser && Render)|\n|[posthtml-load-config][config]|[![npm][config-badge]][config-npm]|Autoload Config (Plugins && Options)|\n|[posthtml-w3c][w3c]|[![npm][w3c-badge]][w3c-npm]|Validate HTML with W3C Validation|\n|[posthtml-hint][hint]|[![npm][hint-badge]][hint-npm]|Lint HTML with HTML Hint|\n|[posthtml-tidy][tidy]|[![npm][tidy-badge]][tidy-npm]|Sanitize HTML with HTML Tidy|\n\n[options]: https://github.com/posthtml/posthtml-load-options\n[options-badge]: https://img.shields.io/npm/v/posthtml-load-options.svg\n[options-npm]: https://npmjs.com/package/posthtml-load-options\n\n[plugins]: https://github.com/posthtml/posthtml-load-plugins\n[plugins-badge]: https://img.shields.io/npm/v/posthtml-load-plugins.svg\n[plugins-npm]: https://npmjs.com/package/posthtml-load-plugins\n\n[config]: https://github.com/posthtml/posthtml-load-config\n[config-badge]: https://img.shields.io/npm/v/posthtml-load-config.svg\n[config-npm]: https://npmjs.com/package/posthtml-load-config\n\n[tidy]: https://github.com/michael-ciniawsky/posthtml-tidy\n[tidy-badge]: https://img.shields.io/npm/v/posthtml-tidy.svg\n[tidy-npm]: https://npmjs.com/package/posthtml-tidy\n\n[hint]: https://github.com/posthtml/posthtml-hint\n[hint-badge]: https://img.shields.io/npm/v/posthtml-hint.svg\n[hint-npm]: https://npmjs.com/package/posthtml-hint\n\n[w3c]: https://github.com/posthtml/posthtml-w3c\n[w3c-badge]: https://img.shields.io/npm/v/posthtml-w3c.svg\n[w3c-npm]: https://npmjs.com/package/posthtml-w3c\n\n## Middleware\n\n|Name|Status|Description|\n|:---|:-----|:----------|\n|[koa-posthtml][koa]|[![npm][koa-badge]][koa-npm]|Koa Middleware|\n|[hapi-posthtml][hapi]|[![npm][hapi-badge]][hapi-npm]|Hapi Plugin|\n|[express-posthtml][express]|[![npm][express-badge]][express-npm]|Express Middleware|\n|[electron-posthtml][electron]|[![npm][electron-badge]][electron-npm]|Electron Plugin|\n|[metalsmith-posthtml][metalsmith]|[![npm][metalsmith-badge]][metalsmith-npm]|Metalsmith Plugin|\n\n[koa]: https://github.com/posthtml/koa-posthtml\n[koa-badge]: https://img.shields.io/npm/v/koa-posthtml.svg\n[koa-npm]: https://npmjs.com/package/koa-posthtml\n\n[hapi]: https://github.com/posthtml/hapi-posthtml\n[hapi-badge]: https://img.shields.io/npm/v/hapi-posthtml.svg\n[hapi-npm]: https://npmjs.com/package/hapi-posthtml\n\n[express]: https://github.com/posthtml/express-posthtml\n[express-badge]: https://img.shields.io/npm/v/express-posthtml.svg\n[express-npm]: https://npmjs.com/package/express-posthtml\n\n[electron]: https://github.com/posthtml/electron-posthtml\n[electron-badge]: https://img.shields.io/npm/v/electron-posthtml.svg\n[electron-npm]: https://npmjs.com/package/electron-posthtml\n\n[metalsmith]: https://github.com/posthtml/metalsmith-posthtml\n[metalsmith-badge]: https://img.shields.io/npm/v/metalsmith-posthtml.svg\n[metalsmith-npm]: https://npmjs.com/package/metalsmith-posthtml\n\n## Maintainers\n\n<table>\n <tbody>\n <tr>\n <td align=\"center\">\n <img width=\"150 height=\"150\"\n src=\"https://avatars0.githubusercontent.com/u/2789192?s=460&v=4\">\n <br />\n <a href=\"https://github.com/scrum\">Ivan Demidov</a>\n </td>\n <td align=\"center\">\n <img width=\"150 height=\"150\"\n src=\"https://avatars.githubusercontent.com/u/1510217?v=3&s=150\">\n <br />\n <a href=\"https://github.com/voischev\">Ivan Voischev</a>\n </td>\n <td align=\"center\">\n <img width=\"150 height=\"150\"\n src=\"https://avatars.githubusercontent.com/u/982072?v=3&s=150\">\n <br />\n <a href=\"https://github.com/awinogradov\">Anton Winogradov</a>\n </td>\n <td align=\"center\">\n <img width=\"150 height=\"150\"\n src=\"https://avatars.githubusercontent.com/u/677518?v=3&s=150\">\n <br />\n <a href=\"https://github.com/zxqfox\">Alexej Yaroshevich</a>\n </td>\n <td align=\"center\">\n <img width=\"150 height=\"150\"\n src=\"https://avatars.githubusercontent.com/u/1813468?v=3&s=150\">\n <br />\n <a href=\"https://github.com/Yeti-or\">Vasiliy</a>\n </td>\n </tr>\n <tbody>\n</table>\n\n## Contributing\n\nSee [PostHTML Guidelines](https://github.com/posthtml/posthtml/tree/master/docs) and [CONTRIBUTING](CONTRIBUTING.md).\n\n## LICENSE\n\n[MIT](LICENSE)\n\n[npm]: https://img.shields.io/npm/v/posthtml.svg\n[npm-url]: https://npmjs.com/package/posthtml\n\n[deps]: https://david-dm.org/posthtml/posthtml.svg\n[deps-url]: https://david-dm.org/posthtml/posthtml\n\n[build]: https://travis-ci.org/posthtml/posthtml.svg?branch=master\n[build-url]: https://travis-ci.org/posthtml/posthtml?branch=master\n\n[cover]: https://coveralls.io/repos/posthtml/posthtml/badge.svg?branch=master\n[cover-url]: https://coveralls.io/r/posthtml/posthtml?branch=master\n\n[code-style]: https://img.shields.io/badge/code%20style-standard-yellow.svg\n[code-style-url]: http://standardjs.com/\n\n[chat]: https://badges.gitter.im/posthtml/posthtml.svg\n[chat-url]: https://gitter.im/posthtml/posthtml?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\"\n# sprintf.js\n**sprintf.js** is a complete open source JavaScript sprintf implementation for the *browser* and *node.js*.\n\nIts prototype is simple:\n\n string sprintf(string format , [mixed arg1 [, mixed arg2 [ ,...]]])\n\nThe placeholders in the format string are marked by `%` and are followed by one or more of these elements, in this order:\n\n* An optional number followed by a `$` sign that selects which argument index to use for the value. If not specified, arguments will be placed in the same order as the placeholders in the input string.\n* An optional `+` sign that forces to preceed the result with a plus or minus sign on numeric values. By default, only the `-` sign is used on negative numbers.\n* An optional padding specifier that says what character to use for padding (if specified). Possible values are `0` or any other character precedeed by a `'` (single quote). The default is to pad with *spaces*.\n* An optional `-` sign, that causes sprintf to left-align the result of this placeholder. The default is to right-align the result.\n* An optional number, that says how many characters the result should have. If the value to be returned is shorter than this number, the result will be padded. When used with the `j` (JSON) type specifier, the padding length specifies the tab size used for indentation.\n* An optional precision modifier, consisting of a `.` (dot) followed by a number, that says how many digits should be displayed for floating point numbers. When used with the `g` type specifier, it specifies the number of significant digits. When used on a string, it causes the result to be truncated.\n* A type specifier that can be any of:\n * `%` — yields a literal `%` character\n * `b` — yields an integer as a binary number\n * `c` — yields an integer as the character with that ASCII value\n * `d` or `i` — yields an integer as a signed decimal number\n * `e` — yields a float using scientific notation\n * `u` — yields an integer as an unsigned decimal number\n * `f` — yields a float as is; see notes on precision above\n * `g` — yields a float as is; see notes on precision above\n * `o` — yields an integer as an octal number\n * `s` — yields a string as is\n * `x` — yields an integer as a hexadecimal number (lower-case)\n * `X` — yields an integer as a hexadecimal number (upper-case)\n * `j` — yields a JavaScript object or array as a JSON encoded string\n\n## JavaScript `vsprintf`\n`vsprintf` is the same as `sprintf` except that it accepts an array of arguments, rather than a variable number of arguments:\n\n vsprintf(\"The first 4 letters of the english alphabet are: %s, %s, %s and %s\", [\"a\", \"b\", \"c\", \"d\"])\n\n## Argument swapping\nYou can also swap the arguments. That is, the order of the placeholders doesn't have to match the order of the arguments. You can do that by simply indicating in the format string which arguments the placeholders refer to:\n\n sprintf(\"%2$s %3$s a %1$s\", \"cracker\", \"Polly\", \"wants\")\nAnd, of course, you can repeat the placeholders without having to increase the number of arguments.\n\n## Named arguments\nFormat strings may contain replacement fields rather than positional placeholders. Instead of referring to a certain argument, you can now refer to a certain key within an object. Replacement fields are surrounded by rounded parentheses - `(` and `)` - and begin with a keyword that refers to a key:\n\n var user = {\n name: \"Dolly\"\n }\n sprintf(\"Hello %(name)s\", user) // Hello Dolly\nKeywords in replacement fields can be optionally followed by any number of keywords or indexes:\n\n var users = [\n {name: \"Dolly\"},\n {name: \"Molly\"},\n {name: \"Polly\"}\n ]\n sprintf(\"Hello %(users[0].name)s, %(users[1].name)s and %(users[2].name)s\", {users: users}) // Hello Dolly, Molly and Polly\nNote: mixing positional and named placeholders is not (yet) supported\n\n## Computed values\nYou can pass in a function as a dynamic value and it will be invoked (with no arguments) in order to compute the value on-the-fly.\n\n sprintf(\"Current timestamp: %d\", Date.now) // Current timestamp: 1398005382890\n sprintf(\"Current date and time: %s\", function() { return new Date().toString() })\n\n# AngularJS\nYou can now use `sprintf` and `vsprintf` (also aliased as `fmt` and `vfmt` respectively) in your AngularJS projects. See `demo/`.\n\n# Installation\n\n## Via Bower\n\n bower install sprintf\n\n## Or as a node.js module\n\n npm install sprintf-js\n\n### Usage\n\n var sprintf = require(\"sprintf-js\").sprintf,\n vsprintf = require(\"sprintf-js\").vsprintf\n\n sprintf(\"%2$s %3$s a %1$s\", \"cracker\", \"Polly\", \"wants\")\n vsprintf(\"The first 4 letters of the english alphabet are: %s, %s, %s and %s\", [\"a\", \"b\", \"c\", \"d\"])\n\n# License\n\n**sprintf.js** is licensed under the terms of the 3-clause BSD license.\n# debug\n[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers)\n[](#sponsors)\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nA tiny JavaScript debugging utility modelled after Node.js core's debugging\ntechnique. Works in Node.js and web browsers.\n\n## Installation\n\n```bash\n$ npm install debug\n```\n\n## Usage\n\n`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.\n\nExample [_app.js_](./examples/node/app.js):\n\n```js\nvar debug = require('debug')('http')\n , http = require('http')\n , name = 'My App';\n\n// fake app\n\ndebug('booting %o', name);\n\nhttp.createServer(function(req, res){\n debug(req.method + ' ' + req.url);\n res.end('hello\\n');\n}).listen(3000, function(){\n debug('listening');\n});\n\n// fake worker of some kind\n\nrequire('./worker');\n```\n\nExample [_worker.js_](./examples/node/worker.js):\n\n```js\nvar a = require('debug')('worker:a')\n , b = require('debug')('worker:b');\n\nfunction work() {\n a('doing lots of uninteresting work');\n setTimeout(work, Math.random() * 1000);\n}\n\nwork();\n\nfunction workb() {\n b('doing some work');\n setTimeout(workb, Math.random() * 2000);\n}\n\nworkb();\n```\n\nThe `DEBUG` environment variable is then used to enable these based on space or\ncomma-delimited names.\n\nHere are some examples:\n\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 04 pm\" src=\"https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 38 pm\" src=\"https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 25 pm\" src=\"https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png\">\n\n#### Windows command prompt notes\n\n##### CMD\n\nOn Windows the environment variable is set using the `set` command.\n\n```cmd\nset DEBUG=*,-not_this\n```\n\nExample:\n\n```cmd\nset DEBUG=* & node app.js\n```\n\n##### PowerShell (VS Code default)\n\nPowerShell uses different syntax to set environment variables.\n\n```cmd\n$env:DEBUG = \"*,-not_this\"\n```\n\nExample:\n\n```cmd\n$env:DEBUG='app';node app.js\n```\n\nThen, run the program to be debugged as usual.\n\nnpm script example:\n```js\n \"windowsDebug\": \"@powershell -Command $env:DEBUG='*';node app.js\",\n```\n\n## Namespace Colors\n\nEvery debug instance has a color generated for it based on its namespace name.\nThis helps when visually parsing the debug output to identify which debug instance\na debug line belongs to.\n\n#### Node.js\n\nIn Node.js, colors are enabled when stderr is a TTY. You also _should_ install\nthe [`supports-color`](https://npmjs.org/supports-color) module alongside debug,\notherwise debug will only use a small handful of basic colors.\n\n<img width=\"521\" src=\"https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png\">\n\n#### Web Browser\n\nColors are also enabled on \"Web Inspectors\" that understand the `%c` formatting\noption. These are WebKit web inspectors, Firefox ([since version\n31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))\nand the Firebug plugin for Firefox (any version).\n\n<img width=\"524\" src=\"https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png\">\n\n## Millisecond diff\n\nWhen actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the \"+NNNms\" will show you how much time was spent between calls.\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nWhen stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png\">\n\n## Conventions\n\nIf you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use \":\" to separate features. For example \"bodyParser\" from Connect would then be \"connect:bodyParser\". If you append a \"*\" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.\n\n## Wildcards\n\nThe `*` character may be used as a wildcard. Suppose for example your library has\ndebuggers named \"connect:bodyParser\", \"connect:compress\", \"connect:session\",\ninstead of listing all three with\n`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do\n`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.\n\nYou can also exclude specific debuggers by prefixing them with a \"-\" character.\nFor example, `DEBUG=*,-connect:*` would include all debuggers except those\nstarting with \"connect:\".\n\n## Environment Variables\n\nWhen running through Node.js, you can set a few environment variables that will\nchange the behavior of the debug logging:\n\n| Name | Purpose |\n|-----------|-------------------------------------------------|\n| `DEBUG` | Enables/disables specific debugging namespaces. |\n| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |\n| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |\n| `DEBUG_DEPTH` | Object inspection depth. |\n| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |\n\n__Note:__ The environment variables beginning with `DEBUG_` end up being\nconverted into an Options object that gets used with `%o`/`%O` formatters.\nSee the Node.js documentation for\n[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)\nfor the complete list.\n\n## Formatters\n\nDebug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.\nBelow are the officially supported formatters:\n\n| Formatter | Representation |\n|-----------|----------------|\n| `%O` | Pretty-print an Object on multiple lines. |\n| `%o` | Pretty-print an Object all on a single line. |\n| `%s` | String. |\n| `%d` | Number (both integer and float). |\n| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |\n| `%%` | Single percent sign ('%'). This does not consume an argument. |\n\n### Custom formatters\n\nYou can add custom formatters by extending the `debug.formatters` object.\nFor example, if you wanted to add support for rendering a Buffer as hex with\n`%h`, you could do something like:\n\n```js\nconst createDebug = require('debug')\ncreateDebug.formatters.h = (v) => {\n return v.toString('hex')\n}\n\n// …elsewhere\nconst debug = createDebug('foo')\ndebug('this is hex: %h', new Buffer('hello world'))\n// foo this is hex: 68656c6c6f20776f726c6421 +0ms\n```\n\n## Browser Support\n\nYou can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),\nor just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),\nif you don't want to build it yourself.\n\nDebug's enable state is currently persisted by `localStorage`.\nConsider the situation shown below where you have `worker:a` and `worker:b`,\nand wish to debug both. You can enable this using `localStorage.debug`:\n\n```js\nlocalStorage.debug = 'worker:*'\n```\n\nAnd then refresh the page.\n\n```js\na = debug('worker:a');\nb = debug('worker:b');\n\nsetInterval(function(){\n a('doing some work');\n}, 1000);\n\nsetInterval(function(){\n b('doing some work');\n}, 1200);\n```\n\n## Output streams\n\n By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:\n\nExample [_stdout.js_](./examples/node/stdout.js):\n\n```js\nvar debug = require('debug');\nvar error = debug('app:error');\n\n// by default stderr is used\nerror('goes to stderr!');\n\nvar log = debug('app:log');\n// set this namespace to log via console.log\nlog.log = console.log.bind(console); // don't forget to bind to console!\nlog('goes to stdout');\nerror('still goes to stderr!');\n\n// set all output to go via console.info\n// overrides all per-namespace log settings\ndebug.log = console.info.bind(console);\nerror('now goes to stdout via console.info');\nlog('still goes to stdout, but via console.info now');\n```\n\n## Extend\nYou can simply extend debugger \n```js\nconst log = require('debug')('auth');\n\n//creates new debug instance with extended namespace\nconst logSign = log.extend('sign');\nconst logLogin = log.extend('login');\n\nlog('hello'); // auth hello\nlogSign('hello'); //auth:sign hello\nlogLogin('hello'); //auth:login hello\n```\n\n## Set dynamically\n\nYou can also enable debug dynamically by calling the `enable()` method :\n\n```js\nlet debug = require('debug');\n\nconsole.log(1, debug.enabled('test'));\n\ndebug.enable('test');\nconsole.log(2, debug.enabled('test'));\n\ndebug.disable();\nconsole.log(3, debug.enabled('test'));\n\n```\n\nprint : \n```\n1 false\n2 true\n3 false\n```\n\nUsage : \n`enable(namespaces)` \n`namespaces` can include modes separated by a colon and wildcards.\n \nNote that calling `enable()` completely overrides previously set DEBUG variable : \n\n```\n$ DEBUG=foo node -e 'var dbg = require(\"debug\"); dbg.enable(\"bar\"); console.log(dbg.enabled(\"foo\"))'\n=> false\n```\n\n`disable()`\n\nWill disable all namespaces. The functions returns the namespaces currently\nenabled (and skipped). This can be useful if you want to disable debugging\ntemporarily without knowing what was enabled to begin with.\n\nFor example:\n\n```js\nlet debug = require('debug');\ndebug.enable('foo:*,-foo:bar');\nlet namespaces = debug.disable();\ndebug.enable(namespaces);\n```\n\nNote: There is no guarantee that the string will be identical to the initial\nenable string, but semantically they will be identical.\n\n## Checking whether a debug target is enabled\n\nAfter you've created a debug instance, you can determine whether or not it is\nenabled by checking the `enabled` property:\n\n```javascript\nconst debug = require('debug')('http');\n\nif (debug.enabled) {\n // do stuff...\n}\n```\n\nYou can also manually toggle this property to force the debug instance to be\nenabled or disabled.\n\n## Authors\n\n - TJ Holowaychuk\n - Nathan Rajlich\n - Andrew Rhyne\n\n## Backers\n\nSupport us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]\n\n<a href=\"https://opencollective.com/debug/backer/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/29/avatar.svg\"></a>\n\n## Sponsors\n\nBecome a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]\n\n<a href=\"https://opencollective.com/debug/sponsor/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/29/avatar.svg\"></a>\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# Glob To Regular Expression\n\n[](https://travis-ci.org/fitzgen/glob-to-regexp)\n\nTurn a \\*-wildcard style glob (`\"*.min.js\"`) into a regular expression\n(`/^.*\\.min\\.js$/`)!\n\nTo match bash-like globs, eg. `?` for any single-character match, `[a-z]` for\ncharacter ranges, and `{*.html, *.js}` for multiple alternatives, call with\n`{ extended: true }`.\n\nTo obey [globstars `**`](https://github.com/isaacs/node-glob#glob-primer) rules set option `{globstar: true}`.\nNOTE: This changes the behavior of `*` when `globstar` is `true` as shown below:\nWhen `{globstar: true}`: `/foo/**` will match any string that starts with `/foo/`\nlike `/foo/index.htm`, `/foo/bar/baz.txt`, etc. Also, `/foo/**/*.txt` will match\nany string that starts with `/foo/` and ends with `.txt` like `/foo/bar.txt`,\n`/foo/bar/baz.txt`, etc.\nWhereas `/foo/*` (single `*`, not a globstar) will match strings that start with\n`/foo/` like `/foo/index.htm`, `/foo/baz.txt` but will not match strings that\ncontain a `/` to the right like `/foo/bar/baz.txt`, `/foo/bar/baz/qux.dat`, etc.\n\nSet flags on the resulting `RegExp` object by adding the `flags` property to the option object, eg `{ flags: \"i\" }` for ignoring case.\n\n## Install\n\n npm install glob-to-regexp\n\n## Usage\n```js\nvar globToRegExp = require('glob-to-regexp');\nvar re = globToRegExp(\"p*uck\");\nre.test(\"pot luck\"); // true\nre.test(\"pluck\"); // true\nre.test(\"puck\"); // true\n\nre = globToRegExp(\"*.min.js\");\nre.test(\"http://example.com/jquery.min.js\"); // true\nre.test(\"http://example.com/jquery.min.js.map\"); // false\n\nre = globToRegExp(\"*/www/*.js\");\nre.test(\"http://example.com/www/app.js\"); // true\nre.test(\"http://example.com/www/lib/factory-proxy-model-observer.js\"); // true\n\n// Extended globs\nre = globToRegExp(\"*/www/{*.js,*.html}\", { extended: true });\nre.test(\"http://example.com/www/app.js\"); // true\nre.test(\"http://example.com/www/index.html\"); // true\n```\n\n## License\n\nCopyright (c) 2013, Nick Fitzgerald\n\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice, this\n list of conditions and the following disclaimer in the documentation and/or\n other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\nANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\nLOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\nANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n<p align=\"center\">\n <a href=\"http://gulpjs.com\">\n <img height=\"257\" width=\"114\" src=\"https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png\">\n </a>\n</p>\n\n# v8flags\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]\n\nGet available v8 and Node.js flags.\n\n## Usage\n```js\nconst v8flags = require('v8flags');\n\nv8flags(function(err, results) {\n console.log(results);\n // [ '--use_strict',\n // '--es5_readonly',\n // '--es52_globals',\n // '--harmony_typeof',\n // '--harmony_scoping',\n // '--harmony_modules',\n // '--harmony_proxies',\n // '--harmony_collections',\n // '--harmony',\n // ...\n});\n```\n\n## API\n\n### `v8flags(cb)`\n\nFinds the available flags and calls the passed callback with any errors and an array of flag results.\n\n### `v8flags.configfile`\n\nThe name of the cache file for flags.\n\n### `v8flags.configPath`\n\nThe filepath location of the `configfile` above.\n\n## License\n\nMIT\n\n[downloads-image]: http://img.shields.io/npm/dm/v8flags.svg\n[npm-url]: https://www.npmjs.com/package/v8flags\n[npm-image]: http://img.shields.io/npm/v/v8flags.svg\n\n[travis-url]: https://travis-ci.org/gulpjs/v8flags\n[travis-image]: http://img.shields.io/travis/gulpjs/v8flags.svg?label=travis-ci\n\n[appveyor-url]: https://ci.appveyor.com/project/gulpjs/v8flags\n[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/v8flags.svg?label=appveyor\n\n[coveralls-url]: https://coveralls.io/r/gulpjs/v8flags\n[coveralls-image]: http://img.shields.io/coveralls/gulpjs/v8flags/master.svg\n\n[gitter-url]: https://gitter.im/gulpjs/gulp\n[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg\n# homedir-polyfill [](https://www.npmjs.com/package/homedir-polyfill) [](https://npmjs.org/package/homedir-polyfill) [](https://npmjs.org/package/homedir-polyfill) [](https://travis-ci.org/doowb/homedir-polyfill) [](https://ci.appveyor.com/project/doowb/homedir-polyfill)\n\n> Node.js os.homedir polyfill for older versions of node.js.\n\nPlease consider following this project's author, [Brian Woodward](https://github.com/doowb), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save homedir-polyfill\n```\n\n## Usage\n\n```js\nvar homedir = require('homedir-polyfill');\nconsole.log(homedir());\n//=> /Users/doowb\n```\n\n## Reasoning\n\nThis library is a polyfill for the [node.js os.homedir](https://nodejs.org/api/os.html#os_os_homedir) method found in modern versions of node.js.\n\nThis implementation tries to follow the implementation found in `libuv` by finding the current user using the `process.geteuid()` method and the `/etc/passwd` file. This should usually work in a linux environment, but will also fallback to looking at user specific environment variables to build the user's home directory if neccessary.\n\nSince `/etc/passwd` is not available on windows platforms, this implementation will use environment variables to find the home directory.\n\nIn modern versions of node.js, [os.homedir](https://nodejs.org/api/os.html#os_os_homedir) is used.\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n[parse-passwd](https://www.npmjs.com/package/parse-passwd): Parse a passwd file into a list of users. | [homepage](https://github.com/doowb/parse-passwd \"Parse a passwd file into a list of users.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 19 | [doowb](https://github.com/doowb) | \n| 2 | [martinheidegger](https://github.com/martinheidegger) | \n\n### Author\n\n**Brian Woodward**\n\n* [GitHub Profile](https://github.com/doowb)\n* [Twitter Profile](https://twitter.com/doowb)\n* [LinkedIn Profile](https://linkedin.com/in/woodwardbrian)\n\n### License\n\nCopyright © 2016 - 2019, [Brian Woodward](https://github.com/doowb).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on February 21, 2019._\n# capability.js - javascript environment capability detection\n\n[](https://travis-ci.org/inf3rno/capability)\n\nThe capability.js library provides capability detection for different javascript environments.\n\n## Documentation\n\nThis project is empty yet.\n\n### Installation\n\n```bash\nnpm install capability\n```\n\n```bash\nbower install capability\n```\n\n#### Environment compatibility\n\nThe lib requires only basic javascript features, so it will run in every js environments.\n\n#### Requirements\n\nIf you want to use the lib in browser, you'll need a node module loader, e.g. browserify, webpack, etc...\n\n#### Usage\n\nIn this documentation I used the lib as follows:\n\n```js\nvar capability = require(\"capability\");\n```\n\n### Capabilities API\n\n#### Defining a capability\n\nYou can define a capability by using the `define(name, test)` function.\n\n```js\ncapability.define(\"Object.create\", function () {\n return Object.create;\n});\n```\n\nThe `name` parameter should contain the identifier of the capability and the `test` parameter should contain a function, which can detect the capability.\nIf the capability is supported by the environment, then the `test()` should return `true`, otherwise it should return `false`.\n\nYou don't have to convert the return value into a `Boolean`, the library will do that for you, so you won't have memory leaks because of this.\n\n#### Testing a capability\n\nThe `test(name)` function will return a `Boolean` about whether the capability is supported by the actual environment.\n\n```js\nconsole.log(capability.test(\"Object.create\"));\n // true - in recent environments\n // false - by pre ES5 environments without Object.create\n```\n\nYou can use `capability(name)` instead of `capability.test(name)` if you want a short code by optional requirements.\n\n#### Checking a capability\n\nThe `check(name)` function will throw an Error when the capability is not supported by the actual environment.\n\n```js\ncapability.check(\"Object.create\");\n // this will throw an Error by pre ES5 environments without Object.create\n```\n\n#### Checking capability with require and modules\n\nIt is possible to check the environments with `require()` by adding a module, which calls the `check(name)` function.\nBy the capability definitions in this lib I added such modules by each definition, so you can do for example `require(\"capability/es5\")`.\nOfc. you can do fun stuff if you want, e.g. you can call multiple `check`s from a single `requirements.js` file in your lib, etc...\n\n### Definitions\n\nCurrently the following definitions are supported by the lib:\n\n - strict mode\n - `arguments.callee.caller`\n - es5\n - `Array.prototype.forEach`\n - `Array.prototype.map`\n - `Function.prototype.bind`\n - `Object.create`\n - `Object.defineProperties`\n - `Object.defineProperty`\n - `Object.prototype.hasOwnProperty`\n - `Error.captureStackTrace`\n - `Error.prototype.stack`\n \n## License\n\nMIT - 2016 Jánszky László Lajos\n# caniuse-api [](https://travis-ci.org/Nyalab/caniuse-api) [](https://ci.appveyor.com/project/MoOx/caniuse-api/branch/master)\n\nrequest the caniuse data to check browsers compatibilities\n\n## Installation\n\n```console\n$ yarn add caniuse-api\n```\n\n## Usage\n\n```js\nconst caniuse = require('caniuse-api')\n\ncaniuse.getSupport('border-radius')\ncaniuse.isSupported('border-radius', 'ie 8, ie 9')\ncaniuse.setBrowserScope('> 5%, last 1 version')\ncaniuse.getSupport('border-radius')\n// ...\n```\n\n## API\n\n#### `caniuse.getSupport(feature)`\n\n_ask since which browsers versions a feature is available_\n\n* `y`: Since which browser version the feature is available\n* `n`: Up to which browser version the feature is unavailable\n* `a`: Up to which browser version the feature is partially supported\n* `x`: Up to which browser version the feature is prefixed\n\n```js\ncaniuse.getSupport('border-radius', true)\n/*\n{ and_chr: { y: 67 },\n and_ff: { y: 60 },\n and_qq: { y: 1.2 },\n and_uc: { y: 11.8 },\n android: { y: 2.1, x: 2.1 },\n baidu: { y: 7.12 },\n chrome: { y: 4, x: 4 },\n edge: { y: 12 },\n firefox: { a: 2, x: 3.6, y: 3 },\n ie: { n: 8, y: 9 },\n ie_mob: { y: 10 },\n ios_saf: { y: 3.2, x: 3.2 },\n op_mini: {},\n op_mob: { n: 10, y: 11 },\n opera: { n: 10, y: 10.5 },\n safari: { y: 3.1, x: 4 },\n samsung: { y: 4 } }\n*/\n```\n\n#### `caniuse.isSupported(feature, browsers)`\n\n_ask if a feature is supported by some browsers_\n\n```js\ncaniuse.isSupported('border-radius', 'ie 8, ie 9') // false\ncaniuse.isSupported('border-radius', 'ie 9') // true\n```\n\n#### `caniuse.find(query)`\n\n_search for a caniuse feature name_\n\nEx:\n\n```js\ncaniuse.find('radius') // ['border-radius']\ncaniuse.find('nothingness') // []\ncaniuse.find('css3')\n/*\n[ 'css3-attr',\n 'css3-boxsizing',\n 'css3-colors',\n 'css3-cursors-grab',\n 'css3-cursors-newer',\n 'css3-cursors',\n 'css3-tabsize' ]\n*/\n```\n\n#### `caniuse.getLatestStableBrowsers()`\n\n_get the current version for each browser_\n\n```js\ncaniuse.getLatestStableBrowsers()\n/*\n[ 'and_chr 67',\n 'and_ff 60',\n 'and_qq 1.2',\n 'and_uc 11.8',\n 'android 67',\n 'baidu 7.12',\n 'bb 10',\n 'chrome 67',\n 'edge 17',\n 'firefox 61',\n 'ie 11',\n 'ie_mob 11',\n 'ios_saf 11.3-11.4',\n 'op_mini all',\n 'op_mob 46',\n 'opera 53',\n 'safari 11.1',\n 'samsung 7.2' ]\n*/\n```\n\n#### `caniuse.getBrowserScope()`\n\n_returns a list of browsers currently used for the scope of operations_\n\n```js\ncaniuse.getBrowserScope()\n/*\n[ 'and_chr',\n 'and_ff',\n 'and_qq',\n 'and_uc',\n 'android',\n 'baidu',\n 'chrome',\n 'edge',\n 'firefox',\n 'ie',\n 'ie_mob',\n 'ios_saf',\n 'op_mini',\n 'op_mob',\n 'opera',\n 'safari',\n 'samsung' ]\n*/\n```\n\n#### `caniuse.setBrowserScope(browserscope)`\n\n_if you do not like the default browser scope, you can set it globally by using this method_\n\n* browserscope should be a 'autoprefixer' formatted string\n\n```js\ncaniuse.setBrowserScope('> 5%, last 2 versions, Firefox ESR, Opera 12.1')\n```\n\n---\n\n## [Changelog](CHANGELOG.md)\n\n## [License](LICENSE)\n# mime-db\n\n[![NPM Version][npm-version-image]][npm-url]\n[![NPM Downloads][npm-downloads-image]][npm-url]\n[![Node.js Version][node-image]][node-url]\n[![Build Status][travis-image]][travis-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n\nThis is a database of all mime types.\nIt consists of a single, public JSON file and does not include any logic,\nallowing it to remain as un-opinionated as possible with an API.\nIt aggregates data from the following sources:\n\n- http://www.iana.org/assignments/media-types/media-types.xhtml\n- http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types\n- http://hg.nginx.org/nginx/raw-file/default/conf/mime.types\n\n## Installation\n\n```bash\nnpm install mime-db\n```\n\n### Database Download\n\nIf you're crazy enough to use this in the browser, you can just grab the\nJSON file using [jsDelivr](https://www.jsdelivr.com/). It is recommended to\nreplace `master` with [a release tag](https://github.com/jshttp/mime-db/tags)\nas the JSON format may change in the future.\n\n```\nhttps://cdn.jsdelivr.net/gh/jshttp/mime-db@master/db.json\n```\n\n## Usage\n\n<!-- eslint-disable no-unused-vars -->\n\n```js\nvar db = require('mime-db')\n\n// grab data on .js files\nvar data = db['application/javascript']\n```\n\n## Data Structure\n\nThe JSON file is a map lookup for lowercased mime types.\nEach mime type has the following properties:\n\n- `.source` - where the mime type is defined.\n If not set, it's probably a custom media type.\n - `apache` - [Apache common media types](http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types)\n - `iana` - [IANA-defined media types](http://www.iana.org/assignments/media-types/media-types.xhtml)\n - `nginx` - [nginx media types](http://hg.nginx.org/nginx/raw-file/default/conf/mime.types)\n- `.extensions[]` - known extensions associated with this mime type.\n- `.compressible` - whether a file of this type can be gzipped.\n- `.charset` - the default charset associated with this type, if any.\n\nIf unknown, every property could be `undefined`.\n\n## Contributing\n\nTo edit the database, only make PRs against `src/custom.json` or\n`src/custom-suffix.json`.\n\nThe `src/custom.json` file is a JSON object with the MIME type as the keys\nand the values being an object with the following keys:\n\n- `compressible` - leave out if you don't know, otherwise `true`/`false` to\n indicate whether the data represented by the type is typically compressible.\n- `extensions` - include an array of file extensions that are associated with\n the type.\n- `notes` - human-readable notes about the type, typically what the type is.\n- `sources` - include an array of URLs of where the MIME type and the associated\n extensions are sourced from. This needs to be a [primary source](https://en.wikipedia.org/wiki/Primary_source);\n links to type aggregating sites and Wikipedia are _not acceptable_.\n\nTo update the build, run `npm run build`.\n\n### Adding Custom Media Types\n\nThe best way to get new media types included in this library is to register\nthem with the IANA. The community registration procedure is outlined in\n[RFC 6838 section 5](http://tools.ietf.org/html/rfc6838#section-5). Types\nregistered with the IANA are automatically pulled into this library.\n\nIf that is not possible / feasible, they can be added directly here as a\n\"custom\" type. To do this, it is required to have a primary source that\ndefinitively lists the media type. If an extension is going to be listed as\nassociateed with this media type, the source must definitively link the\nmedia type and extension as well.\n\n[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/mime-db/master\n[coveralls-url]: https://coveralls.io/r/jshttp/mime-db?branch=master\n[node-image]: https://badgen.net/npm/node/mime-db\n[node-url]: https://nodejs.org/en/download\n[npm-downloads-image]: https://badgen.net/npm/dm/mime-db\n[npm-url]: https://npmjs.org/package/mime-db\n[npm-version-image]: https://badgen.net/npm/v/mime-db\n[travis-image]: https://badgen.net/travis/jshttp/mime-db/master\n[travis-url]: https://travis-ci.org/jshttp/mime-db\n# tar-fs\n\nfilesystem bindings for [tar-stream](https://github.com/mafintosh/tar-stream).\n\n```\nnpm install tar-fs\n```\n\n[](http://travis-ci.org/mafintosh/tar-fs)\n\n## Usage\n\ntar-fs allows you to pack directories into tarballs and extract tarballs into directories.\n\nIt doesn't gunzip for you, so if you want to extract a `.tar.gz` with this you'll need to use something like [gunzip-maybe](https://github.com/mafintosh/gunzip-maybe) in addition to this.\n\n``` js\nvar tar = require('tar-fs')\nvar fs = require('fs')\n\n// packing a directory\ntar.pack('./my-directory').pipe(fs.createWriteStream('my-tarball.tar'))\n\n// extracting a directory\nfs.createReadStream('my-other-tarball.tar').pipe(tar.extract('./my-other-directory'))\n```\n\nTo ignore various files when packing or extracting add a ignore function to the options. `ignore`\nis also an alias for `filter`. Additionally you get `header` if you use ignore while extracting.\nThat way you could also filter by metadata.\n\n``` js\nvar pack = tar.pack('./my-directory', {\n ignore: function(name) {\n return path.extname(name) === '.bin' // ignore .bin files when packing\n }\n})\n\nvar extract = tar.extract('./my-other-directory', {\n ignore: function(name) {\n return path.extname(name) === '.bin' // ignore .bin files inside the tarball when extracing\n }\n})\n\nvar extractFilesDirs = tar.extract('./my-other-other-directory', {\n ignore: function(_, header) {\n // pass files & directories, ignore e.g. symlinks\n return header.type !== 'file' && header.type !== 'directory'\n }\n})\n```\n\nYou can also specify which entries to pack using the `entries` option\n\n```js\nvar pack = tar.pack('./my-directory', {\n entries: ['file1', 'subdir/file2'] // only the specific entries will be packed\n})\n```\n\nIf you want to modify the headers when packing/extracting add a map function to the options\n\n``` js\nvar pack = tar.pack('./my-directory', {\n map: function(header) {\n header.name = 'prefixed/'+header.name\n return header\n }\n})\n\nvar extract = tar.extract('./my-directory', {\n map: function(header) {\n header.name = 'another-prefix/'+header.name\n return header\n }\n})\n```\n\nSimilarly you can use `mapStream` incase you wanna modify the input/output file streams\n\n``` js\nvar pack = tar.pack('./my-directory', {\n mapStream: function(fileStream, header) {\n if (path.extname(header.name) === '.js') {\n return fileStream.pipe(someTransform)\n }\n return fileStream;\n }\n})\n\nvar extract = tar.extract('./my-directory', {\n mapStream: function(fileStream, header) {\n if (path.extname(header.name) === '.js') {\n return fileStream.pipe(someTransform)\n }\n return fileStream;\n }\n})\n```\n\nSet `options.fmode` and `options.dmode` to ensure that files/directories extracted have the corresponding modes\n\n``` js\nvar extract = tar.extract('./my-directory', {\n dmode: parseInt(555, 8), // all dirs should be readable\n fmode: parseInt(444, 8) // all files should be readable\n})\n```\n\nIt can be useful to use `dmode` and `fmode` if you are packing/unpacking tarballs between *nix/windows to ensure that all files/directories unpacked are readable.\n\nAlternatively you can set `options.readable` and/or `options.writable` to set the dmode and fmode to readable/writable.\n\n``` js\nvar extract = tar.extract('./my-directory', {\n readable: true, // all dirs and files should be readable\n writable: true, // all dirs and files should be writable\n})\n```\n\nSet `options.strict` to `false` if you want to ignore errors due to unsupported entry types (like device files)\n\nTo dereference symlinks (pack the contents of the symlink instead of the link itself) set `options.dereference` to `true`.\n\n## Copy a directory\n\nCopying a directory with permissions and mtime intact is as simple as\n\n``` js\ntar.pack('source-directory').pipe(tar.extract('dest-directory'))\n```\n\n## Interaction with [`tar-stream`](https://github.com/mafintosh/tar-stream)\n\nUse `finalize: false` and the `finish` hook to\nleave the pack stream open for further entries (see\n[`tar-stream#pack`](https://github.com/mafintosh/tar-stream#packing)),\nand use `pack` to pass an existing pack stream.\n\n``` js\nvar mypack = tar.pack('./my-directory', {\n finalize: false,\n finish: function(sameAsMypack) {\n mypack.entry({name: 'generated-file.txt'}, \"hello\")\n tar.pack('./other-directory', {\n pack: sameAsMypack\n })\n }\n})\n```\n\n## Performance\n\nPacking and extracting a 6.1 GB with 2496 directories and 2398 files yields the following results on my Macbook Air.\n[See the benchmark here](https://gist.github.com/mafintosh/8102201)\n\n* tar-fs: 34.261 seconds\n* [node-tar](https://github.com/isaacs/node-tar): 366.123 seconds (or 10x slower)\n\n## License\n\nMIT\n<div align=\"center\">\n <h1>jest-each</h1>\n Jest Parameterised Testing\n</div>\n\n<hr />\n\n[](https://www.npmjs.com/package/jest-each) [](http://npm-stat.com/charts.html?package=jest-each&from=2017-03-21) [](https://github.com/facebook/jest/blob/master/LICENSE)\n\nA parameterised testing library for [Jest](https://jestjs.io/) inspired by [mocha-each](https://github.com/ryym/mocha-each).\n\njest-each allows you to provide multiple arguments to your `test`/`describe` which results in the test/suite being run once per row of parameters.\n\n## Features\n\n- `.test` to runs multiple tests with parameterised data\n - Also under the alias: `.it`\n- `.test.only` to only run the parameterised tests\n - Also under the aliases: `.it.only` or `.fit`\n- `.test.skip` to skip the parameterised tests\n - Also under the aliases: `.it.skip` or `.xit` or `.xtest`\n- `.test.concurrent`\n - Also under the alias: `.it.concurrent`\n- `.test.concurrent.only`\n - Also under the alias: `.it.concurrent.only`\n- `.test.concurrent.skip`\n - Also under the alias: `.it.concurrent.skip`\n- `.describe` to runs test suites with parameterised data\n- `.describe.only` to only run the parameterised suite of tests\n - Also under the aliases: `.fdescribe`\n- `.describe.skip` to skip the parameterised suite of tests\n - Also under the aliases: `.xdescribe`\n- Asynchronous tests with `done`\n- Unique test titles with [`printf` formatting](https://nodejs.org/api/util.html#util_util_format_format_args):\n - `%p` - [pretty-format](https://www.npmjs.com/package/pretty-format).\n - `%s`- String.\n - `%d`- Number.\n - `%i` - Integer.\n - `%f` - Floating point value.\n - `%j` - JSON.\n - `%o` - Object.\n - `%#` - Index of the test case.\n - `%%` - single percent sign ('%'). This does not consume an argument.\n- 🖖 Spock like data tables with [Tagged Template Literals](#tagged-template-literal-of-rows)\n\n---\n\n- [Demo](#demo)\n- [Installation](#installation)\n- [Importing](#importing)\n- APIs\n - [Array of Rows](#array-of-rows)\n - [Usage](#usage)\n - [Tagged Template Literal of rows](#tagged-template-literal-of-rows)\n - [Usage](#usage-1)\n\n## Demo\n\n#### Tests without jest-each\n\n\n\n#### Tests can be re-written with jest-each to:\n\n**`.test`**\n\n\n\n**`.test` with Tagged Template Literals**\n\n\n\n**`.describe`**\n\n\n\n## Installation\n\n`npm i --save-dev jest-each`\n\n`yarn add -D jest-each`\n\n## Importing\n\njest-each is a default export so it can be imported with whatever name you like.\n\n```js\n// es6\nimport each from 'jest-each';\n```\n\n```js\n// es5\nconst each = require('jest-each').default;\n```\n\n## Array of rows\n\n### API\n\n#### `each([parameters]).test(name, testFn)`\n\n##### `each`:\n\n- parameters: `Array` of Arrays with the arguments that are passed into the `testFn` for each row\n - _Note_ If you pass in a 1D array of primitives, internally it will be mapped to a table i.e. `[1, 2, 3] -> [[1], [2], [3]]`\n\n##### `.test`:\n\n- name: `String` the title of the `test`.\n - Generate unique test titles by positionally injecting parameters with [`printf` formatting](https://nodejs.org/api/util.html#util_util_format_format_args):\n - `%p` - [pretty-format](https://www.npmjs.com/package/pretty-format).\n - `%s`- String.\n - `%d`- Number.\n - `%i` - Integer.\n - `%f` - Floating point value.\n - `%j` - JSON.\n - `%o` - Object.\n - `%#` - Index of the test case.\n - `%%` - single percent sign ('%'). This does not consume an argument.\n- testFn: `Function` the test logic, this is the function that will receive the parameters of each row as function arguments\n\n#### `each([parameters]).describe(name, suiteFn)`\n\n##### `each`:\n\n- parameters: `Array` of Arrays with the arguments that are passed into the `suiteFn` for each row\n - _Note_ If you pass in a 1D array of primitives, internally it will be mapped to a table i.e. `[1, 2, 3] -> [[1], [2], [3]]`\n\n##### `.describe`:\n\n- name: `String` the title of the `describe`\n - Generate unique test titles by positionally injecting parameters with [`printf` formatting](https://nodejs.org/api/util.html#util_util_format_format_args):\n - `%p` - [pretty-format](https://www.npmjs.com/package/pretty-format).\n - `%s`- String.\n - `%d`- Number.\n - `%i` - Integer.\n - `%f` - Floating point value.\n - `%j` - JSON.\n - `%o` - Object.\n - `%#` - Index of the test case.\n - `%%` - single percent sign ('%'). This does not consume an argument.\n- suiteFn: `Function` the suite of `test`/`it`s to be ran, this is the function that will receive the parameters in each row as function arguments\n\n### Usage\n\n#### `.test(name, fn)`\n\nAlias: `.it(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).test('returns the result of adding %d to %d', (a, b, expected) => {\n expect(a + b).toBe(expected);\n});\n```\n\n#### `.test.only(name, fn)`\n\nAliases: `.it.only(name, fn)` or `.fit(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).test.only('returns the result of adding %d to %d', (a, b, expected) => {\n expect(a + b).toBe(expected);\n});\n```\n\n#### `.test.skip(name, fn)`\n\nAliases: `.it.skip(name, fn)` or `.xit(name, fn)` or `.xtest(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).test.skip('returns the result of adding %d to %d', (a, b, expected) => {\n expect(a + b).toBe(expected);\n});\n```\n\n#### `.test.concurrent(name, fn)`\n\nAliases: `.it.concurrent(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).test.concurrent(\n 'returns the result of adding %d to %d',\n (a, b, expected) => {\n expect(a + b).toBe(expected);\n },\n);\n```\n\n#### `.test.concurrent.only(name, fn)`\n\nAliases: `.it.concurrent.only(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).test.concurrent.only(\n 'returns the result of adding %d to %d',\n (a, b, expected) => {\n expect(a + b).toBe(expected);\n },\n);\n```\n\n#### `.test.concurrent.skip(name, fn)`\n\nAliases: `.it.concurrent.skip(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).test.concurrent.skip(\n 'returns the result of adding %d to %d',\n (a, b, expected) => {\n expect(a + b).toBe(expected);\n },\n);\n```\n\n#### Asynchronous `.test(name, fn(done))`\n\nAlias: `.it(name, fn(done))`\n\n```js\neach([['hello'], ['mr'], ['spy']]).test(\n 'gives 007 secret message: %s',\n (str, done) => {\n const asynchronousSpy = message => {\n expect(message).toBe(str);\n done();\n };\n callSomeAsynchronousFunction(asynchronousSpy)(str);\n },\n);\n```\n\n#### `.describe(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).describe('.add(%d, %d)', (a, b, expected) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n\n test('does not mutate first arg', () => {\n a + b;\n expect(a).toBe(a);\n });\n\n test('does not mutate second arg', () => {\n a + b;\n expect(b).toBe(b);\n });\n});\n```\n\n#### `.describe.only(name, fn)`\n\nAliases: `.fdescribe(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).describe.only('.add(%d, %d)', (a, b, expected) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n});\n```\n\n#### `.describe.skip(name, fn)`\n\nAliases: `.xdescribe(name, fn)`\n\n```js\neach([\n [1, 1, 2],\n [1, 2, 3],\n [2, 1, 3],\n]).describe.skip('.add(%d, %d)', (a, b, expected) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n});\n```\n\n---\n\n## Tagged Template Literal of rows\n\n### API\n\n#### `each[tagged template].test(name, suiteFn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.test('returns $expected when adding $a to $b', ({a, b, expected}) => {\n expect(a + b).toBe(expected);\n});\n```\n\n##### `each` takes a tagged template string with:\n\n- First row of variable name column headings separated with `|`\n- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.\n\n##### `.test`:\n\n- name: `String` the title of the `test`, use `$variable` in the name string to inject test values into the test title from the tagged template expressions\n - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`\n- testFn: `Function` the test logic, this is the function that will receive the parameters of each row as function arguments\n\n#### `each[tagged template].describe(name, suiteFn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.describe('$a + $b', ({a, b, expected}) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n\n test('does not mutate first arg', () => {\n a + b;\n expect(a).toBe(a);\n });\n\n test('does not mutate second arg', () => {\n a + b;\n expect(b).toBe(b);\n });\n});\n```\n\n##### `each` takes a tagged template string with:\n\n- First row of variable name column headings separated with `|`\n- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.\n\n##### `.describe`:\n\n- name: `String` the title of the `test`, use `$variable` in the name string to inject test values into the test title from the tagged template expressions\n - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`\n- suiteFn: `Function` the suite of `test`/`it`s to be ran, this is the function that will receive the parameters in each row as function arguments\n\n### Usage\n\n#### `.test(name, fn)`\n\nAlias: `.it(name, fn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.test('returns $expected when adding $a to $b', ({a, b, expected}) => {\n expect(a + b).toBe(expected);\n});\n```\n\n#### `.test.only(name, fn)`\n\nAliases: `.it.only(name, fn)` or `.fit(name, fn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.test.only('returns $expected when adding $a to $b', ({a, b, expected}) => {\n expect(a + b).toBe(expected);\n});\n```\n\n#### `.test.skip(name, fn)`\n\nAliases: `.it.skip(name, fn)` or `.xit(name, fn)` or `.xtest(name, fn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.test.skip('returns $expected when adding $a to $b', ({a, b, expected}) => {\n expect(a + b).toBe(expected);\n});\n```\n\n#### Asynchronous `.test(name, fn(done))`\n\nAlias: `.it(name, fn(done))`\n\n```js\neach`\n str\n ${'hello'}\n ${'mr'}\n ${'spy'}\n`.test('gives 007 secret message: $str', ({str}, done) => {\n const asynchronousSpy = message => {\n expect(message).toBe(str);\n done();\n };\n callSomeAsynchronousFunction(asynchronousSpy)(str);\n});\n```\n\n#### `.describe(name, fn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.describe('$a + $b', ({a, b, expected}) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n\n test('does not mutate first arg', () => {\n a + b;\n expect(a).toBe(a);\n });\n\n test('does not mutate second arg', () => {\n a + b;\n expect(b).toBe(b);\n });\n});\n```\n\n#### `.describe.only(name, fn)`\n\nAliases: `.fdescribe(name, fn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.describe.only('$a + $b', ({a, b, expected}) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n});\n```\n\n#### `.describe.skip(name, fn)`\n\nAliases: `.xdescribe(name, fn)`\n\n```js\neach`\n a | b | expected\n ${1} | ${1} | ${2}\n ${1} | ${2} | ${3}\n ${2} | ${1} | ${3}\n`.describe.skip('$a + $b', ({a, b, expected}) => {\n test(`returns ${expected}`, () => {\n expect(a + b).toBe(expected);\n });\n});\n```\n\n## License\n\nMIT\n# color-convert\n\n[](https://travis-ci.org/Qix-/color-convert)\n\nColor-convert is a color conversion library for JavaScript and node.\nIt converts all ways between `rgb`, `hsl`, `hsv`, `hwb`, `cmyk`, `ansi`, `ansi16`, `hex` strings, and CSS `keyword`s (will round to closest):\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hsl(140, 200, 100); // [96, 48, 59]\nconvert.keyword.rgb('blue'); // [0, 0, 255]\n\nvar rgbChannels = convert.rgb.channels; // 3\nvar cmykChannels = convert.cmyk.channels; // 4\nvar ansiChannels = convert.ansi16.channels; // 1\n```\n\n# Install\n\n```console\n$ npm install color-convert\n```\n\n# API\n\nSimply get the property of the _from_ and _to_ conversion that you're looking for.\n\nAll functions have a rounded and unrounded variant. By default, return values are rounded. To get the unrounded (raw) results, simply tack on `.raw` to the function.\n\nAll 'from' functions have a hidden property called `.channels` that indicates the number of channels the function expects (not including alpha).\n\n```js\nvar convert = require('color-convert');\n\n// Hex to LAB\nconvert.hex.lab('DEADBF'); // [ 76, 21, -2 ]\nconvert.hex.lab.raw('DEADBF'); // [ 75.56213190997677, 20.653827952644754, -2.290532499330533 ]\n\n// RGB to CMYK\nconvert.rgb.cmyk(167, 255, 4); // [ 35, 0, 98, 0 ]\nconvert.rgb.cmyk.raw(167, 255, 4); // [ 34.509803921568626, 0, 98.43137254901961, 0 ]\n```\n\n### Arrays\nAll functions that accept multiple arguments also support passing an array.\n\nNote that this does **not** apply to functions that convert from a color that only requires one value (e.g. `keyword`, `ansi256`, `hex`, etc.)\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hex(123, 45, 67); // '7B2D43'\nconvert.rgb.hex([123, 45, 67]); // '7B2D43'\n```\n\n## Routing\n\nConversions that don't have an _explicitly_ defined conversion (in [conversions.js](conversions.js)), but can be converted by means of sub-conversions (e.g. XYZ -> **RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex).\n\nKeep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of \"direct\" (single-step) conversions, see [conversions.js](conversions.js).\n\n# Contribute\n\nIf there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.\n\n# License\nCopyright © 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE).\n# Determine the Encoding of a HTML Byte Stream\n\nThis package implements the HTML Standard's [encoding sniffing algorithm](https://html.spec.whatwg.org/multipage/syntax.html#encoding-sniffing-algorithm) in all its glory. The most interesting part of this is how it pre-scans the first 1024 bytes in order to search for certain `<meta charset>`-related patterns.\n\n```js\nconst htmlEncodingSniffer = require(\"html-encoding-sniffer\");\nconst fs = require(\"fs\");\n\nconst htmlBuffer = fs.readFileSync(\"./html-page.html\");\nconst sniffedEncoding = htmlEncodingSniffer(htmlBuffer);\n```\n\nThe returned value will be a canonical [encoding name](https://encoding.spec.whatwg.org/#names-and-labels) (not a label). You might then combine this with the [whatwg-encoding](https://github.com/jsdom/whatwg-encoding) package to decode the result:\n\n```js\nconst whatwgEncoding = require(\"whatwg-encoding\");\nconst htmlString = whatwgEncoding.decode(htmlBuffer, sniffedEncoding);\n```\n\n## Options\n\nYou can pass two potential options to `htmlEncodingSniffer`:\n\n```js\nconst sniffedEncoding = htmlEncodingSniffer(htmlBuffer, {\n transportLayerEncodingLabel,\n defaultEncoding\n});\n```\n\nThese represent two possible inputs into the [encoding sniffing algorithm](https://html.spec.whatwg.org/multipage/syntax.html#encoding-sniffing-algorithm):\n\n- `transportLayerEncodingLabel` is an encoding label that is obtained from the \"transport layer\" (probably a HTTP `Content-Type` header), which overrides everything but a BOM.\n- `defaultEncoding` is the ultimate fallback encoding used if no valid encoding is supplied by the transport layer, and no encoding is sniffed from the bytes. It defaults to `\"windows-1252\"`, as recommended by the algorithm's table of suggested defaults for \"All other locales\" (including the `en` locale).\n\n## Credits\n\nThis package was originally based on the excellent work of [@nicolashenry](https://github.com/nicolashenry), [in jsdom](https://github.com/tmpvar/jsdom/blob/16fd85618f2705d181232f6552125872a37164bc/lib/jsdom/living/helpers/encoding.js). It has since been pulled out into this separate package.\n# isobject [](https://www.npmjs.com/package/isobject) [](https://npmjs.org/package/isobject) [](https://npmjs.org/package/isobject) [](https://travis-ci.org/jonschlinkert/isobject)\n\n> Returns true if the value is an object and not an array or null.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save isobject\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add isobject\n```\n\nUse [is-plain-object](https://github.com/jonschlinkert/is-plain-object) if you want only objects that are created by the `Object` constructor.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install isobject\n```\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install isobject\n```\n\n## Usage\n\n```js\nvar isObject = require('isobject');\n```\n\n**True**\n\nAll of the following return `true`:\n\n```js\nisObject({});\nisObject(Object.create({}));\nisObject(Object.create(Object.prototype));\nisObject(Object.create(null));\nisObject({});\nisObject(new Foo);\nisObject(/foo/);\n```\n\n**False**\n\nAll of the following return `false`:\n\n```js\nisObject();\nisObject(function () {});\nisObject(1);\nisObject([]);\nisObject(undefined);\nisObject(null);\n```\n\n## About\n\n### Related projects\n\n* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow \"Extend an object with the properties of additional objects. node.js/javascript util.\")\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object \"Returns true if an object was created by the `Object` constructor.\")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep \"Recursively merge values in a javascript object.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 29 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 4 | [doowb](https://github.com/doowb) | \n| 1 | [magnudae](https://github.com/magnudae) | \n| 1 | [LeSuisse](https://github.com/LeSuisse) | \n| 1 | [tmcw](https://github.com/tmcw) | \n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 30, 2017._\n# safe-buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]\n\n[travis-image]: https://img.shields.io/travis/feross/safe-buffer/master.svg\n[travis-url]: https://travis-ci.org/feross/safe-buffer\n[npm-image]: https://img.shields.io/npm/v/safe-buffer.svg\n[npm-url]: https://npmjs.org/package/safe-buffer\n[downloads-image]: https://img.shields.io/npm/dm/safe-buffer.svg\n[downloads-url]: https://npmjs.org/package/safe-buffer\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n\n#### Safer Node.js Buffer API\n\n**Use the new Node.js Buffer APIs (`Buffer.from`, `Buffer.alloc`,\n`Buffer.allocUnsafe`, `Buffer.allocUnsafeSlow`) in all versions of Node.js.**\n\n**Uses the built-in implementation when available.**\n\n## install\n\n```\nnpm install safe-buffer\n```\n\n## usage\n\nThe goal of this package is to provide a safe replacement for the node.js `Buffer`.\n\nIt's a drop-in replacement for `Buffer`. You can use it by adding one `require` line to\nthe top of your node.js modules:\n\n```js\nvar Buffer = require('safe-buffer').Buffer\n\n// Existing buffer code will continue to work without issues:\n\nnew Buffer('hey', 'utf8')\nnew Buffer([1, 2, 3], 'utf8')\nnew Buffer(obj)\nnew Buffer(16) // create an uninitialized buffer (potentially unsafe)\n\n// But you can use these new explicit APIs to make clear what you want:\n\nBuffer.from('hey', 'utf8') // convert from many types to a Buffer\nBuffer.alloc(16) // create a zero-filled buffer (safe)\nBuffer.allocUnsafe(16) // create an uninitialized buffer (potentially unsafe)\n```\n\n## api\n\n### Class Method: Buffer.from(array)\n<!-- YAML\nadded: v3.0.0\n-->\n\n* `array` {Array}\n\nAllocates a new `Buffer` using an `array` of octets.\n\n```js\nconst buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);\n // creates a new Buffer containing ASCII bytes\n // ['b','u','f','f','e','r']\n```\n\nA `TypeError` will be thrown if `array` is not an `Array`.\n\n### Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or\n a `new ArrayBuffer()`\n* `byteOffset` {Number} Default: `0`\n* `length` {Number} Default: `arrayBuffer.length - byteOffset`\n\nWhen passed a reference to the `.buffer` property of a `TypedArray` instance,\nthe newly created `Buffer` will share the same allocated memory as the\nTypedArray.\n\n```js\nconst arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = Buffer.from(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n // Prints: <Buffer 88 13 70 17>\n```\n\nThe optional `byteOffset` and `length` arguments specify a memory range within\nthe `arrayBuffer` that will be shared by the `Buffer`.\n\n```js\nconst ab = new ArrayBuffer(10);\nconst buf = Buffer.from(ab, 0, 2);\nconsole.log(buf.length);\n // Prints: 2\n```\n\nA `TypeError` will be thrown if `arrayBuffer` is not an `ArrayBuffer`.\n\n### Class Method: Buffer.from(buffer)\n<!-- YAML\nadded: v3.0.0\n-->\n\n* `buffer` {Buffer}\n\nCopies the passed `buffer` data onto a new `Buffer` instance.\n\n```js\nconst buf1 = Buffer.from('buffer');\nconst buf2 = Buffer.from(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n // 'auffer'\nconsole.log(buf2.toString());\n // 'buffer' (copy is not changed)\n```\n\nA `TypeError` will be thrown if `buffer` is not a `Buffer`.\n\n### Class Method: Buffer.from(str[, encoding])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `str` {String} String to encode.\n* `encoding` {String} Encoding to use, Default: `'utf8'`\n\nCreates a new `Buffer` containing the given JavaScript string `str`. If\nprovided, the `encoding` parameter identifies the character encoding.\nIf not provided, `encoding` defaults to `'utf8'`.\n\n```js\nconst buf1 = Buffer.from('this is a tést');\nconsole.log(buf1.toString());\n // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n // prints: this is a tC)st\n\nconst buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n // prints: this is a tést\n```\n\nA `TypeError` will be thrown if `str` is not a string.\n\n### Class Method: Buffer.alloc(size[, fill[, encoding]])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n* `fill` {Value} Default: `undefined`\n* `encoding` {String} Default: `utf8`\n\nAllocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the\n`Buffer` will be *zero-filled*.\n\n```js\nconst buf = Buffer.alloc(5);\nconsole.log(buf);\n // <Buffer 00 00 00 00 00>\n```\n\nThe `size` must be less than or equal to the value of\n`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is\n`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will\nbe created if a `size` less than or equal to 0 is specified.\n\nIf `fill` is specified, the allocated `Buffer` will be initialized by calling\n`buf.fill(fill)`. See [`buf.fill()`][] for more information.\n\n```js\nconst buf = Buffer.alloc(5, 'a');\nconsole.log(buf);\n // <Buffer 61 61 61 61 61>\n```\n\nIf both `fill` and `encoding` are specified, the allocated `Buffer` will be\ninitialized by calling `buf.fill(fill, encoding)`. For example:\n\n```js\nconst buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');\nconsole.log(buf);\n // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>\n```\n\nCalling `Buffer.alloc(size)` can be significantly slower than the alternative\n`Buffer.allocUnsafe(size)` but ensures that the newly created `Buffer` instance\ncontents will *never contain sensitive data*.\n\nA `TypeError` will be thrown if `size` is not a number.\n\n### Class Method: Buffer.allocUnsafe(size)\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n\nAllocates a new *non-zero-filled* `Buffer` of `size` bytes. The `size` must\nbe less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit\narchitectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is\nthrown. A zero-length Buffer will be created if a `size` less than or equal to\n0 is specified.\n\nThe underlying memory for `Buffer` instances created in this way is *not\ninitialized*. The contents of the newly created `Buffer` are unknown and\n*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such\n`Buffer` instances to zeroes.\n\n```js\nconst buf = Buffer.allocUnsafe(5);\nconsole.log(buf);\n // <Buffer 78 e0 82 02 01>\n // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n // <Buffer 00 00 00 00 00>\n```\n\nA `TypeError` will be thrown if `size` is not a number.\n\nNote that the `Buffer` module pre-allocates an internal `Buffer` instance of\nsize `Buffer.poolSize` that is used as a pool for the fast allocation of new\n`Buffer` instances created using `Buffer.allocUnsafe(size)` (and the deprecated\n`new Buffer(size)` constructor) only when `size` is less than or equal to\n`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). The default\nvalue of `Buffer.poolSize` is `8192` but can be modified.\n\nUse of this pre-allocated internal memory pool is a key difference between\ncalling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.\nSpecifically, `Buffer.alloc(size, fill)` will *never* use the internal Buffer\npool, while `Buffer.allocUnsafe(size).fill(fill)` *will* use the internal\nBuffer pool if `size` is less than or equal to half `Buffer.poolSize`. The\ndifference is subtle but can be important when an application requires the\nadditional performance that `Buffer.allocUnsafe(size)` provides.\n\n### Class Method: Buffer.allocUnsafeSlow(size)\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n\nAllocates a new *non-zero-filled* and non-pooled `Buffer` of `size` bytes. The\n`size` must be less than or equal to the value of\n`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is\n`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will\nbe created if a `size` less than or equal to 0 is specified.\n\nThe underlying memory for `Buffer` instances created in this way is *not\ninitialized*. The contents of the newly created `Buffer` are unknown and\n*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such\n`Buffer` instances to zeroes.\n\nWhen using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,\nallocations under 4KB are, by default, sliced from a single pre-allocated\n`Buffer`. This allows applications to avoid the garbage collection overhead of\ncreating many individually allocated Buffers. This approach improves both\nperformance and memory usage by eliminating the need to track and cleanup as\nmany `Persistent` objects.\n\nHowever, in the case where a developer may need to retain a small chunk of\nmemory from a pool for an indeterminate amount of time, it may be appropriate\nto create an un-pooled Buffer instance using `Buffer.allocUnsafeSlow()` then\ncopy out the relevant bits.\n\n```js\n// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n const data = socket.read();\n // allocate for retained data\n const sb = Buffer.allocUnsafeSlow(10);\n // copy the data into the new allocation\n data.copy(sb, 0, 0, 10);\n store.push(sb);\n});\n```\n\nUse of `Buffer.allocUnsafeSlow()` should be used only as a last resort *after*\na developer has observed undue memory retention in their applications.\n\nA `TypeError` will be thrown if `size` is not a number.\n\n### All the Rest\n\nThe rest of the `Buffer` API is exactly the same as in node.js.\n[See the docs](https://nodejs.org/api/buffer.html).\n\n## Related links\n\n- [Node.js issue: Buffer(number) is unsafe](https://github.com/nodejs/node/issues/4660)\n- [Node.js Enhancement Proposal: Buffer.from/Buffer.alloc/Buffer.zalloc/Buffer() soft-deprecate](https://github.com/nodejs/node-eps/pull/4)\n\n## Why is `Buffer` unsafe?\n\nToday, the node.js `Buffer` constructor is overloaded to handle many different argument\ntypes like `String`, `Array`, `Object`, `TypedArrayView` (`Uint8Array`, etc.),\n`ArrayBuffer`, and also `Number`.\n\nThe API is optimized for convenience: you can throw any type at it, and it will try to do\nwhat you want.\n\nBecause the Buffer constructor is so powerful, you often see code like this:\n\n```js\n// Convert UTF-8 strings to hex\nfunction toHex (str) {\n return new Buffer(str).toString('hex')\n}\n```\n\n***But what happens if `toHex` is called with a `Number` argument?***\n\n### Remote Memory Disclosure\n\nIf an attacker can make your program call the `Buffer` constructor with a `Number`\nargument, then they can make it allocate uninitialized memory from the node.js process.\nThis could potentially disclose TLS private keys, user data, or database passwords.\n\nWhen the `Buffer` constructor is passed a `Number` argument, it returns an\n**UNINITIALIZED** block of memory of the specified `size`. When you create a `Buffer` like\nthis, you **MUST** overwrite the contents before returning it to the user.\n\nFrom the [node.js docs](https://nodejs.org/api/buffer.html#buffer_new_buffer_size):\n\n> `new Buffer(size)`\n>\n> - `size` Number\n>\n> The underlying memory for `Buffer` instances created in this way is not initialized.\n> **The contents of a newly created `Buffer` are unknown and could contain sensitive\n> data.** Use `buf.fill(0)` to initialize a Buffer to zeroes.\n\n(Emphasis our own.)\n\nWhenever the programmer intended to create an uninitialized `Buffer` you often see code\nlike this:\n\n```js\nvar buf = new Buffer(16)\n\n// Immediately overwrite the uninitialized buffer with data from another buffer\nfor (var i = 0; i < buf.length; i++) {\n buf[i] = otherBuf[i]\n}\n```\n\n### Would this ever be a problem in real code?\n\nYes. It's surprisingly common to forget to check the type of your variables in a\ndynamically-typed language like JavaScript.\n\nUsually the consequences of assuming the wrong type is that your program crashes with an\nuncaught exception. But the failure mode for forgetting to check the type of arguments to\nthe `Buffer` constructor is more catastrophic.\n\nHere's an example of a vulnerable service that takes a JSON payload and converts it to\nhex:\n\n```js\n// Take a JSON payload {str: \"some string\"} and convert it to hex\nvar server = http.createServer(function (req, res) {\n var data = ''\n req.setEncoding('utf8')\n req.on('data', function (chunk) {\n data += chunk\n })\n req.on('end', function () {\n var body = JSON.parse(data)\n res.end(new Buffer(body.str).toString('hex'))\n })\n})\n\nserver.listen(8080)\n```\n\nIn this example, an http client just has to send:\n\n```json\n{\n \"str\": 1000\n}\n```\n\nand it will get back 1,000 bytes of uninitialized memory from the server.\n\nThis is a very serious bug. It's similar in severity to the\n[the Heartbleed bug](http://heartbleed.com/) that allowed disclosure of OpenSSL process\nmemory by remote attackers.\n\n### Which real-world packages were vulnerable?\n\n#### [`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht)\n\n[Mathias Buus](https://github.com/mafintosh) and I\n([Feross Aboukhadijeh](http://feross.org/)) found this issue in one of our own packages,\n[`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht). The bug would allow\nanyone on the internet to send a series of messages to a user of `bittorrent-dht` and get\nthem to reveal 20 bytes at a time of uninitialized memory from the node.js process.\n\nHere's\n[the commit](https://github.com/feross/bittorrent-dht/commit/6c7da04025d5633699800a99ec3fbadf70ad35b8)\nthat fixed it. We released a new fixed version, created a\n[Node Security Project disclosure](https://nodesecurity.io/advisories/68), and deprecated all\nvulnerable versions on npm so users will get a warning to upgrade to a newer version.\n\n#### [`ws`](https://www.npmjs.com/package/ws)\n\nThat got us wondering if there were other vulnerable packages. Sure enough, within a short\nperiod of time, we found the same issue in [`ws`](https://www.npmjs.com/package/ws), the\nmost popular WebSocket implementation in node.js.\n\nIf certain APIs were called with `Number` parameters instead of `String` or `Buffer` as\nexpected, then uninitialized server memory would be disclosed to the remote peer.\n\nThese were the vulnerable methods:\n\n```js\nsocket.send(number)\nsocket.ping(number)\nsocket.pong(number)\n```\n\nHere's a vulnerable socket server with some echo functionality:\n\n```js\nserver.on('connection', function (socket) {\n socket.on('message', function (message) {\n message = JSON.parse(message)\n if (message.type === 'echo') {\n socket.send(message.data) // send back the user's message\n }\n })\n})\n```\n\n`socket.send(number)` called on the server, will disclose server memory.\n\nHere's [the release](https://github.com/websockets/ws/releases/tag/1.0.1) where the issue\nwas fixed, with a more detailed explanation. Props to\n[Arnout Kazemier](https://github.com/3rd-Eden) for the quick fix. Here's the\n[Node Security Project disclosure](https://nodesecurity.io/advisories/67).\n\n### What's the solution?\n\nIt's important that node.js offers a fast way to get memory otherwise performance-critical\napplications would needlessly get a lot slower.\n\nBut we need a better way to *signal our intent* as programmers. **When we want\nuninitialized memory, we should request it explicitly.**\n\nSensitive functionality should not be packed into a developer-friendly API that loosely\naccepts many different types. This type of API encourages the lazy practice of passing\nvariables in without checking the type very carefully.\n\n#### A new API: `Buffer.allocUnsafe(number)`\n\nThe functionality of creating buffers with uninitialized memory should be part of another\nAPI. We propose `Buffer.allocUnsafe(number)`. This way, it's not part of an API that\nfrequently gets user input of all sorts of different types passed into it.\n\n```js\nvar buf = Buffer.allocUnsafe(16) // careful, uninitialized memory!\n\n// Immediately overwrite the uninitialized buffer with data from another buffer\nfor (var i = 0; i < buf.length; i++) {\n buf[i] = otherBuf[i]\n}\n```\n\n### How do we fix node.js core?\n\nWe sent [a PR to node.js core](https://github.com/nodejs/node/pull/4514) (merged as\n`semver-major`) which defends against one case:\n\n```js\nvar str = 16\nnew Buffer(str, 'utf8')\n```\n\nIn this situation, it's implied that the programmer intended the first argument to be a\nstring, since they passed an encoding as a second argument. Today, node.js will allocate\nuninitialized memory in the case of `new Buffer(number, encoding)`, which is probably not\nwhat the programmer intended.\n\nBut this is only a partial solution, since if the programmer does `new Buffer(variable)`\n(without an `encoding` parameter) there's no way to know what they intended. If `variable`\nis sometimes a number, then uninitialized memory will sometimes be returned.\n\n### What's the real long-term fix?\n\nWe could deprecate and remove `new Buffer(number)` and use `Buffer.allocUnsafe(number)` when\nwe need uninitialized memory. But that would break 1000s of packages.\n\n~~We believe the best solution is to:~~\n\n~~1. Change `new Buffer(number)` to return safe, zeroed-out memory~~\n\n~~2. Create a new API for creating uninitialized Buffers. We propose: `Buffer.allocUnsafe(number)`~~\n\n#### Update\n\nWe now support adding three new APIs:\n\n- `Buffer.from(value)` - convert from any type to a buffer\n- `Buffer.alloc(size)` - create a zero-filled buffer\n- `Buffer.allocUnsafe(size)` - create an uninitialized buffer with given size\n\nThis solves the core problem that affected `ws` and `bittorrent-dht` which is\n`Buffer(variable)` getting tricked into taking a number argument.\n\nThis way, existing code continues working and the impact on the npm ecosystem will be\nminimal. Over time, npm maintainers can migrate performance-critical code to use\n`Buffer.allocUnsafe(number)` instead of `new Buffer(number)`.\n\n### Conclusion\n\nWe think there's a serious design issue with the `Buffer` API as it exists today. It\npromotes insecure software by putting high-risk functionality into a convenient API\nwith friendly \"developer ergonomics\".\n\nThis wasn't merely a theoretical exercise because we found the issue in some of the\nmost popular npm packages.\n\nFortunately, there's an easy fix that can be applied today. Use `safe-buffer` in place of\n`buffer`.\n\n```js\nvar Buffer = require('safe-buffer').Buffer\n```\n\nEventually, we hope that node.js core can switch to this new, safer behavior. We believe\nthe impact on the ecosystem would be minimal since it's not a breaking change.\nWell-maintained, popular packages would be updated to use `Buffer.alloc` quickly, while\nolder, insecure packages would magically become safe from this attack vector.\n\n## links\n\n- [Node.js PR: buffer: throw if both length and enc are passed](https://github.com/nodejs/node/pull/4514)\n- [Node Security Project disclosure for `ws`](https://nodesecurity.io/advisories/67)\n- [Node Security Project disclosure for`bittorrent-dht`](https://nodesecurity.io/advisories/68)\n\n## credit\n\nThe original issues in `bittorrent-dht`\n([disclosure](https://nodesecurity.io/advisories/68)) and\n`ws` ([disclosure](https://nodesecurity.io/advisories/67)) were discovered by\n[Mathias Buus](https://github.com/mafintosh) and\n[Feross Aboukhadijeh](http://feross.org/).\n\nThanks to [Adam Baldwin](https://github.com/evilpacket) for helping disclose these issues\nand for his work running the [Node Security Project](https://nodesecurity.io/).\n\nThanks to [John Hiesey](https://github.com/jhiesey) for proofreading this README and\nauditing the code.\n\n## license\n\nMIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org)\n# expand-template\n\n> Expand placeholders in a template string.\n\n[](https://www.npmjs.com/package/expand-template)\n\n[](https://travis-ci.org/ralphtheninja/expand-template)\n[](https://standardjs.com)\n\n## Install\n\n```\n$ npm i expand-template -S\n```\n\n## Usage\n\nDefault functionality expands templates using `{}` as separators for string placeholders.\n\n```js\nvar expand = require('expand-template')()\nvar template = '{foo}/{foo}/{bar}/{bar}'\nconsole.log(expand(template, {\n foo: 'BAR',\n bar: 'FOO'\n}))\n// -> BAR/BAR/FOO/FOO\n```\n\nCustom separators:\n\n```js\nvar expand = require('expand-template')({ sep: '[]' })\nvar template = '[foo]/[foo]/[bar]/[bar]'\nconsole.log(expand(template, {\n foo: 'BAR',\n bar: 'FOO'\n}))\n// -> BAR/BAR/FOO/FOO\n```\n\n## License\nAll code, unless stated otherwise, is dual-licensed under [`WTFPL`](http://www.wtfpl.net/txt/copying/) and [`MIT`](https://opensource.org/licenses/MIT).\n# node-touch\n\nFor all your node touching needs.\n\n## Installing\n\n```bash\nnpm install touch\n```\n\n## CLI Usage:\n\nSee `man touch`\n\nThis package exports a binary called `nodetouch` that works mostly\nlike the unix builtin `touch(1)`.\n\n## API Usage:\n\n```javascript\nvar touch = require(\"touch\")\n```\n\nGives you the following functions:\n\n* `touch(filename, options, cb)`\n* `touch.sync(filename, options)`\n* `touch.ftouch(fd, options, cb)`\n* `touch.ftouchSync(fd, options)`\n\nAll the `options` objects are optional.\n\nAll the async functions return a Promise. If a callback function is\nprovided, then it's attached to the Promise.\n\n## Options\n\n* `force` like `touch -f` Boolean\n* `time` like `touch -t <date>` Can be a Date object, or any parseable\n Date string, or epoch ms number.\n* `atime` like `touch -a` Can be either a Boolean, or a Date.\n* `mtime` like `touch -m` Can be either a Boolean, or a Date.\n* `ref` like `touch -r <file>` Must be path to a file.\n* `nocreate` like `touch -c` Boolean\n\nIf neither `atime` nor `mtime` are set, then both values are set. If\none of them is set, then the other is not.\n\n## cli\n\nThis package creates a `nodetouch` command line executable that works\nvery much like the unix builtin `touch(1)`\nhas-unicode\n===========\n\nTry to guess if your terminal supports unicode\n\n```javascript\nvar hasUnicode = require(\"has-unicode\")\n\nif (hasUnicode()) {\n // the terminal probably has unicode support\n}\n```\n```javascript\nvar hasUnicode = require(\"has-unicode\").tryHarder\nhasUnicode(function(unicodeSupported) {\n if (unicodeSupported) {\n // the terminal probably has unicode support\n }\n})\n```\n\n## Detecting Unicode\n\nWhat we actually detect is UTF-8 support, as that's what Node itself supports.\nIf you have a UTF-16 locale then you won't be detected as unicode capable.\n\n### Windows\n\nSince at least Windows 7, `cmd` and `powershell` have been unicode capable,\nbut unfortunately even then it's not guaranteed. In many localizations it\nstill uses legacy code pages and there's no facility short of running\nprograms or linking C++ that will let us detect this. As such, we\nreport any Windows installation as NOT unicode capable, and recommend\nthat you encourage your users to override this via config.\n\n### Unix Like Operating Systems\n\nWe look at the environment variables `LC_ALL`, `LC_CTYPE`, and `LANG` in\nthat order. For `LC_ALL` and `LANG`, it looks for `.UTF-8` in the value. \nFor `LC_CTYPE` it looks to see if the value is `UTF-8`. This is sufficient\nfor most POSIX systems. While locale data can be put in `/etc/locale.conf`\nas well, AFAIK it's always copied into the environment.\n# extsprintf: extended POSIX-style sprintf\n\nStripped down version of s[n]printf(3c). We make a best effort to throw an\nexception when given a format string we don't understand, rather than ignoring\nit, so that we won't break existing programs if/when we go implement the rest\nof this.\n\nThis implementation currently supports specifying\n\n* field alignment ('-' flag),\n* zero-pad ('0' flag)\n* always show numeric sign ('+' flag),\n* field width\n* conversions for strings, decimal integers, and floats (numbers).\n* argument size specifiers. These are all accepted but ignored, since\n Javascript has no notion of the physical size of an argument.\n\nEverything else is currently unsupported, most notably: precision, unsigned\nnumbers, non-decimal numbers, and characters.\n\nBesides the usual POSIX conversions, this implementation supports:\n\n* `%j`: pretty-print a JSON object (using node's \"inspect\")\n* `%r`: pretty-print an Error object\n\n# Example\n\nFirst, install it:\n\n # npm install extsprintf\n\nNow, use it:\n\n var mod_extsprintf = require('extsprintf');\n console.log(mod_extsprintf.sprintf('hello %25s', 'world'));\n\noutputs:\n\n hello world\n\n# Also supported\n\n**printf**: same args as sprintf, but prints the result to stdout\n\n**fprintf**: same args as sprintf, preceded by a Node stream. Prints the result\nto the given stream.\n# Source Map\n\n[](https://travis-ci.org/mozilla/source-map)\n\n[](https://www.npmjs.com/package/source-map)\n\nThis is a library to generate and consume the source map format\n[described here][format].\n\n[format]: https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit\n\n## Use with Node\n\n $ npm install source-map\n\n## Use on the Web\n\n <script src=\"https://raw.githubusercontent.com/mozilla/source-map/master/dist/source-map.min.js\" defer></script>\n\n--------------------------------------------------------------------------------\n\n<!-- `npm run toc` to regenerate the Table of Contents -->\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n## Table of Contents\n\n- [Examples](#examples)\n - [Consuming a source map](#consuming-a-source-map)\n - [Generating a source map](#generating-a-source-map)\n - [With SourceNode (high level API)](#with-sourcenode-high-level-api)\n - [With SourceMapGenerator (low level API)](#with-sourcemapgenerator-low-level-api)\n- [API](#api)\n - [SourceMapConsumer](#sourcemapconsumer)\n - [new SourceMapConsumer(rawSourceMap)](#new-sourcemapconsumerrawsourcemap)\n - [SourceMapConsumer.prototype.computeColumnSpans()](#sourcemapconsumerprototypecomputecolumnspans)\n - [SourceMapConsumer.prototype.originalPositionFor(generatedPosition)](#sourcemapconsumerprototypeoriginalpositionforgeneratedposition)\n - [SourceMapConsumer.prototype.generatedPositionFor(originalPosition)](#sourcemapconsumerprototypegeneratedpositionfororiginalposition)\n - [SourceMapConsumer.prototype.allGeneratedPositionsFor(originalPosition)](#sourcemapconsumerprototypeallgeneratedpositionsfororiginalposition)\n - [SourceMapConsumer.prototype.hasContentsOfAllSources()](#sourcemapconsumerprototypehascontentsofallsources)\n - [SourceMapConsumer.prototype.sourceContentFor(source[, returnNullOnMissing])](#sourcemapconsumerprototypesourcecontentforsource-returnnullonmissing)\n - [SourceMapConsumer.prototype.eachMapping(callback, context, order)](#sourcemapconsumerprototypeeachmappingcallback-context-order)\n - [SourceMapGenerator](#sourcemapgenerator)\n - [new SourceMapGenerator([startOfSourceMap])](#new-sourcemapgeneratorstartofsourcemap)\n - [SourceMapGenerator.fromSourceMap(sourceMapConsumer)](#sourcemapgeneratorfromsourcemapsourcemapconsumer)\n - [SourceMapGenerator.prototype.addMapping(mapping)](#sourcemapgeneratorprototypeaddmappingmapping)\n - [SourceMapGenerator.prototype.setSourceContent(sourceFile, sourceContent)](#sourcemapgeneratorprototypesetsourcecontentsourcefile-sourcecontent)\n - [SourceMapGenerator.prototype.applySourceMap(sourceMapConsumer[, sourceFile[, sourceMapPath]])](#sourcemapgeneratorprototypeapplysourcemapsourcemapconsumer-sourcefile-sourcemappath)\n - [SourceMapGenerator.prototype.toString()](#sourcemapgeneratorprototypetostring)\n - [SourceNode](#sourcenode)\n - [new SourceNode([line, column, source[, chunk[, name]]])](#new-sourcenodeline-column-source-chunk-name)\n - [SourceNode.fromStringWithSourceMap(code, sourceMapConsumer[, relativePath])](#sourcenodefromstringwithsourcemapcode-sourcemapconsumer-relativepath)\n - [SourceNode.prototype.add(chunk)](#sourcenodeprototypeaddchunk)\n - [SourceNode.prototype.prepend(chunk)](#sourcenodeprototypeprependchunk)\n - [SourceNode.prototype.setSourceContent(sourceFile, sourceContent)](#sourcenodeprototypesetsourcecontentsourcefile-sourcecontent)\n - [SourceNode.prototype.walk(fn)](#sourcenodeprototypewalkfn)\n - [SourceNode.prototype.walkSourceContents(fn)](#sourcenodeprototypewalksourcecontentsfn)\n - [SourceNode.prototype.join(sep)](#sourcenodeprototypejoinsep)\n - [SourceNode.prototype.replaceRight(pattern, replacement)](#sourcenodeprototypereplacerightpattern-replacement)\n - [SourceNode.prototype.toString()](#sourcenodeprototypetostring)\n - [SourceNode.prototype.toStringWithSourceMap([startOfSourceMap])](#sourcenodeprototypetostringwithsourcemapstartofsourcemap)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n## Examples\n\n### Consuming a source map\n\n```js\nvar rawSourceMap = {\n version: 3,\n file: 'min.js',\n names: ['bar', 'baz', 'n'],\n sources: ['one.js', 'two.js'],\n sourceRoot: 'http://example.com/www/js/',\n mappings: 'CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA'\n};\n\nvar smc = new SourceMapConsumer(rawSourceMap);\n\nconsole.log(smc.sources);\n// [ 'http://example.com/www/js/one.js',\n// 'http://example.com/www/js/two.js' ]\n\nconsole.log(smc.originalPositionFor({\n line: 2,\n column: 28\n}));\n// { source: 'http://example.com/www/js/two.js',\n// line: 2,\n// column: 10,\n// name: 'n' }\n\nconsole.log(smc.generatedPositionFor({\n source: 'http://example.com/www/js/two.js',\n line: 2,\n column: 10\n}));\n// { line: 2, column: 28 }\n\nsmc.eachMapping(function (m) {\n // ...\n});\n```\n\n### Generating a source map\n\nIn depth guide:\n[**Compiling to JavaScript, and Debugging with Source Maps**](https://hacks.mozilla.org/2013/05/compiling-to-javascript-and-debugging-with-source-maps/)\n\n#### With SourceNode (high level API)\n\n```js\nfunction compile(ast) {\n switch (ast.type) {\n case 'BinaryExpression':\n return new SourceNode(\n ast.location.line,\n ast.location.column,\n ast.location.source,\n [compile(ast.left), \" + \", compile(ast.right)]\n );\n case 'Literal':\n return new SourceNode(\n ast.location.line,\n ast.location.column,\n ast.location.source,\n String(ast.value)\n );\n // ...\n default:\n throw new Error(\"Bad AST\");\n }\n}\n\nvar ast = parse(\"40 + 2\", \"add.js\");\nconsole.log(compile(ast).toStringWithSourceMap({\n file: 'add.js'\n}));\n// { code: '40 + 2',\n// map: [object SourceMapGenerator] }\n```\n\n#### With SourceMapGenerator (low level API)\n\n```js\nvar map = new SourceMapGenerator({\n file: \"source-mapped.js\"\n});\n\nmap.addMapping({\n generated: {\n line: 10,\n column: 35\n },\n source: \"foo.js\",\n original: {\n line: 33,\n column: 2\n },\n name: \"christopher\"\n});\n\nconsole.log(map.toString());\n// '{\"version\":3,\"file\":\"source-mapped.js\",\"sources\":[\"foo.js\"],\"names\":[\"christopher\"],\"mappings\":\";;;;;;;;;mCAgCEA\"}'\n```\n\n## API\n\nGet a reference to the module:\n\n```js\n// Node.js\nvar sourceMap = require('source-map');\n\n// Browser builds\nvar sourceMap = window.sourceMap;\n\n// Inside Firefox\nconst sourceMap = require(\"devtools/toolkit/sourcemap/source-map.js\");\n```\n\n### SourceMapConsumer\n\nA SourceMapConsumer instance represents a parsed source map which we can query\nfor information about the original file positions by giving it a file position\nin the generated source.\n\n#### new SourceMapConsumer(rawSourceMap)\n\nThe only parameter is the raw source map (either as a string which can be\n`JSON.parse`'d, or an object). According to the spec, source maps have the\nfollowing attributes:\n\n* `version`: Which version of the source map spec this map is following.\n\n* `sources`: An array of URLs to the original source files.\n\n* `names`: An array of identifiers which can be referenced by individual\n mappings.\n\n* `sourceRoot`: Optional. The URL root from which all sources are relative.\n\n* `sourcesContent`: Optional. An array of contents of the original source files.\n\n* `mappings`: A string of base64 VLQs which contain the actual mappings.\n\n* `file`: Optional. The generated filename this source map is associated with.\n\n```js\nvar consumer = new sourceMap.SourceMapConsumer(rawSourceMapJsonData);\n```\n\n#### SourceMapConsumer.prototype.computeColumnSpans()\n\nCompute the last column for each generated mapping. The last column is\ninclusive.\n\n```js\n// Before:\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" })\n// [ { line: 2,\n// column: 1 },\n// { line: 2,\n// column: 10 },\n// { line: 2,\n// column: 20 } ]\n\nconsumer.computeColumnSpans();\n\n// After:\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" })\n// [ { line: 2,\n// column: 1,\n// lastColumn: 9 },\n// { line: 2,\n// column: 10,\n// lastColumn: 19 },\n// { line: 2,\n// column: 20,\n// lastColumn: Infinity } ]\n\n```\n\n#### SourceMapConsumer.prototype.originalPositionFor(generatedPosition)\n\nReturns the original source, line, and column information for the generated\nsource's line and column positions provided. The only argument is an object with\nthe following properties:\n\n* `line`: The line number in the generated source.\n\n* `column`: The column number in the generated source.\n\n* `bias`: Either `SourceMapConsumer.GREATEST_LOWER_BOUND` or\n `SourceMapConsumer.LEAST_UPPER_BOUND`. Specifies whether to return the closest\n element that is smaller than or greater than the one we are searching for,\n respectively, if the exact element cannot be found. Defaults to\n `SourceMapConsumer.GREATEST_LOWER_BOUND`.\n\nand an object is returned with the following properties:\n\n* `source`: The original source file, or null if this information is not\n available.\n\n* `line`: The line number in the original source, or null if this information is\n not available.\n\n* `column`: The column number in the original source, or null if this\n information is not available.\n\n* `name`: The original identifier, or null if this information is not available.\n\n```js\nconsumer.originalPositionFor({ line: 2, column: 10 })\n// { source: 'foo.coffee',\n// line: 2,\n// column: 2,\n// name: null }\n\nconsumer.originalPositionFor({ line: 99999999999999999, column: 999999999999999 })\n// { source: null,\n// line: null,\n// column: null,\n// name: null }\n```\n\n#### SourceMapConsumer.prototype.generatedPositionFor(originalPosition)\n\nReturns the generated line and column information for the original source,\nline, and column positions provided. The only argument is an object with\nthe following properties:\n\n* `source`: The filename of the original source.\n\n* `line`: The line number in the original source.\n\n* `column`: The column number in the original source.\n\nand an object is returned with the following properties:\n\n* `line`: The line number in the generated source, or null.\n\n* `column`: The column number in the generated source, or null.\n\n```js\nconsumer.generatedPositionFor({ source: \"example.js\", line: 2, column: 10 })\n// { line: 1,\n// column: 56 }\n```\n\n#### SourceMapConsumer.prototype.allGeneratedPositionsFor(originalPosition)\n\nReturns all generated line and column information for the original source, line,\nand column provided. If no column is provided, returns all mappings\ncorresponding to a either the line we are searching for or the next closest line\nthat has any mappings. Otherwise, returns all mappings corresponding to the\ngiven line and either the column we are searching for or the next closest column\nthat has any offsets.\n\nThe only argument is an object with the following properties:\n\n* `source`: The filename of the original source.\n\n* `line`: The line number in the original source.\n\n* `column`: Optional. The column number in the original source.\n\nand an array of objects is returned, each with the following properties:\n\n* `line`: The line number in the generated source, or null.\n\n* `column`: The column number in the generated source, or null.\n\n```js\nconsumer.allGeneratedpositionsfor({ line: 2, source: \"foo.coffee\" })\n// [ { line: 2,\n// column: 1 },\n// { line: 2,\n// column: 10 },\n// { line: 2,\n// column: 20 } ]\n```\n\n#### SourceMapConsumer.prototype.hasContentsOfAllSources()\n\nReturn true if we have the embedded source content for every source listed in\nthe source map, false otherwise.\n\nIn other words, if this method returns `true`, then\n`consumer.sourceContentFor(s)` will succeed for every source `s` in\n`consumer.sources`.\n\n```js\n// ...\nif (consumer.hasContentsOfAllSources()) {\n consumerReadyCallback(consumer);\n} else {\n fetchSources(consumer, consumerReadyCallback);\n}\n// ...\n```\n\n#### SourceMapConsumer.prototype.sourceContentFor(source[, returnNullOnMissing])\n\nReturns the original source content for the source provided. The only\nargument is the URL of the original source file.\n\nIf the source content for the given source is not found, then an error is\nthrown. Optionally, pass `true` as the second param to have `null` returned\ninstead.\n\n```js\nconsumer.sources\n// [ \"my-cool-lib.clj\" ]\n\nconsumer.sourceContentFor(\"my-cool-lib.clj\")\n// \"...\"\n\nconsumer.sourceContentFor(\"this is not in the source map\");\n// Error: \"this is not in the source map\" is not in the source map\n\nconsumer.sourceContentFor(\"this is not in the source map\", true);\n// null\n```\n\n#### SourceMapConsumer.prototype.eachMapping(callback, context, order)\n\nIterate over each mapping between an original source/line/column and a\ngenerated line/column in this source map.\n\n* `callback`: The function that is called with each mapping. Mappings have the\n form `{ source, generatedLine, generatedColumn, originalLine, originalColumn,\n name }`\n\n* `context`: Optional. If specified, this object will be the value of `this`\n every time that `callback` is called.\n\n* `order`: Either `SourceMapConsumer.GENERATED_ORDER` or\n `SourceMapConsumer.ORIGINAL_ORDER`. Specifies whether you want to iterate over\n the mappings sorted by the generated file's line/column order or the\n original's source/line/column order, respectively. Defaults to\n `SourceMapConsumer.GENERATED_ORDER`.\n\n```js\nconsumer.eachMapping(function (m) { console.log(m); })\n// ...\n// { source: 'illmatic.js',\n// generatedLine: 1,\n// generatedColumn: 0,\n// originalLine: 1,\n// originalColumn: 0,\n// name: null }\n// { source: 'illmatic.js',\n// generatedLine: 2,\n// generatedColumn: 0,\n// originalLine: 2,\n// originalColumn: 0,\n// name: null }\n// ...\n```\n### SourceMapGenerator\n\nAn instance of the SourceMapGenerator represents a source map which is being\nbuilt incrementally.\n\n#### new SourceMapGenerator([startOfSourceMap])\n\nYou may pass an object with the following properties:\n\n* `file`: The filename of the generated source that this source map is\n associated with.\n\n* `sourceRoot`: A root for all relative URLs in this source map.\n\n* `skipValidation`: Optional. When `true`, disables validation of mappings as\n they are added. This can improve performance but should be used with\n discretion, as a last resort. Even then, one should avoid using this flag when\n running tests, if possible.\n\n```js\nvar generator = new sourceMap.SourceMapGenerator({\n file: \"my-generated-javascript-file.js\",\n sourceRoot: \"http://example.com/app/js/\"\n});\n```\n\n#### SourceMapGenerator.fromSourceMap(sourceMapConsumer)\n\nCreates a new `SourceMapGenerator` from an existing `SourceMapConsumer` instance.\n\n* `sourceMapConsumer` The SourceMap.\n\n```js\nvar generator = sourceMap.SourceMapGenerator.fromSourceMap(consumer);\n```\n\n#### SourceMapGenerator.prototype.addMapping(mapping)\n\nAdd a single mapping from original source line and column to the generated\nsource's line and column for this source map being created. The mapping object\nshould have the following properties:\n\n* `generated`: An object with the generated line and column positions.\n\n* `original`: An object with the original line and column positions.\n\n* `source`: The original source file (relative to the sourceRoot).\n\n* `name`: An optional original token name for this mapping.\n\n```js\ngenerator.addMapping({\n source: \"module-one.scm\",\n original: { line: 128, column: 0 },\n generated: { line: 3, column: 456 }\n})\n```\n\n#### SourceMapGenerator.prototype.setSourceContent(sourceFile, sourceContent)\n\nSet the source content for an original source file.\n\n* `sourceFile` the URL of the original source file.\n\n* `sourceContent` the content of the source file.\n\n```js\ngenerator.setSourceContent(\"module-one.scm\",\n fs.readFileSync(\"path/to/module-one.scm\"))\n```\n\n#### SourceMapGenerator.prototype.applySourceMap(sourceMapConsumer[, sourceFile[, sourceMapPath]])\n\nApplies a SourceMap for a source file to the SourceMap.\nEach mapping to the supplied source file is rewritten using the\nsupplied SourceMap. Note: The resolution for the resulting mappings\nis the minimum of this map and the supplied map.\n\n* `sourceMapConsumer`: The SourceMap to be applied.\n\n* `sourceFile`: Optional. The filename of the source file.\n If omitted, sourceMapConsumer.file will be used, if it exists.\n Otherwise an error will be thrown.\n\n* `sourceMapPath`: Optional. The dirname of the path to the SourceMap\n to be applied. If relative, it is relative to the SourceMap.\n\n This parameter is needed when the two SourceMaps aren't in the same\n directory, and the SourceMap to be applied contains relative source\n paths. If so, those relative source paths need to be rewritten\n relative to the SourceMap.\n\n If omitted, it is assumed that both SourceMaps are in the same directory,\n thus not needing any rewriting. (Supplying `'.'` has the same effect.)\n\n#### SourceMapGenerator.prototype.toString()\n\nRenders the source map being generated to a string.\n\n```js\ngenerator.toString()\n// '{\"version\":3,\"sources\":[\"module-one.scm\"],\"names\":[],\"mappings\":\"...snip...\",\"file\":\"my-generated-javascript-file.js\",\"sourceRoot\":\"http://example.com/app/js/\"}'\n```\n\n### SourceNode\n\nSourceNodes provide a way to abstract over interpolating and/or concatenating\nsnippets of generated JavaScript source code, while maintaining the line and\ncolumn information associated between those snippets and the original source\ncode. This is useful as the final intermediate representation a compiler might\nuse before outputting the generated JS and source map.\n\n#### new SourceNode([line, column, source[, chunk[, name]]])\n\n* `line`: The original line number associated with this source node, or null if\n it isn't associated with an original line.\n\n* `column`: The original column number associated with this source node, or null\n if it isn't associated with an original column.\n\n* `source`: The original source's filename; null if no filename is provided.\n\n* `chunk`: Optional. Is immediately passed to `SourceNode.prototype.add`, see\n below.\n\n* `name`: Optional. The original identifier.\n\n```js\nvar node = new SourceNode(1, 2, \"a.cpp\", [\n new SourceNode(3, 4, \"b.cpp\", \"extern int status;\\n\"),\n new SourceNode(5, 6, \"c.cpp\", \"std::string* make_string(size_t n);\\n\"),\n new SourceNode(7, 8, \"d.cpp\", \"int main(int argc, char** argv) {}\\n\"),\n]);\n```\n\n#### SourceNode.fromStringWithSourceMap(code, sourceMapConsumer[, relativePath])\n\nCreates a SourceNode from generated code and a SourceMapConsumer.\n\n* `code`: The generated code\n\n* `sourceMapConsumer` The SourceMap for the generated code\n\n* `relativePath` The optional path that relative sources in `sourceMapConsumer`\n should be relative to.\n\n```js\nvar consumer = new SourceMapConsumer(fs.readFileSync(\"path/to/my-file.js.map\", \"utf8\"));\nvar node = SourceNode.fromStringWithSourceMap(fs.readFileSync(\"path/to/my-file.js\"),\n consumer);\n```\n\n#### SourceNode.prototype.add(chunk)\n\nAdd a chunk of generated JS to this source node.\n\n* `chunk`: A string snippet of generated JS code, another instance of\n `SourceNode`, or an array where each member is one of those things.\n\n```js\nnode.add(\" + \");\nnode.add(otherNode);\nnode.add([leftHandOperandNode, \" + \", rightHandOperandNode]);\n```\n\n#### SourceNode.prototype.prepend(chunk)\n\nPrepend a chunk of generated JS to this source node.\n\n* `chunk`: A string snippet of generated JS code, another instance of\n `SourceNode`, or an array where each member is one of those things.\n\n```js\nnode.prepend(\"/** Build Id: f783haef86324gf **/\\n\\n\");\n```\n\n#### SourceNode.prototype.setSourceContent(sourceFile, sourceContent)\n\nSet the source content for a source file. This will be added to the\n`SourceMap` in the `sourcesContent` field.\n\n* `sourceFile`: The filename of the source file\n\n* `sourceContent`: The content of the source file\n\n```js\nnode.setSourceContent(\"module-one.scm\",\n fs.readFileSync(\"path/to/module-one.scm\"))\n```\n\n#### SourceNode.prototype.walk(fn)\n\nWalk over the tree of JS snippets in this node and its children. The walking\nfunction is called once for each snippet of JS and is passed that snippet and\nthe its original associated source's line/column location.\n\n* `fn`: The traversal function.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n new SourceNode(3, 4, \"b.js\", \"uno\"),\n \"dos\",\n [\n \"tres\",\n new SourceNode(5, 6, \"c.js\", \"quatro\")\n ]\n]);\n\nnode.walk(function (code, loc) { console.log(\"WALK:\", code, loc); })\n// WALK: uno { source: 'b.js', line: 3, column: 4, name: null }\n// WALK: dos { source: 'a.js', line: 1, column: 2, name: null }\n// WALK: tres { source: 'a.js', line: 1, column: 2, name: null }\n// WALK: quatro { source: 'c.js', line: 5, column: 6, name: null }\n```\n\n#### SourceNode.prototype.walkSourceContents(fn)\n\nWalk over the tree of SourceNodes. The walking function is called for each\nsource file content and is passed the filename and source content.\n\n* `fn`: The traversal function.\n\n```js\nvar a = new SourceNode(1, 2, \"a.js\", \"generated from a\");\na.setSourceContent(\"a.js\", \"original a\");\nvar b = new SourceNode(1, 2, \"b.js\", \"generated from b\");\nb.setSourceContent(\"b.js\", \"original b\");\nvar c = new SourceNode(1, 2, \"c.js\", \"generated from c\");\nc.setSourceContent(\"c.js\", \"original c\");\n\nvar node = new SourceNode(null, null, null, [a, b, c]);\nnode.walkSourceContents(function (source, contents) { console.log(\"WALK:\", source, \":\", contents); })\n// WALK: a.js : original a\n// WALK: b.js : original b\n// WALK: c.js : original c\n```\n\n#### SourceNode.prototype.join(sep)\n\nLike `Array.prototype.join` except for SourceNodes. Inserts the separator\nbetween each of this source node's children.\n\n* `sep`: The separator.\n\n```js\nvar lhs = new SourceNode(1, 2, \"a.rs\", \"my_copy\");\nvar operand = new SourceNode(3, 4, \"a.rs\", \"=\");\nvar rhs = new SourceNode(5, 6, \"a.rs\", \"orig.clone()\");\n\nvar node = new SourceNode(null, null, null, [ lhs, operand, rhs ]);\nvar joinedNode = node.join(\" \");\n```\n\n#### SourceNode.prototype.replaceRight(pattern, replacement)\n\nCall `String.prototype.replace` on the very right-most source snippet. Useful\nfor trimming white space from the end of a source node, etc.\n\n* `pattern`: The pattern to replace.\n\n* `replacement`: The thing to replace the pattern with.\n\n```js\n// Trim trailing white space.\nnode.replaceRight(/\\s*$/, \"\");\n```\n\n#### SourceNode.prototype.toString()\n\nReturn the string representation of this source node. Walks over the tree and\nconcatenates all the various snippets together to one string.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n new SourceNode(3, 4, \"b.js\", \"uno\"),\n \"dos\",\n [\n \"tres\",\n new SourceNode(5, 6, \"c.js\", \"quatro\")\n ]\n]);\n\nnode.toString()\n// 'unodostresquatro'\n```\n\n#### SourceNode.prototype.toStringWithSourceMap([startOfSourceMap])\n\nReturns the string representation of this tree of source nodes, plus a\nSourceMapGenerator which contains all the mappings between the generated and\noriginal sources.\n\nThe arguments are the same as those to `new SourceMapGenerator`.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n new SourceNode(3, 4, \"b.js\", \"uno\"),\n \"dos\",\n [\n \"tres\",\n new SourceNode(5, 6, \"c.js\", \"quatro\")\n ]\n]);\n\nnode.toStringWithSourceMap({ file: \"my-output-file.js\" })\n// { code: 'unodostresquatro',\n// map: [object SourceMapGenerator] }\n```\n# nanomatch [](https://www.npmjs.com/package/nanomatch) [](https://npmjs.org/package/nanomatch) [](https://npmjs.org/package/nanomatch) [](https://travis-ci.org/micromatch/nanomatch) [](https://ci.appveyor.com/project/micromatch/nanomatch)\n\n> Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Table of Contents\n\n<details>\n<summary><strong>Details</strong></summary>\n\n- [Install](#install)\n- [What is nanomatch?](#what-is-nanomatch)\n- [Getting started](#getting-started)\n * [Installing nanomatch](#installing-nanomatch)\n * [Usage](#usage)\n- [Documentation](#documentation)\n * [Escaping](#escaping)\n- [API](#api)\n- [Options](#options)\n * [options.basename](#optionsbasename)\n * [options.bash](#optionsbash)\n * [options.cache](#optionscache)\n * [options.dot](#optionsdot)\n * [options.failglob](#optionsfailglob)\n * [options.ignore](#optionsignore)\n * [options.matchBase](#optionsmatchbase)\n * [options.nocase](#optionsnocase)\n * [options.nodupes](#optionsnodupes)\n * [options.noglobstar](#optionsnoglobstar)\n * [options.nonegate](#optionsnonegate)\n * [options.nonull](#optionsnonull)\n * [options.nullglob](#optionsnullglob)\n * [options.slash](#optionsslash)\n * [options.star](#optionsstar)\n * [options.snapdragon](#optionssnapdragon)\n * [options.sourcemap](#optionssourcemap)\n * [options.unescape](#optionsunescape)\n * [options.unixify](#optionsunixify)\n- [Features](#features)\n- [Bash expansion libs](#bash-expansion-libs)\n- [Benchmarks](#benchmarks)\n * [Running benchmarks](#running-benchmarks)\n * [Nanomatch vs. Minimatch vs. Multimatch](#nanomatch-vs-minimatch-vs-multimatch)\n- [About](#about)\n\n</details>\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save nanomatch\n```\n\n<details>\n<summary><strong>Release history</strong></summary>\n\n## History\n\n### key\n\nChangelog entries are classified using the following labels _(from [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog)_):\n\n* `added`: for new features\n* `changed`: for changes in existing functionality\n* `deprecated`: for once-stable features removed in upcoming releases\n* `removed`: for deprecated features removed in this release\n* `fixed`: for any bug fixes\n* `bumped`: updated dependencies, only minor or higher will be listed.\n\n### [1.1.0](https://github.com/micromatch/nanomatch/compare/1.0.4...1.1.0) - 2017-04-11\n\n**Fixed**\n\n* adds support for unclosed quotes\n\n**Added**\n\n* adds support for `options.noglobstar`\n\n### [1.0.4](https://github.com/micromatch/nanomatch/compare/1.0.3...1.0.4) - 2017-04-06\n\nHousekeeping updates. Adds documentation section about escaping, cleans up utils.\n\n### [1.0.3](https://github.com/micromatch/nanomatch/compare/1.0.1...1.0.3) - 2017-04-06\n\nThis release includes fixes for windows path edge cases and other improvements for stricter adherence to bash spec.\n\n**Fixed**\n\n* More windows path edge cases\n\n**Added**\n\n* Support for bash-like quoted strings for escaping sequences of characters, such as `foo/\"**\"/bar` where `**` should be matched literally and not evaluated as special characters.\n\n### [1.0.1](https://github.com/micromatch/nanomatch/compare/1.0.0...1.0.1) - 2016-12-12\n\n**Added**\n\n* Support for windows path edge cases where backslashes are used in brackets or other unusual combinations.\n\n### [1.0.0](https://github.com/micromatch/nanomatch/compare/0.1.0...1.0.0) - 2016-12-12\n\nStable release.\n\n### [0.1.0] - 2016-10-08\n\nFirst release.\n\n</details>\n\n## What is nanomatch?\n\nNanomatch is a fast and accurate glob matcher with full support for standard Bash glob features, including the following \"metacharacters\": `*`, `**`, `?` and `[...]`.\n\n**Learn more**\n\n* [Getting started](#getting-started): learn how to install and begin using nanomatch\n* [Features](#features): jump to info about supported patterns, and a glob matching reference\n* [API documentation](#api): jump to available options and methods\n* [Unit tests](test): visit unit tests. there is no better way to learn a code library than spending time the unit tests. Nanomatch has 36,000 unit tests - go become a glob matching ninja!\n\n<details>\n<summary><strong>How is this different?</strong></summary>\n\n**Speed and accuracy**\n\nNanomatch uses [snapdragon](https://github.com/jonschlinkert/snapdragon) for parsing and compiling globs, which results in:\n\n* Granular control over the entire conversion process in a way that is easy to understand, reason about, and customize.\n* Faster matching, from a combination of optimized glob patterns and (optional) caching.\n* Much greater accuracy than minimatch. In fact, nanomatch passes _all of the spec tests_ from bash, including some that bash still fails. However, since there is no real specification for globs, if you encounter a pattern that yields unexpected match results [after researching previous issues](../../issues), [please let us know](../../issues/new).\n\n**Basic globbing only**\n\nNanomatch supports [basic globbing only](#features), which is limited to `*`, `**`, `?` and regex-like brackets.\n\nIf you need support for the other [bash \"expansion\" types](#bash-expansion-libs) (in addition to the wildcard matching provided by nanomatch), consider using [micromatch](https://github.com/micromatch/micromatch) instead. _(micromatch >=3.0.0 uses the nanomatch parser and compiler for basic glob matching)_\n\n</details>\n\n## Getting started\n\n### Installing nanomatch\n\n**Install with [yarn](https://yarnpkg.com/)**\n\n```sh\n$ yarn add nanomatch\n```\n\n**Install with [npm](https://npmjs.com)**\n\n```sh\n$ npm install nanomatch\n```\n\n### Usage\n\nAdd nanomatch to your project using node's `require()` system:\n\n```js\nvar nanomatch = require('nanomatch');\n\n// the main export is a function that takes an array of strings to match\n// and a string or array of patterns to use for matching\nnanomatch(list, patterns[, options]);\n```\n\n**Params**\n\n* `list` **{String|Array}**: List of strings to perform matches against. This is often a list of file paths.\n* `patterns` **{String|Array}**: One or more [glob paterns](#features) to use for matching.\n* `options` **{Object}**: Any [supported options](#options) may be passed\n\n**Examples**\n\n```js\nvar nm = require('nanomatch');\nconsole.log(nm(['a', 'b/b', 'c/c/c'], '*'));\n//=> ['a']\n\nconsole.log(nm(['a', 'b/b', 'c/c/c'], '*/*'));\n//=> ['b/b']\n\nconsole.log(nm(['a', 'b/b', 'c/c/c'], '**'));\n//=> ['a', 'b/b', 'c/c/c']\n```\n\nSee the [API documentation](#api) for available methods and [options](https://github.com/einaros/options.js).\n\n## Documentation\n\n### Escaping\n\n_Backslashes and quotes_ can be used to escape characters, forcing nanomatch to regard those characters as a literal characters.\n\n**Backslashes**\n\nUse backslashes to escape single characters. For example, the following pattern would match `foo/*/bar` exactly:\n\n```js\n'foo/\\*/bar'\n```\n\nThe following pattern would match `foo/` followed by a literal `*`, followed by zero or more of any characters besides `/`, followed by `/bar`.\n\n```js\n'foo/\\**/bar'\n```\n\n**Quoted strings**\n\nUse single or double quotes to escape sequences of characters. For example, the following patterns would match `foo/**/bar` exactly:\n\n```js\n'foo/\"**\"/bar'\n'foo/\\'**\\'/bar'\n\"foo/'**'/bar\"\n```\n\n**Matching literal quotes**\n\nIf you need to match quotes literally, you can escape them as well. For example, the following will match `foo/\"*\"/bar`, `foo/\"a\"/bar`, `foo/\"b\"/bar`, or `foo/\"c\"/bar`:\n\n```js\n'foo/\\\\\"*\\\\\"/bar'\n```\n\nAnd the following will match `foo/'*'/bar`, `foo/'a'/bar`, `foo/'b'/bar`, or `foo/'c'/bar`:\n\n```js\n'foo/\\\\\\'*\\\\\\'/bar'\n```\n\n## API\n\n### [nanomatch](index.js#L40)\n\nThe main function takes a list of strings and one or more glob patterns to use for matching.\n\n**Params**\n\n* `list` **{Array}**: A list of strings to match\n* `patterns` **{String|Array}**: One or more glob patterns to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Array}**: Returns an array of matches\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm(list, patterns[, options]);\n\nconsole.log(nm(['a.js', 'a.txt'], ['*.js']));\n//=> [ 'a.js' ]\n```\n\n### [.match](index.js#L106)\n\nSimilar to the main function, but `pattern` must be a string.\n\n**Params**\n\n* `list` **{Array}**: Array of strings to match\n* `pattern` **{String}**: Glob pattern to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Array}**: Returns an array of matches\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.match(list, pattern[, options]);\n\nconsole.log(nm.match(['a.a', 'a.aa', 'a.b', 'a.c'], '*.a'));\n//=> ['a.a', 'a.aa']\n```\n\n### [.isMatch](index.js#L167)\n\nReturns true if the specified `string` matches the given glob `pattern`.\n\n**Params**\n\n* `string` **{String}**: String to match\n* `pattern` **{String}**: Glob pattern to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns true if the string matches the glob pattern.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.isMatch(string, pattern[, options]);\n\nconsole.log(nm.isMatch('a.a', '*.a'));\n//=> true\nconsole.log(nm.isMatch('a.b', '*.a'));\n//=> false\n```\n\n### [.some](index.js#L205)\n\nReturns true if some of the elements in the given `list` match any of the given glob `patterns`.\n\n**Params**\n\n* `list` **{String|Array}**: The string or array of strings to test. Returns as soon as the first match is found.\n* `patterns` **{String|Array}**: One or more glob patterns to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns true if any patterns match `str`\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.some(list, patterns[, options]);\n\nconsole.log(nm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js']));\n// true\nconsole.log(nm.some(['foo.js'], ['*.js', '!foo.js']));\n// false\n```\n\n### [.every](index.js#L243)\n\nReturns true if every element in the given `list` matches at least one of the given glob `patterns`.\n\n**Params**\n\n* `list` **{String|Array}**: The string or array of strings to test.\n* `patterns` **{String|Array}**: One or more glob patterns to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns true if any patterns match `str`\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.every(list, patterns[, options]);\n\nconsole.log(nm.every('foo.js', ['foo.js']));\n// true\nconsole.log(nm.every(['foo.js', 'bar.js'], ['*.js']));\n// true\nconsole.log(nm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js']));\n// false\nconsole.log(nm.every(['foo.js'], ['*.js', '!foo.js']));\n// false\n```\n\n### [.any](index.js#L277)\n\nReturns true if **any** of the given glob `patterns` match the specified `string`.\n\n**Params**\n\n* `str` **{String|Array}**: The string to test.\n* `patterns` **{String|Array}**: One or more glob patterns to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns true if any patterns match `str`\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.any(string, patterns[, options]);\n\nconsole.log(nm.any('a.a', ['b.*', '*.a']));\n//=> true\nconsole.log(nm.any('a.a', 'b.*'));\n//=> false\n```\n\n### [.all](index.js#L325)\n\nReturns true if **all** of the given `patterns` match the specified string.\n\n**Params**\n\n* `str` **{String|Array}**: The string to test.\n* `patterns` **{String|Array}**: One or more glob patterns to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns true if any patterns match `str`\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.all(string, patterns[, options]);\n\nconsole.log(nm.all('foo.js', ['foo.js']));\n// true\n\nconsole.log(nm.all('foo.js', ['*.js', '!foo.js']));\n// false\n\nconsole.log(nm.all('foo.js', ['*.js', 'foo.js']));\n// true\n\nconsole.log(nm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js']));\n// true\n```\n\n### [.not](index.js#L359)\n\nReturns a list of strings that _**do not match any**_ of the given `patterns`.\n\n**Params**\n\n* `list` **{Array}**: Array of strings to match.\n* `patterns` **{String|Array}**: One or more glob pattern to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Array}**: Returns an array of strings that **do not match** the given patterns.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.not(list, patterns[, options]);\n\nconsole.log(nm.not(['a.a', 'b.b', 'c.c'], '*.a'));\n//=> ['b.b', 'c.c']\n```\n\n### [.contains](index.js#L394)\n\nReturns true if the given `string` contains the given pattern. Similar to [.isMatch](#isMatch) but the pattern can match any part of the string.\n\n**Params**\n\n* `str` **{String}**: The string to match.\n* `patterns` **{String|Array}**: Glob pattern to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns true if the patter matches any part of `str`.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.contains(string, pattern[, options]);\n\nconsole.log(nm.contains('aa/bb/cc', '*b'));\n//=> true\nconsole.log(nm.contains('aa/bb/cc', '*d'));\n//=> false\n```\n\n### [.matchKeys](index.js#L450)\n\nFilter the keys of the given object with the given `glob` pattern and `options`. Does not attempt to match nested keys. If you need this feature, use [glob-object](https://github.com/jonschlinkert/glob-object) instead.\n\n**Params**\n\n* `object` **{Object}**: The object with keys to filter.\n* `patterns` **{String|Array}**: One or more glob patterns to use for matching.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Object}**: Returns an object with only keys that match the given patterns.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.matchKeys(object, patterns[, options]);\n\nvar obj = { aa: 'a', ab: 'b', ac: 'c' };\nconsole.log(nm.matchKeys(obj, '*b'));\n//=> { ab: 'b' }\n```\n\n### [.matcher](index.js#L479)\n\nReturns a memoized matcher function from the given glob `pattern` and `options`. The returned function takes a string to match as its only argument and returns true if the string is a match.\n\n**Params**\n\n* `pattern` **{String}**: Glob pattern\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed.\n* `returns` **{Function}**: Returns a matcher function.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.matcher(pattern[, options]);\n\nvar isMatch = nm.matcher('*.!(*a)');\nconsole.log(isMatch('a.a'));\n//=> false\nconsole.log(isMatch('a.b'));\n//=> true\n```\n\n### [.capture](index.js#L560)\n\nReturns an array of matches captured by `pattern` in `string, or`null` if the pattern did not match.\n\n**Params**\n\n* `pattern` **{String}**: Glob pattern to use for matching.\n* `string` **{String}**: String to match\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed\n* `returns` **{Boolean}**: Returns an array of captures if the string matches the glob pattern, otherwise `null`.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.capture(pattern, string[, options]);\n\nconsole.log(nm.capture('test/*.js', 'test/foo.js'));\n//=> ['foo']\nconsole.log(nm.capture('test/*.js', 'foo/bar.css'));\n//=> null\n```\n\n### [.makeRe](index.js#L595)\n\nCreate a regular expression from the given glob `pattern`.\n\n**Params**\n\n* `pattern` **{String}**: A glob pattern to convert to regex.\n* `options` **{Object}**: See available [options](#options) for changing how matches are performed.\n* `returns` **{RegExp}**: Returns a regex created from the given pattern.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.makeRe(pattern[, options]);\n\nconsole.log(nm.makeRe('*.js'));\n//=> /^(?:(\\.[\\\\\\/])?(?!\\.)(?=.)[^\\/]*?\\.js)$/\n```\n\n### [.create](index.js#L658)\n\nParses the given glob `pattern` and returns an object with the compiled `output` and optional source `map`.\n\n**Params**\n\n* `pattern` **{String}**: Glob pattern to parse and compile.\n* `options` **{Object}**: Any [options](#options) to change how parsing and compiling is performed.\n* `returns` **{Object}**: Returns an object with the parsed AST, compiled string and optional source map.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.create(pattern[, options]);\n\nconsole.log(nm.create('abc/*.js'));\n// { options: { source: 'string', sourcemap: true },\n// state: {},\n// compilers:\n// { ... },\n// output: '(\\\\.[\\\\\\\\\\\\/])?abc\\\\/(?!\\\\.)(?=.)[^\\\\/]*?\\\\.js',\n// ast:\n// { type: 'root',\n// errors: [],\n// nodes:\n// [ ... ],\n// dot: false,\n// input: 'abc/*.js' },\n// parsingErrors: [],\n// map:\n// { version: 3,\n// sources: [ 'string' ],\n// names: [],\n// mappings: 'AAAA,GAAG,EAAC,kBAAC,EAAC,EAAE',\n// sourcesContent: [ 'abc/*.js' ] },\n// position: { line: 1, column: 28 },\n// content: {},\n// files: {},\n// idx: 6 }\n```\n\n### [.parse](index.js#L697)\n\nParse the given `str` with the given `options`.\n\n**Params**\n\n* `str` **{String}**\n* `options` **{Object}**\n* `returns` **{Object}**: Returns an AST\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.parse(pattern[, options]);\n\nvar ast = nm.parse('a/{b,c}/d');\nconsole.log(ast);\n// { type: 'root',\n// errors: [],\n// input: 'a/{b,c}/d',\n// nodes:\n// [ { type: 'bos', val: '' },\n// { type: 'text', val: 'a/' },\n// { type: 'brace',\n// nodes:\n// [ { type: 'brace.open', val: '{' },\n// { type: 'text', val: 'b,c' },\n// { type: 'brace.close', val: '}' } ] },\n// { type: 'text', val: '/d' },\n// { type: 'eos', val: '' } ] }\n```\n\n### [.compile](index.js#L745)\n\nCompile the given `ast` or string with the given `options`.\n\n**Params**\n\n* `ast` **{Object|String}**\n* `options` **{Object}**\n* `returns` **{Object}**: Returns an object that has an `output` property with the compiled string.\n\n**Example**\n\n```js\nvar nm = require('nanomatch');\nnm.compile(ast[, options]);\n\nvar ast = nm.parse('a/{b,c}/d');\nconsole.log(nm.compile(ast));\n// { options: { source: 'string' },\n// state: {},\n// compilers:\n// { eos: [Function],\n// noop: [Function],\n// bos: [Function],\n// brace: [Function],\n// 'brace.open': [Function],\n// text: [Function],\n// 'brace.close': [Function] },\n// output: [ 'a/(b|c)/d' ],\n// ast:\n// { ... },\n// parsingErrors: [] }\n```\n\n### [.clearCache](index.js#L768)\n\nClear the regex cache.\n\n**Example**\n\n```js\nnm.clearCache();\n```\n\n## Options\n\n<details>\n<summary><strong>basename</strong></summary>\n\n### options.basename\n\nAllow glob patterns without slashes to match a file path based on its basename. Same behavior as [minimatch](https://github.com/isaacs/minimatch) option `matchBase`.\n\nType: `boolean`\n\nDefault: `false`\n\n**Example**\n\n```js\nnm(['a/b.js', 'a/c.md'], '*.js');\n//=> []\n\nnm(['a/b.js', 'a/c.md'], '*.js', {matchBase: true});\n//=> ['a/b.js']\n```\n\n</details>\n\n<details>\n<summary><strong>bash</strong></summary>\n\n### options.bash\n\nEnabled by default, this option enforces bash-like behavior with stars immediately following a bracket expression. Bash bracket expressions are similar to regex character classes, but unlike regex, a star following a bracket expression **does not repeat the bracketed characters**. Instead, the star is treated the same as an other star.\n\nType: `boolean`\n\nDefault: `true`\n\n**Example**\n\n```js\nvar files = ['abc', 'ajz'];\nconsole.log(nm(files, '[a-c]*'));\n//=> ['abc', 'ajz']\n\nconsole.log(nm(files, '[a-c]*', {bash: false}));\n```\n\n</details>\n\n<details>\n<summary><strong>cache</strong></summary>\n\n### options.cache\n\nDisable regex and function memoization.\n\nType: `boolean`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong>dot</strong></summary>\n\n### options.dot\n\nMatch dotfiles. Same behavior as [minimatch](https://github.com/isaacs/minimatch) option `dot`.\n\nType: `boolean`\n\nDefault: `false`\n\n</details>\n\n<details>\n<summary><strong>failglob</strong></summary>\n\n### options.failglob\n\nSimilar to the `--failglob` behavior in Bash, throws an error when no matches are found.\n\nType: `boolean`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong>ignore</strong></summary>\n\n### options.ignore\n\nString or array of glob patterns to match files to ignore.\n\nType: `String|Array`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong>matchBase</strong></summary>\n\n### options.matchBase\n\nAlias for [options.basename](#options-basename).\n\n</details>\n\n<details>\n<summary><strong>nocase</strong></summary>\n\n### options.nocase\n\nUse a case-insensitive regex for matching files. Same behavior as [minimatch](https://github.com/isaacs/minimatch).\n\nType: `boolean`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong>nodupes</strong></summary>\n\n### options.nodupes\n\nRemove duplicate elements from the result array.\n\nType: `boolean`\n\nDefault: `true` (enabled by default)\n\n**Example**\n\nExample of using the `unescape` and `nodupes` options together:\n\n```js\nnm.match(['a/b/c', 'a/b/c'], '**');\n//=> ['abc']\n\nnm.match(['a/b/c', 'a/b/c'], '**', {nodupes: false});\n//=> ['a/b/c', 'a/b/c']\n```\n\n</details>\n\n<details>\n<summary><strong>nonegate</strong></summary>\n\n### options.noglobstar\n\nDisable matching with globstars (`**`).\n\nType: `boolean`\n\nDefault: `undefined`\n\n```js\nnm(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**');\n//=> ['a/b', 'a/b/c', 'a/b/c/d']\n\nnm(['a/b', 'a/b/c', 'a/b/c/d'], 'a/**', {noglobstar: true});\n//=> ['a/b']\n```\n\n</details>\n\n<details>\n<summary><strong>nonegate</strong></summary>\n\n### options.nonegate\n\nDisallow negation (`!`) patterns, and treat leading `!` as a literal character to match.\n\nType: `boolean`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong>nonull</strong></summary>\n\n### options.nonull\n\nAlias for [options.nullglob](#options-nullglob).\n\n</details>\n\n<details>\n<summary><strong>nullglob</strong></summary>\n\n### options.nullglob\n\nIf `true`, when no matches are found the actual (arrayified) glob pattern is returned instead of an empty array. Same behavior as [minimatch](https://github.com/isaacs/minimatch) option `nonull`.\n\nType: `boolean`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong><a name=\"slash\">slash</a></strong></summary>\n\n### options.slash\n\nCustomize the slash character(s) to use for matching.\n\nType: `string|function`\n\nDefault: `[/\\\\]` (forward slash and backslash)\n\n</details>\n\n<details>\n<summary><strong><a name=\"star\">star</a></strong></summary>\n\n### options.star\n\nCustomize the star character(s) to use for matching. It's not recommended that you modify this unless you have advanced knowledge of the compiler and matching rules.\n\nType: `string|function`\n\nDefault: `[^/\\\\]*?`\n\n</details>\n\n<details>\n<summary><strong><a name=\"snapdragon\">snapdragon</a></strong></summary>\n\n### options.snapdragon\n\nPass your own instance of [snapdragon](https://github.com/jonschlinkert/snapdragon) to customize parsers or compilers.\n\nType: `object`\n\nDefault: `undefined`\n\n</details>\n\n<details>\n<summary><strong>snapdragon</strong></summary>\n\n### options.sourcemap\n\nGenerate a source map by enabling the `sourcemap` option with the `.parse`, `.compile`, or `.create` methods.\n\n**Examples**\n\n```js\nvar nm = require('nanomatch');\n\nvar res = nm.create('abc/*.js', {sourcemap: true});\nconsole.log(res.map);\n// { version: 3,\n// sources: [ 'string' ],\n// names: [],\n// mappings: 'AAAA,GAAG,EAAC,iBAAC,EAAC,EAAE',\n// sourcesContent: [ 'abc/*.js' ] }\n\nvar ast = nm.parse('abc/**/*.js');\nvar res = nm.compile(ast, {sourcemap: true});\nconsole.log(res.map);\n// { version: 3,\n// sources: [ 'string' ],\n// names: [],\n// mappings: 'AAAA,GAAG,EAAC,2BAAE,EAAC,iBAAC,EAAC,EAAE',\n// sourcesContent: [ 'abc/**/*.js' ] }\n```\n\n</details>\n\n<details>\n<summary><strong>unescape</strong></summary>\n\n### options.unescape\n\nRemove backslashes from returned matches.\n\nType: `boolean`\n\nDefault: `undefined`\n\n**Example**\n\nIn this example we want to match a literal `*`:\n\n```js\nnm.match(['abc', 'a\\\\*c'], 'a\\\\*c');\n//=> ['a\\\\*c']\n\nnm.match(['abc', 'a\\\\*c'], 'a\\\\*c', {unescape: true});\n//=> ['a*c']\n```\n\n</details>\n\n<details>\n<summary><strong>unixify</strong></summary>\n\n### options.unixify\n\nConvert path separators on returned files to posix/unix-style forward slashes.\n\nType: `boolean`\n\nDefault: `true`\n\n**Example**\n\n```js\nnm.match(['a\\\\b\\\\c'], 'a/**');\n//=> ['a/b/c']\n\nnm.match(['a\\\\b\\\\c'], {unixify: false});\n//=> ['a\\\\b\\\\c']\n```\n\n</details>\n\n## Features\n\nNanomatch has full support for standard Bash glob features, including the following \"metacharacters\": `*`, `**`, `?` and `[...]`.\n\nHere are some examples of how they work:\n\n| **Pattern** | **Description** | \n| --- | --- |\n| `*` | Matches any string except for `/`, leading `.`, or `/.` inside a path |\n| `**` | Matches any string including `/`, but not a leading `.` or `/.` inside a path. More than two stars (e.g. `***` is treated the same as one star, and `**` loses its special meaning | when it's not the only thing in a path segment, per Bash specifications) |\n| `foo*` | Matches any string beginning with `foo` |\n| `*bar*` | Matches any string containing `bar` (beginning, middle or end) |\n| `*.min.js` | Matches any string ending with `.min.js` |\n| `[abc]*.js` | Matches any string beginning with `a`, `b`, or `c` and ending with `.js` |\n| `abc?` | Matches `abcd` or `abcz` but not `abcde` |\n\nThe exceptions noted for `*` apply to all patterns that contain a `*`.\n\n**Not supported**\n\nThe following extended-globbing features are not supported:\n\n* [brace expansion](https://github.com/jonschlinkert/braces) (e.g. `{a,b,c}`)\n* [extglobs](https://github.com/jonschlinkert/extglob) (e.g. `@(a|!(c|d))`)\n* [POSIX brackets](https://github.com/jonschlinkert/expand-brackets) (e.g. `[[:alpha:][:digit:]]`)\n\nIf you need any of these features consider using [micromatch](https://github.com/micromatch/micromatch) instead.\n\n## Bash expansion libs\n\nNanomatch is part of a suite of libraries aimed at bringing the power and expressiveness of [Bash's](https://www.gnu.org/software/bash/) matching and expansion capabilities to JavaScript, _and - as you can see by the [benchmarks](#benchmarks) - without sacrificing speed_.\n\n| **Related library** | **Matching Type** | **Example** | **Description** | \n| --- | --- | --- | --- |\n| `nanomatch` (you are here) | Wildcards | `*` | [Filename expansion](https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html#Filename-Expansion), also referred to as globbing and pathname expansion, allows the use of [wildcards](#features) for matching. |\n| [expand-tilde](https://github.com/jonschlinkert/expand-tilde) | Tildes | `~` | [Tilde expansion](https://www.gnu.org/software/bash/manual/html_node/Tilde-Expansion.html#Tilde-Expansion) converts the leading tilde in a file path to the user home directory. |\n| [braces](https://github.com/jonschlinkert/braces) | Braces | `{a,b,c}` | [Brace expansion](https://www.gnu.org/software/bash/manual/html_node/Brace-Expansion.html) |\n| [expand-brackets](https://github.com/jonschlinkert/expand-brackets) | Brackets | `[[:alpha:]]` | [POSIX character classes](https://www.gnu.org/software/grep/manual/html_node/Character-Classes-and-Bracket-Expressions.html) (also referred to as POSIX brackets, or POSIX character classes) |\n| [extglob](https://github.com/jonschlinkert/extglob) | Parens | `!(a\\ | b)` | [Extglobs](https://www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html#Pattern-Matching) |\n| [micromatch](https://github.com/micromatch/micromatch) | All | all | Micromatch is built on top of the other libraries. |\n\nThere are many resources available on the web if you want to dive deeper into how these features work in Bash.\n\n## Benchmarks\n\n### Running benchmarks\n\nInstall dev dependencies:\n\n```bash\nnpm i -d && node benchmark\n```\n\n### Nanomatch vs. Minimatch vs. Multimatch\n\n```bash\n# globstar-basic (182 bytes)\n minimatch x 69,512 ops/sec ±1.92% (88 runs sampled)\n multimatch x 63,376 ops/sec ±1.41% (89 runs sampled)\n nanomatch x 432,451 ops/sec ±0.92% (88 runs sampled)\n\n fastest is nanomatch (by 651% avg)\n\n# large-list-globstar (485686 bytes)\n minimatch x 34.02 ops/sec ±1.42% (59 runs sampled)\n multimatch x 33.58 ops/sec ±1.97% (58 runs sampled)\n nanomatch x 483 ops/sec ±1.06% (86 runs sampled)\n\n fastest is nanomatch (by 1429% avg)\n\n# long-list-globstar (194085 bytes)\n minimatch x 383 ops/sec ±0.74% (90 runs sampled)\n multimatch x 378 ops/sec ±0.59% (89 runs sampled)\n nanomatch x 990 ops/sec ±1.14% (85 runs sampled)\n\n fastest is nanomatch (by 260% avg)\n\n# negation-basic (132 bytes)\n minimatch x 242,145 ops/sec ±1.17% (89 runs sampled)\n multimatch x 76,403 ops/sec ±0.78% (92 runs sampled)\n nanomatch x 537,253 ops/sec ±1.44% (86 runs sampled)\n\n fastest is nanomatch (by 337% avg)\n\n# not-glob-basic (93 bytes)\n minimatch x 252,402 ops/sec ±1.33% (89 runs sampled)\n multimatch x 209,954 ops/sec ±1.30% (90 runs sampled)\n nanomatch x 1,716,468 ops/sec ±1.13% (86 runs sampled)\n\n fastest is nanomatch (by 742% avg)\n\n# star-basic (93 bytes)\n minimatch x 182,780 ops/sec ±1.41% (91 runs sampled)\n multimatch x 153,210 ops/sec ±0.72% (89 runs sampled)\n nanomatch x 599,621 ops/sec ±1.22% (90 runs sampled)\n\n fastest is nanomatch (by 357% avg)\n\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [extglob](https://www.npmjs.com/package/extglob): Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob… [more](https://github.com/micromatch/extglob) | [homepage](https://github.com/micromatch/extglob \"Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.\")\n* [is-extglob](https://www.npmjs.com/package/is-extglob): Returns true if a string has an extglob. | [homepage](https://github.com/jonschlinkert/is-extglob \"Returns true if a string has an extglob.\")\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 164 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 1 | [devongovett](https://github.com/devongovett) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 18, 2018._\n# detect-libc\n\nNode.js module to detect the C standard library (libc) implementation\nfamily and version in use on a given Linux system.\n\nProvides a value suitable for use with the `LIBC` option of\n[prebuild](https://www.npmjs.com/package/prebuild),\n[prebuild-ci](https://www.npmjs.com/package/prebuild-ci) and\n[prebuild-install](https://www.npmjs.com/package/prebuild-install),\ntherefore allowing build and provision of pre-compiled binaries\nfor musl-based Linux e.g. Alpine as well as glibc-based.\n\nCurrently supports libc detection of `glibc` and `musl`.\n\n## Install\n\n```sh\nnpm install detect-libc\n```\n\n## Usage\n\n### API\n\n```js\nconst { GLIBC, MUSL, family, version, isNonGlibcLinux } = require('detect-libc');\n```\n\n* `GLIBC` is a String containing the value \"glibc\" for comparison with `family`.\n* `MUSL` is a String containing the value \"musl\" for comparison with `family`.\n* `family` is a String representing the system libc family.\n* `version` is a String representing the system libc version number.\n* `isNonGlibcLinux` is a Boolean representing whether the system is a non-glibc Linux, e.g. Alpine.\n\n### detect-libc command line tool\n\nWhen run on a Linux system with a non-glibc libc,\nthe child command will be run with the `LIBC` environment variable\nset to the relevant value.\n\nOn all other platforms will run the child command as-is.\n\nThe command line feature requires `spawnSync` provided by Node v0.12+.\n\n```sh\ndetect-libc child-command\n```\n\n## Integrating with prebuild\n\n```json\n \"scripts\": {\n \"install\": \"detect-libc prebuild-install || node-gyp rebuild\",\n \"test\": \"mocha && detect-libc prebuild-ci\"\n },\n \"dependencies\": {\n \"detect-libc\": \"^1.0.2\",\n \"prebuild-install\": \"^2.2.0\"\n },\n \"devDependencies\": {\n \"prebuild\": \"^6.2.1\",\n \"prebuild-ci\": \"^2.2.3\"\n }\n```\n\n## Licence\n\nCopyright 2017 Lovell Fuller\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n# Determine the Encoding of a HTML Byte Stream\n\nThis package implements the HTML Standard's [encoding sniffing algorithm](https://html.spec.whatwg.org/multipage/syntax.html#encoding-sniffing-algorithm) in all its glory. The most interesting part of this is how it pre-scans the first 1024 bytes in order to search for certain `<meta charset>`-related patterns.\n\n```js\nconst htmlEncodingSniffer = require(\"html-encoding-sniffer\");\nconst fs = require(\"fs\");\n\nconst htmlBuffer = fs.readFileSync(\"./html-page.html\");\nconst sniffedEncoding = htmlEncodingSniffer(htmlBuffer);\n```\n\nThe returned value will be a canonical [encoding name](https://encoding.spec.whatwg.org/#names-and-labels) (not a label). You might then combine this with the [whatwg-encoding](https://github.com/jsdom/whatwg-encoding) package to decode the result:\n\n```js\nconst whatwgEncoding = require(\"whatwg-encoding\");\nconst htmlString = whatwgEncoding.decode(htmlBuffer, sniffedEncoding);\n```\n\n## Options\n\nYou can pass two potential options to `htmlEncodingSniffer`:\n\n```js\nconst sniffedEncoding = htmlEncodingSniffer(htmlBuffer, {\n transportLayerEncodingLabel,\n defaultEncoding\n});\n```\n\nThese represent two possible inputs into the [encoding sniffing algorithm](https://html.spec.whatwg.org/multipage/syntax.html#encoding-sniffing-algorithm):\n\n- `transportLayerEncodingLabel` is an encoding label that is obtained from the \"transport layer\" (probably a HTTP `Content-Type` header), which overrides everything but a BOM.\n- `defaultEncoding` is the ultimate fallback encoding used if no valid encoding is supplied by the transport layer, and no encoding is sniffed from the bytes. It defaults to `\"windows-1252\"`, as recommended by the algorithm's table of suggested defaults for \"All other locales\" (including the `en` locale).\n\n## Credits\n\nThis package was originally based on the excellent work of [@nicolashenry](https://github.com/nicolashenry), [in jsdom](https://github.com/tmpvar/jsdom/blob/16fd85618f2705d181232f6552125872a37164bc/lib/jsdom/living/helpers/encoding.js). It has since been pulled out into this separate package.\n## istanbul-lib-coverage\n\n[](https://greenkeeper.io/)\n[](https://travis-ci.org/istanbuljs/istanbul-lib-coverage)\n\nAn API that provides a read-only view of coverage information with the ability\nto merge and summarize coverage info.\n\nSupersedes `object-utils` and `collector` from the v0 istanbul API.\n\nSee the docs for the full API.\n\n```js\nvar libCoverage = require('istanbul-lib-coverage');\nvar map = libCoverage.createCoverageMap(globalCoverageVar);\nvar summary = libCoverage.createCoverageSummary();\n\n// merge another coverage map into the one we created\nmap.merge(otherCoverageMap);\n\n// inspect and summarize all file coverage objects in the map\nmap.files().forEach(function(f) {\n var fc = map.fileCoverageFor(f),\n s = fc.toSummary();\n summary.merge(s);\n});\n\nconsole.log('Global summary', summary);\n```\nThe AssemblyScript Runtime\n==========================\n\nThe runtime provides the functionality necessary to dynamically allocate and deallocate memory of objects, arrays and buffers, as well as keep track of references that are no longer used.\n\nInterface\n---------\n\n* **__alloc**(size: `usize`, id: `u32` = 0): `usize`<br />\n Dynamically allocates a chunk of memory of at least the specified size and returns its address.\n Alignment is guaranteed to be 16 bytes to fit up to v128 values naturally.\n\n* **__realloc**(ref: `usize`, size: `usize`): `usize`<br />\n Dynamically changes the size of a chunk of memory, possibly moving it to a new address.\n\n* **__free**(ref: `usize`): `void`<br />\n Frees a dynamically allocated chunk of memory by its address.\n\n* **__retain**(ref: `usize`): `usize`<br />\n Retains a reference to an object. The object doesn't become collected as long as there's at least one retained reference. Returns the retained reference.\n\n* **__release**(ref: `usize`): `void`<br />\n Releases a reference to an object. The object is considered for collection once all references to it have been released.\n\n* **__collect**(): `void`<br />\n Forces a full garbage collection cycle. By default this means that reference cycles are resolved and possibly collected.\n\n### Internals\n\n* **__visit**(ref: `usize`, cookie: `u32`): `void`<br />\n Concrete visitor implementation called during traversal. Cookie can be used to indicate one of multiple operations.\n\n### Built-ins\n\n* **__typeinfo**(id: `u32`): `RTTIFlags`<br />\n Obtains the runtime type information for objects with the specified runtime id. Runtime type information is a set of flags indicating whether a reference type is managed, an array or similar, and what the relevant alignments when creating an instance externally are etc.\n\n* **__instanceof**\n\n* **__visit_globals**(cookie: `u32`): `void`<br />\n Calls `__visit` on each global that is of a reference type. Not used anymore (originally provided to support tracing GCs) but still here for possible future use.\n\n* **__visit_members**(ref: `usize`, cookie: `u32`): `void`<br />\n Calls `__visit` on each member of the object pointed to by `ref`.\n\n### Related\n\n* **idof**<`T`>(): `u32`<br />\n Obtains the unique internal class id of a reference type.\n\nFull/half\n---------\n\nThe [full](./index-full.ts) runtime is based on [the TLSF memory manager](./tlsf.ts) and [a pure reference counting garbage collector](./pure.ts) and provides all the functionality necessary. The [half](./index-half.ts) alias is essentially the same, but doesn't expose the runtime API so unused runtime code can be DCE'ed.\n\nStub/none\n---------\n\nThe [stub](./index-stub.ts) runtime, though fully functional, provides minimal dynamic memory allocation but no deallocation. Useful for prototyping or very short-lived programs with hardly any memory footprint. The [none](./index-none.ts) alias is the same, but doesn't expose the runtime API so unused runtime code can be DCE'ed.\n\nIntegration notes\n-----------------\n\nThe underlying reference counting implementation works very similar to other implementations. When an object is stored in a local, global or field, its reference becomes retained (reference count is incremented by 1), respectively when it becomes deleted, it is released (reference count is decremented by 1). Once the reference count reaches zero, the object is considered for collection and the reference count of all contained objects (fields, array elements etc.) is decremented by 1. Now, if an object is inherently acyclic (most objects are), it is free'd right away, while otherwise it is added to a cycle pool and considered for cycle collection on the next `__collect`.\n\nDifferences to other implementations include:\n\n* A new object from `__alloc` doesn't start with a reference count of 1, but 0.\n* When an object is returned from a function, it remains at RC + 1 and the caller is expected to release it.\n* Functions with reference type arguments retain each such argument when called, and release it again when exited. This can't be counted on, however, because the compiler may decide to eliminate these where unnecessary.\n* Getters, setters, operator overloads and constructors are function calls and behave like one.\n\nEven though the rules are simple, working with the runtime internals within standard library code can be tricky and requires knowledge of where the compiler will insert runtime calls automatically. For instance\n\n* `changetype`ing a pointer to a reference type or vice-versa has no side-effects. For example in a `changetype<Ref>(ptr)` the pointer is untracked before, and the reference becomes tracked afterwards, but there's nothing inserted in between.\n* `load`, `store` and similar built-ins aren't functions but intrinsics and as such have no side-effects. For example a `load<Ref>(...)` is equivalent to a `changetype<Ref>(load<usize>(...))` and a `store<Ref>(..., ref)` equivalent to a `store<usize>(..., changetype<usize>(ref))`.\n\n**GOOD:** In case of doubt, the following pattern is universal:\n\n```ts\nvar ref = changetype<Ref>(__alloc(SIZE, idof<Ref>())); // assignment retains, RC=1\n// ... safe ...\nreturn ref; // knows `ref` is already retained and simply returns it\n```\n\n**BAD:** A pattern one shouldn't use is:\n\n```ts\nvar ptr = __alloc(SIZE, idof<Ref>()); // RC=0\n// ... not safe while RC=0 ... e.g.:\nsomeFunc(changetype<Ref>(ptr)); // might, or might not, free the object!\n```\n\n**BONUS:** Beware of runtime calls in conditional expressions like a ternary IF, logical AND or OR. Each arm can be in either of two states: Either in-flight if immediately retained/returned or not if the expression or the target doesn't support it. Don't fight the compiler there.\n# indexes-of\n\nlike Array/String#indexOf but return all the indexes in an array.\n\n``` js\nvar indexesOf = require('indexes-of')\n\nvar twosIndexes = indexesOf([1, 2, 3, 4, 5, 4, 3, 2, 1], 2)\n\nconsole.log(twosIndexes)\n\n// [1, 7]\n\n```\n\n# Haiku\n\n* A 5 line module.\n* But the tests are 40 lines.\n* npm publish.\n\n## License\n\nMIT\nStandard library\n================\n\nStandard library components for use with `tsc` (portable) and `asc` (assembly).\n\nBase configurations (.json) and definition files (.d.ts) are relevant to `tsc` only and not used by `asc`.\n# w3c-xmlserializer\n\nAn XML serializer that follows the [W3C specification](https://w3c.github.io/DOM-Parsing/).\n\nThis package can be used in Node.js, as long as you feed it a DOM node, e.g. one produced by [jsdom](https://github.com/jsdom/jsdom).\n\n## Basic usage\n\nAssume you have a DOM tree rooted at a node `node`. In Node.js, you could create this using [jsdom](https://github.com/jsdom/jsdom) as follows:\n\n```js\nconst { JSDOM } = require(\"jsdom\");\n\nconst { document } = new JSDOM().window;\nconst node = document.createElement(\"akomaNtoso\");\n```\n\nThen, you use this package as follows:\n\n```js\nconst serialize = require(\"w3c-xmlserializer\");\n\nconsole.log(serialize(node));\n// => '<akomantoso xmlns=\"http://www.w3.org/1999/xhtml\"></akomantoso>'\n```\n\n## `requireWellFormed` option\n\nBy default the input DOM tree is not required to be \"well-formed\"; any given input will serialize to some output string. You can instead require well-formedness via\n\n```js\nserialize(node, { requireWellFormed: true });\n```\n\nwhich will cause `Error`s to be thrown when non-well-formed constructs are encountered. [Per the spec](https://w3c.github.io/DOM-Parsing/#dfn-require-well-formed), this largely is about imposing constraints on the names of elements, attributes, etc.\n\nAs a point of reference, on the web platform:\n\n* The [`innerHTML` getter](https://w3c.github.io/DOM-Parsing/#dom-innerhtml-innerhtml) uses the require-well-formed mode, i.e. trying to get the `innerHTML` of non-well-formed subtrees will throw.\n* The [`xhr.send()` method](https://xhr.spec.whatwg.org/#the-send()-method) does not require well-formedness, i.e. sending non-well-formed `Document`s will serialize and send them anyway.\n# jsbn: javascript big number\n\n[Tom Wu's Original Website](http://www-cs-students.stanford.edu/~tjw/jsbn/)\n\nI felt compelled to put this on github and publish to npm. I haven't tested every other big integer library out there, but the few that I have tested in comparison to this one have not even come close in performance. I am aware of the `bi` module on npm, however it has been modified and I wanted to publish the original without modifications. This is jsbn and jsbn2 from Tom Wu's original website above, with the modular pattern applied to prevent global leaks and to allow for use with node.js on the server side.\n\n## usage\n\n var BigInteger = require('jsbn');\n \n var a = new BigInteger('91823918239182398123');\n alert(a.bitLength()); // 67\n\n## API\n\n### bi.toString()\n\nreturns the base-10 number as a string\n\n### bi.negate()\n\nreturns a new BigInteger equal to the negation of `bi`\n\n### bi.abs\n\nreturns new BI of absolute value\n\n### bi.compareTo\n\n### bi.bitLength\n\n### bi.mod\n\n### bi.modPowInt\n\n### bi.clone\n\n### bi.intValue\n\n### bi.byteValue\n\n### bi.shortValue\n\n### bi.signum\n\n### bi.toByteArray\n\n### bi.equals\n\n### bi.min\n\n### bi.max\n\n### bi.and\n\n### bi.or\n\n### bi.xor\n\n### bi.andNot\n\n### bi.not\n\n### bi.shiftLeft\n\n### bi.shiftRight\n\n### bi.getLowestSetBit\n\n### bi.bitCount\n\n### bi.testBit\n\n### bi.setBit\n\n### bi.clearBit\n\n### bi.flipBit\n\n### bi.add\n\n### bi.subtract\n\n### bi.multiply\n\n### bi.divide\n\n### bi.remainder\n\n### bi.divideAndRemainder\n\n### bi.modPow\n\n### bi.modInverse\n\n### bi.pow\n\n### bi.gcd\n\n### bi.isProbablePrime\n# Browserslist [![Cult Of Martians][cult-img]][cult]\n\n<img width=\"120\" height=\"120\" alt=\"Browserslist logo by Anton Lovchikov\"\n src=\"https://browserslist.github.io/browserslist/logo.svg\" align=\"right\">\n\nThe config to share target browsers and Node.js versions between different\nfront-end tools. It is used in:\n\n* [Autoprefixer]\n* [Babel]\n* [postcss-preset-env]\n* [eslint-plugin-compat]\n* [stylelint-no-unsupported-browser-features]\n* [postcss-normalize]\n* [obsolete-webpack-plugin]\n\nAll tools will find target browsers automatically,\nwhen you add the following to `package.json`:\n\n```json\n \"browserslist\": [\n \"defaults\",\n \"not IE 11\",\n \"not IE_Mob 11\",\n \"maintained node versions\"\n ]\n```\n\nOr in `.browserslistrc` config:\n\n```yaml\n# Browsers that we support\n\ndefaults\nnot IE 11\nnot IE_Mob 11\nmaintained node versions\n```\n\nDevelopers set their version lists using queries like `last 2 versions`\nto be free from updating versions manually.\nBrowserslist will use [`caniuse-lite`] with [Can I Use] data for this queries.\n\nBrowserslist will take queries from tool option,\n`browserslist` config, `.browserslistrc` config,\n`browserslist` section in `package.json` or environment variables.\n\n[Browserslist Example] shows how every tool uses Browserslist.\n\n[cult-img]: https://cultofmartians.com/assets/badges/badge.svg\n[cult]: https://cultofmartians.com/done.html\n\n<a href=\"https://evilmartians.com/?utm_source=browserslist\">\n <img src=\"https://evilmartians.com/badges/sponsored-by-evil-martians.svg\"\n alt=\"Sponsored by Evil Martians\" width=\"236\" height=\"54\">\n</a>\n\n[stylelint-no-unsupported-browser-features]: https://github.com/ismay/stylelint-no-unsupported-browser-features\n[eslint-plugin-compat]: https://github.com/amilajack/eslint-plugin-compat\n[Browserslist Example]: https://github.com/browserslist/browserslist-example\n[postcss-preset-env]: https://github.com/jonathantneal/postcss-preset-env\n[postcss-normalize]: https://github.com/jonathantneal/postcss-normalize\n[`caniuse-lite`]: https://github.com/ben-eb/caniuse-lite\n[Autoprefixer]: https://github.com/postcss/autoprefixer\n[Can I Use]: https://caniuse.com/\n[Babel]: https://github.com/babel/babel/tree/master/packages/babel-preset-env\n[obsolete-webpack-plugin]: https://github.com/ElemeFE/obsolete-webpack-plugin\n\n## Table of Contents\n\n* [Tools](#tools)\n* [Best Practices](#best-practices)\n* [Browsers Data Updating](#browsers-data-updating)\n* [Queries](#queries)\n * [Query Composition](#query-composition)\n * [Full List](#full-list)\n * [Debug](#debug)\n * [Browsers](#browsers)\n* [Config File](#config-file)\n * [`package.json`](#packagejson)\n * [`.browserslistrc`](#browserslistrc)\n* [Shareable Configs](#shareable-configs)\n* [Configuring for Different Environments](#configuring-for-different-environments)\n* [Custom Usage Data](#custom-usage-data)\n* [JS API](#js-api)\n* [Environment Variables](#environment-variables)\n* [Cache](#cache)\n* [Security Contact](#security-contact)\n* [For Enterprise](#for-enterprise)\n\n## Tools\n\n* [`browserl.ist`](https://browserl.ist/) is an online tool to check\n what browsers will be selected by some query.\n* [`browserslist-ga`] and [`browserslist-ga-export`] download your website\n browsers statistics to use it in `> 0.5% in my stats` query.\n* [`browserslist-useragent-regexp`] compiles Browserslist query to a RegExp\n to test browser useragent.\n* [`browserslist-useragent-ruby`] is a Ruby library to checks browser\n by user agent string to match Browserslist.\n* [`browserslist-browserstack`] runs BrowserStack tests for all browsers\n in Browserslist config.\n* [`browserslist-adobe-analytics`] use Adobe Analytics data to target browsers.\n* [`caniuse-api`] returns browsers which support some specific feature.\n* Run `npx browserslist` in your project directory to see project’s\n target browsers. This CLI tool is built-in and available in any project\n with Autoprefixer.\n\n[`browserslist-useragent-regexp`]: https://github.com/browserslist/browserslist-useragent-regexp\n[`browserslist-adobe-analytics`]: https://github.com/xeroxinteractive/browserslist-adobe-analytics\n[`browserslist-useragent-ruby`]: https://github.com/browserslist/browserslist-useragent-ruby\n[`browserslist-browserstack`]: https://github.com/xeroxinteractive/browserslist-browserstack\n[`browserslist-ga-export`]: https://github.com/browserslist/browserslist-ga-export\n[`browserslist-useragent`]: https://github.com/pastelsky/browserslist-useragent\n[`browserslist-ga`]: https://github.com/browserslist/browserslist-ga\n[`caniuse-api`]: https://github.com/Nyalab/caniuse-api\n\n## Best Practices\n\n* There is a `defaults` query, which gives a reasonable configuration\n for most users:\n\n ```json\n \"browserslist\": [\n \"defaults\"\n ]\n ```\n\n* If you want to change the default set of browsers, we recommend combining\n `last 2 versions`, `not dead` with a usage number like `> 0.2%`. This is\n because `last n versions` on its own does not add popular old versions, while\n only using a percentage above `0.2%` will in the long run make popular\n browsers even more popular. We might run into a monopoly and stagnation\n situation, as we had with Internet Explorer 6. Please use this setting\n with caution.\n* Select browsers directly (`last 2 Chrome versions`) only if you are making\n a web app for a kiosk with one browser. There are a lot of browsers\n on the market. If you are making general web app you should respect\n browsers diversity.\n* Don’t remove browsers just because you don’t know them. Opera Mini has\n 100 million users in Africa and it is more popular in the global market\n than Microsoft Edge. Chinese QQ Browsers has more market share than Firefox\n and desktop Safari combined.\n\n## Browsers Data Updating\n\n`npx browserslist@latest --update-db` updates `caniuse-lite` version\nin your npm, yarn or pnpm lock file.\n\nYou need to do it regularly for two reasons:\n\n1. To use the latest browser’s versions and statistics in queries like\n `last 2 versions` or `>1%`. For example, if you created your project\n 2 years ago and did not update your dependencies, `last 1 version`\n will return 2 year old browsers.\n2. `caiuse-lite` deduplication: to synchronize version in different tools.\n\n> What is deduplication?\n\nDue to how npm architecture is setup, you may have a situation\nwhere you have multiple versions of a single dependency required.\n\nImagine you begin a project, and you add `autoprefixer` as a dependency.\nnpm looks for the latest `caniuse-lite` version (1.0.30000700) and adds it to\n`package-lock.json` under `autoprefixer` dependencies.\n\nA year later, you decide to add Babel. At this moment, we have a\nnew version of `canuse-lite` (1.0.30000900). npm took the latest version\nand added it to your lock file under `@babel/preset-env` dependencies.\n\nNow your lock file looks like this:\n\n```ocaml\nautoprefixer 7.1.4\n browserslist 3.1.1\n caniuse-lite 1.0.30000700\n@babel/preset-env 7.10.0\n browserslist 4.13.0\n caniuse-lite 1.0.30000900\n```\n\nAs you can see, we now have two versions of `caniuse-lite` installed.\n\n## Queries\n\nBrowserslist will use browsers and Node.js versions query\nfrom one of these sources:\n\n1. `browserslist` key in `package.json` file in current or parent directories.\n **We recommend this way.**\n2. `.browserslistrc` config file in current or parent directories.\n3. `browserslist` config file in current or parent directories.\n4. `BROWSERSLIST` environment variable.\n5. If the above methods did not produce a valid result\n Browserslist will use defaults:\n `> 0.5%, last 2 versions, Firefox ESR, not dead`.\n\n### Query Composition\n\nAn `or` combiner can use the keyword `or` as well as `,`.\n`last 1 version or > 1%` is equal to `last 1 version, > 1%`.\n\n`and` query combinations are also supported to perform an\nintersection of all the previous queries:\n`last 1 version or chrome > 75 and > 1%` will select\n(`browser last version` or `Chrome since 76`) and `more than 1% marketshare`.\n\nThere is 3 different ways to combine queries as depicted below. First you start\nwith a single query and then we combine the queries to get our final list.\n\nObviously you can *not* start with a `not` combiner, since there is no left-hand\nside query to combine it with. The left-hand is always resolved as `and`\ncombiner even if `or` is used (this is an API implementation specificity).\n\n| Query combiner type | Illustration | Example |\n| ------------------- | :----------: | ------- |\n|`or`/`,` combiner <br> (union) |  | `> .5% or last 2 versions` <br> `> .5%, last 2 versions` |\n| `and` combiner <br> (intersection) |  | `> .5% and last 2 versions` |\n| `not` combiner <br> (relative complement) |  | All those three are equivalent to the first one <br> `> .5% and not last 2 versions` <br> `> .5% or not last 2 versions` <br> `> .5%, not last 2 versions` |\n\n_A quick way to test your query is to do `npx browserslist '> 0.5%, not IE 11'`\nin your terminal._\n\n### Full List\n\nYou can specify the browser and Node.js versions by queries (case insensitive):\n\n* `defaults`: Browserslist’s default browsers\n (`> 0.5%, last 2 versions, Firefox ESR, not dead`).\n* `> 5%`: browsers versions selected by global usage statistics.\n `>=`, `<` and `<=` work too.\n * `> 5% in US`: uses USA usage statistics.\n It accepts [two-letter country code].\n * `> 5% in alt-AS`: uses Asia region usage statistics.\n List of all region codes can be found at [`caniuse-lite/data/regions`].\n * `> 5% in my stats`: uses [custom usage data].\n * `> 5% in browserslist-config-mycompany stats`: uses [custom usage data]\n from `browserslist-config-mycompany/browserslist-stats.json`.\n * `cover 99.5%`: most popular browsers that provide coverage.\n * `cover 99.5% in US`: same as above, with [two-letter country code].\n * `cover 99.5% in my stats`: uses [custom usage data].\n* `dead`: browsers without official support or updates for 24 months.\n Right now it is `IE 10`, `IE_Mob 11`, `BlackBerry 10`, `BlackBerry 7`,\n `Samsung 4` and `OperaMobile 12.1`.\n* `last 2 versions`: the last 2 versions for *each* browser.\n * `last 2 Chrome versions`: the last 2 versions of Chrome browser.\n * `last 2 major versions` or `last 2 iOS major versions`:\n all minor/patch releases of last 2 major versions.\n* `node 10` and `node 10.4`: selects latest Node.js `10.x.x`\n or `10.4.x` release.\n * `current node`: Node.js version used by Browserslist right now.\n * `maintained node versions`: all Node.js versions, which are [still maintained]\n by Node.js Foundation.\n* `iOS 7`: the iOS browser version 7 directly.\n * `Firefox > 20`: versions of Firefox newer than 20.\n `>=`, `<` and `<=` work too. It also works with Node.js.\n * `ie 6-8`: selects an inclusive range of versions.\n * `Firefox ESR`: the latest [Firefox ESR] version.\n * `PhantomJS 2.1` and `PhantomJS 1.9`: selects Safari versions similar\n to PhantomJS runtime.\n* `extends browserslist-config-mycompany`: take queries from\n `browserslist-config-mycompany` npm package.\n* `supports es6-module`: browsers with support for specific features.\n `es6-module` here is the `feat` parameter at the URL of the [Can I Use]\n page. A list of all available features can be found at\n [`caniuse-lite/data/features`].\n* `since 2015` or `last 2 years`: all versions released since year 2015\n (also `since 2015-03` and `since 2015-03-10`).\n* `unreleased versions` or `unreleased Chrome versions`:\n alpha and beta versions.\n* `not ie <= 8`: exclude browsers selected by previous queries.\n\nYou can add `not ` to any query.\n\n[`caniuse-lite/data/regions`]: https://github.com/ben-eb/caniuse-lite/tree/master/data/regions\n[`caniuse-lite/data/features`]: https://github.com/ben-eb/caniuse-lite/tree/master/data/features\n[two-letter country code]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements\n[custom usage data]: #custom-usage-data\n[still maintained]: https://github.com/nodejs/Release\n[Can I Use]: https://caniuse.com/\n\n### Debug\n\nRun `npx browserslist` in project directory to see what browsers was selected\nby your queries.\n\n```sh\n$ npx browserslist\nand_chr 61\nand_ff 56\nand_qq 1.2\nand_uc 11.4\nandroid 56\nbaidu 7.12\nbb 10\nchrome 62\nedge 16\nfirefox 56\nios_saf 11\nopera 48\nsafari 11\nsamsung 5\n```\n\n### Browsers\n\nNames are case insensitive:\n\n* `Android` for Android WebView.\n* `Baidu` for Baidu Browser.\n* `BlackBerry` or `bb` for Blackberry browser.\n* `Chrome` for Google Chrome.\n* `ChromeAndroid` or `and_chr` for Chrome for Android\n* `Edge` for Microsoft Edge.\n* `Electron` for Electron framework. It will be converted to Chrome version.\n* `Explorer` or `ie` for Internet Explorer.\n* `ExplorerMobile` or `ie_mob` for Internet Explorer Mobile.\n* `Firefox` or `ff` for Mozilla Firefox.\n* `FirefoxAndroid` or `and_ff` for Firefox for Android.\n* `iOS` or `ios_saf` for iOS Safari.\n* `Node` for Node.js.\n* `Opera` for Opera.\n* `OperaMini` or `op_mini` for Opera Mini.\n* `OperaMobile` or `op_mob` for Opera Mobile.\n* `QQAndroid` or `and_qq` for QQ Browser for Android.\n* `Safari` for desktop Safari.\n* `Samsung` for Samsung Internet.\n* `UCAndroid` or `and_uc` for UC Browser for Android.\n* `kaios` for KaiOS Browser.\n\n## Config File\n\n### `package.json`\n\nIf you want to reduce config files in project root, you can specify\nbrowsers in `package.json` with `browserslist` key:\n\n```json\n{\n \"private\": true,\n \"dependencies\": {\n \"autoprefixer\": \"^6.5.4\"\n },\n \"browserslist\": [\n \"last 1 version\",\n \"> 1%\",\n \"IE 10\"\n ]\n}\n```\n\n### `.browserslistrc`\n\nSeparated Browserslist config should be named `.browserslistrc`\nand have browsers queries split by a new line.\nEach line is combined with the `or` combiner. Comments starts with `#` symbol:\n\n```yaml\n# Browsers that we support\n\nlast 1 version\n> 1%\nIE 10 # sorry\n```\n\nBrowserslist will check config in every directory in `path`.\nSo, if tool process `app/styles/main.css`, you can put config to root,\n`app/` or `app/styles`.\n\nYou can specify direct path in `BROWSERSLIST_CONFIG` environment variables.\n\n## Shareable Configs\n\nYou can use the following query to reference an exported Browserslist config\nfrom another package:\n\n```json\n \"browserslist\": [\n \"extends browserslist-config-mycompany\"\n ]\n```\n\nFor security reasons, external configuration only supports packages that have\nthe `browserslist-config-` prefix. npm scoped packages are also supported, by\nnaming or prefixing the module with `@scope/browserslist-config`, such as\n`@scope/browserslist-config` or `@scope/browserslist-config-mycompany`.\n\nIf you don’t accept Browserslist queries from users, you can disable the\nvalidation by using the or `BROWSERSLIST_DANGEROUS_EXTEND` environment variable\nor `dangerousExtend` option.\n\n```sh\nBROWSERSLIST_DANGEROUS_EXTEND=1 npx webpack\n```\n\nBecause this uses `npm`'s resolution, you can also reference specific files\nin a package:\n\n```json\n \"browserslist\": [\n \"extends browserslist-config-mycompany/desktop\",\n \"extends browserslist-config-mycompany/mobile\"\n ]\n```\n\nWhen writing a shared Browserslist package, just export an array.\n`browserslist-config-mycompany/index.js`:\n\n```js\nmodule.exports = [\n 'last 1 version',\n '> 1%',\n 'ie 10'\n]\n```\n\nYou can also include a `browserslist-stats.json` file as part of your shareable\nconfig at the root and query it using\n`> 5% in browserslist-config-mycompany stats`. It uses the same format\nas `extends` and the `dangerousExtend` property as above.\n\nYou can export configs for different environments and select environment\nby `BROWSERSLIST_ENV` or `env` option in your tool:\n\n```js\nmodule.exports = {\n development: [\n 'last 1 version'\n ],\n production: [\n 'last 1 version',\n '> 1%',\n 'ie 10'\n ]\n}\n```\n\n## Configuring for Different Environments\n\nYou can also specify different browser queries for various environments.\nBrowserslist will choose query according to `BROWSERSLIST_ENV` or `NODE_ENV`\nvariables. If none of them is declared, Browserslist will firstly look\nfor `production` queries and then use defaults.\n\nIn `package.json`:\n\n```js\n \"browserslist\": {\n \"production\": [\n \"> 1%\",\n \"ie 10\"\n ],\n \"modern\": [\n \"last 1 chrome version\",\n \"last 1 firefox version\"\n ],\n \"ssr\": [\n \"node 12\"\n ]\n }\n```\n\nIn `.browserslistrc` config:\n\n```ini\n[production]\n> 1%\nie 10\n\n[modern]\nlast 1 chrome version\nlast 1 firefox version\n\n[ssr]\nnode 12\n```\n\n## Custom Usage Data\n\nIf you have a website, you can query against the usage statistics of your site.\n[`browserslist-ga`] will ask access to Google Analytics and then generate\n`browserslist-stats.json`:\n\n```\nnpx browserslist-ga\n```\n\nOr you can use [`browserslist-ga-export`] to convert Google Analytics data without giving a password for Google account.\n\nYou can generate usage statistics file by any other method. File format should\nbe like:\n\n```js\n{\n \"ie\": {\n \"6\": 0.01,\n \"7\": 0.4,\n \"8\": 1.5\n },\n \"chrome\": {\n …\n },\n …\n}\n```\n\nNote that you can query against your custom usage data while also querying\nagainst global or regional data. For example, the query\n`> 1% in my stats, > 5% in US, 10%` is permitted.\n\n[`browserslist-ga-export`]: https://github.com/browserslist/browserslist-ga-export\n[`browserslist-ga`]: https://github.com/browserslist/browserslist-ga\n[Can I Use]: https://caniuse.com/\n\n## JS API\n\n```js\nconst browserslist = require('browserslist')\n\n// Your CSS/JS build tool code\nfunction process (source, opts) {\n const browsers = browserslist(opts.overrideBrowserslist, {\n stats: opts.stats,\n path: opts.file,\n env: opts.env\n })\n // Your code to add features for selected browsers\n}\n```\n\nQueries can be a string `\"> 1%, IE 10\"`\nor an array `['> 1%', 'IE 10']`.\n\nIf a query is missing, Browserslist will look for a config file.\nYou can provide a `path` option (that can be a file) to find the config file\nrelatively to it.\n\nOptions:\n\n* `path`: file or a directory path to look for config file. Default is `.`.\n* `env`: what environment section use from config. Default is `production`.\n* `stats`: custom usage statistics data.\n* `config`: path to config if you want to set it manually.\n* `ignoreUnknownVersions`: do not throw on direct query (like `ie 12`).\n Default is `false.`\n* `dangerousExtend`: Disable security checks for `extend` query.\n Default is `false.`\n* `mobileToDesktop`: Use desktop browsers if Can I Use doesn’t have data\n about this mobile version. For instance, Browserslist will return\n `chrome 20` on `and_chr 20` query (Can I Use has only data only about\n latest versions of mobile browsers). Default is `false`.\n\nFor non-JS environment and debug purpose you can use CLI tool:\n\n```sh\nbrowserslist \"> 1%, IE 10\"\n```\n\nYou can get total users coverage for selected browsers by JS API:\n\n```js\nbrowserslist.coverage(browserslist('> 1%'))\n//=> 81.4\n```\n\n```js\nbrowserslist.coverage(browserslist('> 1% in US'), 'US')\n//=> 83.1\n```\n\n```js\nbrowserslist.coverage(browserslist('> 1% in my stats'), 'my stats')\n//=> 83.1\n```\n\n```js\nbrowserslist.coverage(browserslist('> 1% in my stats', { stats }), stats)\n//=> 82.2\n```\n\nOr by CLI:\n\n```sh\n$ browserslist --coverage \"> 1%\"\nThese browsers account for 81.4% of all users globally\n```\n\n```sh\n$ browserslist --coverage=US \"> 1% in US\"\nThese browsers account for 83.1% of all users in the US\n```\n\n```sh\n$ browserslist --coverage \"> 1% in my stats\"\nThese browsers account for 83.1% of all users in custom statistics\n```\n\n```sh\n$ browserslist --coverage \"> 1% in my stats\" --stats=./stats.json\nThese browsers account for 83.1% of all users in custom statistics\n```\n\n## Environment Variables\n\nIf a tool uses Browserslist inside, you can change the Browserslist settings\nwith [environment variables]:\n\n* `BROWSERSLIST` with browsers queries.\n\n ```sh\n BROWSERSLIST=\"> 5%\" npx webpack\n ```\n\n* `BROWSERSLIST_CONFIG` with path to config file.\n\n ```sh\n BROWSERSLIST_CONFIG=./config/browserslist npx webpack\n ```\n\n* `BROWSERSLIST_ENV` with environments string.\n\n ```sh\n BROWSERSLIST_ENV=\"development\" npx webpack\n ```\n\n* `BROWSERSLIST_STATS` with path to the custom usage data\n for `> 1% in my stats` query.\n\n ```sh\n BROWSERSLIST_STATS=./config/usage_data.json npx webpack\n ```\n\n* `BROWSERSLIST_DISABLE_CACHE` if you want to disable config reading cache.\n\n ```sh\n BROWSERSLIST_DISABLE_CACHE=1 npx webpack\n ```\n\n* `BROWSERSLIST_DANGEROUS_EXTEND` to disable security shareable config\n name check.\n\n ```sh\n BROWSERSLIST_DANGEROUS_EXTEND=1 npx webpack\n ```\n\n[environment variables]: https://en.wikipedia.org/wiki/Environment_variable\n\n## Cache\n\nBrowserslist caches the configuration it reads from `package.json` and\n`browserslist` files, as well as knowledge about the existence of files,\nfor the duration of the hosting process.\n\nTo clear these caches, use:\n\n```js\nbrowserslist.clearCaches()\n```\n\nTo disable the caching altogether, set the `BROWSERSLIST_DISABLE_CACHE`\nenvironment variable.\n\n## Security Contact\n\nTo report a security vulnerability, please use the [Tidelift security contact].\nTidelift will coordinate the fix and disclosure.\n\n[Tidelift security contact]: https://tidelift.com/security\n\n## For Enterprise\n\nAvailable as part of the Tidelift Subscription.\n\nThe maintainers of `browserslist` and thousands of other packages are working\nwith Tidelift to deliver commercial support and maintenance for the open source\ndependencies you use to build your applications. Save time, reduce risk,\nand improve code health, while paying the maintainers of the exact dependencies\nyou use. [Learn more.](https://tidelift.com/subscription/pkg/npm-browserslist?utm_source=npm-browserslist&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)\n# is-typedarray [](http://github.com/badges/stability-badges)\n\nDetect whether or not an object is a\n[Typed Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays).\n\n## Usage\n\n[](https://nodei.co/npm/is-typedarray/)\n\n### isTypedArray(array)\n\nReturns `true` when array is a Typed Array, and `false` when it is not.\n\n## License\n\nMIT. See [LICENSE.md](http://github.com/hughsk/is-typedarray/blob/master/LICENSE.md) for details.\nsemver(1) -- The semantic versioner for npm\n===========================================\n\n## Install\n\n```bash\nnpm install --save semver\n````\n\n## Usage\n\nAs a node module:\n\n```js\nconst semver = require('semver')\n\nsemver.valid('1.2.3') // '1.2.3'\nsemver.valid('a.b.c') // null\nsemver.clean(' =v1.2.3 ') // '1.2.3'\nsemver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true\nsemver.gt('1.2.3', '9.8.7') // false\nsemver.lt('1.2.3', '9.8.7') // true\nsemver.minVersion('>=1.0.0') // '1.0.0'\nsemver.valid(semver.coerce('v2')) // '2.0.0'\nsemver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'\n```\n\nAs a command-line utility:\n\n```\n$ semver -h\n\nA JavaScript implementation of the https://semver.org/ specification\nCopyright Isaac Z. Schlueter\n\nUsage: semver [options] <version> [<version> [...]]\nPrints valid versions sorted by SemVer precedence\n\nOptions:\n-r --range <range>\n Print versions that match the specified range.\n\n-i --increment [<level>]\n Increment a version by the specified level. Level can\n be one of: major, minor, patch, premajor, preminor,\n prepatch, or prerelease. Default level is 'patch'.\n Only one version may be specified.\n\n--preid <identifier>\n Identifier to be used to prefix premajor, preminor,\n prepatch or prerelease version increments.\n\n-l --loose\n Interpret versions and ranges loosely\n\n-p --include-prerelease\n Always include prerelease versions in range matching\n\n-c --coerce\n Coerce a string into SemVer if possible\n (does not imply --loose)\n\nProgram exits successfully if any valid version satisfies\nall supplied ranges, and prints all satisfying versions.\n\nIf no satisfying versions are found, then exits failure.\n\nVersions are printed in ascending order, so supplying\nmultiple versions to the utility will just sort them.\n```\n\n## Versions\n\nA \"version\" is described by the `v2.0.0` specification found at\n<https://semver.org/>.\n\nA leading `\"=\"` or `\"v\"` character is stripped off and ignored.\n\n## Ranges\n\nA `version range` is a set of `comparators` which specify versions\nthat satisfy the range.\n\nA `comparator` is composed of an `operator` and a `version`. The set\nof primitive `operators` is:\n\n* `<` Less than\n* `<=` Less than or equal to\n* `>` Greater than\n* `>=` Greater than or equal to\n* `=` Equal. If no operator is specified, then equality is assumed,\n so this operator is optional, but MAY be included.\n\nFor example, the comparator `>=1.2.7` would match the versions\n`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6`\nor `1.1.0`.\n\nComparators can be joined by whitespace to form a `comparator set`,\nwhich is satisfied by the **intersection** of all of the comparators\nit includes.\n\nA range is composed of one or more comparator sets, joined by `||`. A\nversion matches a range if and only if every comparator in at least\none of the `||`-separated comparator sets is satisfied by the version.\n\nFor example, the range `>=1.2.7 <1.3.0` would match the versions\n`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`,\nor `1.1.0`.\n\nThe range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`,\n`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.\n\n### Prerelease Tags\n\nIf a version has a prerelease tag (for example, `1.2.3-alpha.3`) then\nit will only be allowed to satisfy comparator sets if at least one\ncomparator with the same `[major, minor, patch]` tuple also has a\nprerelease tag.\n\nFor example, the range `>1.2.3-alpha.3` would be allowed to match the\nversion `1.2.3-alpha.7`, but it would *not* be satisfied by\n`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically \"greater\nthan\" `1.2.3-alpha.3` according to the SemVer sort rules. The version\nrange only accepts prerelease tags on the `1.2.3` version. The\nversion `3.4.5` *would* satisfy the range, because it does not have a\nprerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.\n\nThe purpose for this behavior is twofold. First, prerelease versions\nfrequently are updated very quickly, and contain many breaking changes\nthat are (by the author's design) not yet fit for public consumption.\nTherefore, by default, they are excluded from range matching\nsemantics.\n\nSecond, a user who has opted into using a prerelease version has\nclearly indicated the intent to use *that specific* set of\nalpha/beta/rc versions. By including a prerelease tag in the range,\nthe user is indicating that they are aware of the risk. However, it\nis still not appropriate to assume that they have opted into taking a\nsimilar risk on the *next* set of prerelease versions.\n\nNote that this behavior can be suppressed (treating all prerelease\nversions as if they were normal versions, for the purpose of range\nmatching) by setting the `includePrerelease` flag on the options\nobject to any\n[functions](https://github.com/npm/node-semver#functions) that do\nrange matching.\n\n#### Prerelease Identifiers\n\nThe method `.inc` takes an additional `identifier` string argument that\nwill append the value of the string as a prerelease identifier:\n\n```javascript\nsemver.inc('1.2.3', 'prerelease', 'beta')\n// '1.2.4-beta.0'\n```\n\ncommand-line example:\n\n```bash\n$ semver 1.2.3 -i prerelease --preid beta\n1.2.4-beta.0\n```\n\nWhich then can be used to increment further:\n\n```bash\n$ semver 1.2.4-beta.0 -i prerelease\n1.2.4-beta.1\n```\n\n### Advanced Range Syntax\n\nAdvanced range syntax desugars to primitive comparators in\ndeterministic ways.\n\nAdvanced ranges may be combined in the same way as primitive\ncomparators using white space or `||`.\n\n#### Hyphen Ranges `X.Y.Z - A.B.C`\n\nSpecifies an inclusive set.\n\n* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`\n\nIf a partial version is provided as the first version in the inclusive\nrange, then the missing pieces are replaced with zeroes.\n\n* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`\n\nIf a partial version is provided as the second version in the\ninclusive range, then all versions that start with the supplied parts\nof the tuple are accepted, but nothing that would be greater than the\nprovided tuple parts.\n\n* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`\n* `1.2.3 - 2` := `>=1.2.3 <3.0.0`\n\n#### X-Ranges `1.2.x` `1.X` `1.2.*` `*`\n\nAny of `X`, `x`, or `*` may be used to \"stand in\" for one of the\nnumeric values in the `[major, minor, patch]` tuple.\n\n* `*` := `>=0.0.0` (Any version satisfies)\n* `1.x` := `>=1.0.0 <2.0.0` (Matching major version)\n* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)\n\nA partial version range is treated as an X-Range, so the special\ncharacter is in fact optional.\n\n* `\"\"` (empty string) := `*` := `>=0.0.0`\n* `1` := `1.x.x` := `>=1.0.0 <2.0.0`\n* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`\n\n#### Tilde Ranges `~1.2.3` `~1.2` `~1`\n\nAllows patch-level changes if a minor version is specified on the\ncomparator. Allows minor-level changes if not.\n\n* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`\n* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)\n* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)\n* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`\n* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)\n* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)\n* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n\n#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`\n\nAllows changes that do not modify the left-most non-zero digit in the\n`[major, minor, patch]` tuple. In other words, this allows patch and\nminor updates for versions `1.0.0` and above, patch updates for\nversions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`.\n\nMany authors treat a `0.x` version as if the `x` were the major\n\"breaking-change\" indicator.\n\nCaret ranges are ideal when an author may make breaking changes\nbetween `0.2.4` and `0.3.0` releases, which is a common practice.\nHowever, it presumes that there will *not* be breaking changes between\n`0.2.4` and `0.2.5`. It allows for changes that are presumed to be\nadditive (but non-breaking), according to commonly observed practices.\n\n* `^1.2.3` := `>=1.2.3 <2.0.0`\n* `^0.2.3` := `>=0.2.3 <0.3.0`\n* `^0.0.3` := `>=0.0.3 <0.0.4`\n* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the\n `0.0.3` version *only* will be allowed, if they are greater than or\n equal to `beta`. So, `0.0.3-pr.2` would be allowed.\n\nWhen parsing caret ranges, a missing `patch` value desugars to the\nnumber `0`, but will allow flexibility within that value, even if the\nmajor and minor versions are both `0`.\n\n* `^1.2.x` := `>=1.2.0 <2.0.0`\n* `^0.0.x` := `>=0.0.0 <0.1.0`\n* `^0.0` := `>=0.0.0 <0.1.0`\n\nA missing `minor` and `patch` values will desugar to zero, but also\nallow flexibility within those values, even if the major version is\nzero.\n\n* `^1.x` := `>=1.0.0 <2.0.0`\n* `^0.x` := `>=0.0.0 <1.0.0`\n\n### Range Grammar\n\nPutting all this together, here is a Backus-Naur grammar for ranges,\nfor the benefit of parser authors:\n\n```bnf\nrange-set ::= range ( logical-or range ) *\nlogical-or ::= ( ' ' ) * '||' ( ' ' ) *\nrange ::= hyphen | simple ( ' ' simple ) * | ''\nhyphen ::= partial ' - ' partial\nsimple ::= primitive | partial | tilde | caret\nprimitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial\npartial ::= xr ( '.' xr ( '.' xr qualifier ? )? )?\nxr ::= 'x' | 'X' | '*' | nr\nnr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *\ntilde ::= '~' partial\ncaret ::= '^' partial\nqualifier ::= ( '-' pre )? ( '+' build )?\npre ::= parts\nbuild ::= parts\nparts ::= part ( '.' part ) *\npart ::= nr | [-0-9A-Za-z]+\n```\n\n## Functions\n\nAll methods and classes take a final `options` object argument. All\noptions in this object are `false` by default. The options supported\nare:\n\n- `loose` Be more forgiving about not-quite-valid semver strings.\n (Any resulting output will always be 100% strict compliant, of\n course.) For backwards compatibility reasons, if the `options`\n argument is a boolean value instead of an object, it is interpreted\n to be the `loose` param.\n- `includePrerelease` Set to suppress the [default\n behavior](https://github.com/npm/node-semver#prerelease-tags) of\n excluding prerelease tagged versions from ranges unless they are\n explicitly opted into.\n\nStrict-mode Comparators and Ranges will be strict about the SemVer\nstrings that they parse.\n\n* `valid(v)`: Return the parsed version, or null if it's not valid.\n* `inc(v, release)`: Return the version incremented by the release\n type (`major`, `premajor`, `minor`, `preminor`, `patch`,\n `prepatch`, or `prerelease`), or null if it's not valid\n * `premajor` in one call will bump the version up to the next major\n version and down to a prerelease of that major version.\n `preminor`, and `prepatch` work the same way.\n * If called from a non-prerelease version, the `prerelease` will work the\n same as `prepatch`. It increments the patch version, then makes a\n prerelease. If the input version is already a prerelease it simply\n increments it.\n* `prerelease(v)`: Returns an array of prerelease components, or null\n if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]`\n* `major(v)`: Return the major version number.\n* `minor(v)`: Return the minor version number.\n* `patch(v)`: Return the patch version number.\n* `intersects(r1, r2, loose)`: Return true if the two supplied ranges\n or comparators intersect.\n* `parse(v)`: Attempt to parse a string as a semantic version, returning either\n a `SemVer` object or `null`.\n\n### Comparison\n\n* `gt(v1, v2)`: `v1 > v2`\n* `gte(v1, v2)`: `v1 >= v2`\n* `lt(v1, v2)`: `v1 < v2`\n* `lte(v1, v2)`: `v1 <= v2`\n* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent,\n even if they're not the exact same string. You already know how to\n compare strings.\n* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`.\n* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call\n the corresponding function above. `\"===\"` and `\"!==\"` do simple\n string comparison, but are included for completeness. Throws if an\n invalid comparison string is provided.\n* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if\n `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.\n* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions\n in descending order when passed to `Array.sort()`.\n* `diff(v1, v2)`: Returns difference between two versions by the release type\n (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`),\n or null if the versions are the same.\n\n### Comparators\n\n* `intersects(comparator)`: Return true if the comparators intersect\n\n### Ranges\n\n* `validRange(range)`: Return the valid range or null if it's not valid\n* `satisfies(version, range)`: Return true if the version satisfies the\n range.\n* `maxSatisfying(versions, range)`: Return the highest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minSatisfying(versions, range)`: Return the lowest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minVersion(range)`: Return the lowest version that can possibly match\n the given range.\n* `gtr(version, range)`: Return `true` if version is greater than all the\n versions possible in the range.\n* `ltr(version, range)`: Return `true` if version is less than all the\n versions possible in the range.\n* `outside(version, range, hilo)`: Return true if the version is outside\n the bounds of the range in either the high or low direction. The\n `hilo` argument must be either the string `'>'` or `'<'`. (This is\n the function called by `gtr` and `ltr`.)\n* `intersects(range)`: Return true if any of the ranges comparators intersect\n\nNote that, since ranges may be non-contiguous, a version might not be\ngreater than a range, less than a range, *or* satisfy a range! For\nexample, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9`\nuntil `2.0.0`, so the version `1.2.10` would not be greater than the\nrange (because `2.0.1` satisfies, which is higher), nor less than the\nrange (since `1.2.8` satisfies, which is lower), and it also does not\nsatisfy the range.\n\nIf you want to know if a version satisfies or does not satisfy a\nrange, use the `satisfies(version, range)` function.\n\n### Coercion\n\n* `coerce(version)`: Coerces a string to semver if possible\n\nThis aims to provide a very forgiving translation of a non-semver string to\nsemver. It looks for the first digit in a string, and consumes all\nremaining characters which satisfy at least a partial semver (e.g., `1`,\n`1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer\nversions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All\nsurrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes\n`3.4.0`). Only text which lacks digits will fail coercion (`version one`\nis not valid). The maximum length for any semver component considered for\ncoercion is 16 characters; longer components will be ignored\n(`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any\nsemver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value\ncomponents are invalid (`9999999999999999.4.7.4` is likely invalid).\nsemver(1) -- The semantic versioner for npm\n===========================================\n\n## Install\n\n```bash\nnpm install --save semver\n````\n\n## Usage\n\nAs a node module:\n\n```js\nconst semver = require('semver')\n\nsemver.valid('1.2.3') // '1.2.3'\nsemver.valid('a.b.c') // null\nsemver.clean(' =v1.2.3 ') // '1.2.3'\nsemver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true\nsemver.gt('1.2.3', '9.8.7') // false\nsemver.lt('1.2.3', '9.8.7') // true\nsemver.minVersion('>=1.0.0') // '1.0.0'\nsemver.valid(semver.coerce('v2')) // '2.0.0'\nsemver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'\n```\n\nAs a command-line utility:\n\n```\n$ semver -h\n\nA JavaScript implementation of the https://semver.org/ specification\nCopyright Isaac Z. Schlueter\n\nUsage: semver [options] <version> [<version> [...]]\nPrints valid versions sorted by SemVer precedence\n\nOptions:\n-r --range <range>\n Print versions that match the specified range.\n\n-i --increment [<level>]\n Increment a version by the specified level. Level can\n be one of: major, minor, patch, premajor, preminor,\n prepatch, or prerelease. Default level is 'patch'.\n Only one version may be specified.\n\n--preid <identifier>\n Identifier to be used to prefix premajor, preminor,\n prepatch or prerelease version increments.\n\n-l --loose\n Interpret versions and ranges loosely\n\n-p --include-prerelease\n Always include prerelease versions in range matching\n\n-c --coerce\n Coerce a string into SemVer if possible\n (does not imply --loose)\n\nProgram exits successfully if any valid version satisfies\nall supplied ranges, and prints all satisfying versions.\n\nIf no satisfying versions are found, then exits failure.\n\nVersions are printed in ascending order, so supplying\nmultiple versions to the utility will just sort them.\n```\n\n## Versions\n\nA \"version\" is described by the `v2.0.0` specification found at\n<https://semver.org/>.\n\nA leading `\"=\"` or `\"v\"` character is stripped off and ignored.\n\n## Ranges\n\nA `version range` is a set of `comparators` which specify versions\nthat satisfy the range.\n\nA `comparator` is composed of an `operator` and a `version`. The set\nof primitive `operators` is:\n\n* `<` Less than\n* `<=` Less than or equal to\n* `>` Greater than\n* `>=` Greater than or equal to\n* `=` Equal. If no operator is specified, then equality is assumed,\n so this operator is optional, but MAY be included.\n\nFor example, the comparator `>=1.2.7` would match the versions\n`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6`\nor `1.1.0`.\n\nComparators can be joined by whitespace to form a `comparator set`,\nwhich is satisfied by the **intersection** of all of the comparators\nit includes.\n\nA range is composed of one or more comparator sets, joined by `||`. A\nversion matches a range if and only if every comparator in at least\none of the `||`-separated comparator sets is satisfied by the version.\n\nFor example, the range `>=1.2.7 <1.3.0` would match the versions\n`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`,\nor `1.1.0`.\n\nThe range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`,\n`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.\n\n### Prerelease Tags\n\nIf a version has a prerelease tag (for example, `1.2.3-alpha.3`) then\nit will only be allowed to satisfy comparator sets if at least one\ncomparator with the same `[major, minor, patch]` tuple also has a\nprerelease tag.\n\nFor example, the range `>1.2.3-alpha.3` would be allowed to match the\nversion `1.2.3-alpha.7`, but it would *not* be satisfied by\n`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically \"greater\nthan\" `1.2.3-alpha.3` according to the SemVer sort rules. The version\nrange only accepts prerelease tags on the `1.2.3` version. The\nversion `3.4.5` *would* satisfy the range, because it does not have a\nprerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.\n\nThe purpose for this behavior is twofold. First, prerelease versions\nfrequently are updated very quickly, and contain many breaking changes\nthat are (by the author's design) not yet fit for public consumption.\nTherefore, by default, they are excluded from range matching\nsemantics.\n\nSecond, a user who has opted into using a prerelease version has\nclearly indicated the intent to use *that specific* set of\nalpha/beta/rc versions. By including a prerelease tag in the range,\nthe user is indicating that they are aware of the risk. However, it\nis still not appropriate to assume that they have opted into taking a\nsimilar risk on the *next* set of prerelease versions.\n\nNote that this behavior can be suppressed (treating all prerelease\nversions as if they were normal versions, for the purpose of range\nmatching) by setting the `includePrerelease` flag on the options\nobject to any\n[functions](https://github.com/npm/node-semver#functions) that do\nrange matching.\n\n#### Prerelease Identifiers\n\nThe method `.inc` takes an additional `identifier` string argument that\nwill append the value of the string as a prerelease identifier:\n\n```javascript\nsemver.inc('1.2.3', 'prerelease', 'beta')\n// '1.2.4-beta.0'\n```\n\ncommand-line example:\n\n```bash\n$ semver 1.2.3 -i prerelease --preid beta\n1.2.4-beta.0\n```\n\nWhich then can be used to increment further:\n\n```bash\n$ semver 1.2.4-beta.0 -i prerelease\n1.2.4-beta.1\n```\n\n### Advanced Range Syntax\n\nAdvanced range syntax desugars to primitive comparators in\ndeterministic ways.\n\nAdvanced ranges may be combined in the same way as primitive\ncomparators using white space or `||`.\n\n#### Hyphen Ranges `X.Y.Z - A.B.C`\n\nSpecifies an inclusive set.\n\n* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`\n\nIf a partial version is provided as the first version in the inclusive\nrange, then the missing pieces are replaced with zeroes.\n\n* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`\n\nIf a partial version is provided as the second version in the\ninclusive range, then all versions that start with the supplied parts\nof the tuple are accepted, but nothing that would be greater than the\nprovided tuple parts.\n\n* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`\n* `1.2.3 - 2` := `>=1.2.3 <3.0.0`\n\n#### X-Ranges `1.2.x` `1.X` `1.2.*` `*`\n\nAny of `X`, `x`, or `*` may be used to \"stand in\" for one of the\nnumeric values in the `[major, minor, patch]` tuple.\n\n* `*` := `>=0.0.0` (Any version satisfies)\n* `1.x` := `>=1.0.0 <2.0.0` (Matching major version)\n* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)\n\nA partial version range is treated as an X-Range, so the special\ncharacter is in fact optional.\n\n* `\"\"` (empty string) := `*` := `>=0.0.0`\n* `1` := `1.x.x` := `>=1.0.0 <2.0.0`\n* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`\n\n#### Tilde Ranges `~1.2.3` `~1.2` `~1`\n\nAllows patch-level changes if a minor version is specified on the\ncomparator. Allows minor-level changes if not.\n\n* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`\n* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)\n* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)\n* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`\n* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)\n* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)\n* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n\n#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`\n\nAllows changes that do not modify the left-most non-zero digit in the\n`[major, minor, patch]` tuple. In other words, this allows patch and\nminor updates for versions `1.0.0` and above, patch updates for\nversions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`.\n\nMany authors treat a `0.x` version as if the `x` were the major\n\"breaking-change\" indicator.\n\nCaret ranges are ideal when an author may make breaking changes\nbetween `0.2.4` and `0.3.0` releases, which is a common practice.\nHowever, it presumes that there will *not* be breaking changes between\n`0.2.4` and `0.2.5`. It allows for changes that are presumed to be\nadditive (but non-breaking), according to commonly observed practices.\n\n* `^1.2.3` := `>=1.2.3 <2.0.0`\n* `^0.2.3` := `>=0.2.3 <0.3.0`\n* `^0.0.3` := `>=0.0.3 <0.0.4`\n* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the\n `0.0.3` version *only* will be allowed, if they are greater than or\n equal to `beta`. So, `0.0.3-pr.2` would be allowed.\n\nWhen parsing caret ranges, a missing `patch` value desugars to the\nnumber `0`, but will allow flexibility within that value, even if the\nmajor and minor versions are both `0`.\n\n* `^1.2.x` := `>=1.2.0 <2.0.0`\n* `^0.0.x` := `>=0.0.0 <0.1.0`\n* `^0.0` := `>=0.0.0 <0.1.0`\n\nA missing `minor` and `patch` values will desugar to zero, but also\nallow flexibility within those values, even if the major version is\nzero.\n\n* `^1.x` := `>=1.0.0 <2.0.0`\n* `^0.x` := `>=0.0.0 <1.0.0`\n\n### Range Grammar\n\nPutting all this together, here is a Backus-Naur grammar for ranges,\nfor the benefit of parser authors:\n\n```bnf\nrange-set ::= range ( logical-or range ) *\nlogical-or ::= ( ' ' ) * '||' ( ' ' ) *\nrange ::= hyphen | simple ( ' ' simple ) * | ''\nhyphen ::= partial ' - ' partial\nsimple ::= primitive | partial | tilde | caret\nprimitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial\npartial ::= xr ( '.' xr ( '.' xr qualifier ? )? )?\nxr ::= 'x' | 'X' | '*' | nr\nnr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *\ntilde ::= '~' partial\ncaret ::= '^' partial\nqualifier ::= ( '-' pre )? ( '+' build )?\npre ::= parts\nbuild ::= parts\nparts ::= part ( '.' part ) *\npart ::= nr | [-0-9A-Za-z]+\n```\n\n## Functions\n\nAll methods and classes take a final `options` object argument. All\noptions in this object are `false` by default. The options supported\nare:\n\n- `loose` Be more forgiving about not-quite-valid semver strings.\n (Any resulting output will always be 100% strict compliant, of\n course.) For backwards compatibility reasons, if the `options`\n argument is a boolean value instead of an object, it is interpreted\n to be the `loose` param.\n- `includePrerelease` Set to suppress the [default\n behavior](https://github.com/npm/node-semver#prerelease-tags) of\n excluding prerelease tagged versions from ranges unless they are\n explicitly opted into.\n\nStrict-mode Comparators and Ranges will be strict about the SemVer\nstrings that they parse.\n\n* `valid(v)`: Return the parsed version, or null if it's not valid.\n* `inc(v, release)`: Return the version incremented by the release\n type (`major`, `premajor`, `minor`, `preminor`, `patch`,\n `prepatch`, or `prerelease`), or null if it's not valid\n * `premajor` in one call will bump the version up to the next major\n version and down to a prerelease of that major version.\n `preminor`, and `prepatch` work the same way.\n * If called from a non-prerelease version, the `prerelease` will work the\n same as `prepatch`. It increments the patch version, then makes a\n prerelease. If the input version is already a prerelease it simply\n increments it.\n* `prerelease(v)`: Returns an array of prerelease components, or null\n if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]`\n* `major(v)`: Return the major version number.\n* `minor(v)`: Return the minor version number.\n* `patch(v)`: Return the patch version number.\n* `intersects(r1, r2, loose)`: Return true if the two supplied ranges\n or comparators intersect.\n* `parse(v)`: Attempt to parse a string as a semantic version, returning either\n a `SemVer` object or `null`.\n\n### Comparison\n\n* `gt(v1, v2)`: `v1 > v2`\n* `gte(v1, v2)`: `v1 >= v2`\n* `lt(v1, v2)`: `v1 < v2`\n* `lte(v1, v2)`: `v1 <= v2`\n* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent,\n even if they're not the exact same string. You already know how to\n compare strings.\n* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`.\n* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call\n the corresponding function above. `\"===\"` and `\"!==\"` do simple\n string comparison, but are included for completeness. Throws if an\n invalid comparison string is provided.\n* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if\n `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.\n* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions\n in descending order when passed to `Array.sort()`.\n* `diff(v1, v2)`: Returns difference between two versions by the release type\n (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`),\n or null if the versions are the same.\n\n### Comparators\n\n* `intersects(comparator)`: Return true if the comparators intersect\n\n### Ranges\n\n* `validRange(range)`: Return the valid range or null if it's not valid\n* `satisfies(version, range)`: Return true if the version satisfies the\n range.\n* `maxSatisfying(versions, range)`: Return the highest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minSatisfying(versions, range)`: Return the lowest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minVersion(range)`: Return the lowest version that can possibly match\n the given range.\n* `gtr(version, range)`: Return `true` if version is greater than all the\n versions possible in the range.\n* `ltr(version, range)`: Return `true` if version is less than all the\n versions possible in the range.\n* `outside(version, range, hilo)`: Return true if the version is outside\n the bounds of the range in either the high or low direction. The\n `hilo` argument must be either the string `'>'` or `'<'`. (This is\n the function called by `gtr` and `ltr`.)\n* `intersects(range)`: Return true if any of the ranges comparators intersect\n\nNote that, since ranges may be non-contiguous, a version might not be\ngreater than a range, less than a range, *or* satisfy a range! For\nexample, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9`\nuntil `2.0.0`, so the version `1.2.10` would not be greater than the\nrange (because `2.0.1` satisfies, which is higher), nor less than the\nrange (since `1.2.8` satisfies, which is lower), and it also does not\nsatisfy the range.\n\nIf you want to know if a version satisfies or does not satisfy a\nrange, use the `satisfies(version, range)` function.\n\n### Coercion\n\n* `coerce(version)`: Coerces a string to semver if possible\n\nThis aims to provide a very forgiving translation of a non-semver string to\nsemver. It looks for the first digit in a string, and consumes all\nremaining characters which satisfy at least a partial semver (e.g., `1`,\n`1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer\nversions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All\nsurrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes\n`3.4.0`). Only text which lacks digits will fail coercion (`version one`\nis not valid). The maximum length for any semver component considered for\ncoercion is 16 characters; longer components will be ignored\n(`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any\nsemver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value\ncomponents are invalid (`9999999999999999.4.7.4` is likely invalid).\n# clone-response\n\n> Clone a Node.js HTTP response stream\n\n[](https://travis-ci.org/lukechilds/clone-response)\n[](https://coveralls.io/github/lukechilds/clone-response?branch=master)\n[](https://www.npmjs.com/package/clone-response)\n[](https://www.npmjs.com/package/clone-response)\n\nReturns a new stream and copies over all properties and methods from the original response giving you a complete duplicate.\n\nThis is useful in situations where you need to consume the response stream but also want to pass an unconsumed stream somewhere else to be consumed later.\n\n## Install\n\n```shell\nnpm install --save clone-response\n```\n\n## Usage\n\n```js\nconst http = require('http');\nconst cloneResponse = require('clone-response');\n\nhttp.get('http://example.com', response => {\n const clonedResponse = cloneResponse(response);\n response.pipe(process.stdout);\n\n setImmediate(() => {\n // The response stream has already been consumed by the time this executes,\n // however the cloned response stream is still available.\n doSomethingWithResponse(clonedResponse);\n });\n});\n```\n\nPlease bear in mind that the process of cloning a stream consumes it. However, you can consume a stream multiple times in the same tick, therefore allowing you to create multiple clones. e.g:\n\n```js\nconst clone1 = cloneResponse(response);\nconst clone2 = cloneResponse(response);\n// response can still be consumed in this tick but cannot be consumed if passed\n// into any async callbacks. clone1 and clone2 can be passed around and be\n// consumed in the future.\n```\n\n## API\n\n### cloneResponse(response)\n\nReturns a clone of the passed in response.\n\n#### response\n\nType: `stream`\n\nA [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage) to clone.\n\n## License\n\nMIT © Luke Childs\n# ws: a Node.js WebSocket library\n\n[](https://www.npmjs.com/package/ws)\n[](https://travis-ci.org/websockets/ws)\n[](https://ci.appveyor.com/project/lpinca/ws)\n[](https://coveralls.io/r/websockets/ws?branch=master)\n\nws is a simple to use, blazing fast, and thoroughly tested WebSocket client\nand server implementation.\n\nPasses the quite extensive Autobahn test suite: [server][server-report],\n[client][client-report].\n\n**Note**: This module does not work in the browser. The client in the docs is a\nreference to a back end with the role of a client in the WebSocket\ncommunication. Browser clients must use the native\n[`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) object.\nTo make the same code work seamlessly on Node.js and the browser, you can use\none of the many wrappers available on npm, like\n[isomorphic-ws](https://github.com/heineiuo/isomorphic-ws).\n\n## Table of Contents\n\n* [Protocol support](#protocol-support)\n* [Installing](#installing)\n + [Opt-in for performance and spec compliance](#opt-in-for-performance-and-spec-compliance)\n* [API docs](#api-docs)\n* [WebSocket compression](#websocket-compression)\n* [Usage examples](#usage-examples)\n + [Sending and receiving text data](#sending-and-receiving-text-data)\n + [Sending binary data](#sending-binary-data)\n + [Simple server](#simple-server)\n + [External HTTP/S server](#external-https-server)\n + [Multiple servers sharing a single HTTP/S server](#multiple-servers-sharing-a-single-https-server)\n + [Server broadcast](#server-broadcast)\n + [echo.websocket.org demo](#echowebsocketorg-demo)\n + [Other examples](#other-examples)\n* [Error handling best practices](#error-handling-best-practices)\n* [FAQ](#faq)\n + [How to get the IP address of the client?](#how-to-get-the-ip-address-of-the-client)\n + [How to detect and close broken connections?](#how-to-detect-and-close-broken-connections)\n + [How to connect via a proxy?](#how-to-connect-via-a-proxy)\n* [Changelog](#changelog)\n* [License](#license)\n\n## Protocol support\n\n* **HyBi drafts 07-12** (Use the option `protocolVersion: 8`)\n* **HyBi drafts 13-17** (Current default, alternatively option `protocolVersion: 13`)\n\n## Installing\n\n```\nnpm install --save ws\n```\n\n### Opt-in for performance and spec compliance\n\nThere are 2 optional modules that can be installed along side with the ws\nmodule. These modules are binary addons which improve certain operations.\nPrebuilt binaries are available for the most popular platforms so you don't\nnecessarily need to have a C++ compiler installed on your machine.\n\n- `npm install --save-optional bufferutil`: Allows to efficiently perform\n operations such as masking and unmasking the data payload of the WebSocket\n frames.\n- `npm install --save-optional utf-8-validate`: Allows to efficiently check\n if a message contains valid UTF-8 as required by the spec.\n\n## API docs\n\nSee [`/doc/ws.md`](./doc/ws.md) for Node.js-like docs for the ws classes.\n\n## WebSocket compression\n\nws supports the [permessage-deflate extension][permessage-deflate] which\nenables the client and server to negotiate a compression algorithm and its\nparameters, and then selectively apply it to the data payloads of each\nWebSocket message.\n\nThe extension is disabled by default on the server and enabled by default on\nthe client. It adds a significant overhead in terms of performance and memory\nconsumption so we suggest to enable it only if it is really needed.\n\nNote that Node.js has a variety of issues with high-performance compression,\nwhere increased concurrency, especially on Linux, can lead to\n[catastrophic memory fragmentation][node-zlib-bug] and slow performance.\nIf you intend to use permessage-deflate in production, it is worthwhile to set\nup a test representative of your workload and ensure Node.js/zlib will handle\nit with acceptable performance and memory usage.\n\nTuning of permessage-deflate can be done via the options defined below. You can\nalso use `zlibDeflateOptions` and `zlibInflateOptions`, which is passed directly\ninto the creation of [raw deflate/inflate streams][node-zlib-deflaterawdocs].\n\nSee [the docs][ws-server-options] for more options.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({\n port: 8080,\n perMessageDeflate: {\n zlibDeflateOptions: { // See zlib defaults.\n chunkSize: 1024,\n memLevel: 7,\n level: 3,\n },\n zlibInflateOptions: {\n chunkSize: 10 * 1024\n },\n // Other options settable:\n clientNoContextTakeover: true, // Defaults to negotiated value.\n serverNoContextTakeover: true, // Defaults to negotiated value.\n clientMaxWindowBits: 10, // Defaults to negotiated value.\n serverMaxWindowBits: 10, // Defaults to negotiated value.\n // Below options specified as default values.\n concurrencyLimit: 10, // Limits zlib concurrency for perf.\n threshold: 1024, // Size (in bytes) below which messages\n // should not be compressed.\n }\n});\n```\n\nThe client will only use the extension if it is supported and enabled on the\nserver. To always disable the extension on the client set the\n`perMessageDeflate` option to `false`.\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('ws://www.host.com/path', {\n perMessageDeflate: false\n});\n```\n\n## Usage examples\n\n### Sending and receiving text data\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('ws://www.host.com/path');\n\nws.on('open', function open() {\n ws.send('something');\n});\n\nws.on('message', function incoming(data) {\n console.log(data);\n});\n```\n\n### Sending binary data\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('ws://www.host.com/path');\n\nws.on('open', function open() {\n const array = new Float32Array(5);\n\n for (var i = 0; i < array.length; ++i) {\n array[i] = i / 2;\n }\n\n ws.send(array);\n});\n```\n\n### Simple server\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(message) {\n console.log('received: %s', message);\n });\n\n ws.send('something');\n});\n```\n\n### External HTTP/S server\n\n```js\nconst fs = require('fs');\nconst https = require('https');\nconst WebSocket = require('ws');\n\nconst server = new https.createServer({\n cert: fs.readFileSync('/path/to/cert.pem'),\n key: fs.readFileSync('/path/to/key.pem')\n});\nconst wss = new WebSocket.Server({ server });\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(message) {\n console.log('received: %s', message);\n });\n\n ws.send('something');\n});\n\nserver.listen(8080);\n```\n\n### Multiple servers sharing a single HTTP/S server\n\n```js\nconst http = require('http');\nconst WebSocket = require('ws');\n\nconst server = http.createServer();\nconst wss1 = new WebSocket.Server({ noServer: true });\nconst wss2 = new WebSocket.Server({ noServer: true });\n\nwss1.on('connection', function connection(ws) {\n // ...\n});\n\nwss2.on('connection', function connection(ws) {\n // ...\n});\n\nserver.on('upgrade', function upgrade(request, socket, head) {\n const pathname = url.parse(request.url).pathname;\n\n if (pathname === '/foo') {\n wss1.handleUpgrade(request, socket, head, function done(ws) {\n wss1.emit('connection', ws, request);\n });\n } else if (pathname === '/bar') {\n wss2.handleUpgrade(request, socket, head, function done(ws) {\n wss2.emit('connection', ws, request);\n });\n } else {\n socket.destroy();\n }\n});\n\nserver.listen(8080);\n```\n\n### Server broadcast\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\n// Broadcast to all.\nwss.broadcast = function broadcast(data) {\n wss.clients.forEach(function each(client) {\n if (client.readyState === WebSocket.OPEN) {\n client.send(data);\n }\n });\n};\n\nwss.on('connection', function connection(ws) {\n ws.on('message', function incoming(data) {\n // Broadcast to everyone else.\n wss.clients.forEach(function each(client) {\n if (client !== ws && client.readyState === WebSocket.OPEN) {\n client.send(data);\n }\n });\n });\n});\n```\n\n### echo.websocket.org demo\n\n```js\nconst WebSocket = require('ws');\n\nconst ws = new WebSocket('wss://echo.websocket.org/', {\n origin: 'https://websocket.org'\n});\n\nws.on('open', function open() {\n console.log('connected');\n ws.send(Date.now());\n});\n\nws.on('close', function close() {\n console.log('disconnected');\n});\n\nws.on('message', function incoming(data) {\n console.log(`Roundtrip time: ${Date.now() - data} ms`);\n\n setTimeout(function timeout() {\n ws.send(Date.now());\n }, 500);\n});\n```\n\n### Other examples\n\nFor a full example with a browser client communicating with a ws server, see the\nexamples folder.\n\nOtherwise, see the test cases.\n\n## Error handling best practices\n\n```js\n// If the WebSocket is closed before the following send is attempted\nws.send('something');\n\n// Errors (both immediate and async write errors) can be detected in an optional\n// callback. The callback is also the only way of being notified that data has\n// actually been sent.\nws.send('something', function ack(error) {\n // If error is not defined, the send has been completed, otherwise the error\n // object will indicate what failed.\n});\n\n// Immediate errors can also be handled with `try...catch`, but **note** that\n// since sends are inherently asynchronous, socket write failures will *not* be\n// captured when this technique is used.\ntry { ws.send('something'); }\ncatch (e) { /* handle error */ }\n```\n\n## FAQ\n\n### How to get the IP address of the client?\n\nThe remote IP address can be obtained from the raw socket.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nwss.on('connection', function connection(ws, req) {\n const ip = req.connection.remoteAddress;\n});\n```\n\nWhen the server runs behind a proxy like NGINX, the de-facto standard is to use\nthe `X-Forwarded-For` header.\n\n```js\nwss.on('connection', function connection(ws, req) {\n const ip = req.headers['x-forwarded-for'].split(/\\s*,\\s*/)[0];\n});\n```\n\n### How to detect and close broken connections?\n\nSometimes the link between the server and the client can be interrupted in a\nway that keeps both the server and the client unaware of the broken state of the\nconnection (e.g. when pulling the cord).\n\nIn these cases ping messages can be used as a means to verify that the remote\nendpoint is still responsive.\n\n```js\nconst WebSocket = require('ws');\n\nconst wss = new WebSocket.Server({ port: 8080 });\n\nfunction noop() {}\n\nfunction heartbeat() {\n this.isAlive = true;\n}\n\nwss.on('connection', function connection(ws) {\n ws.isAlive = true;\n ws.on('pong', heartbeat);\n});\n\nconst interval = setInterval(function ping() {\n wss.clients.forEach(function each(ws) {\n if (ws.isAlive === false) return ws.terminate();\n\n ws.isAlive = false;\n ws.ping(noop);\n });\n}, 30000);\n```\n\nPong messages are automatically sent in response to ping messages as required\nby the spec.\n\n### How to connect via a proxy?\n\nUse a custom `http.Agent` implementation like [https-proxy-agent][] or\n[socks-proxy-agent][].\n\n## Changelog\n\nWe're using the GitHub [releases][changelog] for changelog entries.\n\n## License\n\n[MIT](LICENSE)\n\n[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent\n[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent\n[client-report]: http://websockets.github.io/ws/autobahn/clients/\n[server-report]: http://websockets.github.io/ws/autobahn/servers/\n[permessage-deflate]: https://tools.ietf.org/html/rfc7692\n[changelog]: https://github.com/websockets/ws/releases\n[node-zlib-bug]: https://github.com/nodejs/node/issues/8871\n[node-zlib-deflaterawdocs]: https://nodejs.org/api/zlib.html#zlib_zlib_createdeflateraw_options\n[ws-server-options]: https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback\n# fs-constants\n\nSmall module that allows you to get the fs constants across\nNode and the browser. \n\n```\nnpm install fs-constants\n```\n\nPreviously you would use `require('constants')` for this in node but that has been\ndeprecated and changed to `require('fs').constants` which does not browserify.\n\nThis module uses `require('constants')` in the browser and `require('fs').constants` in node to work around this\n\n## Usage\n\n``` js\nvar constants = require('fs-constants')\n\nconsole.log('constants:', constants)\n```\n\n## License\n\nMIT\n# minimalistic-crypto-utils\n[](http://travis-ci.org/indutny/minimalistic-crypto-utils)\n[](http://badge.fury.io/js/minimalistic-crypto-utils)\n\nVery minimal utils that are required in order to write reasonable JS-only\ncrypto module.\n\n## Usage\n\n```js\nconst utils = require('minimalistic-crypto-utils');\n\nutils.toArray('abcd', 'hex');\nutils.encode([ 1, 2, 3, 4 ], 'hex');\nutils.toHex([ 1, 2, 3, 4 ]);\n```\n\n#### LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2017.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: http://tools.ietf.org/html/rfc6979\n[1]: https://github.com/indutny/bn.js\n[2]: https://github.com/indutny/hash.js\n[3]: https://github.com/bitchan/eccrypto\n[4]: https://github.com/wanderer/secp256k1-node\ngauge\n=====\n\nA nearly stateless terminal based horizontal gauge / progress bar.\n\n```javascript\nvar Gauge = require(\"gauge\")\n\nvar gauge = new Gauge()\n\ngauge.show(\"test\", 0.20)\n\ngauge.pulse(\"this\")\n\ngauge.hide()\n```\n\n\n\n### CHANGES FROM 1.x\n\nGauge 2.x is breaking release, please see the [changelog] for details on\nwhat's changed if you were previously a user of this module.\n\n[changelog]: CHANGELOG.md\n\n### THE GAUGE CLASS\n\nThis is the typical interface to the module– it provides a pretty\nfire-and-forget interface to displaying your status information.\n\n```\nvar Gauge = require(\"gauge\")\n\nvar gauge = new Gauge([stream], [options])\n```\n\n* **stream** – *(optional, default STDERR)* A stream that progress bar\n updates are to be written to. Gauge honors backpressure and will pause\n most writing if it is indicated.\n* **options** – *(optional)* An option object.\n\nConstructs a new gauge. Gauges are drawn on a single line, and are not drawn\nif **stream** isn't a tty and a tty isn't explicitly provided.\n\nIf **stream** is a terminal or if you pass in **tty** to **options** then we\nwill detect terminal resizes and redraw to fit. We do this by watching for\n`resize` events on the tty. (To work around a bug in verisons of Node prior\nto 2.5.0, we watch for them on stdout if the tty is stderr.) Resizes to\nlarger window sizes will be clean, but shrinking the window will always\nresult in some cruft.\n\n**IMPORTANT:** If you prevously were passing in a non-tty stream but you still\nwant output (for example, a stream wrapped by the `ansi` module) then you\nneed to pass in the **tty** option below, as `gauge` needs access to\nthe underlying tty in order to do things like terminal resizes and terminal\nwidth detection.\n\nThe **options** object can have the following properties, all of which are\noptional:\n\n* **updateInterval**: How often gauge updates should be drawn, in miliseconds.\n* **fixedFramerate**: Defaults to false on node 0.8, true on everything\n else. When this is true a timer is created to trigger once every\n `updateInterval` ms, when false, updates are printed as soon as they come\n in but updates more often than `updateInterval` are ignored. The reason\n 0.8 doesn't have this set to true is that it can't `unref` its timer and\n so it would stop your program from exiting– if you want to use this\n feature with 0.8 just make sure you call `gauge.disable()` before you\n expect your program to exit.\n* **themes**: A themeset to use when selecting the theme to use. Defaults\n to `gauge/themes`, see the [themes] documentation for details.\n* **theme**: Select a theme for use, it can be a:\n * Theme object, in which case the **themes** is not used.\n * The name of a theme, which will be looked up in the current *themes*\n object.\n * A configuration object with any of `hasUnicode`, `hasColor` or\n `platform` keys, which if wlll be used to override our guesses when making\n a default theme selection.\n\n If no theme is selected then a default is picked using a combination of our\n best guesses at your OS, color support and unicode support.\n* **template**: Describes what you want your gauge to look like. The\n default is what npm uses. Detailed [documentation] is later in this\n document.\n* **hideCursor**: Defaults to true. If true, then the cursor will be hidden\n while the gauge is displayed.\n* **tty**: The tty that you're ultimately writing to. Defaults to the same\n as **stream**. This is used for detecting the width of the terminal and\n resizes. The width used is `tty.columns - 1`. If no tty is available then\n a width of `79` is assumed.\n* **enabled**: Defaults to true if `tty` is a TTY, false otherwise. If true\n the gauge starts enabled. If disabled then all update commands are\n ignored and no gauge will be printed until you call `.enable()`.\n* **Plumbing**: The class to use to actually generate the gauge for\n printing. This defaults to `require('gauge/plumbing')` and ordinarly you\n shouldn't need to override this.\n* **cleanupOnExit**: Defaults to true. Ordinarily we register an exit\n handler to make sure your cursor is turned back on and the progress bar\n erased when your process exits, even if you Ctrl-C out or otherwise exit\n unexpectedly. You can disable this and it won't register the exit handler.\n\n[has-unicode]: https://www.npmjs.com/package/has-unicode\n[themes]: #themes\n[documentation]: #templates\n\n#### `gauge.show(section | status, [completed])`\n\nThe first argument is either the section, the name of the current thing\ncontributing to progress, or an object with keys like **section**,\n**subsection** & **completed** (or any others you have types for in a custom\ntemplate). If you don't want to update or set any of these you can pass\n`null` and it will be ignored.\n\nThe second argument is the percent completed as a value between 0 and 1.\nWithout it, completion is just not updated. You'll also note that completion\ncan be passed in as part of a status object as the first argument. If both\nit and the completed argument are passed in, the completed argument wins.\n\n#### `gauge.hide([cb])`\n\nRemoves the gauge from the terminal. Optionally, callback `cb` after IO has\nhad an opportunity to happen (currently this just means after `setImmediate`\nhas called back.)\n\nIt turns out this is important when you're pausing the progress bar on one\nfilehandle and printing to another– otherwise (with a big enough print) node\ncan end up printing the \"end progress bar\" bits to the progress bar filehandle\nwhile other stuff is printing to another filehandle. These getting interleaved\ncan cause corruption in some terminals.\n\n#### `gauge.pulse([subsection])`\n\n* **subsection** – *(optional)* The specific thing that triggered this pulse\n\nSpins the spinner in the gauge to show output. If **subsection** is\nincluded then it will be combined with the last name passed to `gauge.show`.\n\n#### `gauge.disable()`\n\nHides the gauge and ignores further calls to `show` or `pulse`.\n\n#### `gauge.enable()`\n\nShows the gauge and resumes updating when `show` or `pulse` is called.\n\n#### `gauge.isEnabled()`\n\nReturns true if the gauge is enabled.\n\n#### `gauge.setThemeset(themes)`\n\nChange the themeset to select a theme from. The same as the `themes` option\nused in the constructor. The theme will be reselected from this themeset.\n\n#### `gauge.setTheme(theme)`\n\nChange the active theme, will be displayed with the next show or pulse. This can be:\n\n* Theme object, in which case the **themes** is not used.\n* The name of a theme, which will be looked up in the current *themes*\n object.\n* A configuration object with any of `hasUnicode`, `hasColor` or\n `platform` keys, which if wlll be used to override our guesses when making\n a default theme selection.\n\nIf no theme is selected then a default is picked using a combination of our\nbest guesses at your OS, color support and unicode support.\n\n#### `gauge.setTemplate(template)`\n\nChange the active template, will be displayed with the next show or pulse\n\n### Tracking Completion\n\nIf you have more than one thing going on that you want to track completion\nof, you may find the related [are-we-there-yet] helpful. It's `change`\nevent can be wired up to the `show` method to get a more traditional\nprogress bar interface.\n\n[are-we-there-yet]: https://www.npmjs.com/package/are-we-there-yet\n\n### THEMES\n\n```\nvar themes = require('gauge/themes')\n\n// fetch the default color unicode theme for this platform\nvar ourTheme = themes({hasUnicode: true, hasColor: true})\n\n// fetch the default non-color unicode theme for osx\nvar ourTheme = themes({hasUnicode: true, hasColor: false, platform: 'darwin'})\n\n// create a new theme based on the color ascii theme for this platform\n// that brackets the progress bar with arrows\nvar ourTheme = themes.newTheme(theme(hasUnicode: false, hasColor: true}), {\n preProgressbar: '→',\n postProgressbar: '←'\n})\n```\n\nThe object returned by `gauge/themes` is an instance of the `ThemeSet` class.\n\n```\nvar ThemeSet = require('gauge/theme-set')\nvar themes = new ThemeSet()\n// or\nvar themes = require('gauge/themes')\nvar mythemes = themes.newThemeset() // creates a new themeset based on the default themes\n```\n\n#### themes(opts)\n#### themes.getDefault(opts)\n\nTheme objects are a function that fetches the default theme based on\nplatform, unicode and color support.\n\nOptions is an object with the following properties:\n\n* **hasUnicode** - If true, fetch a unicode theme, if no unicode theme is\n available then a non-unicode theme will be used.\n* **hasColor** - If true, fetch a color theme, if no color theme is\n available a non-color theme will be used.\n* **platform** (optional) - Defaults to `process.platform`. If no\n platform match is available then `fallback` is used instead.\n\nIf no compatible theme can be found then an error will be thrown with a\n`code` of `EMISSINGTHEME`.\n\n#### themes.addTheme(themeName, themeObj)\n#### themes.addTheme(themeName, [parentTheme], newTheme)\n\nAdds a named theme to the themeset. You can pass in either a theme object,\nas returned by `themes.newTheme` or the arguments you'd pass to\n`themes.newTheme`.\n\n#### themes.getThemeNames()\n\nReturn a list of all of the names of the themes in this themeset. Suitable\nfor use in `themes.getTheme(…)`.\n\n#### themes.getTheme(name)\n\nReturns the theme object from this theme set named `name`.\n\nIf `name` does not exist in this themeset an error will be thrown with\na `code` of `EMISSINGTHEME`.\n\n#### themes.setDefault([opts], themeName)\n\n`opts` is an object with the following properties.\n\n* **platform** - Defaults to `'fallback'`. If your theme is platform\n specific, specify that here with the platform from `process.platform`, eg,\n `win32`, `darwin`, etc.\n* **hasUnicode** - Defaults to `false`. If your theme uses unicode you\n should set this to true.\n* **hasColor** - Defaults to `false`. If your theme uses color you should\n set this to true.\n\n`themeName` is the name of the theme (as given to `addTheme`) to use for\nthis set of `opts`.\n\n#### themes.newTheme([parentTheme,] newTheme)\n\nCreate a new theme object based on `parentTheme`. If no `parentTheme` is\nprovided then a minimal parentTheme that defines functions for rendering the\nactivity indicator (spinner) and progress bar will be defined. (This\nfallback parent is defined in `gauge/base-theme`.)\n\nnewTheme should be a bare object– we'll start by discussing the properties\ndefined by the default themes:\n\n* **preProgressbar** - displayed prior to the progress bar, if the progress\n bar is displayed.\n* **postProgressbar** - displayed after the progress bar, if the progress bar\n is displayed.\n* **progressBarTheme** - The subtheme passed through to the progress bar\n renderer, it's an object with `complete` and `remaining` properties\n that are the strings you want repeated for those sections of the progress\n bar.\n* **activityIndicatorTheme** - The theme for the activity indicator (spinner),\n this can either be a string, in which each character is a different step, or\n an array of strings.\n* **preSubsection** - Displayed as a separator between the `section` and\n `subsection` when the latter is printed.\n\nMore generally, themes can have any value that would be a valid value when rendering\ntemplates. The properties in the theme are used when their name matches a type in\nthe template. Their values can be:\n\n* **strings & numbers** - They'll be included as is\n* **function (values, theme, width)** - Should return what you want in your output.\n *values* is an object with values provided via `gauge.show`,\n *theme* is the theme specific to this item (see below) or this theme object,\n and *width* is the number of characters wide your result should be.\n\nThere are a couple of special prefixes:\n\n* **pre** - Is shown prior to the property, if its displayed.\n* **post** - Is shown after the property, if its displayed.\n\nAnd one special suffix:\n\n* **Theme** - Its value is passed to a function-type item as the theme.\n\n#### themes.addToAllThemes(theme)\n\nThis *mixes-in* `theme` into all themes currently defined. It also adds it\nto the default parent theme for this themeset, so future themes added to\nthis themeset will get the values from `theme` by default.\n\n#### themes.newThemeset()\n\nCopy the current themeset into a new one. This allows you to easily inherit\none themeset from another.\n\n### TEMPLATES\n\nA template is an array of objects and strings that, after being evaluated,\nwill be turned into the gauge line. The default template is:\n\n```javascript\n[\n {type: 'progressbar', length: 20},\n {type: 'activityIndicator', kerning: 1, length: 1},\n {type: 'section', kerning: 1, default: ''},\n {type: 'subsection', kerning: 1, default: ''}\n]\n```\n\nThe various template elements can either be **plain strings**, in which case they will\nbe be included verbatum in the output, or objects with the following properties:\n\n* *type* can be any of the following plus any keys you pass into `gauge.show` plus\n any keys you have on a custom theme.\n * `section` – What big thing you're working on now.\n * `subsection` – What component of that thing is currently working.\n * `activityIndicator` – Shows a spinner using the `activityIndicatorTheme`\n from your active theme.\n * `progressbar` – A progress bar representing your current `completed`\n using the `progressbarTheme` from your active theme.\n* *kerning* – Number of spaces that must be between this item and other\n items, if this item is displayed at all.\n* *maxLength* – The maximum length for this element. If its value is longer it\n will be truncated.\n* *minLength* – The minimum length for this element. If its value is shorter it\n will be padded according to the *align* value.\n* *align* – (Default: left) Possible values \"left\", \"right\" and \"center\". Works\n as you'd expect from word processors.\n* *length* – Provides a single value for both *minLength* and *maxLength*. If both\n *length* and *minLength or *maxLength* are specifed then the latter take precedence.\n* *value* – A literal value to use for this template item.\n* *default* – A default value to use for this template item if a value\n wasn't otherwise passed in.\n\n### PLUMBING\n\nThis is the super simple, assume nothing, do no magic internals used by gauge to\nimplement its ordinary interface.\n\n```\nvar Plumbing = require('gauge/plumbing')\nvar gauge = new Plumbing(theme, template, width)\n```\n\n* **theme**: The theme to use.\n* **template**: The template to use.\n* **width**: How wide your gauge should be\n\n#### `gauge.setTheme(theme)`\n\nChange the active theme.\n\n#### `gauge.setTemplate(template)`\n\nChange the active template.\n\n#### `gauge.setWidth(width)`\n\nChange the width to render at.\n\n#### `gauge.hide()`\n\nReturn the string necessary to hide the progress bar\n\n#### `gauge.hideCursor()`\n\nReturn a string to hide the cursor.\n\n#### `gauge.showCursor()`\n\nReturn a string to show the cursor.\n\n#### `gauge.show(status)`\n\nUsing `status` for values, render the provided template with the theme and return\na string that is suitable for printing to update the gauge.\n\n\nAlmost There is a crowdfunding platform based on [NEAR](https://near.org/) and hosted on [Sia](https://siasky.net/). Users can both create new Almost There \"campaigns\", or donate to one. Each campaign is also created as their own webpage (also hosted on Sia), that the users can link and promote on their own. The campaigns have a date of closing and donations goal. When the date is reached, if the goal was achieved or surpassed, the donations are sent to the campaign owner; if not, the donations are returned to the donors.\n\nCheck the [demo!](https://siasky.net/hns/lunafromthemoon/) and the [video on how to use it!](https://siasky.net/AACjNkdbHx6SJ_L3MLT8otJ1moEEqiaGZQXrtWa4RJC0ig)\n\n# How does it work?\n\nAlmost There is a web application, and as with most web apps, it has a frontend and a backend. The frontend is a traditional HTML5 page, hosted on Sia. The backend is a smart contract hosted in the NEAR Network (currently only testnet).\n\nWhile the frontend takes care of the look and feel and templating of the campaigns, the backend handles the account management and donations.\n# cssesc [](https://travis-ci.org/mathiasbynens/cssesc) [](https://codecov.io/gh/mathiasbynens/cssesc)\n\nA JavaScript library for escaping CSS strings and identifiers while generating the shortest possible ASCII-only output.\n\nThis is a JavaScript library for [escaping text for use in CSS strings or identifiers](https://mathiasbynens.be/notes/css-escapes) while generating the shortest possible valid ASCII-only output. [Here’s an online demo.](https://mothereff.in/css-escapes)\n\n[A polyfill for the CSSOM `CSS.escape()` method is available in a separate repository.](https://mths.be/cssescape) (In comparison, _cssesc_ is much more powerful.)\n\nFeel free to fork if you see possible improvements!\n\n## Installation\n\nVia [npm](https://www.npmjs.com/):\n\n```bash\nnpm install cssesc\n```\n\nIn a browser:\n\n```html\n<script src=\"cssesc.js\"></script>\n```\n\nIn [Node.js](https://nodejs.org/):\n\n```js\nconst cssesc = require('cssesc');\n```\n\nIn Ruby using [the `ruby-cssesc` wrapper gem](https://github.com/borodean/ruby-cssesc):\n\n```bash\ngem install ruby-cssesc\n```\n\n```ruby\nrequire 'ruby-cssesc'\nCSSEsc.escape('I ♥ Ruby', is_identifier: true)\n```\n\nIn Sass using [`sassy-escape`](https://github.com/borodean/sassy-escape):\n\n```bash\ngem install sassy-escape\n```\n\n```scss\nbody {\n content: escape('I ♥ Sass', $is-identifier: true);\n}\n```\n\n## API\n\n### `cssesc(value, options)`\n\nThis function takes a value and returns an escaped version of the value where any characters that are not printable ASCII symbols are escaped using the shortest possible (but valid) [escape sequences for use in CSS strings or identifiers](https://mathiasbynens.be/notes/css-escapes).\n\n```js\ncssesc('Ich ♥ Bücher');\n// → 'Ich \\\\2665 B\\\\FC cher'\n\ncssesc('foo 𝌆 bar');\n// → 'foo \\\\1D306 bar'\n```\n\nBy default, `cssesc` returns a string that can be used as part of a CSS string. If the target is a CSS identifier rather than a CSS string, use the `isIdentifier: true` setting (see below).\n\nThe optional `options` argument accepts an object with the following options:\n\n#### `isIdentifier`\n\nThe default value for the `isIdentifier` option is `false`. This means that the input text will be escaped for use in a CSS string literal. If you want to use the result as a CSS identifier instead (in a selector, for example), set this option to `true`.\n\n```js\ncssesc('123a2b');\n// → '123a2b'\n\ncssesc('123a2b', {\n 'isIdentifier': true\n});\n// → '\\\\31 23a2b'\n```\n\n#### `quotes`\n\nThe default value for the `quotes` option is `'single'`. This means that any occurences of `'` in the input text will be escaped as `\\'`, so that the output can be used in a CSS string literal wrapped in single quotes.\n\n```js\ncssesc('Lorem ipsum \"dolor\" sit \\'amet\\' etc.');\n// → 'Lorem ipsum \"dolor\" sit \\\\\\'amet\\\\\\' etc.'\n// → \"Lorem ipsum \\\"dolor\\\" sit \\\\'amet\\\\' etc.\"\n\ncssesc('Lorem ipsum \"dolor\" sit \\'amet\\' etc.', {\n 'quotes': 'single'\n});\n// → 'Lorem ipsum \"dolor\" sit \\\\\\'amet\\\\\\' etc.'\n// → \"Lorem ipsum \\\"dolor\\\" sit \\\\'amet\\\\' etc.\"\n```\n\nIf you want to use the output as part of a CSS string literal wrapped in double quotes, set the `quotes` option to `'double'`.\n\n```js\ncssesc('Lorem ipsum \"dolor\" sit \\'amet\\' etc.', {\n 'quotes': 'double'\n});\n// → 'Lorem ipsum \\\\\"dolor\\\\\" sit \\'amet\\' etc.'\n// → \"Lorem ipsum \\\\\\\"dolor\\\\\\\" sit 'amet' etc.\"\n```\n\n#### `wrap`\n\nThe `wrap` option takes a boolean value (`true` or `false`), and defaults to `false` (disabled). When enabled, the output will be a valid CSS string literal wrapped in quotes. The type of quotes can be specified through the `quotes` setting.\n\n```js\ncssesc('Lorem ipsum \"dolor\" sit \\'amet\\' etc.', {\n 'quotes': 'single',\n 'wrap': true\n});\n// → '\\'Lorem ipsum \"dolor\" sit \\\\\\'amet\\\\\\' etc.\\''\n// → \"\\'Lorem ipsum \\\"dolor\\\" sit \\\\\\'amet\\\\\\' etc.\\'\"\n\ncssesc('Lorem ipsum \"dolor\" sit \\'amet\\' etc.', {\n 'quotes': 'double',\n 'wrap': true\n});\n// → '\"Lorem ipsum \\\\\"dolor\\\\\" sit \\'amet\\' etc.\"'\n// → \"\\\"Lorem ipsum \\\\\\\"dolor\\\\\\\" sit \\'amet\\' etc.\\\"\"\n```\n\n#### `escapeEverything`\n\nThe `escapeEverything` option takes a boolean value (`true` or `false`), and defaults to `false` (disabled). When enabled, all the symbols in the output will be escaped, even printable ASCII symbols.\n\n```js\ncssesc('lolwat\"foo\\'bar', {\n 'escapeEverything': true\n});\n// → '\\\\6C\\\\6F\\\\6C\\\\77\\\\61\\\\74\\\\\"\\\\66\\\\6F\\\\6F\\\\\\'\\\\62\\\\61\\\\72'\n// → \"\\\\6C\\\\6F\\\\6C\\\\77\\\\61\\\\74\\\\\\\"\\\\66\\\\6F\\\\6F\\\\'\\\\62\\\\61\\\\72\"\n```\n\n#### Overriding the default options globally\n\nThe global default settings can be overridden by modifying the `css.options` object. This saves you from passing in an `options` object for every call to `encode` if you want to use the non-default setting.\n\n```js\n// Read the global default setting for `escapeEverything`:\ncssesc.options.escapeEverything;\n// → `false` by default\n\n// Override the global default setting for `escapeEverything`:\ncssesc.options.escapeEverything = true;\n\n// Using the global default setting for `escapeEverything`, which is now `true`:\ncssesc('foo © bar ≠ baz 𝌆 qux');\n// → '\\\\66\\\\6F\\\\6F\\\\ \\\\A9\\\\ \\\\62\\\\61\\\\72\\\\ \\\\2260\\\\ \\\\62\\\\61\\\\7A\\\\ \\\\1D306\\\\ \\\\71\\\\75\\\\78'\n```\n\n### `cssesc.version`\n\nA string representing the semantic version number.\n\n### Using the `cssesc` binary\n\nTo use the `cssesc` binary in your shell, simply install cssesc globally using npm:\n\n```bash\nnpm install -g cssesc\n```\n\nAfter that you will be able to escape text for use in CSS strings or identifiers from the command line:\n\n```bash\n$ cssesc 'föo ♥ bår 𝌆 baz'\nf\\F6o \\2665 b\\E5r \\1D306 baz\n```\n\nIf the output needs to be a CSS identifier rather than part of a string literal, use the `-i`/`--identifier` option:\n\n```bash\n$ cssesc --identifier 'föo ♥ bår 𝌆 baz'\nf\\F6o\\ \\2665\\ b\\E5r\\ \\1D306\\ baz\n```\n\nSee `cssesc --help` for the full list of options.\n\n## Support\n\nThis library supports the Node.js and browser versions mentioned in [`.babelrc`](https://github.com/mathiasbynens/cssesc/blob/master/.babelrc). For a version that supports a wider variety of legacy browsers and environments out-of-the-box, [see v0.1.0](https://github.com/mathiasbynens/cssesc/releases/tag/v0.1.0).\n\n## Author\n\n| [](https://twitter.com/mathias \"Follow @mathias on Twitter\") |\n|---|\n| [Mathias Bynens](https://mathiasbynens.be/) |\n\n## License\n\nThis library is available under the [MIT](https://mths.be/mit) license.\n# is-accessor-descriptor [](https://www.npmjs.com/package/is-accessor-descriptor) [](https://npmjs.org/package/is-accessor-descriptor) [](https://npmjs.org/package/is-accessor-descriptor) [](https://travis-ci.org/jonschlinkert/is-accessor-descriptor)\n\n> Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-accessor-descriptor\n```\n\n## Usage\n\n```js\nvar isAccessor = require('is-accessor-descriptor');\n\nisAccessor({get: function() {}});\n//=> true\n```\n\nYou may also pass an object and property name to check if the property is an accessor:\n\n```js\nisAccessor(foo, 'bar');\n```\n\n## Examples\n\n`false` when not an object\n\n```js\nisAccessor('a')\nisAccessor(null)\nisAccessor([])\n//=> false\n```\n\n`true` when the object has valid properties\n\nand the properties all have the correct JavaScript types:\n\n```js\nisAccessor({get: noop, set: noop})\nisAccessor({get: noop})\nisAccessor({set: noop})\n//=> true\n```\n\n`false` when the object has invalid properties\n\n```js\nisAccessor({get: noop, set: noop, bar: 'baz'})\nisAccessor({get: noop, writable: true})\nisAccessor({get: noop, value: true})\n//=> false\n```\n\n`false` when an accessor is not a function\n\n```js\nisAccessor({get: noop, set: 'baz'})\nisAccessor({get: 'foo', set: noop})\nisAccessor({get: 'foo', bar: 'baz'})\nisAccessor({get: 'foo', set: 'baz'})\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisAccessor({get: noop, set: noop, enumerable: 'foo'})\nisAccessor({set: noop, configurable: 'foo'})\nisAccessor({get: noop, configurable: 'foo'})\n//=> false\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor \"Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\")\n* [is-data-descriptor](https://www.npmjs.com/package/is-data-descriptor): Returns true if a value has the characteristics of a valid JavaScript data descriptor. | [homepage](https://github.com/jonschlinkert/is-data-descriptor \"Returns true if a value has the characteristics of a valid JavaScript data descriptor.\")\n* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor \"Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.\")\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object \"Returns true if an object was created by the `Object` constructor.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 22 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [realityking](https://github.com/realityking) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 01, 2017._\nnode-bindings\n=============\n### Helper module for loading your native module's `.node` file\n\nThis is a helper module for authors of Node.js native addon modules.\nIt is basically the \"swiss army knife\" of `require()`ing your native module's\n`.node` file.\n\nThroughout the course of Node's native addon history, addons have ended up being\ncompiled in a variety of different places, depending on which build tool and which\nversion of node was used. To make matters worse, now the `gyp` build tool can\nproduce either a __Release__ or __Debug__ build, each being built into different\nlocations.\n\nThis module checks _all_ the possible locations that a native addon would be built\nat, and returns the first one that loads successfully.\n\nInstallation\n------------\n\nInstall with `npm`:\n\n``` bash\n$ npm install --save bindings\n```\n\nOr add it to the `\"dependencies\"` section of your `package.json` file.\n\nExample\n-------\n\n`require()`ing the proper bindings file for the current node version, platform\nand architecture is as simple as:\n\n``` js\nvar bindings = require('bindings')('binding.node')\n\n// Use your bindings defined in your C files\nbindings.your_c_function()\n```\n\nNice Error Output\n-----------------\n\nWhen the `.node` file could not be loaded, `node-bindings` throws an Error with\na nice error message telling you exactly what was tried. You can also check the\n`err.tries` Array property.\n\n```\nError: Could not load the bindings file. Tried:\n → /Users/nrajlich/ref/build/binding.node\n → /Users/nrajlich/ref/build/Debug/binding.node\n → /Users/nrajlich/ref/build/Release/binding.node\n → /Users/nrajlich/ref/out/Debug/binding.node\n → /Users/nrajlich/ref/Debug/binding.node\n → /Users/nrajlich/ref/out/Release/binding.node\n → /Users/nrajlich/ref/Release/binding.node\n → /Users/nrajlich/ref/build/default/binding.node\n → /Users/nrajlich/ref/compiled/0.8.2/darwin/x64/binding.node\n at bindings (/Users/nrajlich/ref/node_modules/bindings/bindings.js:84:13)\n at Object.<anonymous> (/Users/nrajlich/ref/lib/ref.js:5:47)\n at Module._compile (module.js:449:26)\n at Object.Module._extensions..js (module.js:467:10)\n at Module.load (module.js:356:32)\n at Function.Module._load (module.js:312:12)\n ...\n```\n\nThe searching for the `.node` file will originate from the first directory in which has a `package.json` file is found.\n\nLicense\n-------\n\n(The MIT License)\n\nCopyright (c) 2012 Nathan Rajlich <nathan@tootallnate.net>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# is-accessor-descriptor [](https://www.npmjs.com/package/is-accessor-descriptor) [](https://npmjs.org/package/is-accessor-descriptor) [](https://npmjs.org/package/is-accessor-descriptor) [](https://travis-ci.org/jonschlinkert/is-accessor-descriptor)\n\n> Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-accessor-descriptor\n```\n\n## Usage\n\n```js\nvar isAccessor = require('is-accessor-descriptor');\n\nisAccessor({get: function() {}});\n//=> true\n```\n\nYou may also pass an object and property name to check if the property is an accessor:\n\n```js\nisAccessor(foo, 'bar');\n```\n\n## Examples\n\n`false` when not an object\n\n```js\nisAccessor('a')\nisAccessor(null)\nisAccessor([])\n//=> false\n```\n\n`true` when the object has valid properties\n\nand the properties all have the correct JavaScript types:\n\n```js\nisAccessor({get: noop, set: noop})\nisAccessor({get: noop})\nisAccessor({set: noop})\n//=> true\n```\n\n`false` when the object has invalid properties\n\n```js\nisAccessor({get: noop, set: noop, bar: 'baz'})\nisAccessor({get: noop, writable: true})\nisAccessor({get: noop, value: true})\n//=> false\n```\n\n`false` when an accessor is not a function\n\n```js\nisAccessor({get: noop, set: 'baz'})\nisAccessor({get: 'foo', set: noop})\nisAccessor({get: 'foo', bar: 'baz'})\nisAccessor({get: 'foo', set: 'baz'})\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisAccessor({get: noop, set: noop, enumerable: 'foo'})\nisAccessor({set: noop, configurable: 'foo'})\nisAccessor({get: noop, configurable: 'foo'})\n//=> false\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor \"Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\")\n* [is-data-descriptor](https://www.npmjs.com/package/is-data-descriptor): Returns true if a value has the characteristics of a valid JavaScript data descriptor. | [homepage](https://github.com/jonschlinkert/is-data-descriptor \"Returns true if a value has the characteristics of a valid JavaScript data descriptor.\")\n* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor \"Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.\")\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object \"Returns true if an object was created by the `Object` constructor.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 22 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [realityking](https://github.com/realityking) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 01, 2017._\n[](https://www.npmjs.com/package/csso)\n[](https://travis-ci.org/css/csso)\n[](https://coveralls.io/github/css/csso?branch=master)\n[](https://www.npmjs.com/package/csso)\n[](https://twitter.com/cssoptimizer)\n\nCSSO (CSS Optimizer) is a CSS minifier. It performs three sort of transformations: cleaning (removing redundant), compression (replacement for shorter form) and restructuring (merge of declarations, rulesets and so on). As a result your CSS becomes much smaller.\n\n[](https://www.yandex.com/)\n[](https://www.avito.ru/)\n\n## Ready to use\n\n- [Web interface](http://css.github.io/csso/csso.html)\n- [csso-cli](https://github.com/css/csso-cli) – command line interface\n- [gulp-csso](https://github.com/ben-eb/gulp-csso) – `Gulp` plugin\n- [grunt-csso](https://github.com/t32k/grunt-csso) – `Grunt` plugin\n- [broccoli-csso](https://github.com/sindresorhus/broccoli-csso) – `Broccoli` plugin\n- [postcss-csso](https://github.com/lahmatiy/postcss-csso) – `PostCSS` plugin\n- [csso-loader](https://github.com/sandark7/csso-loader) – `webpack` loader\n- [csso-webpack-plugin](https://github.com/zoobestik/csso-webpack-plugin) – `webpack` plugin\n- [CSSO Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=Aneryu.csso)\n\n## Install\n\n```\nnpm install csso\n```\n\n## API\n\n<!-- TOC depthfrom:3 -->\n\n- [minify(source[, options])](#minifysource-options)\n- [minifyBlock(source[, options])](#minifyblocksource-options)\n- [syntax.compress(ast[, options])](#syntaxcompressast-options)\n- [Source maps](#source-maps)\n- [Usage data](#usage-data)\n - [White list filtering](#white-list-filtering)\n - [Black list filtering](#black-list-filtering)\n - [Scopes](#scopes)\n\n<!-- /TOC -->\n\nBasic usage:\n\n```js\nvar csso = require('csso');\n\nvar minifiedCss = csso.minify('.test { color: #ff0000; }').css;\n\nconsole.log(minifiedCss);\n// .test{color:red}\n```\n\nCSSO is based on [CSSTree](https://github.com/csstree/csstree) to parse CSS into AST, AST traversal and to generate AST back to CSS. All `CSSTree` API is available behind `syntax` field. You may minify CSS step by step:\n\n```js\nvar csso = require('csso');\nvar ast = csso.syntax.parse('.test { color: #ff0000; }');\nvar compressedAst = csso.syntax.compress(ast).ast;\nvar minifiedCss = csso.syntax.generate(compressedAst);\n\nconsole.log(minifiedCss);\n// .test{color:red}\n```\n\n> Warning: CSSO uses early versions of CSSTree that still in active development. CSSO doesn't guarantee API behind `syntax` field or AST format will not change in future releases of CSSO, since it's subject to change in CSSTree. Be careful with CSSO updates if you use `syntax` API until this warning removal.\n\n### minify(source[, options])\n\nMinify `source` CSS passed as `String`.\n\n```js\nvar result = csso.minify('.test { color: #ff0000; }', {\n restructure: false, // don't change CSS structure, i.e. don't merge declarations, rulesets etc\n debug: true // show additional debug information:\n // true or number from 1 to 3 (greater number - more details)\n});\n\nconsole.log(result.css);\n// > .test{color:red}\n```\n\nReturns an object with properties:\n\n- css `String` – resulting CSS\n- map `Object` – instance of [`SourceMapGenerator`](https://github.com/mozilla/source-map#sourcemapgenerator) or `null`\n\nOptions:\n\n- sourceMap\n\n Type: `Boolean` \n Default: `false`\n\n Generate a source map when `true`.\n\n- filename\n\n Type: `String` \n Default: `'<unknown>'`\n\n Filename of input CSS, uses for source map generation.\n\n- debug\n\n Type: `Boolean` \n Default: `false`\n\n Output debug information to `stderr`.\n\n- beforeCompress\n\n Type: `function(ast, options)` or `Array<function(ast, options)>` or `null` \n Default: `null`\n\n Called right after parse is run.\n\n- afterCompress\n\n Type: `function(compressResult, options)` or `Array<function(compressResult, options)>` or `null` \n Default: `null`\n\n Called right after [`syntax.compress()`](#syntaxcompressast-options) is run.\n\n- Other options are the same as for [`syntax.compress()`](#syntaxcompressast-options) function.\n\n### minifyBlock(source[, options])\n\nThe same as `minify()` but for list of declarations. Usually it's a `style` attribute value.\n\n```js\nvar result = csso.minifyBlock('color: rgba(255, 0, 0, 1); color: #ff0000');\n\nconsole.log(result.css);\n// > color:red\n```\n\n### syntax.compress(ast[, options])\n\nDoes the main task – compress an AST. This is CSSO's extension in CSSTree syntax API.\n\n> NOTE: `syntax.compress()` performs AST compression by transforming input AST by default (since AST cloning is expensive and needed in rare cases). Use `clone` option with truthy value in case you want to keep input AST untouched.\n\nReturns an object with properties:\n\n- ast `Object` – resulting AST\n\nOptions:\n\n- restructure\n\n Type: `Boolean` \n Default: `true`\n\n Disable or enable a structure optimisations.\n\n- forceMediaMerge\n\n Type: `Boolean` \n Default: `false`\n\n Enables merging of `@media` rules with the same media query by splitted by other rules. The optimisation is unsafe in general, but should work fine in most cases. Use it on your own risk.\n\n- clone\n\n Type: `Boolean` \n Default: `false`\n\n Transform a copy of input AST if `true`. Useful in case of AST reuse.\n\n- comments\n\n Type: `String` or `Boolean` \n Default: `true`\n\n Specify what comments to leave:\n\n - `'exclamation'` or `true` – leave all exclamation comments (i.e. `/*! .. */`)\n - `'first-exclamation'` – remove every comment except first one\n - `false` – remove all comments\n\n- usage\n\n Type: `Object` or `null` \n Default: `null`\n\n Usage data for advanced optimisations (see [Usage data](#usage-data) for details)\n\n- logger\n\n Type: `Function` or `null` \n Default: `null`\n\n Function to track every step of transformation.\n\n### Source maps\n\nTo get a source map set `true` for `sourceMap` option. Additianaly `filename` option can be passed to specify source file. When `sourceMap` option is `true`, `map` field of result object will contain a [`SourceMapGenerator`](https://github.com/mozilla/source-map#sourcemapgenerator) instance. This object can be mixed with another source map or translated to string.\n\n```js\nvar csso = require('csso');\nvar css = fs.readFileSync('path/to/my.css', 'utf8');\nvar result = csso.minify(css, {\n filename: 'path/to/my.css', // will be added to source map as reference to source file\n sourceMap: true // generate source map\n});\n\nconsole.log(result);\n// { css: '...minified...', map: SourceMapGenerator {} }\n\nconsole.log(result.map.toString());\n// '{ .. source map content .. }'\n```\n\nExample of generating source map with respect of source map from input CSS:\n\n```js\nvar require('source-map');\nvar csso = require('csso');\nvar inputFile = 'path/to/my.css';\nvar input = fs.readFileSync(inputFile, 'utf8');\nvar inputMap = input.match(/\\/\\*# sourceMappingURL=(\\S+)\\s*\\*\\/\\s*$/);\nvar output = csso.minify(input, {\n filename: inputFile,\n sourceMap: true\n});\n\n// apply input source map to output\nif (inputMap) {\n output.map.applySourceMap(\n new SourceMapConsumer(inputMap[1]),\n inputFile\n )\n}\n\n// result CSS with source map\nconsole.log(\n output.css +\n '/*# sourceMappingURL=data:application/json;base64,' +\n new Buffer(output.map.toString()).toString('base64') +\n ' */'\n);\n```\n\n### Usage data\n\n`CSSO` can use data about how `CSS` is used in a markup for better compression. File with this data (`JSON`) can be set using `usage` option. Usage data may contain following sections:\n\n- `blacklist` – a set of black lists (see [Black list filtering](#black-list-filtering))\n- `tags` – white list of tags\n- `ids` – white list of ids\n- `classes` – white list of classes\n- `scopes` – groups of classes which never used with classes from other groups on the same element\n\nAll sections are optional. Value of `tags`, `ids` and `classes` should be an array of a string, value of `scopes` should be an array of arrays of strings. Other values are ignoring.\n\n#### White list filtering\n\n`tags`, `ids` and `classes` are using on clean stage to filter selectors that contain something not in the lists. Selectors are filtering only by those kind of simple selector which white list is specified. For example, if only `tags` list is specified then type selectors are checking, and if all type selectors in selector present in list or selector has no any type selector it isn't filter.\n\n> `ids` and `classes` are case sensitive, `tags` – is not.\n\nInput CSS:\n\n```css\n* { color: green; }\nul, ol, li { color: blue; }\nUL.foo, span.bar { color: red; }\n```\n\nUsage data:\n\n```json\n{\n \"tags\": [\"ul\", \"LI\"]\n}\n```\n\nResulting CSS:\n\n```css\n*{color:green}ul,li{color:blue}ul.foo{color:red}\n```\n\nFiltering performs for nested selectors too. `:not()` pseudos content is ignoring since the result of matching is unpredictable. Example for the same usage data as above:\n\n```css\n:nth-child(2n of ul, ol) { color: red }\n:nth-child(3n + 1 of img) { color: yellow }\n:not(div, ol, ul) { color: green }\n:has(:matches(ul, ol), ul, ol) { color: blue }\n```\n\nTurns into:\n\n```css\n:nth-child(2n of ul){color:red}:not(div,ol,ul){color:green}:has(:matches(ul),ul){color:blue}\n```\n\n#### Black list filtering\n\nBlack list filtering performs the same as white list filtering, but filters things that mentioned in the lists. `blacklist` can contain the lists `tags`, `ids` and `classes`.\n\nBlack list has a higher priority, so when something mentioned in the white list and in the black list then white list occurrence is ignoring. The `:not()` pseudos content ignoring as well.\n\n```css\n* { color: green; }\nul, ol, li { color: blue; }\nUL.foo, li.bar { color: red; }\n```\n\nUsage data:\n\n```json\n{\n \"blacklist\": {\n \"tags\": [\"ul\"]\n },\n \"tags\": [\"ul\", \"LI\"]\n}\n```\n\nResulting CSS:\n\n```css\n*{color:green}li{color:blue}li.bar{color:red}\n```\n\n#### Scopes\n\nScopes is designed for CSS scope isolation solutions such as [css-modules](https://github.com/css-modules/css-modules). Scopes are similar to namespaces and define lists of class names that exclusively used on some markup. This information allows the optimizer to move rules more agressive. Since it assumes selectors from different scopes don't match for the same element. This can improve rule merging.\n\nSuppose we have a file:\n\n```css\n.module1-foo { color: red; }\n.module1-bar { font-size: 1.5em; background: yellow; }\n\n.module2-baz { color: red; }\n.module2-qux { font-size: 1.5em; background: yellow; width: 50px; }\n```\n\nIt can be assumed that first two rules are never used with the second two on the same markup. But we can't say that for sure without a markup review. The optimizer doesn't know it either and will perform safe transformations only. The result will be the same as input but with no spaces and some semicolons:\n\n```css\n.module1-foo{color:red}.module1-bar{font-size:1.5em;background:#ff0}.module2-baz{color:red}.module2-qux{font-size:1.5em;background:#ff0;width:50px}\n```\n\nWith usage data `CSSO` can produce better output. If follow usage data is provided:\n\n```json\n{\n \"scopes\": [\n [\"module1-foo\", \"module1-bar\"],\n [\"module2-baz\", \"module2-qux\"]\n ]\n}\n```\n\nThe result will be (29 bytes extra saving):\n\n```css\n.module1-foo,.module2-baz{color:red}.module1-bar,.module2-qux{font-size:1.5em;background:#ff0}.module2-qux{width:50px}\n```\n\nIf class name isn't mentioned in the `scopes` it belongs to default scope. `scopes` data doesn't affect `classes` whitelist. If class name mentioned in `scopes` but missed in `classes` (both sections are specified) it will be filtered.\n\nNote that class name can't be set for several scopes. Also a selector can't have class names from different scopes. In both cases an exception will thrown.\n\nCurrently the optimizer doesn't care about changing order safety for out-of-bounds selectors (i.e. selectors that match to elements without class name, e.g. `.scope div` or `.scope ~ :last-child`). It assumes that scoped CSS modules doesn't relay on it's order. It may be fix in future if to be an issue.\n# merge-stream\n\nMerge (interleave) a bunch of streams.\n\n[](http://travis-ci.org/grncdr/merge-stream)\n\n## Synopsis\n\n```javascript\nvar stream1 = new Stream();\nvar stream2 = new Stream();\n\nvar merged = mergeStream(stream1, stream2);\n\nvar stream3 = new Stream();\nmerged.add(stream3);\nmerged.isEmpty();\n//=> false\n```\n\n## Description\n\nThis is adapted from [event-stream](https://github.com/dominictarr/event-stream) separated into a new module, using Streams3.\n\n## API\n\n### `mergeStream`\n\nType: `function`\n\nMerges an arbitrary number of streams. Returns a merged stream.\n\n#### `merged.add`\n\nA method to dynamically add more sources to the stream. The argument supplied to `add` can be either a source or an array of sources.\n\n#### `merged.isEmpty`\n\nA method that tells you if the merged stream is empty.\n\nWhen a stream is \"empty\" (aka. no sources were added), it could not be returned to a gulp task.\n\nSo, we could do something like this:\n\n```js\nstream = require('merge-stream')();\n// Something like a loop to add some streams to the merge stream\n// stream.add(streamA);\n// stream.add(streamB);\nreturn stream.isEmpty() ? null : stream;\n```\n\n## Gulp example\n\nAn example use case for **merge-stream** is to combine parts of a task in a project's **gulpfile.js** like this:\n\n```js\nconst gulp = require('gulp');\nconst htmlValidator = require('gulp-w3c-html-validator');\nconst jsHint = require('gulp-jshint');\nconst mergeStream = require('merge-stream');\n\nfunction lint() {\n return mergeStream(\n gulp.src('src/*.html')\n .pipe(htmlValidator())\n .pipe(htmlValidator.reporter()),\n gulp.src('src/*.js')\n .pipe(jsHint())\n .pipe(jsHint.reporter())\n );\n}\ngulp.task('lint', lint);\n```\n\n## License\n\nMIT\n# arr-diff [](https://www.npmjs.com/package/arr-diff) [](https://npmjs.org/package/arr-diff) [](https://travis-ci.org/jonschlinkert/arr-diff)\n\n> Returns an array with only the unique values from the first array, by excluding all values from additional arrays using strict equality for comparisons.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save arr-diff\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add arr-diff\n```\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install arr-diff --save\n```\n\n## Usage\n\nReturns the difference between the first array and additional arrays.\n\n```js\nvar diff = require('arr-diff');\n\nvar a = ['a', 'b', 'c', 'd'];\nvar b = ['b', 'c'];\n\nconsole.log(diff(a, b))\n//=> ['a', 'd']\n```\n\n## Benchmarks\n\nThis library versus [array-differ](https://github.com/sindresorhus/array-differ), on April 14, 2017:\n\n```\nBenchmarking: (4 of 4)\n · long-dupes\n · long\n · med\n · short\n\n# benchmark/fixtures/long-dupes.js (100804 bytes)\n arr-diff-3.0.0 x 822 ops/sec ±0.67% (86 runs sampled)\n arr-diff-4.0.0 x 2,141 ops/sec ±0.42% (89 runs sampled)\n array-differ x 708 ops/sec ±0.70% (89 runs sampled)\n\n fastest is arr-diff-4.0.0\n\n# benchmark/fixtures/long.js (94529 bytes)\n arr-diff-3.0.0 x 882 ops/sec ±0.60% (87 runs sampled)\n arr-diff-4.0.0 x 2,329 ops/sec ±0.97% (83 runs sampled)\n array-differ x 769 ops/sec ±0.61% (90 runs sampled)\n\n fastest is arr-diff-4.0.0\n\n# benchmark/fixtures/med.js (708 bytes)\n arr-diff-3.0.0 x 856,150 ops/sec ±0.42% (89 runs sampled)\n arr-diff-4.0.0 x 4,665,249 ops/sec ±1.06% (89 runs sampled)\n array-differ x 653,888 ops/sec ±1.02% (86 runs sampled)\n\n fastest is arr-diff-4.0.0\n\n# benchmark/fixtures/short.js (60 bytes)\n arr-diff-3.0.0 x 3,078,467 ops/sec ±0.77% (93 runs sampled)\n arr-diff-4.0.0 x 9,213,296 ops/sec ±0.65% (89 runs sampled)\n array-differ x 1,337,051 ops/sec ±0.91% (92 runs sampled)\n\n fastest is arr-diff-4.0.0\n```\n\n## About\n\n### Related projects\n\n* [arr-flatten](https://www.npmjs.com/package/arr-flatten): Recursively flatten an array or arrays. This is the fastest implementation of array flatten. | [homepage](https://github.com/jonschlinkert/arr-flatten \"Recursively flatten an array or arrays. This is the fastest implementation of array flatten.\")\n* [array-filter](https://www.npmjs.com/package/array-filter): Array#filter for older browsers. | [homepage](https://github.com/juliangruber/array-filter \"Array#filter for older browsers.\")\n* [array-intersection](https://www.npmjs.com/package/array-intersection): Return an array with the unique values present in _all_ given arrays using strict equality… [more](https://github.com/jonschlinkert/array-intersection) | [homepage](https://github.com/jonschlinkert/array-intersection \"Return an array with the unique values present in _all_ given arrays using strict equality for comparisons.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 33 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [paulmillr](https://github.com/paulmillr) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 14, 2017._\n# has-value [](https://www.npmjs.com/package/has-value) [](https://npmjs.org/package/has-value) [](https://travis-ci.org/jonschlinkert/has-value)\n\n> Returns true if a value exists, false if empty. Works with deeply nested values using object paths.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install has-value --save\n```\n\n**Works for:**\n\n* booleans\n* functions\n* numbers (pass `true` as the last arg to treat zero as a value instead of falsey)\n* strings\n* nulls\n* object\n* arrays\n\n## Usage\n\nWorks with nested object paths or a single value:\n\n```js\nvar hasValue = require('has-value');\n\nhasValue({a: {b: {c: 'foo'}}} 'a.b.c');\n//=> true\n\nhasValue('a');\n//=> true\n\nhasValue('');\n//=> false\n\nhasValue(1);\n//=> true\n\nhasValue(0);\n//=> false\n\nhasValue(0, true); // pass `true` as the last arg to treat zero as a value\n//=> true\n\nhasValue({a: 'a'}});\n//=> true\n\nhasValue({}});\n//=> false\n\nhasValue(['a']);\n//=> true\n\nhasValue([]);\n//=> false\n\nhasValue(function(foo) {}); // function length/arity\n//=> true\n\nhasValue(function() {});\n//=> false\n\nhasValue(true);\nhasValue(false);\n//=> true\n```\n\n## isEmpty\n\nTo do the opposite and test for empty values, do:\n\n```js\nfunction isEmpty(o, isZero) {\n return !hasValue.apply(hasValue, arguments);\n}\n```\n\n## Related projects\n\nYou might also be interested in these projects:\n\n* [get-object](https://www.npmjs.com/package/get-object): Get a property from an object using dot (object path) notation. | [homepage](https://github.com/jonschlinkert/get-object)\n* [get-property](https://www.npmjs.com/package/get-property): Get a nested property or its value from an object using simple `a.b.c` paths. | [homepage](https://github.com/jonschlinkert/get-property)\n* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value)\n* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value)\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/has-value/issues/new).\n\n## Building docs\n\nGenerate readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install verb && npm run docs\n```\n\nOr, if [verb](https://github.com/verbose/verb) is installed globally:\n\n```sh\n$ verb\n```\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/has-value/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb), v, on March 27, 2016._\n# ES6-Promise (subset of [rsvp.js](https://github.com/tildeio/rsvp.js)) [](https://travis-ci.org/stefanpenner/es6-promise)\n\nThis is a polyfill of the [ES6 Promise](http://www.ecma-international.org/ecma-262/6.0/#sec-promise-constructor). The implementation is a subset of [rsvp.js](https://github.com/tildeio/rsvp.js) extracted by @jakearchibald, if you're wanting extra features and more debugging options, check out the [full library](https://github.com/tildeio/rsvp.js).\n\nFor API details and how to use promises, see the <a href=\"http://www.html5rocks.com/en/tutorials/es6/promises/\">JavaScript Promises HTML5Rocks article</a>.\n\n## Downloads\n\n* [es6-promise 27.86 KB (7.33 KB gzipped)](https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.js)\n* [es6-promise-auto 27.78 KB (7.3 KB gzipped)](https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.auto.js) - Automatically provides/replaces `Promise` if missing or broken.\n* [es6-promise-min 6.17 KB (2.4 KB gzipped)](https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.min.js)\n* [es6-promise-auto-min 6.19 KB (2.4 KB gzipped)](https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.auto.min.js) - Minified version of `es6-promise-auto` above.\n\n## CDN \n\nTo use via a CDN include this in your html:\n\n```html\n<!-- Automatically provides/replaces `Promise` if missing or broken. -->\n<script src=\"https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.js\"></script>\n<script src=\"https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.js\"></script> \n\n<!-- Minified version of `es6-promise-auto` below. -->\n<script src=\"https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.min.js\"></script>\n<script src=\"https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.min.js\"></script> \n\n```\n\n## Node.js\n\nTo install:\n\n```sh\nyarn add es6-promise\n```\n\nor\n\n```sh\nnpm install es6-promise\n```\n\nTo use:\n\n```js\nvar Promise = require('es6-promise').Promise;\n```\n\n## Usage in IE<9\n\n`catch` and `finally` are reserved keywords in IE<9, meaning\n`promise.catch(func)` or `promise.finally(func)` throw a syntax error. To work\naround this, you can use a string to access the property as shown in the\nfollowing example.\n\nHowever most minifiers will automatically fix this for you, making the\nresulting code safe for old browsers and production:\n\n```js\npromise['catch'](function(err) {\n // ...\n});\n```\n\n```js\npromise['finally'](function() {\n // ...\n});\n```\n\n## Auto-polyfill\n\nTo polyfill the global environment (either in Node or in the browser via CommonJS) use the following code snippet:\n\n```js\nrequire('es6-promise').polyfill();\n```\n\nAlternatively\n\n```js\nrequire('es6-promise/auto');\n```\n\nNotice that we don't assign the result of `polyfill()` to any variable. The `polyfill()` method will patch the global environment (in this case to the `Promise` name) when called.\n\n## Building & Testing\n\nYou will need to have PhantomJS installed globally in order to run the tests.\n\n`npm install -g phantomjs`\n\n* `npm run build` to build\n* `npm test` to run tests\n* `npm start` to run a build watcher, and webserver to test\n* `npm run test:server` for a testem test runner and watching builder\n# Growly #\n\nSimple zero-dependency Growl notifications using GNTP.\n\n## Installation ##\n\nInstall growly using `npm`:\n\n```\nnpm install growly\n```\n\nAnd then require it:\n\n```javascript\nvar growly = require('growly');\n```\n\nThis module uses the Growl Network Transport Protocol (GNTP) which was implemented in Growl since version 1.3, so you **must have an appropriate version of Growl installed** for Growly to work.\n\n## Example ##\n\nSending a minimal Growl notification:\n\n```javascript\nvar growly = require('growly');\n\ngrowly.notify('This is as easy as it gets', { title: 'Hello, World!' });\n```\n\nMore examples can be found in the *example/* directory.\n\n## Usage ##\n\nThe growly module exposes only three methods: `Growly.register()`, `Growly.notify()`, and `Growly.setHost()`.\n\n### Growly.register(appname, [appicon], [notifications], [callback]) ###\n\nRegisters a new application with Growl. Registration is completely optional since it will be performed automatically for you with sensible defaults. Useful if you want your application, with its own icon and types of notifications, to show up in Growl's prefence panel.\n\n - `appname` the name of the application (required.)\n - `appicon` url, file path, or Buffer instance for an application icon image.\n - `notifications` a list of defined notification types with the following properties:\n - `.label` name used to identify the type of notification being used (required.)\n - `.dispname` name users will see in Growl's preference panel (defaults to `.label`.)\n - `.enabled` whether or not notifications of this type are enabled (defaults to true.)\n - `callback` called when the registration completes; if registration fails, the first argument will be an Error object.\n\nAn example:\n\n```javascript\ngrowly.register('My Application', 'path/to/icon.png', [\n { label: 'success', dispname: 'Success' },\n { label: 'warning', dispname: 'Warning', enabled: false }\n], function(err) {\n console.log(err || 'Registration successful!');\n});\n```\n\n### Growly.notify(text, [opts], [callback]) ###\n\nSends a Growl notification. If an application wasn't registered beforehand with `growly.register()`, a default application will automatically be registered beforesending the notification.\n\n - `text` the body of the notification.\n - `opts` an object with the following properties:\n - `.title` title of the notification.\n - `.icon` url, file path, or Buffer instance for the notification's icon.\n - `.sticky` whether or not to sticky the notification (defaults to false.)\n - `.label` type of notification to use (defaults to the first registered notification type.)\n - `.priority` the priority of the notification from lowest (-2) to highest (2).\n - `.coalescingId` replace/update the matching previous notification. May be ignored.\n - `callback` called when the user has closed/clicked the notification. The callback is passed an Error object `err` as the first argument when the notification fails; otherwise, the second argument `action` is a string that'll describe which action has been taken by the user (either 'closed' or 'clicked'.)\n\nAn example:\n\n```javascript\n/* Assuming an application was registered with a notification type labeled 'warning'. */\ngrowly.notify('Stuffs broken!', { label: 'warning' }, function(err, action) {\n console.log('Action:', action);\n});\n```\n\n### Growly.setHost(host, port) ###\n\nSet the host and port that Growl (GNTP) requests will be sent to. Using this method is optional since GNTP defaults to using host 'localhost' and port 23053.\n\n## License ##\n\nCopyright (C) 2014 Ibrahim Al-Rajhi <abrahamalrajhi@gmail.com>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```javascript\nvar correct = require('spdx-correct')\nvar assert = require('assert')\n\nassert.equal(correct('mit'), 'MIT')\n\nassert.equal(correct('Apache 2'), 'Apache-2.0')\n\nassert(correct('No idea what license') === null)\n\n// disable upgrade option\nassert(correct('GPL-3.0'), 'GPL-3.0-or-later')\nassert(correct('GPL-3.0', { upgrade: false }), 'GPL-3.0')\n```\n# balanced-match\n\nMatch balanced string pairs, like `{` and `}` or `<b>` and `</b>`. Supports regular expressions as well!\n\n[](http://travis-ci.org/juliangruber/balanced-match)\n[](https://www.npmjs.org/package/balanced-match)\n\n[](https://ci.testling.com/juliangruber/balanced-match)\n\n## Example\n\nGet the first matching pair of braces:\n\n```js\nvar balanced = require('balanced-match');\n\nconsole.log(balanced('{', '}', 'pre{in{nested}}post'));\nconsole.log(balanced('{', '}', 'pre{first}between{second}post'));\nconsole.log(balanced(/\\s+\\{\\s+/, /\\s+\\}\\s+/, 'pre { in{nest} } post'));\n```\n\nThe matches are:\n\n```bash\n$ node example.js\n{ start: 3, end: 14, pre: 'pre', body: 'in{nested}', post: 'post' }\n{ start: 3,\n end: 9,\n pre: 'pre',\n body: 'first',\n post: 'between{second}post' }\n{ start: 3, end: 17, pre: 'pre', body: 'in{nest}', post: 'post' }\n```\n\n## API\n\n### var m = balanced(a, b, str)\n\nFor the first non-nested matching pair of `a` and `b` in `str`, return an\nobject with those keys:\n\n* **start** the index of the first match of `a`\n* **end** the index of the matching `b`\n* **pre** the preamble, `a` and `b` not included\n* **body** the match, `a` and `b` not included\n* **post** the postscript, `a` and `b` not included\n\nIf there's no match, `undefined` will be returned.\n\nIf the `str` contains more `a` than `b` / there are unmatched pairs, the first match that was closed will be used. For example, `{{a}` will match `['{', 'a', '']` and `{a}}` will match `['', 'a', '}']`.\n\n### var r = balanced.range(a, b, str)\n\nFor the first non-nested matching pair of `a` and `b` in `str`, return an\narray with indexes: `[ <a index>, <b index> ]`.\n\nIf there's no match, `undefined` will be returned.\n\nIf the `str` contains more `a` than `b` / there are unmatched pairs, the first match that was closed will be used. For example, `{{a}` will match `[ 1, 3 ]` and `{a}}` will match `[0, 2]`.\n\n## Installation\n\nWith [npm](https://npmjs.org) do:\n\n```bash\nnpm install balanced-match\n```\n\n## License\n\n(MIT)\n\nCopyright (c) 2013 Julian Gruber <julian@juliangruber.com>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n# cache-base [](https://www.npmjs.com/package/cache-base) [](https://npmjs.org/package/cache-base) [](https://npmjs.org/package/cache-base) [](https://travis-ci.org/jonschlinkert/cache-base)\n\n> Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save cache-base\n```\n\n## Usage\n\n```js\nvar Cache = require('cache-base');\n\n// instantiate\nvar app = new Cache();\n\n// set values\napp.set('a', 'b');\napp.set('c.d', 'e');\n\n// get values\napp.get('a');\n//=> 'b'\napp.get('c');\n//=> {d: 'e'}\n\nconsole.log(app.cache);\n//=> {a: 'b'}\n```\n\n**Inherit**\n\n```js\nvar util = require('util');\nvar Cache = require('cache-base');\n\nfunction MyApp() {\n Cache.call(this);\n}\nutil.inherits(MyApp, Cache);\n\nvar app = new MyApp();\napp.set('a', 'b');\napp.get('a');\n//=> 'b'\n```\n\n**Namespace**\n\nDefine a custom property for storing values.\n\n```js\nvar Cache = require('cache-base').namespace('data');\nvar app = new Cache();\napp.set('a', 'b');\nconsole.log(app.data);\n//=> {a: 'b'}\n```\n\n## API\n\n### [namespace](index.js#L29)\n\nCreate a `Cache` constructor that when instantiated will store values on the given `prop`.\n\n**Params**\n\n* `prop` **{String}**: The property name to use for storing values.\n* `returns` **{Function}**: Returns a custom `Cache` constructor\n\n**Example**\n\n```js\nvar Cache = require('cache-base').namespace('data');\nvar cache = new Cache();\n\ncache.set('foo', 'bar');\n//=> {data: {foo: 'bar'}}\n```\n\n### [Cache](index.js#L43)\n\nCreate a new `Cache`. Internally the `Cache` constructor is created using the `namespace` function, with `cache` defined as the storage object.\n\n**Params**\n\n* `cache` **{Object}**: Optionally pass an object to initialize with.\n\n**Example**\n\n```js\nvar app = new Cache();\n```\n\n### [.set](index.js#L84)\n\nAssign `value` to `key`. Also emits `set` with the key and value.\n\n**Params**\n\n* `key` **{String}**\n* `value` **{any}**\n* `returns` **{Object}**: Returns the instance for chaining.\n\n**Events**\n\n* `emits`: `set` with `key` and `value` as arguments.\n\n**Example**\n\n```js\napp.on('set', function(key, val) {\n // do something when `set` is emitted\n});\n\napp.set(key, value);\n\n// also takes an object or array\napp.set({name: 'Halle'});\napp.set([{foo: 'bar'}, {baz: 'quux'}]);\nconsole.log(app);\n//=> {name: 'Halle', foo: 'bar', baz: 'quux'}\n```\n\n### [.union](index.js#L114)\n\nUnion `array` to `key`. Also emits `set` with the key and value.\n\n**Params**\n\n* `key` **{String}**\n* `value` **{any}**\n* `returns` **{Object}**: Returns the instance for chaining.\n\n**Example**\n\n```js\napp.union('a.b', ['foo']);\napp.union('a.b', ['bar']);\nconsole.log(app.get('a'));\n//=> {b: ['foo', 'bar']}\n```\n\n### [.get](index.js#L144)\n\nReturn the value of `key`. Dot notation may be used to get [nested property values](https://github.com/jonschlinkert/get-value).\n\n**Params**\n\n* `key` **{String}**: The name of the property to get. Dot-notation may be used.\n* `returns` **{any}**: Returns the value of `key`\n\n**Events**\n\n* `emits`: `get` with `key` and `value` as arguments.\n\n**Example**\n\n```js\napp.set('a.b.c', 'd');\napp.get('a.b');\n//=> {c: 'd'}\n\napp.get(['a', 'b']);\n//=> {c: 'd'}\n```\n\n### [.has](index.js#L171)\n\nReturn true if app has a stored value for `key`, false only if value is `undefined`.\n\n**Params**\n\n* `key` **{String}**\n* `returns` **{Boolean}**\n\n**Events**\n\n* `emits`: `has` with `key` and true or false as arguments.\n\n**Example**\n\n```js\napp.set('foo', 'bar');\napp.has('foo');\n//=> true\n```\n\n### [.del](index.js#L199)\n\nDelete one or more properties from the instance.\n\n**Params**\n\n* `key` **{String|Array}**: Property name or array of property names.\n* `returns` **{Object}**: Returns the instance for chaining.\n\n**Events**\n\n* `emits`: `del` with the `key` as the only argument.\n\n**Example**\n\n```js\napp.del(); // delete all\n// or\napp.del('foo');\n// or\napp.del(['foo', 'bar']);\n```\n\n### [.clear](index.js#L218)\n\nReset the entire cache to an empty object.\n\n**Example**\n\n```js\napp.clear();\n```\n\n### [.visit](index.js#L235)\n\nVisit `method` over the properties in the given object, or map\nvisit over the object-elements in an array.\n\n**Params**\n\n* `method` **{String}**: The name of the `base` method to call.\n* `val` **{Object|Array}**: The object or array to iterate over.\n* `returns` **{Object}**: Returns the instance for chaining.\n\n## About\n\n### Related projects\n\n* [base-methods](https://www.npmjs.com/package/base-methods): base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/jonschlinkert/base-methods) | [homepage](https://github.com/jonschlinkert/base-methods \"base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.\")\n* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value \"Use property paths (`a.b.c`) to get a nested value from an object.\")\n* [has-value](https://www.npmjs.com/package/has-value): Returns true if a value exists, false if empty. Works with deeply nested values using… [more](https://github.com/jonschlinkert/has-value) | [homepage](https://github.com/jonschlinkert/has-value \"Returns true if a value exists, false if empty. Works with deeply nested values using object paths.\")\n* [option-cache](https://www.npmjs.com/package/option-cache): Simple API for managing options in JavaScript applications. | [homepage](https://github.com/jonschlinkert/option-cache \"Simple API for managing options in JavaScript applications.\")\n* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value \"Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths.\")\n* [unset-value](https://www.npmjs.com/package/unset-value): Delete nested properties from an object using dot notation. | [homepage](https://github.com/jonschlinkert/unset-value \"Delete nested properties from an object using dot notation.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 54 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 22, 2017._\n# loose-envify\n\n[](https://travis-ci.org/zertosh/loose-envify)\n\nFast (and loose) selective `process.env` replacer using [js-tokens](https://github.com/lydell/js-tokens) instead of an AST. Works just like [envify](https://github.com/hughsk/envify) but much faster.\n\n## Gotchas\n\n* Doesn't handle broken syntax.\n* Doesn't look inside embedded expressions in template strings.\n - **this won't work:**\n ```js\n console.log(`the current env is ${process.env.NODE_ENV}`);\n ```\n* Doesn't replace oddly-spaced or oddly-commented expressions.\n - **this won't work:**\n ```js\n console.log(process./*won't*/env./*work*/NODE_ENV);\n ```\n\n## Usage/Options\n\nloose-envify has the exact same interface as [envify](https://github.com/hughsk/envify), including the CLI.\n\n## Benchmark\n\n```\nenvify:\n\n $ for i in {1..5}; do node bench/bench.js 'envify'; done\n 708ms\n 727ms\n 791ms\n 719ms\n 720ms\n\nloose-envify:\n\n $ for i in {1..5}; do node bench/bench.js '../'; done\n 51ms\n 52ms\n 52ms\n 52ms\n 52ms\n```\n# [postcss][postcss]-svgo\n\n> Optimise inline SVG with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-svgo) do:\n\n```\nnpm install postcss-svgo --save\n```\n\n## Example\n\n### Input\n\n```css\nh1 {\n background: url('data:image/svg+xml;charset=utf-8,<?xml version=\"1.0\" encoding=\"utf-8\"?><!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\"><svg version=\"1.1\" id=\"Layer_1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xml:space=\"preserve\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"yellow\" /></svg>');\n}\n\nh2 {\n background: url('data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+PGNpcmNsZSBjeD0iNTAiIGN5PSI1MCIgcj0iNDAiIGZpbGw9InllbGxvdyIgLz48IS0tdGVzdCBjb21tZW50LS0+PC9zdmc+');\n}\n```\n\n### Output\n\n```css\nh1 {\n background: url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"%23ff0\"/></svg>');\n}\n\nh2 {\n background: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxjaXJjbGUgY3g9IjUwIiBjeT0iNTAiIHI9IjQwIiBmaWxsPSIjZmYwIi8+PC9zdmc+');\n}\n```\n\n## API\n\n### `svgo([options])`\n\nNote that postcss-svgo is an *asynchronous* processor. It cannot be used\nlike this:\n\n```js\nvar result = postcss([ svgo() ]).process(css).css;\nconsole.log(result);\n```\n\nInstead make sure your PostCSS runner uses the asynchronous API:\n\n```js\npostcss([ svgo() ]).process(css).then(function (result) {\n console.log(result.css);\n});\n```\n\n#### options\n\n##### encode\n\nType: `boolean`\nDefault: `undefined`\n\nIf `true`, it will encode URL-unsafe characters such as `<`, `>` and `&`;\n`false` will decode these characters, and `undefined` will neither encode nor\ndecode the original input. Note that regardless of this setting, `#` will\nalways be URL-encoded.\n\n##### plugins\n\nOptionally, you can customise the output by specifying the `plugins` option. You\nwill need to provide the config in comma separated objects, like the example\nbelow. Note that you can either disable the plugin by setting it to `false`,\nor pass different options to change the default behaviour.\n\n```js\nvar postcss = require('postcss');\nvar svgo = require('postcss-svgo');\n\nvar opts = {\n plugins: [{\n removeDoctype: false\n }, {\n removeComments: false\n }, {\n cleanupNumericValues: {\n floatPrecision: 2\n }\n }, {\n convertColors: {\n names2hex: false,\n rgb2hex: false\n }\n }]\n};\n\npostcss([ svgo(opts) ]).process(css).then(function (result) {\n console.log(result.css)\n});\n```\n\nYou can view the [full list of plugins here][plugins].\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n[plugins]: https://github.com/svg/svgo/tree/master/plugins\n# browserify-zlib\n\n[](https://travis-ci.org/devongovett/browserify-zlib)\n[](https://david-dm.org/devongovett/browserify-zlib) [](https://github.com/feross/standard)\n\n## Description\n\nEmulates Node's [zlib](https://nodejs.org/api/zlib.html) module for the browser. Can be used as a drop in replacement with [Browserify](http://browserify.org) and [webpack](http://webpack.github.io/).\n\nThe heavy lifting is done using [pako](https://github.com/nodeca/pako). The code in this module is modeled closely after the code in the source of Node core to get as much compatability as possible.\n\n## API\n\nhttps://nodejs.org/api/zlib.html\n\n## Not implemented\n\nThe following options/methods are not supported because pako does not support them yet.\n\n* The `params` method\n\n## License\n\nMIT\n# Javascript Error Polyfill\n\n[](https://travis-ci.org/inf3rno/error-polyfill)\n\nImplementing the [V8 Stack Trace API](https://github.com/v8/v8/wiki/Stack-Trace-API) in non-V8 environments as much as possible\n\n## Installation\n\n```bash\nnpm install error-polyfill\n```\n\n```bash\nbower install error-polyfill\n```\n\n### Environment compatibility\n\nTested on the following environments:\n\nWindows 7\n - **Node.js** 9.6\n - **Chrome** 64.0\n - **Firefox** 58.0\n - **Internet Explorer** 10.0, 11.0\n - **PhantomJS** 2.1\n - **Opera** 51.0\n\nTravis\n - **Node.js** 8, 9\n - **Chrome**\n - **Firefox**\n - **PhantomJS**\n \nThe polyfill might work on other environments too due to its adaptive design. I use [Karma](https://github.com/karma-runner/karma) with [Browserify](https://github.com/substack/node-browserify) to test the framework in browsers.\n\n### Requirements\n\nES5 support is required, without that the lib throws an Error and stops working. \n\nThe ES5 features are tested by the [capability](https://github.com/inf3rno/capability) lib run time.\nClasses are created by the [o3](https://github.com/inf3rno/o3) lib.\nUtility functions are implemented in the [u3](https://github.com/inf3rno/u3) lib.\n\n## API documentation\n\n### Usage\n\nIn this documentation I used the framework as follows:\n\n```js\nrequire(\"error-polyfill\");\n\n// <- your code here\n```\n\nIt is recommended to require the polyfill in your main script.\n\n### Getting a past stack trace with `Error.getStackTrace`\n\nThis static method is not part of the V8 Stack Trace API, but it is recommended to **use `Error.getStackTrace(throwable)` instead of `throwable.stack`** to get the stack trace of Error instances!\n\nExplanation:\n\nBy non-V8 environments we cannot replace the default stack generation algorithm, so we need a workaround to generate the stack when somebody tries to access it. So the original stack string will be parsed and the result will be properly formatted by accessing the stack using the `Error.getStackTrace` method.\n\nArguments and return values:\n\n - The `throwable` argument should be an `Error` (descendant) instance, but it can be an `Object` instance as well.\n - The return value is the generated `stack` of the `throwable` argument.\n\nExample:\n\n```js\ntry {\n theNotDefinedFunction();\n}\ncatch (error) {\n console.log(Error.getStackTrace(error));\n // ReferenceError: theNotDefinedFunction is not defined\n // at ...\n // ...\n}\n```\n\n### Capturing the present stack trace with `Error.captureStackTrace`\n\nThe `Error.captureStackTrace(throwable [, terminator])` sets the present stack above the `terminator` on the `throwable`. \n\nArguments and return values:\n\n - The `throwable` argument should be an instance of an `Error` descendant, but it can be an `Object` instance as well. It is recommended to use `Error` descendant instances instead of inline objects, because we can recognize them by type e.g. `error instanceof UserError`.\n - The optional `terminator` argument should be a `Function`. Only the calls before this function will be reported in the stack, so without a `terminator` argument, the last call in the stack will be the call of the `Error.captureStackTrace`.\n - There is no return value, the `stack` will be set on the `throwable` so you will be able to access it using `Error.getStackTrace`. The format of the stack depends on the `Error.prepareStackTrace` implementation.\n\nExample:\n\n```js\n\nvar UserError = function (message){\n this.name = \"UserError\";\n this.message = message;\n Error.captureStackTrace(this, this.constructor);\n};\nUserError.prototype = Object.create(Error.prototype);\n\nfunction codeSmells(){\n throw new UserError(\"What's going on?!\");\n}\n\ncodeSmells();\n // UserError: What's going on?!\n // at codeSmells (myModule.js:23:1)\n // ...\n\n```\n\nLimitations:\n\nBy the current implementation the `terminator` can be only the `Error.captureStackTrace` caller function. This will change soon, but in certain conditions, e.g. by using strict mode (`\"use strict\";`) it is not possible to access the information necessary to implement this feature. You will get an empty `frames` array and a `warning` in the `Error.prepareStackTrace` when the stack parser meets with such conditions.\n\n### Formatting the stack trace with `Error.prepareStackTrace`\n\nThe `Error.prepareStackTrace(throwable, frames [, warnings])` formats the stack `frames` and returns the `stack` value for `Error.captureStackTrace` or `Error.getStackTrace`. The native implementation returns a stack string, but you can override that by setting a new function value.\n\nArguments and return values:\n\n - The `throwable` argument is an `Error` or `Object` instance coming from the `Error.captureStackTrace` or from the creation of a new `Error` instance. Be aware that in some environments you need to throw that instance to get a parsable stack. Without that you will get only a `warning` by trying to access the stack with `Error.getStackTrace`.\n - The `frames` argument is an array of `Frame` instances. Each `frame` represents a function call in the stack. You can use these frames to build a stack string. To access information about individual frames you can use the following methods.\n - `frame.toString()` - Returns the string representation of the frame, e.g. `codeSmells (myModule.js:23:1)`.\n - `frame.getThis()` - **Cannot be supported.** Returns the context of the call, only V8 environments support this natively.\n - `frame.getTypeName()` - **Not implemented yet.** Returns the type name of the context, by the global namespace it is `Window` in Chrome.\n - `frame.getFunction()` - Returns the called function or `undefined` by strict mode.\n - `frame.getFunctionName()` - **Not implemented yet.** Returns the name of the called function.\n - `frame.getMethodName()` - **Not implemented yet.** Returns the method name of the called function is a method of an object.\n - `frame.getFileName()` - **Not implemented yet.** Returns the file name where the function was called.\n - `frame.getLineNumber()` - **Not implemented yet.** Returns at which line the function was called in the file.\n - `frame.getColumnNumber()` - **Not implemented yet.** Returns at which column the function was called in the file. This information is not always available.\n - `frame.getEvalOrigin()` - **Not implemented yet.** Returns the original of an `eval` call.\n - `frame.isTopLevel()` - **Not implemented yet.** Returns whether the function was called from the top level.\n - `frame.isEval()` - **Not implemented yet.** Returns whether the called function was `eval`.\n - `frame.isNative()` - **Not implemented yet.** Returns whether the called function was native.\n - `frame.isConstructor()` - **Not implemented yet.** Returns whether the called function was a constructor.\n - The optional `warnings` argument contains warning messages coming from the stack parser. It is not part of the V8 Stack Trace API.\n - The return value will be the stack you can access with `Error.getStackTrace(throwable)`. If it is an object, it is recommended to add a `toString` method, so you will be able to read it in the console.\n\nExample:\n\n```js\nError.prepareStackTrace = function (throwable, frames, warnings) {\n var string = \"\";\n string += throwable.name || \"Error\";\n string += \": \" + (throwable.message || \"\");\n if (warnings instanceof Array)\n for (var warningIndex in warnings) {\n var warning = warnings[warningIndex];\n string += \"\\n # \" + warning;\n }\n for (var frameIndex in frames) {\n var frame = frames[frameIndex];\n string += \"\\n at \" + frame.toString();\n }\n return string;\n};\n```\n\n### Stack trace size limits with `Error.stackTraceLimit`\n\n**Not implemented yet.**\n\nYou can set size limits on the stack trace, so you won't have any problems because of too long stack traces.\n\nExample:\n\n```js\nError.stackTraceLimit = 10;\n```\n\n### Handling uncaught errors and rejections\n\n**Not implemented yet.**\n\n## Differences between environments and modes\n\nSince there is no Stack Trace API standard, every browsers solves this problem differently. I try to document what I've found about these differences as detailed as possible, so it will be easier to follow the code.\n\nOverriding the `error.stack` property with custom Stack instances\n \n - by Node.js and Chrome the `Error.prepareStackTrace()` can override every `error.stack` automatically right by creation\n - by Firefox, Internet Explorer and Opera you cannot automatically override every `error.stack` by native errors\n - by PhantomJS you cannot override the `error.stack` property of native errors, it is not configurable\n \nCapturing the current stack trace\n \n - by Node.js, Chrome, Firefox and Opera the stack property is added by instantiating a native error\n - by Node.js and Chrome the stack creation is lazy loaded and cached, so the `Error.prepareStackTrace()` is called only by the first access\n - by Node.js and Chrome the current stack can be added to any object with `Error.captureStackTrace()`\n - by Internet Explorer the stack is created by throwing a native error\n - by PhantomJS the stack is created by throwing any object, but not a primitive\n \nAccessing the stack\n \n - by Node.js, Chrome, Firefox, Internet Explorer, Opera and PhantomJS you can use the `error.stack` property\n - by old Opera you have to use the `error.stacktrace` property to get the stack\n \nPrefixes and postfixes on the stack string\n \n - by Node.js, Chrome, Internet Explorer and Opera you have the `error.name` and the `error.message` in a `{name}: {message}` format at the beginning of the stack string\n - by Firefox and PhantomJS the stack string does not contain the `error.name` and the `error.message`\n - by Firefox you have an empty line at the end of the stack string\n \nAccessing the stack frames array\n\n - by Node.js and Chrome you can access the frame objects directly by overriding the `Error.prepareStackTrace()`\n - by Firefox, Internet Explorer, PhantomJS, and Opera you need to parse the stack string in order to get the frames\n \nThe structure of the frame string\n\n - by Node.js and Chrome\n - the frame string of calling a function from a module: `thirdFn (http://localhost/myModule.js:45:29)`\n - the frame strings contain an ` at ` prefix, which is not present by the `frame.toString()` output, so it is added by the `stack.toString()`\n - by Firefox\n - the frame string of calling a function from a module: `thirdFn@http://localhost/myModule.js:45:29`\n - by Internet Explorer\n - the frame string of calling a function from a module: ` at thirdFn (http://localhost/myModule.js:45:29)`\n - by PhantomJS\n - the frame string of calling a function from a module: `thirdFn@http://localhost/myModule.js:45:29`\n - by Opera\n - the frame string of calling a function from a module: ` at thirdFn (http://localhost/myModule.js:45)`\n \nAccessing information by individual frames\n\n - by Node.js and Chrome the `frame.getThis()` and the `frame.getFunction()` returns `undefined` by frames originate from [strict mode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode) code\n - by Firefox, Internet Explorer, PhantomJS, and Opera the context of the function calls is not accessible, so the `frame.getThis()` cannot be implemented\n - by Firefox, Internet Explorer, PhantomJS, and Opera functions are not accessible with `arguments.callee.caller` by frames originate from strict mode, so by these frames `frame.getFunction()` can return only `undefined` (this is consistent with V8 behavior)\n\n## License\n\nMIT - 2016 Jánszky László Lajos\n# Decode According to the WHATWG Encoding Standard\n\nThis package provides a thin layer on top of [iconv-lite](https://github.com/ashtuchkin/iconv-lite) which makes it expose some of the same primitives as the [Encoding Standard](https://encoding.spec.whatwg.org/).\n\n```js\nconst whatwgEncoding = require(\"whatwg-encoding\");\n\nconsole.assert(whatwgEncoding.labelToName(\"latin1\") === \"windows-1252\");\nconsole.assert(whatwgEncoding.labelToName(\" CYRILLic \") === \"ISO-8859-5\");\n\nconsole.assert(whatwgEncoding.isSupported(\"IBM866\") === true);\n\n// Not supported by the Encoding Standard\nconsole.assert(whatwgEncoding.isSupported(\"UTF-32\") === false);\n\n// In the Encoding Standard, but this package can't decode it\nconsole.assert(whatwgEncoding.isSupported(\"x-mac-cyrillic\") === false);\n\nconsole.assert(whatwgEncoding.getBOMEncoding(new Buffer([0xFE, 0xFF])) === \"UTF-16BE\");\nconsole.assert(whatwgEncoding.getBOMEncoding(new Buffer([0x48, 0x69])) === null);\n\nconsole.assert(whatwgEncoding.decode(new Buffer([0x48, 0x69]), \"UTF-8\") === \"Hi\");\n```\n\n## API\n\n- `decode(buffer, fallbackEncodingName)`: performs the [decode](https://encoding.spec.whatwg.org/#decode) algorithm (in which any BOM will override the passed fallback encoding), and returns the resulting string\n- `labelToName(label)`: performs the [get an encoding](https://encoding.spec.whatwg.org/#concept-encoding-get) algorithm and returns the resulting encoding's name, or `null` for failure\n- `isSupported(name)`: returns whether the encoding is one of [the encodings](https://encoding.spec.whatwg.org/#names-and-labels) of the Encoding Standard, _and_ is an encoding that this package can decode (via iconv-lite)\n- `getBOMEncoding(buffer)`: sniffs the first 2–3 bytes of the supplied `Buffer`, returning one of the encoding names `\"UTF-8\"`, `\"UTF-16LE\"`, or `\"UTF-16BE\"` if the appropriate BOM is present, or `null` if no BOM is present\n\n## Unsupported encodings\n\nSince we rely on iconv-lite, we are limited to support only the encodings that they support. Currently we are missing support for:\n\n- ISO-2022-JP\n- ISO-8859-8-I\n- replacement\n- x-mac-cyrillic\n- x-user-defined\n\nPassing these encoding names will return `false` when calling `isSupported`, and passing any of the possible labels for these encodings to `labelToName` will return `null`.\n\n## Credits\n\nThis package was originally based on the excellent work of [@nicolashenry](https://github.com/nicolashenry), [in jsdom](https://github.com/tmpvar/jsdom/blob/7ce11776ce161e8d5921a7a183585327400f786b/lib/jsdom/living/helpers/encoding.js). It has since been pulled out into this separate package.\n\n## Alternatives\n\nIf you are looking for a JavaScript implementation of the Encoding Standard's `TextEncoder` and `TextDecoder` APIs, you'll want [@inexorabletash](https://github.com/inexorabletash)'s [text-encoding](https://github.com/inexorabletash/text-encoding) package.\n# <img src=\"./logo.png\" alt=\"bn.js\" width=\"160\" height=\"160\" />\n\n> BigNum in pure javascript\n\n[](http://travis-ci.org/indutny/bn.js)\n\n## Install\n`npm install --save bn.js`\n\n## Usage\n\n```js\nconst BN = require('bn.js');\n\nvar a = new BN('dead', 16);\nvar b = new BN('101010', 2);\n\nvar res = a.add(b);\nconsole.log(res.toString(10)); // 57047\n```\n\n**Note**: decimals are not supported in this library.\n\n## Notation\n\n### Prefixes\n\nThere are several prefixes to instructions that affect the way the work. Here\nis the list of them in the order of appearance in the function name:\n\n* `i` - perform operation in-place, storing the result in the host object (on\n which the method was invoked). Might be used to avoid number allocation costs\n* `u` - unsigned, ignore the sign of operands when performing operation, or\n always return positive value. Second case applies to reduction operations\n like `mod()`. In such cases if the result will be negative - modulo will be\n added to the result to make it positive\n\n### Postfixes\n\nThe only available postfix at the moment is:\n\n* `n` - which means that the argument of the function must be a plain JavaScript\n Number. Decimals are not supported.\n\n### Examples\n\n* `a.iadd(b)` - perform addition on `a` and `b`, storing the result in `a`\n* `a.umod(b)` - reduce `a` modulo `b`, returning positive value\n* `a.iushln(13)` - shift bits of `a` left by 13\n\n## Instructions\n\nPrefixes/postfixes are put in parens at the of the line. `endian` - could be\neither `le` (little-endian) or `be` (big-endian).\n\n### Utilities\n\n* `a.clone()` - clone number\n* `a.toString(base, length)` - convert to base-string and pad with zeroes\n* `a.toNumber()` - convert to Javascript Number (limited to 53 bits)\n* `a.toJSON()` - convert to JSON compatible hex string (alias of `toString(16)`)\n* `a.toArray(endian, length)` - convert to byte `Array`, and optionally zero\n pad to length, throwing if already exceeding\n* `a.toArrayLike(type, endian, length)` - convert to an instance of `type`,\n which must behave like an `Array`\n* `a.toBuffer(endian, length)` - convert to Node.js Buffer (if available). For\n compatibility with browserify and similar tools, use this instead:\n `a.toArrayLike(Buffer, endian, length)`\n* `a.bitLength()` - get number of bits occupied\n* `a.zeroBits()` - return number of less-significant consequent zero bits\n (example: `1010000` has 4 zero bits)\n* `a.byteLength()` - return number of bytes occupied\n* `a.isNeg()` - true if the number is negative\n* `a.isEven()` - no comments\n* `a.isOdd()` - no comments\n* `a.isZero()` - no comments\n* `a.cmp(b)` - compare numbers and return `-1` (a `<` b), `0` (a `==` b), or `1` (a `>` b)\n depending on the comparison result (`ucmp`, `cmpn`)\n* `a.lt(b)` - `a` less than `b` (`n`)\n* `a.lte(b)` - `a` less than or equals `b` (`n`)\n* `a.gt(b)` - `a` greater than `b` (`n`)\n* `a.gte(b)` - `a` greater than or equals `b` (`n`)\n* `a.eq(b)` - `a` equals `b` (`n`)\n* `a.toTwos(width)` - convert to two's complement representation, where `width` is bit width\n* `a.fromTwos(width)` - convert from two's complement representation, where `width` is the bit width\n* `BN.isBN(object)` - returns true if the supplied `object` is a BN.js instance\n\n### Arithmetics\n\n* `a.neg()` - negate sign (`i`)\n* `a.abs()` - absolute value (`i`)\n* `a.add(b)` - addition (`i`, `n`, `in`)\n* `a.sub(b)` - subtraction (`i`, `n`, `in`)\n* `a.mul(b)` - multiply (`i`, `n`, `in`)\n* `a.sqr()` - square (`i`)\n* `a.pow(b)` - raise `a` to the power of `b`\n* `a.div(b)` - divide (`divn`, `idivn`)\n* `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`)\n* `a.divRound(b)` - rounded division\n\n### Bit operations\n\n* `a.or(b)` - or (`i`, `u`, `iu`)\n* `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced\n with `andn` in future)\n* `a.xor(b)` - xor (`i`, `u`, `iu`)\n* `a.setn(b)` - set specified bit to `1`\n* `a.shln(b)` - shift left (`i`, `u`, `iu`)\n* `a.shrn(b)` - shift right (`i`, `u`, `iu`)\n* `a.testn(b)` - test if specified bit is set\n* `a.maskn(b)` - clear bits with indexes higher or equal to `b` (`i`)\n* `a.bincn(b)` - add `1 << b` to the number\n* `a.notn(w)` - not (for the width specified by `w`) (`i`)\n\n### Reduction\n\n* `a.gcd(b)` - GCD\n* `a.egcd(b)` - Extended GCD results (`{ a: ..., b: ..., gcd: ... }`)\n* `a.invm(b)` - inverse `a` modulo `b`\n\n## Fast reduction\n\nWhen doing lots of reductions using the same modulo, it might be beneficial to\nuse some tricks: like [Montgomery multiplication][0], or using special algorithm\nfor [Mersenne Prime][1].\n\n### Reduction context\n\nTo enable this tricks one should create a reduction context:\n\n```js\nvar red = BN.red(num);\n```\nwhere `num` is just a BN instance.\n\nOr:\n\n```js\nvar red = BN.red(primeName);\n```\n\nWhere `primeName` is either of these [Mersenne Primes][1]:\n\n* `'k256'`\n* `'p224'`\n* `'p192'`\n* `'p25519'`\n\nOr:\n\n```js\nvar red = BN.mont(num);\n```\n\nTo reduce numbers with [Montgomery trick][0]. `.mont()` is generally faster than\n`.red(num)`, but slower than `BN.red(primeName)`.\n\n### Converting numbers\n\nBefore performing anything in reduction context - numbers should be converted\nto it. Usually, this means that one should:\n\n* Convert inputs to reducted ones\n* Operate on them in reduction context\n* Convert outputs back from the reduction context\n\nHere is how one may convert numbers to `red`:\n\n```js\nvar redA = a.toRed(red);\n```\nWhere `red` is a reduction context created using instructions above\n\nHere is how to convert them back:\n\n```js\nvar a = redA.fromRed();\n```\n\n### Red instructions\n\nMost of the instructions from the very start of this readme have their\ncounterparts in red context:\n\n* `a.redAdd(b)`, `a.redIAdd(b)`\n* `a.redSub(b)`, `a.redISub(b)`\n* `a.redShl(num)`\n* `a.redMul(b)`, `a.redIMul(b)`\n* `a.redSqr()`, `a.redISqr()`\n* `a.redSqrt()` - square root modulo reduction context's prime\n* `a.redInvm()` - modular inverse of the number\n* `a.redNeg()`\n* `a.redPow(b)` - modular exponentiation\n\n## LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2015.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication\n[1]: https://en.wikipedia.org/wiki/Mersenne_prime\n# Glob\n\nMatch files using the patterns the shell uses, like stars and stuff.\n\n[](https://travis-ci.org/isaacs/node-glob/) [](https://ci.appveyor.com/project/isaacs/node-glob) [](https://coveralls.io/github/isaacs/node-glob?branch=master)\n\nThis is a glob implementation in JavaScript. It uses the `minimatch`\nlibrary to do its matching.\n\n\n\n## Usage\n\nInstall with npm\n\n```\nnpm i glob\n```\n\n```javascript\nvar glob = require(\"glob\")\n\n// options is optional\nglob(\"**/*.js\", options, function (er, files) {\n // files is an array of filenames.\n // If the `nonull` option is set, and nothing\n // was found, then files is [\"**/*.js\"]\n // er is an error object or null.\n})\n```\n\n## Glob Primer\n\n\"Globs\" are the patterns you type when you do stuff like `ls *.js` on\nthe command line, or put `build/*` in a `.gitignore` file.\n\nBefore parsing the path part patterns, braced sections are expanded\ninto a set. Braced sections start with `{` and end with `}`, with any\nnumber of comma-delimited sections within. Braced sections may contain\nslash characters, so `a{/b/c,bcd}` would expand into `a/b/c` and `abcd`.\n\nThe following characters have special magic meaning when used in a\npath portion:\n\n* `*` Matches 0 or more characters in a single path portion\n* `?` Matches 1 character\n* `[...]` Matches a range of characters, similar to a RegExp range.\n If the first character of the range is `!` or `^` then it matches\n any character not in the range.\n* `!(pattern|pattern|pattern)` Matches anything that does not match\n any of the patterns provided.\n* `?(pattern|pattern|pattern)` Matches zero or one occurrence of the\n patterns provided.\n* `+(pattern|pattern|pattern)` Matches one or more occurrences of the\n patterns provided.\n* `*(a|b|c)` Matches zero or more occurrences of the patterns provided\n* `@(pattern|pat*|pat?erN)` Matches exactly one of the patterns\n provided\n* `**` If a \"globstar\" is alone in a path portion, then it matches\n zero or more directories and subdirectories searching for matches.\n It does not crawl symlinked directories.\n\n### Dots\n\nIf a file or directory path portion has a `.` as the first character,\nthen it will not match any glob pattern unless that pattern's\ncorresponding path part also has a `.` as its first character.\n\nFor example, the pattern `a/.*/c` would match the file at `a/.b/c`.\nHowever the pattern `a/*/c` would not, because `*` does not start with\na dot character.\n\nYou can make glob treat dots as normal characters by setting\n`dot:true` in the options.\n\n### Basename Matching\n\nIf you set `matchBase:true` in the options, and the pattern has no\nslashes in it, then it will seek for any file anywhere in the tree\nwith a matching basename. For example, `*.js` would match\n`test/simple/basic.js`.\n\n### Empty Sets\n\nIf no matching files are found, then an empty array is returned. This\ndiffers from the shell, where the pattern itself is returned. For\nexample:\n\n $ echo a*s*d*f\n a*s*d*f\n\nTo get the bash-style behavior, set the `nonull:true` in the options.\n\n### See Also:\n\n* `man sh`\n* `man bash` (Search for \"Pattern Matching\")\n* `man 3 fnmatch`\n* `man 5 gitignore`\n* [minimatch documentation](https://github.com/isaacs/minimatch)\n\n## glob.hasMagic(pattern, [options])\n\nReturns `true` if there are any special characters in the pattern, and\n`false` otherwise.\n\nNote that the options affect the results. If `noext:true` is set in\nthe options object, then `+(a|b)` will not be considered a magic\npattern. If the pattern has a brace expansion, like `a/{b/c,x/y}`\nthen that is considered magical, unless `nobrace:true` is set in the\noptions.\n\n## glob(pattern, [options], cb)\n\n* `pattern` `{String}` Pattern to be matched\n* `options` `{Object}`\n* `cb` `{Function}`\n * `err` `{Error | null}`\n * `matches` `{Array<String>}` filenames found matching the pattern\n\nPerform an asynchronous glob search.\n\n## glob.sync(pattern, [options])\n\n* `pattern` `{String}` Pattern to be matched\n* `options` `{Object}`\n* return: `{Array<String>}` filenames found matching the pattern\n\nPerform a synchronous glob search.\n\n## Class: glob.Glob\n\nCreate a Glob object by instantiating the `glob.Glob` class.\n\n```javascript\nvar Glob = require(\"glob\").Glob\nvar mg = new Glob(pattern, options, cb)\n```\n\nIt's an EventEmitter, and starts walking the filesystem to find matches\nimmediately.\n\n### new glob.Glob(pattern, [options], [cb])\n\n* `pattern` `{String}` pattern to search for\n* `options` `{Object}`\n* `cb` `{Function}` Called when an error occurs, or matches are found\n * `err` `{Error | null}`\n * `matches` `{Array<String>}` filenames found matching the pattern\n\nNote that if the `sync` flag is set in the options, then matches will\nbe immediately available on the `g.found` member.\n\n### Properties\n\n* `minimatch` The minimatch object that the glob uses.\n* `options` The options object passed in.\n* `aborted` Boolean which is set to true when calling `abort()`. There\n is no way at this time to continue a glob search after aborting, but\n you can re-use the statCache to avoid having to duplicate syscalls.\n* `cache` Convenience object. Each field has the following possible\n values:\n * `false` - Path does not exist\n * `true` - Path exists\n * `'FILE'` - Path exists, and is not a directory\n * `'DIR'` - Path exists, and is a directory\n * `[file, entries, ...]` - Path exists, is a directory, and the\n array value is the results of `fs.readdir`\n* `statCache` Cache of `fs.stat` results, to prevent statting the same\n path multiple times.\n* `symlinks` A record of which paths are symbolic links, which is\n relevant in resolving `**` patterns.\n* `realpathCache` An optional object which is passed to `fs.realpath`\n to minimize unnecessary syscalls. It is stored on the instantiated\n Glob object, and may be re-used.\n\n### Events\n\n* `end` When the matching is finished, this is emitted with all the\n matches found. If the `nonull` option is set, and no match was found,\n then the `matches` list contains the original pattern. The matches\n are sorted, unless the `nosort` flag is set.\n* `match` Every time a match is found, this is emitted with the specific\n thing that matched. It is not deduplicated or resolved to a realpath.\n* `error` Emitted when an unexpected error is encountered, or whenever\n any fs error occurs if `options.strict` is set.\n* `abort` When `abort()` is called, this event is raised.\n\n### Methods\n\n* `pause` Temporarily stop the search\n* `resume` Resume the search\n* `abort` Stop the search forever\n\n### Options\n\nAll the options that can be passed to Minimatch can also be passed to\nGlob to change pattern matching behavior. Also, some have been added,\nor have glob-specific ramifications.\n\nAll options are false by default, unless otherwise noted.\n\nAll options are added to the Glob object, as well.\n\nIf you are running many `glob` operations, you can pass a Glob object\nas the `options` argument to a subsequent operation to shortcut some\n`stat` and `readdir` calls. At the very least, you may pass in shared\n`symlinks`, `statCache`, `realpathCache`, and `cache` options, so that\nparallel glob operations will be sped up by sharing information about\nthe filesystem.\n\n* `cwd` The current working directory in which to search. Defaults\n to `process.cwd()`.\n* `root` The place where patterns starting with `/` will be mounted\n onto. Defaults to `path.resolve(options.cwd, \"/\")` (`/` on Unix\n systems, and `C:\\` or some such on Windows.)\n* `dot` Include `.dot` files in normal matches and `globstar` matches.\n Note that an explicit dot in a portion of the pattern will always\n match dot files.\n* `nomount` By default, a pattern starting with a forward-slash will be\n \"mounted\" onto the root setting, so that a valid filesystem path is\n returned. Set this flag to disable that behavior.\n* `mark` Add a `/` character to directory matches. Note that this\n requires additional stat calls.\n* `nosort` Don't sort the results.\n* `stat` Set to true to stat *all* results. This reduces performance\n somewhat, and is completely unnecessary, unless `readdir` is presumed\n to be an untrustworthy indicator of file existence.\n* `silent` When an unusual error is encountered when attempting to\n read a directory, a warning will be printed to stderr. Set the\n `silent` option to true to suppress these warnings.\n* `strict` When an unusual error is encountered when attempting to\n read a directory, the process will just continue on in search of\n other matches. Set the `strict` option to raise an error in these\n cases.\n* `cache` See `cache` property above. Pass in a previously generated\n cache object to save some fs calls.\n* `statCache` A cache of results of filesystem information, to prevent\n unnecessary stat calls. While it should not normally be necessary\n to set this, you may pass the statCache from one glob() call to the\n options object of another, if you know that the filesystem will not\n change between calls. (See \"Race Conditions\" below.)\n* `symlinks` A cache of known symbolic links. You may pass in a\n previously generated `symlinks` object to save `lstat` calls when\n resolving `**` matches.\n* `sync` DEPRECATED: use `glob.sync(pattern, opts)` instead.\n* `nounique` In some cases, brace-expanded patterns can result in the\n same file showing up multiple times in the result set. By default,\n this implementation prevents duplicates in the result set. Set this\n flag to disable that behavior.\n* `nonull` Set to never return an empty set, instead returning a set\n containing the pattern itself. This is the default in glob(3).\n* `debug` Set to enable debug logging in minimatch and glob.\n* `nobrace` Do not expand `{a,b}` and `{1..3}` brace sets.\n* `noglobstar` Do not match `**` against multiple filenames. (Ie,\n treat it as a normal `*` instead.)\n* `noext` Do not match `+(a|b)` \"extglob\" patterns.\n* `nocase` Perform a case-insensitive match. Note: on\n case-insensitive filesystems, non-magic patterns will match by\n default, since `stat` and `readdir` will not raise errors.\n* `matchBase` Perform a basename-only match if the pattern does not\n contain any slash characters. That is, `*.js` would be treated as\n equivalent to `**/*.js`, matching all js files in all directories.\n* `nodir` Do not match directories, only files. (Note: to match\n *only* directories, simply put a `/` at the end of the pattern.)\n* `ignore` Add a pattern or an array of glob patterns to exclude matches.\n Note: `ignore` patterns are *always* in `dot:true` mode, regardless\n of any other settings.\n* `follow` Follow symlinked directories when expanding `**` patterns.\n Note that this can result in a lot of duplicate references in the\n presence of cyclic links.\n* `realpath` Set to true to call `fs.realpath` on all of the results.\n In the case of a symlink that cannot be resolved, the full absolute\n path to the matched entry is returned (though it will usually be a\n broken symlink)\n* `absolute` Set to true to always receive absolute paths for matched\n files. Unlike `realpath`, this also affects the values returned in\n the `match` event.\n\n## Comparisons to other fnmatch/glob implementations\n\nWhile strict compliance with the existing standards is a worthwhile\ngoal, some discrepancies exist between node-glob and other\nimplementations, and are intentional.\n\nThe double-star character `**` is supported by default, unless the\n`noglobstar` flag is set. This is supported in the manner of bsdglob\nand bash 4.3, where `**` only has special significance if it is the only\nthing in a path part. That is, `a/**/b` will match `a/x/y/b`, but\n`a/**b` will not.\n\nNote that symlinked directories are not crawled as part of a `**`,\nthough their contents may match against subsequent portions of the\npattern. This prevents infinite loops and duplicates and the like.\n\nIf an escaped pattern has no matches, and the `nonull` flag is set,\nthen glob returns the pattern as-provided, rather than\ninterpreting the character escapes. For example,\n`glob.match([], \"\\\\*a\\\\?\")` will return `\"\\\\*a\\\\?\"` rather than\n`\"*a?\"`. This is akin to setting the `nullglob` option in bash, except\nthat it does not resolve escaped pattern characters.\n\nIf brace expansion is not disabled, then it is performed before any\nother interpretation of the glob pattern. Thus, a pattern like\n`+(a|{b),c)}`, which would not be valid in bash or zsh, is expanded\n**first** into the set of `+(a|b)` and `+(a|c)`, and those patterns are\nchecked for validity. Since those two are valid, matching proceeds.\n\n### Comments and Negation\n\nPreviously, this module let you mark a pattern as a \"comment\" if it\nstarted with a `#` character, or a \"negated\" pattern if it started\nwith a `!` character.\n\nThese options were deprecated in version 5, and removed in version 6.\n\nTo specify things that should not match, use the `ignore` option.\n\n## Windows\n\n**Please only use forward-slashes in glob expressions.**\n\nThough windows uses either `/` or `\\` as its path separator, only `/`\ncharacters are used by this glob implementation. You must use\nforward-slashes **only** in glob expressions. Back-slashes will always\nbe interpreted as escape characters, not path separators.\n\nResults from absolute patterns such as `/foo/*` are mounted onto the\nroot setting using `path.join`. On windows, this will by default result\nin `/foo/*` matching `C:\\foo\\bar.txt`.\n\n## Race Conditions\n\nGlob searching, by its very nature, is susceptible to race conditions,\nsince it relies on directory walking and such.\n\nAs a result, it is possible that a file that exists when glob looks for\nit may have been deleted or modified by the time it returns the result.\n\nAs part of its internal implementation, this program caches all stat\nand readdir calls that it makes, in order to cut down on system\noverhead. However, this also makes it even more susceptible to races,\nespecially if the cache or statCache objects are reused between glob\ncalls.\n\nUsers are thus advised not to use a glob result as a guarantee of\nfilesystem state in the face of rapid changes. For the vast majority\nof operations, this is never a problem.\n\n## Glob Logo\nGlob's logo was created by [Tanya Brassie](http://tanyabrassie.com/). Logo files can be found [here](https://github.com/isaacs/node-glob/tree/master/logo).\n\nThe logo is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).\n\n## Contributing\n\nAny change to behavior (including bugfixes) must come with a test.\n\nPatches that fail tests or reduce performance will be rejected.\n\n```\n# to run tests\nnpm test\n\n# to re-generate test fixtures\nnpm run test-regen\n\n# to benchmark against bash/zsh\nnpm run bench\n\n# to profile javascript\nnpm run prof\n```\n\n\n# bip39-light\n\nA lightweight fork of [bitcoinjs/bip39](https://github.com/bitcoinjs/bip39). Only english wordlist and removed some dependendecies.\n\nJavaScript implementation of [Bitcoin BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki): Mnemonic code for generating deterministic keys\n\n## Reminder for developers\n\n***Please remember to allow recovery from mnemonic phrases that have invalid checksums (or that you don't have the wordlist)***\n\nWhen a checksum is invalid, warn the user that the phrase is not something generated by your app, and ask if they would like to use it anyway. This way, your app only needs to hold the wordlists for your supported languages, but you can recover phrases made by other apps in other languages.\n\nHowever, there should be other checks in place, such as checking to make sure the user is inputting 12 words or more separated by a space. ie. `phrase.trim().split(/\\s+/g).length >= 12`\n\n## Examples\n``` js\n// Generate a random mnemonic (uses crypto.randomBytes under the hood), defaults to 128-bits of entropy\nvar mnemonic = bip39.generateMnemonic()\n// => 'seed sock milk update focus rotate barely fade car face mechanic mercy'\n\nbip39.mnemonicToSeedHex('basket actual')\n// => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'\n\nbip39.mnemonicToSeed('basket actual')\n// => <Buffer 5c f2 d4 a8 b0 35 5e 90 29 5b df c5 65 a0 22 a4 09 af 06 3d 53 65 bb 57 bf 74 d9 52 8f 49 4b fa 44 00 f5 3d 83 49 b8 0f da e4 40 82 d7 f9 54 1e 1d ba 2b ...>\n\nbip39.validateMnemonic(mnemonic)\n// => true\n\nbip39.validateMnemonic('basket actual')\n// => false\n```\n\n``` js\nvar bip39 = require('bip39-light')\n\n// defaults to BIP39 English word list\n// uses HEX strings for entropy\nvar mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000')\n// => abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about\n\n// reversible\nbip39.mnemonicToEntropy(mnemonic)\n// => '00000000000000000000000000000000'\n```\n# whatwg-url\n\nwhatwg-url is a full implementation of the WHATWG [URL Standard](https://url.spec.whatwg.org/). It can be used standalone, but it also exposes a lot of the internal algorithms that are useful for integrating a URL parser into a project like [jsdom](https://github.com/tmpvar/jsdom).\n\n## Specification conformance\n\nwhatwg-url is currently up to date with the URL spec up to commit [7ae1c69](https://github.com/whatwg/url/commit/7ae1c691c96f0d82fafa24c33aa1e8df9ffbf2bc).\n\nFor `file:` URLs, whose [origin is left unspecified](https://url.spec.whatwg.org/#concept-url-origin), whatwg-url chooses to use a new opaque origin (which serializes to `\"null\"`).\n\n## API\n\n### The `URL` and `URLSearchParams` classes\n\nThe main API is provided by the [`URL`](https://url.spec.whatwg.org/#url-class) and [`URLSearchParams`](https://url.spec.whatwg.org/#interface-urlsearchparams) exports, which follows the spec's behavior in all ways (including e.g. `USVString` conversion). Most consumers of this library will want to use these.\n\n### Low-level URL Standard API\n\nThe following methods are exported for use by places like jsdom that need to implement things like [`HTMLHyperlinkElementUtils`](https://html.spec.whatwg.org/#htmlhyperlinkelementutils). They mostly operate on or return an \"internal URL\" or [\"URL record\"](https://url.spec.whatwg.org/#concept-url) type.\n\n- [URL parser](https://url.spec.whatwg.org/#concept-url-parser): `parseURL(input, { baseURL, encodingOverride })`\n- [Basic URL parser](https://url.spec.whatwg.org/#concept-basic-url-parser): `basicURLParse(input, { baseURL, encodingOverride, url, stateOverride })`\n- [URL serializer](https://url.spec.whatwg.org/#concept-url-serializer): `serializeURL(urlRecord, excludeFragment)`\n- [Host serializer](https://url.spec.whatwg.org/#concept-host-serializer): `serializeHost(hostFromURLRecord)`\n- [Serialize an integer](https://url.spec.whatwg.org/#serialize-an-integer): `serializeInteger(number)`\n- [Origin](https://url.spec.whatwg.org/#concept-url-origin) [serializer](https://html.spec.whatwg.org/multipage/origin.html#ascii-serialisation-of-an-origin): `serializeURLOrigin(urlRecord)`\n- [Set the username](https://url.spec.whatwg.org/#set-the-username): `setTheUsername(urlRecord, usernameString)`\n- [Set the password](https://url.spec.whatwg.org/#set-the-password): `setThePassword(urlRecord, passwordString)`\n- [Cannot have a username/password/port](https://url.spec.whatwg.org/#cannot-have-a-username-password-port): `cannotHaveAUsernamePasswordPort(urlRecord)`\n- [Percent decode](https://url.spec.whatwg.org/#percent-decode): `percentDecode(buffer)`\n\nThe `stateOverride` parameter is one of the following strings:\n\n- [`\"scheme start\"`](https://url.spec.whatwg.org/#scheme-start-state)\n- [`\"scheme\"`](https://url.spec.whatwg.org/#scheme-state)\n- [`\"no scheme\"`](https://url.spec.whatwg.org/#no-scheme-state)\n- [`\"special relative or authority\"`](https://url.spec.whatwg.org/#special-relative-or-authority-state)\n- [`\"path or authority\"`](https://url.spec.whatwg.org/#path-or-authority-state)\n- [`\"relative\"`](https://url.spec.whatwg.org/#relative-state)\n- [`\"relative slash\"`](https://url.spec.whatwg.org/#relative-slash-state)\n- [`\"special authority slashes\"`](https://url.spec.whatwg.org/#special-authority-slashes-state)\n- [`\"special authority ignore slashes\"`](https://url.spec.whatwg.org/#special-authority-ignore-slashes-state)\n- [`\"authority\"`](https://url.spec.whatwg.org/#authority-state)\n- [`\"host\"`](https://url.spec.whatwg.org/#host-state)\n- [`\"hostname\"`](https://url.spec.whatwg.org/#hostname-state)\n- [`\"port\"`](https://url.spec.whatwg.org/#port-state)\n- [`\"file\"`](https://url.spec.whatwg.org/#file-state)\n- [`\"file slash\"`](https://url.spec.whatwg.org/#file-slash-state)\n- [`\"file host\"`](https://url.spec.whatwg.org/#file-host-state)\n- [`\"path start\"`](https://url.spec.whatwg.org/#path-start-state)\n- [`\"path\"`](https://url.spec.whatwg.org/#path-state)\n- [`\"cannot-be-a-base-URL path\"`](https://url.spec.whatwg.org/#cannot-be-a-base-url-path-state)\n- [`\"query\"`](https://url.spec.whatwg.org/#query-state)\n- [`\"fragment\"`](https://url.spec.whatwg.org/#fragment-state)\n\nThe URL record type has the following API:\n\n- [`scheme`](https://url.spec.whatwg.org/#concept-url-scheme)\n- [`username`](https://url.spec.whatwg.org/#concept-url-username)\n- [`password`](https://url.spec.whatwg.org/#concept-url-password)\n- [`host`](https://url.spec.whatwg.org/#concept-url-host)\n- [`port`](https://url.spec.whatwg.org/#concept-url-port)\n- [`path`](https://url.spec.whatwg.org/#concept-url-path) (as an array)\n- [`query`](https://url.spec.whatwg.org/#concept-url-query)\n- [`fragment`](https://url.spec.whatwg.org/#concept-url-fragment)\n- [`cannotBeABaseURL`](https://url.spec.whatwg.org/#url-cannot-be-a-base-url-flag) (as a boolean)\n\nThese properties should be treated with care, as in general changing them will cause the URL record to be in an inconsistent state until the appropriate invocation of `basicURLParse` is used to fix it up. You can see examples of this in the URL Standard, where there are many step sequences like \"4. Set context object’s url’s fragment to the empty string. 5. Basic URL parse _input_ with context object’s url as _url_ and fragment state as _state override_.\" In between those two steps, a URL record is in an unusable state.\n\nThe return value of \"failure\" in the spec is represented by `null`. That is, functions like `parseURL` and `basicURLParse` can return _either_ a URL record _or_ `null`.\n\n## Development instructions\n\nFirst, install [Node.js](https://nodejs.org/). Then, fetch the dependencies of whatwg-url, by running from this directory:\n\n npm install\n\nTo run tests:\n\n npm test\n\nTo generate a coverage report:\n\n npm run coverage\n\nTo build and run the live viewer:\n\n npm run build\n npm run build-live-viewer\n\nServe the contents of the `live-viewer` directory using any web server.\n\n## Supporting whatwg-url\n\nThe jsdom project (including whatwg-url) is a community-driven project maintained by a team of [volunteers](https://github.com/orgs/jsdom/people). You could support us by:\n\n- [Getting professional support for whatwg-url](https://tidelift.com/subscription/pkg/npm-whatwg-url?utm_source=npm-whatwg-url&utm_medium=referral&utm_campaign=readme) as part of a Tidelift subscription. Tidelift helps making open source sustainable for us while giving teams assurances for maintenance, licensing, and security.\n- Contributing directly to the project.\n# Validate XML Names and Qualified Names\n\nThis package simply tells you whether or not a string matches the [`Name`](http://www.w3.org/TR/xml/#NT-Name) or [`QName`](http://www.w3.org/TR/xml-names/#NT-QName) productions in the XML Namespaces specification. We use it for implementing the [validate](https://dom.spec.whatwg.org/#validate) algorithm in jsdom, but you can use it for whatever you want.\n\n## Usage\n\nThis package's main module's default export takes a string and will return an object of the form `{ success, error }`, where `success` is a boolean and if it is `false`, then `error` is a string containing some hint as to where the match went wrong.\n\n```js\n\"use strict\":\nvar xnv = require(\"xml-name-validator\");\nvar assert = require(\"assert\");\n\n// Will return { success: true, error: undefined }\nxnv.name(\"x\");\nxnv.name(\":\");\nxnv.name(\"a:0\");\nxnv.name(\"a:b:c\");\n\n// Will return { success: false, error: <an explanatory string> }\nxnv.name(\"\\\\\");\nxnv.name(\"'\");\nxnv.name(\"0\");\nxnv.name(\"a!\");\n\n// Will return { success: true, error: undefined }\nxnv.qname(\"x\");\nxnv.qname(\"a0\");\nxnv.qname(\"a:b\");\n\n// Will return { success: false, error: <an explanatory string> }\nxnv.qname(\":a\");\nxnv.qname(\":b\");\nxnv.qname(\"a:b:c\");\nxnv.qname(\"a:0\");\n```\n# safe-buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]\n\n[travis-image]: https://img.shields.io/travis/feross/safe-buffer/master.svg\n[travis-url]: https://travis-ci.org/feross/safe-buffer\n[npm-image]: https://img.shields.io/npm/v/safe-buffer.svg\n[npm-url]: https://npmjs.org/package/safe-buffer\n[downloads-image]: https://img.shields.io/npm/dm/safe-buffer.svg\n[downloads-url]: https://npmjs.org/package/safe-buffer\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n\n#### Safer Node.js Buffer API\n\n**Use the new Node.js Buffer APIs (`Buffer.from`, `Buffer.alloc`,\n`Buffer.allocUnsafe`, `Buffer.allocUnsafeSlow`) in all versions of Node.js.**\n\n**Uses the built-in implementation when available.**\n\n## install\n\n```\nnpm install safe-buffer\n```\n\n## usage\n\nThe goal of this package is to provide a safe replacement for the node.js `Buffer`.\n\nIt's a drop-in replacement for `Buffer`. You can use it by adding one `require` line to\nthe top of your node.js modules:\n\n```js\nvar Buffer = require('safe-buffer').Buffer\n\n// Existing buffer code will continue to work without issues:\n\nnew Buffer('hey', 'utf8')\nnew Buffer([1, 2, 3], 'utf8')\nnew Buffer(obj)\nnew Buffer(16) // create an uninitialized buffer (potentially unsafe)\n\n// But you can use these new explicit APIs to make clear what you want:\n\nBuffer.from('hey', 'utf8') // convert from many types to a Buffer\nBuffer.alloc(16) // create a zero-filled buffer (safe)\nBuffer.allocUnsafe(16) // create an uninitialized buffer (potentially unsafe)\n```\n\n## api\n\n### Class Method: Buffer.from(array)\n<!-- YAML\nadded: v3.0.0\n-->\n\n* `array` {Array}\n\nAllocates a new `Buffer` using an `array` of octets.\n\n```js\nconst buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);\n // creates a new Buffer containing ASCII bytes\n // ['b','u','f','f','e','r']\n```\n\nA `TypeError` will be thrown if `array` is not an `Array`.\n\n### Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or\n a `new ArrayBuffer()`\n* `byteOffset` {Number} Default: `0`\n* `length` {Number} Default: `arrayBuffer.length - byteOffset`\n\nWhen passed a reference to the `.buffer` property of a `TypedArray` instance,\nthe newly created `Buffer` will share the same allocated memory as the\nTypedArray.\n\n```js\nconst arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = Buffer.from(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n // Prints: <Buffer 88 13 70 17>\n```\n\nThe optional `byteOffset` and `length` arguments specify a memory range within\nthe `arrayBuffer` that will be shared by the `Buffer`.\n\n```js\nconst ab = new ArrayBuffer(10);\nconst buf = Buffer.from(ab, 0, 2);\nconsole.log(buf.length);\n // Prints: 2\n```\n\nA `TypeError` will be thrown if `arrayBuffer` is not an `ArrayBuffer`.\n\n### Class Method: Buffer.from(buffer)\n<!-- YAML\nadded: v3.0.0\n-->\n\n* `buffer` {Buffer}\n\nCopies the passed `buffer` data onto a new `Buffer` instance.\n\n```js\nconst buf1 = Buffer.from('buffer');\nconst buf2 = Buffer.from(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n // 'auffer'\nconsole.log(buf2.toString());\n // 'buffer' (copy is not changed)\n```\n\nA `TypeError` will be thrown if `buffer` is not a `Buffer`.\n\n### Class Method: Buffer.from(str[, encoding])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `str` {String} String to encode.\n* `encoding` {String} Encoding to use, Default: `'utf8'`\n\nCreates a new `Buffer` containing the given JavaScript string `str`. If\nprovided, the `encoding` parameter identifies the character encoding.\nIf not provided, `encoding` defaults to `'utf8'`.\n\n```js\nconst buf1 = Buffer.from('this is a tést');\nconsole.log(buf1.toString());\n // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n // prints: this is a tC)st\n\nconst buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n // prints: this is a tést\n```\n\nA `TypeError` will be thrown if `str` is not a string.\n\n### Class Method: Buffer.alloc(size[, fill[, encoding]])\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n* `fill` {Value} Default: `undefined`\n* `encoding` {String} Default: `utf8`\n\nAllocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the\n`Buffer` will be *zero-filled*.\n\n```js\nconst buf = Buffer.alloc(5);\nconsole.log(buf);\n // <Buffer 00 00 00 00 00>\n```\n\nThe `size` must be less than or equal to the value of\n`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is\n`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will\nbe created if a `size` less than or equal to 0 is specified.\n\nIf `fill` is specified, the allocated `Buffer` will be initialized by calling\n`buf.fill(fill)`. See [`buf.fill()`][] for more information.\n\n```js\nconst buf = Buffer.alloc(5, 'a');\nconsole.log(buf);\n // <Buffer 61 61 61 61 61>\n```\n\nIf both `fill` and `encoding` are specified, the allocated `Buffer` will be\ninitialized by calling `buf.fill(fill, encoding)`. For example:\n\n```js\nconst buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');\nconsole.log(buf);\n // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>\n```\n\nCalling `Buffer.alloc(size)` can be significantly slower than the alternative\n`Buffer.allocUnsafe(size)` but ensures that the newly created `Buffer` instance\ncontents will *never contain sensitive data*.\n\nA `TypeError` will be thrown if `size` is not a number.\n\n### Class Method: Buffer.allocUnsafe(size)\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n\nAllocates a new *non-zero-filled* `Buffer` of `size` bytes. The `size` must\nbe less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit\narchitectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is\nthrown. A zero-length Buffer will be created if a `size` less than or equal to\n0 is specified.\n\nThe underlying memory for `Buffer` instances created in this way is *not\ninitialized*. The contents of the newly created `Buffer` are unknown and\n*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such\n`Buffer` instances to zeroes.\n\n```js\nconst buf = Buffer.allocUnsafe(5);\nconsole.log(buf);\n // <Buffer 78 e0 82 02 01>\n // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n // <Buffer 00 00 00 00 00>\n```\n\nA `TypeError` will be thrown if `size` is not a number.\n\nNote that the `Buffer` module pre-allocates an internal `Buffer` instance of\nsize `Buffer.poolSize` that is used as a pool for the fast allocation of new\n`Buffer` instances created using `Buffer.allocUnsafe(size)` (and the deprecated\n`new Buffer(size)` constructor) only when `size` is less than or equal to\n`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). The default\nvalue of `Buffer.poolSize` is `8192` but can be modified.\n\nUse of this pre-allocated internal memory pool is a key difference between\ncalling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.\nSpecifically, `Buffer.alloc(size, fill)` will *never* use the internal Buffer\npool, while `Buffer.allocUnsafe(size).fill(fill)` *will* use the internal\nBuffer pool if `size` is less than or equal to half `Buffer.poolSize`. The\ndifference is subtle but can be important when an application requires the\nadditional performance that `Buffer.allocUnsafe(size)` provides.\n\n### Class Method: Buffer.allocUnsafeSlow(size)\n<!-- YAML\nadded: v5.10.0\n-->\n\n* `size` {Number}\n\nAllocates a new *non-zero-filled* and non-pooled `Buffer` of `size` bytes. The\n`size` must be less than or equal to the value of\n`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is\n`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will\nbe created if a `size` less than or equal to 0 is specified.\n\nThe underlying memory for `Buffer` instances created in this way is *not\ninitialized*. The contents of the newly created `Buffer` are unknown and\n*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such\n`Buffer` instances to zeroes.\n\nWhen using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,\nallocations under 4KB are, by default, sliced from a single pre-allocated\n`Buffer`. This allows applications to avoid the garbage collection overhead of\ncreating many individually allocated Buffers. This approach improves both\nperformance and memory usage by eliminating the need to track and cleanup as\nmany `Persistent` objects.\n\nHowever, in the case where a developer may need to retain a small chunk of\nmemory from a pool for an indeterminate amount of time, it may be appropriate\nto create an un-pooled Buffer instance using `Buffer.allocUnsafeSlow()` then\ncopy out the relevant bits.\n\n```js\n// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n const data = socket.read();\n // allocate for retained data\n const sb = Buffer.allocUnsafeSlow(10);\n // copy the data into the new allocation\n data.copy(sb, 0, 0, 10);\n store.push(sb);\n});\n```\n\nUse of `Buffer.allocUnsafeSlow()` should be used only as a last resort *after*\na developer has observed undue memory retention in their applications.\n\nA `TypeError` will be thrown if `size` is not a number.\n\n### All the Rest\n\nThe rest of the `Buffer` API is exactly the same as in node.js.\n[See the docs](https://nodejs.org/api/buffer.html).\n\n## Related links\n\n- [Node.js issue: Buffer(number) is unsafe](https://github.com/nodejs/node/issues/4660)\n- [Node.js Enhancement Proposal: Buffer.from/Buffer.alloc/Buffer.zalloc/Buffer() soft-deprecate](https://github.com/nodejs/node-eps/pull/4)\n\n## Why is `Buffer` unsafe?\n\nToday, the node.js `Buffer` constructor is overloaded to handle many different argument\ntypes like `String`, `Array`, `Object`, `TypedArrayView` (`Uint8Array`, etc.),\n`ArrayBuffer`, and also `Number`.\n\nThe API is optimized for convenience: you can throw any type at it, and it will try to do\nwhat you want.\n\nBecause the Buffer constructor is so powerful, you often see code like this:\n\n```js\n// Convert UTF-8 strings to hex\nfunction toHex (str) {\n return new Buffer(str).toString('hex')\n}\n```\n\n***But what happens if `toHex` is called with a `Number` argument?***\n\n### Remote Memory Disclosure\n\nIf an attacker can make your program call the `Buffer` constructor with a `Number`\nargument, then they can make it allocate uninitialized memory from the node.js process.\nThis could potentially disclose TLS private keys, user data, or database passwords.\n\nWhen the `Buffer` constructor is passed a `Number` argument, it returns an\n**UNINITIALIZED** block of memory of the specified `size`. When you create a `Buffer` like\nthis, you **MUST** overwrite the contents before returning it to the user.\n\nFrom the [node.js docs](https://nodejs.org/api/buffer.html#buffer_new_buffer_size):\n\n> `new Buffer(size)`\n>\n> - `size` Number\n>\n> The underlying memory for `Buffer` instances created in this way is not initialized.\n> **The contents of a newly created `Buffer` are unknown and could contain sensitive\n> data.** Use `buf.fill(0)` to initialize a Buffer to zeroes.\n\n(Emphasis our own.)\n\nWhenever the programmer intended to create an uninitialized `Buffer` you often see code\nlike this:\n\n```js\nvar buf = new Buffer(16)\n\n// Immediately overwrite the uninitialized buffer with data from another buffer\nfor (var i = 0; i < buf.length; i++) {\n buf[i] = otherBuf[i]\n}\n```\n\n### Would this ever be a problem in real code?\n\nYes. It's surprisingly common to forget to check the type of your variables in a\ndynamically-typed language like JavaScript.\n\nUsually the consequences of assuming the wrong type is that your program crashes with an\nuncaught exception. But the failure mode for forgetting to check the type of arguments to\nthe `Buffer` constructor is more catastrophic.\n\nHere's an example of a vulnerable service that takes a JSON payload and converts it to\nhex:\n\n```js\n// Take a JSON payload {str: \"some string\"} and convert it to hex\nvar server = http.createServer(function (req, res) {\n var data = ''\n req.setEncoding('utf8')\n req.on('data', function (chunk) {\n data += chunk\n })\n req.on('end', function () {\n var body = JSON.parse(data)\n res.end(new Buffer(body.str).toString('hex'))\n })\n})\n\nserver.listen(8080)\n```\n\nIn this example, an http client just has to send:\n\n```json\n{\n \"str\": 1000\n}\n```\n\nand it will get back 1,000 bytes of uninitialized memory from the server.\n\nThis is a very serious bug. It's similar in severity to the\n[the Heartbleed bug](http://heartbleed.com/) that allowed disclosure of OpenSSL process\nmemory by remote attackers.\n\n### Which real-world packages were vulnerable?\n\n#### [`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht)\n\n[Mathias Buus](https://github.com/mafintosh) and I\n([Feross Aboukhadijeh](http://feross.org/)) found this issue in one of our own packages,\n[`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht). The bug would allow\nanyone on the internet to send a series of messages to a user of `bittorrent-dht` and get\nthem to reveal 20 bytes at a time of uninitialized memory from the node.js process.\n\nHere's\n[the commit](https://github.com/feross/bittorrent-dht/commit/6c7da04025d5633699800a99ec3fbadf70ad35b8)\nthat fixed it. We released a new fixed version, created a\n[Node Security Project disclosure](https://nodesecurity.io/advisories/68), and deprecated all\nvulnerable versions on npm so users will get a warning to upgrade to a newer version.\n\n#### [`ws`](https://www.npmjs.com/package/ws)\n\nThat got us wondering if there were other vulnerable packages. Sure enough, within a short\nperiod of time, we found the same issue in [`ws`](https://www.npmjs.com/package/ws), the\nmost popular WebSocket implementation in node.js.\n\nIf certain APIs were called with `Number` parameters instead of `String` or `Buffer` as\nexpected, then uninitialized server memory would be disclosed to the remote peer.\n\nThese were the vulnerable methods:\n\n```js\nsocket.send(number)\nsocket.ping(number)\nsocket.pong(number)\n```\n\nHere's a vulnerable socket server with some echo functionality:\n\n```js\nserver.on('connection', function (socket) {\n socket.on('message', function (message) {\n message = JSON.parse(message)\n if (message.type === 'echo') {\n socket.send(message.data) // send back the user's message\n }\n })\n})\n```\n\n`socket.send(number)` called on the server, will disclose server memory.\n\nHere's [the release](https://github.com/websockets/ws/releases/tag/1.0.1) where the issue\nwas fixed, with a more detailed explanation. Props to\n[Arnout Kazemier](https://github.com/3rd-Eden) for the quick fix. Here's the\n[Node Security Project disclosure](https://nodesecurity.io/advisories/67).\n\n### What's the solution?\n\nIt's important that node.js offers a fast way to get memory otherwise performance-critical\napplications would needlessly get a lot slower.\n\nBut we need a better way to *signal our intent* as programmers. **When we want\nuninitialized memory, we should request it explicitly.**\n\nSensitive functionality should not be packed into a developer-friendly API that loosely\naccepts many different types. This type of API encourages the lazy practice of passing\nvariables in without checking the type very carefully.\n\n#### A new API: `Buffer.allocUnsafe(number)`\n\nThe functionality of creating buffers with uninitialized memory should be part of another\nAPI. We propose `Buffer.allocUnsafe(number)`. This way, it's not part of an API that\nfrequently gets user input of all sorts of different types passed into it.\n\n```js\nvar buf = Buffer.allocUnsafe(16) // careful, uninitialized memory!\n\n// Immediately overwrite the uninitialized buffer with data from another buffer\nfor (var i = 0; i < buf.length; i++) {\n buf[i] = otherBuf[i]\n}\n```\n\n### How do we fix node.js core?\n\nWe sent [a PR to node.js core](https://github.com/nodejs/node/pull/4514) (merged as\n`semver-major`) which defends against one case:\n\n```js\nvar str = 16\nnew Buffer(str, 'utf8')\n```\n\nIn this situation, it's implied that the programmer intended the first argument to be a\nstring, since they passed an encoding as a second argument. Today, node.js will allocate\nuninitialized memory in the case of `new Buffer(number, encoding)`, which is probably not\nwhat the programmer intended.\n\nBut this is only a partial solution, since if the programmer does `new Buffer(variable)`\n(without an `encoding` parameter) there's no way to know what they intended. If `variable`\nis sometimes a number, then uninitialized memory will sometimes be returned.\n\n### What's the real long-term fix?\n\nWe could deprecate and remove `new Buffer(number)` and use `Buffer.allocUnsafe(number)` when\nwe need uninitialized memory. But that would break 1000s of packages.\n\n~~We believe the best solution is to:~~\n\n~~1. Change `new Buffer(number)` to return safe, zeroed-out memory~~\n\n~~2. Create a new API for creating uninitialized Buffers. We propose: `Buffer.allocUnsafe(number)`~~\n\n#### Update\n\nWe now support adding three new APIs:\n\n- `Buffer.from(value)` - convert from any type to a buffer\n- `Buffer.alloc(size)` - create a zero-filled buffer\n- `Buffer.allocUnsafe(size)` - create an uninitialized buffer with given size\n\nThis solves the core problem that affected `ws` and `bittorrent-dht` which is\n`Buffer(variable)` getting tricked into taking a number argument.\n\nThis way, existing code continues working and the impact on the npm ecosystem will be\nminimal. Over time, npm maintainers can migrate performance-critical code to use\n`Buffer.allocUnsafe(number)` instead of `new Buffer(number)`.\n\n### Conclusion\n\nWe think there's a serious design issue with the `Buffer` API as it exists today. It\npromotes insecure software by putting high-risk functionality into a convenient API\nwith friendly \"developer ergonomics\".\n\nThis wasn't merely a theoretical exercise because we found the issue in some of the\nmost popular npm packages.\n\nFortunately, there's an easy fix that can be applied today. Use `safe-buffer` in place of\n`buffer`.\n\n```js\nvar Buffer = require('safe-buffer').Buffer\n```\n\nEventually, we hope that node.js core can switch to this new, safer behavior. We believe\nthe impact on the ecosystem would be minimal since it's not a breaking change.\nWell-maintained, popular packages would be updated to use `Buffer.alloc` quickly, while\nolder, insecure packages would magically become safe from this attack vector.\n\n## links\n\n- [Node.js PR: buffer: throw if both length and enc are passed](https://github.com/nodejs/node/pull/4514)\n- [Node Security Project disclosure for `ws`](https://nodesecurity.io/advisories/67)\n- [Node Security Project disclosure for`bittorrent-dht`](https://nodesecurity.io/advisories/68)\n\n## credit\n\nThe original issues in `bittorrent-dht`\n([disclosure](https://nodesecurity.io/advisories/68)) and\n`ws` ([disclosure](https://nodesecurity.io/advisories/67)) were discovered by\n[Mathias Buus](https://github.com/mafintosh) and\n[Feross Aboukhadijeh](http://feross.org/).\n\nThanks to [Adam Baldwin](https://github.com/evilpacket) for helping disclose these issues\nand for his work running the [Node Security Project](https://nodesecurity.io/).\n\nThanks to [John Hiesey](https://github.com/jhiesey) for proofreading this README and\nauditing the code.\n\n## license\n\nMIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org)\n# kind-of [](https://www.npmjs.com/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://travis-ci.org/jonschlinkert/kind-of)\n\n> Get the native type of a value.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save kind-of\n```\n\n## Install\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install kind-of --save\n```\n\n## Usage\n\n> es5, browser and es6 ready\n\n```js\nvar kindOf = require('kind-of');\n\nkindOf(undefined);\n//=> 'undefined'\n\nkindOf(null);\n//=> 'null'\n\nkindOf(true);\n//=> 'boolean'\n\nkindOf(false);\n//=> 'boolean'\n\nkindOf(new Boolean(true));\n//=> 'boolean'\n\nkindOf(new Buffer(''));\n//=> 'buffer'\n\nkindOf(42);\n//=> 'number'\n\nkindOf(new Number(42));\n//=> 'number'\n\nkindOf('str');\n//=> 'string'\n\nkindOf(new String('str'));\n//=> 'string'\n\nkindOf(arguments);\n//=> 'arguments'\n\nkindOf({});\n//=> 'object'\n\nkindOf(Object.create(null));\n//=> 'object'\n\nkindOf(new Test());\n//=> 'object'\n\nkindOf(new Date());\n//=> 'date'\n\nkindOf([]);\n//=> 'array'\n\nkindOf([1, 2, 3]);\n//=> 'array'\n\nkindOf(new Array());\n//=> 'array'\n\nkindOf(/foo/);\n//=> 'regexp'\n\nkindOf(new RegExp('foo'));\n//=> 'regexp'\n\nkindOf(function () {});\n//=> 'function'\n\nkindOf(function * () {});\n//=> 'function'\n\nkindOf(new Function());\n//=> 'function'\n\nkindOf(new Map());\n//=> 'map'\n\nkindOf(new WeakMap());\n//=> 'weakmap'\n\nkindOf(new Set());\n//=> 'set'\n\nkindOf(new WeakSet());\n//=> 'weakset'\n\nkindOf(Symbol('str'));\n//=> 'symbol'\n\nkindOf(new Int8Array());\n//=> 'int8array'\n\nkindOf(new Uint8Array());\n//=> 'uint8array'\n\nkindOf(new Uint8ClampedArray());\n//=> 'uint8clampedarray'\n\nkindOf(new Int16Array());\n//=> 'int16array'\n\nkindOf(new Uint16Array());\n//=> 'uint16array'\n\nkindOf(new Int32Array());\n//=> 'int32array'\n\nkindOf(new Uint32Array());\n//=> 'uint32array'\n\nkindOf(new Float32Array());\n//=> 'float32array'\n\nkindOf(new Float64Array());\n//=> 'float64array'\n```\n\n## Benchmarks\n\nBenchmarked against [typeof](http://github.com/CodingFu/typeof) and [type-of](https://github.com/ForbesLindesay/type-of).\nNote that performaces is slower for es6 features `Map`, `WeakMap`, `Set` and `WeakSet`.\n\n```bash\n#1: array\n current x 23,329,397 ops/sec ±0.82% (94 runs sampled)\n lib-type-of x 4,170,273 ops/sec ±0.55% (94 runs sampled)\n lib-typeof x 9,686,935 ops/sec ±0.59% (98 runs sampled)\n\n#2: boolean\n current x 27,197,115 ops/sec ±0.85% (94 runs sampled)\n lib-type-of x 3,145,791 ops/sec ±0.73% (97 runs sampled)\n lib-typeof x 9,199,562 ops/sec ±0.44% (99 runs sampled)\n\n#3: date\n current x 20,190,117 ops/sec ±0.86% (92 runs sampled)\n lib-type-of x 5,166,970 ops/sec ±0.74% (94 runs sampled)\n lib-typeof x 9,610,821 ops/sec ±0.50% (96 runs sampled)\n\n#4: function\n current x 23,855,460 ops/sec ±0.60% (97 runs sampled)\n lib-type-of x 5,667,740 ops/sec ±0.54% (100 runs sampled)\n lib-typeof x 10,010,644 ops/sec ±0.44% (100 runs sampled)\n\n#5: null\n current x 27,061,047 ops/sec ±0.97% (96 runs sampled)\n lib-type-of x 13,965,573 ops/sec ±0.62% (97 runs sampled)\n lib-typeof x 8,460,194 ops/sec ±0.61% (97 runs sampled)\n\n#6: number\n current x 25,075,682 ops/sec ±0.53% (99 runs sampled)\n lib-type-of x 2,266,405 ops/sec ±0.41% (98 runs sampled)\n lib-typeof x 9,821,481 ops/sec ±0.45% (99 runs sampled)\n\n#7: object\n current x 3,348,980 ops/sec ±0.49% (99 runs sampled)\n lib-type-of x 3,245,138 ops/sec ±0.60% (94 runs sampled)\n lib-typeof x 9,262,952 ops/sec ±0.59% (99 runs sampled)\n\n#8: regex\n current x 21,284,827 ops/sec ±0.72% (96 runs sampled)\n lib-type-of x 4,689,241 ops/sec ±0.43% (100 runs sampled)\n lib-typeof x 8,957,593 ops/sec ±0.62% (98 runs sampled)\n\n#9: string\n current x 25,379,234 ops/sec ±0.58% (96 runs sampled)\n lib-type-of x 3,635,148 ops/sec ±0.76% (93 runs sampled)\n lib-typeof x 9,494,134 ops/sec ±0.49% (98 runs sampled)\n\n#10: undef\n current x 27,459,221 ops/sec ±1.01% (93 runs sampled)\n lib-type-of x 14,360,433 ops/sec ±0.52% (99 runs sampled)\n lib-typeof x 23,202,868 ops/sec ±0.59% (94 runs sampled)\n\n```\n\n## Optimizations\n\nIn 7 out of 8 cases, this library is 2x-10x faster than other top libraries included in the benchmarks. There are a few things that lead to this performance advantage, none of them hard and fast rules, but all of them simple and repeatable in almost any code library:\n\n1. Optimize around the fastest and most common use cases first. Of course, this will change from project-to-project, but I took some time to understand how and why `typeof` checks were being used in my own libraries and other libraries I use a lot.\n2. Optimize around bottlenecks - In other words, the order in which conditionals are implemented is significant, because each check is only as fast as the failing checks that came before it. Here, the biggest bottleneck by far is checking for plain objects (an object that was created by the `Object` constructor). I opted to make this check happen by process of elimination rather than brute force up front (e.g. by using something like `val.constructor.name`), so that every other type check would not be penalized it.\n3. Don't do uneccessary processing - why do `.slice(8, -1).toLowerCase();` just to get the word `regex`? It's much faster to do `if (type === '[object RegExp]') return 'regex'`\n\n## About\n\n### Related projects\n\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [is-number](https://www.npmjs.com/package/is-number): Returns true if the value is a number. comprehensive tests. | [homepage](https://github.com/jonschlinkert/is-number \"Returns true if the value is a number. comprehensive tests.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 59 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [miguelmota](https://github.com/miguelmota) |\n| 1 | [dtothefp](https://github.com/dtothefp) |\n| 1 | [ksheedlo](https://github.com/ksheedlo) |\n| 1 | [pdehaan](https://github.com/pdehaan) |\n| 1 | [laggingreflex](https://github.com/laggingreflex) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 16, 2017._\nTweetNaCl.js\n============\n\nPort of [TweetNaCl](http://tweetnacl.cr.yp.to) / [NaCl](http://nacl.cr.yp.to/)\nto JavaScript for modern browsers and Node.js. Public domain.\n\n[\n](https://travis-ci.org/dchest/tweetnacl-js)\n\nDemo: <https://tweetnacl.js.org>\n\n**:warning: The library is stable and API is frozen, however it has not been\nindependently reviewed. If you can help reviewing it, please [contact\nme](mailto:dmitry@codingrobots.com).**\n\nDocumentation\n=============\n\n* [Overview](#overview)\n* [Installation](#installation)\n* [Usage](#usage)\n * [Public-key authenticated encryption (box)](#public-key-authenticated-encryption-box)\n * [Secret-key authenticated encryption (secretbox)](#secret-key-authenticated-encryption-secretbox)\n * [Scalar multiplication](#scalar-multiplication)\n * [Signatures](#signatures)\n * [Hashing](#hashing)\n * [Random bytes generation](#random-bytes-generation)\n * [Constant-time comparison](#constant-time-comparison)\n* [System requirements](#system-requirements)\n* [Development and testing](#development-and-testing)\n* [Benchmarks](#benchmarks)\n* [Contributors](#contributors)\n* [Who uses it](#who-uses-it)\n\nOverview\n--------\n\nThe primary goal of this project is to produce a translation of TweetNaCl to\nJavaScript which is as close as possible to the original C implementation, plus\na thin layer of idiomatic high-level API on top of it.\n\nThere are two versions, you can use either of them:\n\n* `nacl.js` is the port of TweetNaCl with minimum differences from the\n original + high-level API.\n\n* `nacl-fast.js` is like `nacl.js`, but with some functions replaced with\n faster versions.\n\nInstallation\n------------\n\nYou can install TweetNaCl.js via a package manager:\n\n[Bower](http://bower.io):\n\n $ bower install tweetnacl\n\n[NPM](https://www.npmjs.org/):\n\n $ npm install tweetnacl\n\nor [download source code](https://github.com/dchest/tweetnacl-js/releases).\n\nUsage\n-----\n\nAll API functions accept and return bytes as `Uint8Array`s. If you need to\nencode or decode strings, use functions from\n<https://github.com/dchest/tweetnacl-util-js> or one of the more robust codec\npackages.\n\nIn Node.js v4 and later `Buffer` objects are backed by `Uint8Array`s, so you\ncan freely pass them to TweetNaCl.js functions as arguments. The returned\nobjects are still `Uint8Array`s, so if you need `Buffer`s, you'll have to\nconvert them manually; make sure to convert using copying: `new Buffer(array)`,\ninstead of sharing: `new Buffer(array.buffer)`, because some functions return\nsubarrays of their buffers.\n\n### Public-key authenticated encryption (box)\n\nImplements *curve25519-xsalsa20-poly1305*.\n\n#### nacl.box.keyPair()\n\nGenerates a new random key pair for box and returns it as an object with\n`publicKey` and `secretKey` members:\n\n {\n publicKey: ..., // Uint8Array with 32-byte public key\n secretKey: ... // Uint8Array with 32-byte secret key\n }\n\n#### nacl.box.keyPair.fromSecretKey(secretKey)\n\nReturns a key pair for box with public key corresponding to the given secret\nkey.\n\n#### nacl.box(message, nonce, theirPublicKey, mySecretKey)\n\nEncrypt and authenticates message using peer's public key, our secret key, and\nthe given nonce, which must be unique for each distinct message for a key pair.\n\nReturns an encrypted and authenticated message, which is\n`nacl.box.overheadLength` longer than the original message.\n\n#### nacl.box.open(box, nonce, theirPublicKey, mySecretKey)\n\nAuthenticates and decrypts the given box with peer's public key, our secret\nkey, and the given nonce.\n\nReturns the original message, or `false` if authentication fails.\n\n#### nacl.box.before(theirPublicKey, mySecretKey)\n\nReturns a precomputed shared key which can be used in `nacl.box.after` and\n`nacl.box.open.after`.\n\n#### nacl.box.after(message, nonce, sharedKey)\n\nSame as `nacl.box`, but uses a shared key precomputed with `nacl.box.before`.\n\n#### nacl.box.open.after(box, nonce, sharedKey)\n\nSame as `nacl.box.open`, but uses a shared key precomputed with `nacl.box.before`.\n\n#### nacl.box.publicKeyLength = 32\n\nLength of public key in bytes.\n\n#### nacl.box.secretKeyLength = 32\n\nLength of secret key in bytes.\n\n#### nacl.box.sharedKeyLength = 32\n\nLength of precomputed shared key in bytes.\n\n#### nacl.box.nonceLength = 24\n\nLength of nonce in bytes.\n\n#### nacl.box.overheadLength = 16\n\nLength of overhead added to box compared to original message.\n\n### Secret-key authenticated encryption (secretbox)\n\nImplements *xsalsa20-poly1305*.\n\n#### nacl.secretbox(message, nonce, key)\n\nEncrypt and authenticates message using the key and the nonce. The nonce must\nbe unique for each distinct message for this key.\n\nReturns an encrypted and authenticated message, which is\n`nacl.secretbox.overheadLength` longer than the original message.\n\n#### nacl.secretbox.open(box, nonce, key)\n\nAuthenticates and decrypts the given secret box using the key and the nonce.\n\nReturns the original message, or `false` if authentication fails.\n\n#### nacl.secretbox.keyLength = 32\n\nLength of key in bytes.\n\n#### nacl.secretbox.nonceLength = 24\n\nLength of nonce in bytes.\n\n#### nacl.secretbox.overheadLength = 16\n\nLength of overhead added to secret box compared to original message.\n\n### Scalar multiplication\n\nImplements *curve25519*.\n\n#### nacl.scalarMult(n, p)\n\nMultiplies an integer `n` by a group element `p` and returns the resulting\ngroup element.\n\n#### nacl.scalarMult.base(n)\n\nMultiplies an integer `n` by a standard group element and returns the resulting\ngroup element.\n\n#### nacl.scalarMult.scalarLength = 32\n\nLength of scalar in bytes.\n\n#### nacl.scalarMult.groupElementLength = 32\n\nLength of group element in bytes.\n\n### Signatures\n\nImplements [ed25519](http://ed25519.cr.yp.to).\n\n#### nacl.sign.keyPair()\n\nGenerates new random key pair for signing and returns it as an object with\n`publicKey` and `secretKey` members:\n\n {\n publicKey: ..., // Uint8Array with 32-byte public key\n secretKey: ... // Uint8Array with 64-byte secret key\n }\n\n#### nacl.sign.keyPair.fromSecretKey(secretKey)\n\nReturns a signing key pair with public key corresponding to the given\n64-byte secret key. The secret key must have been generated by\n`nacl.sign.keyPair` or `nacl.sign.keyPair.fromSeed`.\n\n#### nacl.sign.keyPair.fromSeed(seed)\n\nReturns a new signing key pair generated deterministically from a 32-byte seed.\nThe seed must contain enough entropy to be secure. This method is not\nrecommended for general use: instead, use `nacl.sign.keyPair` to generate a new\nkey pair from a random seed.\n\n#### nacl.sign(message, secretKey)\n\nSigns the message using the secret key and returns a signed message.\n\n#### nacl.sign.open(signedMessage, publicKey)\n\nVerifies the signed message and returns the message without signature.\n\nReturns `null` if verification failed.\n\n#### nacl.sign.detached(message, secretKey)\n\nSigns the message using the secret key and returns a signature.\n\n#### nacl.sign.detached.verify(message, signature, publicKey)\n\nVerifies the signature for the message and returns `true` if verification\nsucceeded or `false` if it failed.\n\n#### nacl.sign.publicKeyLength = 32\n\nLength of signing public key in bytes.\n\n#### nacl.sign.secretKeyLength = 64\n\nLength of signing secret key in bytes.\n\n#### nacl.sign.seedLength = 32\n\nLength of seed for `nacl.sign.keyPair.fromSeed` in bytes.\n\n#### nacl.sign.signatureLength = 64\n\nLength of signature in bytes.\n\n### Hashing\n\nImplements *SHA-512*.\n\n#### nacl.hash(message)\n\nReturns SHA-512 hash of the message.\n\n#### nacl.hash.hashLength = 64\n\nLength of hash in bytes.\n\n### Random bytes generation\n\n#### nacl.randomBytes(length)\n\nReturns a `Uint8Array` of the given length containing random bytes of\ncryptographic quality.\n\n**Implementation note**\n\nTweetNaCl.js uses the following methods to generate random bytes,\ndepending on the platform it runs on:\n\n* `window.crypto.getRandomValues` (WebCrypto standard)\n* `window.msCrypto.getRandomValues` (Internet Explorer 11)\n* `crypto.randomBytes` (Node.js)\n\nIf the platform doesn't provide a suitable PRNG, the following functions,\nwhich require random numbers, will throw exception:\n\n* `nacl.randomBytes`\n* `nacl.box.keyPair`\n* `nacl.sign.keyPair`\n\nOther functions are deterministic and will continue working.\n\nIf a platform you are targeting doesn't implement secure random number\ngenerator, but you somehow have a cryptographically-strong source of entropy\n(not `Math.random`!), and you know what you are doing, you can plug it into\nTweetNaCl.js like this:\n\n nacl.setPRNG(function(x, n) {\n // ... copy n random bytes into x ...\n });\n\nNote that `nacl.setPRNG` *completely replaces* internal random byte generator\nwith the one provided.\n\n### Constant-time comparison\n\n#### nacl.verify(x, y)\n\nCompares `x` and `y` in constant time and returns `true` if their lengths are\nnon-zero and equal, and their contents are equal.\n\nReturns `false` if either of the arguments has zero length, or arguments have\ndifferent lengths, or their contents differ.\n\nSystem requirements\n-------------------\n\nTweetNaCl.js supports modern browsers that have a cryptographically secure\npseudorandom number generator and typed arrays, including the latest versions\nof:\n\n* Chrome\n* Firefox\n* Safari (Mac, iOS)\n* Internet Explorer 11\n\nOther systems:\n\n* Node.js\n\nDevelopment and testing\n------------------------\n\nInstall NPM modules needed for development:\n\n $ npm install\n\nTo build minified versions:\n\n $ npm run build\n\nTests use minified version, so make sure to rebuild it every time you change\n`nacl.js` or `nacl-fast.js`.\n\n### Testing\n\nTo run tests in Node.js:\n\n $ npm run test-node\n\nBy default all tests described here work on `nacl.min.js`. To test other\nversions, set environment variable `NACL_SRC` to the file name you want to test.\nFor example, the following command will test fast minified version:\n\n $ NACL_SRC=nacl-fast.min.js npm run test-node\n\nTo run full suite of tests in Node.js, including comparing outputs of\nJavaScript port to outputs of the original C version:\n\n $ npm run test-node-all\n\nTo prepare tests for browsers:\n\n $ npm run build-test-browser\n\nand then open `test/browser/test.html` (or `test/browser/test-fast.html`) to\nrun them.\n\nTo run headless browser tests with `tape-run` (powered by Electron):\n\n $ npm run test-browser\n\n(If you get `Error: spawn ENOENT`, install *xvfb*: `sudo apt-get install xvfb`.)\n\nTo run tests in both Node and Electron:\n\n $ npm test\n\n### Benchmarking\n\nTo run benchmarks in Node.js:\n\n $ npm run bench\n $ NACL_SRC=nacl-fast.min.js npm run bench\n\nTo run benchmarks in a browser, open `test/benchmark/bench.html` (or\n`test/benchmark/bench-fast.html`).\n\nBenchmarks\n----------\n\nFor reference, here are benchmarks from MacBook Pro (Retina, 13-inch, Mid 2014)\nlaptop with 2.6 GHz Intel Core i5 CPU (Intel) in Chrome 53/OS X and Xiaomi Redmi\nNote 3 smartphone with 1.8 GHz Qualcomm Snapdragon 650 64-bit CPU (ARM) in\nChrome 52/Android:\n\n| | nacl.js Intel | nacl-fast.js Intel | nacl.js ARM | nacl-fast.js ARM |\n| ------------- |:-------------:|:-------------------:|:-------------:|:-----------------:|\n| salsa20 | 1.3 MB/s | 128 MB/s | 0.4 MB/s | 43 MB/s |\n| poly1305 | 13 MB/s | 171 MB/s | 4 MB/s | 52 MB/s |\n| hash | 4 MB/s | 34 MB/s | 0.9 MB/s | 12 MB/s |\n| secretbox 1K | 1113 op/s | 57583 op/s | 334 op/s | 14227 op/s |\n| box 1K | 145 op/s | 718 op/s | 37 op/s | 368 op/s |\n| scalarMult | 171 op/s | 733 op/s | 56 op/s | 380 op/s |\n| sign | 77 op/s | 200 op/s | 20 op/s | 61 op/s |\n| sign.open | 39 op/s | 102 op/s | 11 op/s | 31 op/s |\n\n(You can run benchmarks on your devices by clicking on the links at the bottom\nof the [home page](https://tweetnacl.js.org)).\n\nIn short, with *nacl-fast.js* and 1024-byte messages you can expect to encrypt and\nauthenticate more than 57000 messages per second on a typical laptop or more than\n14000 messages per second on a $170 smartphone, sign about 200 and verify 100\nmessages per second on a laptop or 60 and 30 messages per second on a smartphone,\nper CPU core (with Web Workers you can do these operations in parallel),\nwhich is good enough for most applications.\n\nContributors\n------------\n\nSee AUTHORS.md file.\n\nThird-party libraries based on TweetNaCl.js\n-------------------------------------------\n\n* [forward-secrecy](https://github.com/alax/forward-secrecy) — Axolotl ratchet implementation\n* [nacl-stream](https://github.com/dchest/nacl-stream-js) - streaming encryption\n* [tweetnacl-auth-js](https://github.com/dchest/tweetnacl-auth-js) — implementation of [`crypto_auth`](http://nacl.cr.yp.to/auth.html)\n* [chloride](https://github.com/dominictarr/chloride) - unified API for various NaCl modules\n\nWho uses it\n-----------\n\nSome notable users of TweetNaCl.js:\n\n* [miniLock](http://minilock.io/)\n* [Stellar](https://www.stellar.org/)\n[![npm][npm]][npm-url]\n[![node]]()\n[![deps][deps]][deps-url]\n[![tests][tests]][tests-url]\n[![coverage][cover]][cover-url]\n[![chat][chat]][chat-url]\n\n<div align=\"center\">\n <a href=\"https://github.com/posthtml/posthtml\">\n <img width=\"200\" height=\"200\" alt=\"PostHTML\"\n src=\"http://posthtml.github.io/posthtml/logo.svg\">\n </a>\n <h1>PostHTML Render</h1>\n <p>Renders a PostHTML Tree to HTML/XML</p>\n</div>\n\n<h2 align=\"center\">Install</h2>\n\n```bash\nnpm i -D posthtml-render\n```\n\n> ℹ️ This module is also available for [bower](http://bower.io) and as an AMD, CommonJS and IIFE (global) module, uncompressed and compressed\n\n<h2 align=\"center\">Usage</h2>\n\n### `NodeJS`\n\n```js\nconst render = require('posthtml-render')\n\nconst tree = []\n\nconst node = {}\n\nnode.tag = 'ul'\nnode.attrs = { class: 'list' }\nnode.content = [\n 'one',\n 'two',\n 'three'\n].map((content) => ({ tag: 'li', content }))\n\ntree.push(node)\n\nconst html = render(tree, options)\n\n```\n\n```html\n<ul class=\"list\">\n <li>one</li>\n <li>two</li>\n <li>three</li>\n</ul>\n```\n\n### `🌐 Browser`\n\n```html\n<!DOCTYPE html>\n<html>\n<head>\n <title>Title</title>\n <script src=\"./node_modules/posthtml-render/lib/browser.min.js\"></script>\n <script >\n const tree = {\n tag: 'h1',\n attrs: {\n style: 'color: red;'\n },\n content: [ 'Title' ]\n }\n\n window.onload = function () {\n document.body.innerHTML = render(tree)\n }\n </script>\n</head>\n<body></body>\n</html>\n```\n\n<h2 align=\"center\">Options</h2>\n\n|Name|Type|Default|Description|\n|:--:|:--:|:-----:|:----------|\n|**[`singleTags`](#singletags)**|`{Array<String\\|RegExp>}`|`[]`|Specify custom single tags (self closing)|\n|**[`closingSingleTag`](#closingSingleTag)**|`{String}`|[`>`](#default)|Specify the single tag closing format|\n|**[`quoteAllAttributes`](#quoteAllAttributes)**|`{Boolean}`|[`true`](#default)|Put double quotes around all tags, even when not necessary.|\n\n### `singleTags`\n\nSpecify custom single tags (self closing)\n\n### `{String}`\n\n```js\nconst render = require('posthtml-render')\n\nconst tree = [ { tag: 'name' } ]\nconst options = { singleTags: [ 'name' ] }\n\nconst html = render(tree, options)\n```\n\n**result.html**\n```html\n<name>\n```\n\n#### `{RegExp}`\n\n```js\nconst render = require('posthtml-render')\n\nconst tree = [ { tag: '%=title%' } ]\nconst options = { singleTags: [ '/^%.*%$/' ] }\n\nconst html = render(tree, options)\n```\n\n**result.html**\n```html\n<%=title%>\n```\n\n### `closingSingleTag`\n\nSpecify the single tag closing format\n\n#### `Formats`\n\n```js\nconst render = require('posthtml-render')\n\nconst tree = [ { tag: 'img' } ]\n```\n\n##### `'tag'`\n\n```js\nconst html = render(tree, { closingSingleTag: 'tag' })\n```\n\n```html\n<custom></custom>\n```\n\n##### `'slash'`\n\n```js\nconst html = render(tree, { closingSingleTag: 'slash' })\n```\n\n```html\n<custom />\n```\n\n##### `'default' (Default)`\n\n```js\nconst html = render(tree)\n```\n\n```html\n<img></img>\n```\n\n### `quoteAllAttributes`\n\nSpecify if all attributes should be quoted.\n\n##### `true (Default)`\n\n```html\n<script src=\"index.js\"></script>\n```\n\n##### `false`\n\n```html\n<script src=index.js></script>\n```\n\n[npm]: https://img.shields.io/npm/v/posthtml-render.svg\n[npm-url]: https://npmjs.com/package/posthtml-render\n\n[node]: https://img.shields.io/node/v/posthtml-render.svg\n[node-url]: https://img.shields.io/node/v/posthtml-render.svg\n\n[deps]: https://david-dm.org/posthtml/posthtml-render.svg\n[deps-url]: https://david-dm.org/posthtml/posthtml-render\n\n[tests]: http://img.shields.io/travis/posthtml/posthtml-render.svg\n[tests-url]: https://travis-ci.org/posthtml/posthtml-render\n\n[cover]: https://coveralls.io/repos/github/posthtml/posthtml-render/badge.svg\n[cover-url]: https://coveralls.io/github/posthtml/posthtml-render\n\n[chat]: https://badges.gitter.im/posthtml/posthtml.svg\n[chat-url]: https://gitter.im/posthtml/posthtml\n# Source Map\n\n[](https://travis-ci.org/mozilla/source-map)\n\n[](https://www.npmjs.com/package/source-map)\n\nThis is a library to generate and consume the source map format\n[described here][format].\n\n[format]: https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit\n\n## Use with Node\n\n $ npm install source-map\n\n## Use on the Web\n\n <script src=\"https://raw.githubusercontent.com/mozilla/source-map/master/dist/source-map.min.js\" defer></script>\n\n--------------------------------------------------------------------------------\n\n<!-- `npm run toc` to regenerate the Table of Contents -->\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n## Table of Contents\n\n- [Examples](#examples)\n - [Consuming a source map](#consuming-a-source-map)\n - [Generating a source map](#generating-a-source-map)\n - [With SourceNode (high level API)](#with-sourcenode-high-level-api)\n - [With SourceMapGenerator (low level API)](#with-sourcemapgenerator-low-level-api)\n- [API](#api)\n - [SourceMapConsumer](#sourcemapconsumer)\n - [new SourceMapConsumer(rawSourceMap)](#new-sourcemapconsumerrawsourcemap)\n - [SourceMapConsumer.prototype.computeColumnSpans()](#sourcemapconsumerprototypecomputecolumnspans)\n - [SourceMapConsumer.prototype.originalPositionFor(generatedPosition)](#sourcemapconsumerprototypeoriginalpositionforgeneratedposition)\n - [SourceMapConsumer.prototype.generatedPositionFor(originalPosition)](#sourcemapconsumerprototypegeneratedpositionfororiginalposition)\n - [SourceMapConsumer.prototype.allGeneratedPositionsFor(originalPosition)](#sourcemapconsumerprototypeallgeneratedpositionsfororiginalposition)\n - [SourceMapConsumer.prototype.hasContentsOfAllSources()](#sourcemapconsumerprototypehascontentsofallsources)\n - [SourceMapConsumer.prototype.sourceContentFor(source[, returnNullOnMissing])](#sourcemapconsumerprototypesourcecontentforsource-returnnullonmissing)\n - [SourceMapConsumer.prototype.eachMapping(callback, context, order)](#sourcemapconsumerprototypeeachmappingcallback-context-order)\n - [SourceMapGenerator](#sourcemapgenerator)\n - [new SourceMapGenerator([startOfSourceMap])](#new-sourcemapgeneratorstartofsourcemap)\n - [SourceMapGenerator.fromSourceMap(sourceMapConsumer)](#sourcemapgeneratorfromsourcemapsourcemapconsumer)\n - [SourceMapGenerator.prototype.addMapping(mapping)](#sourcemapgeneratorprototypeaddmappingmapping)\n - [SourceMapGenerator.prototype.setSourceContent(sourceFile, sourceContent)](#sourcemapgeneratorprototypesetsourcecontentsourcefile-sourcecontent)\n - [SourceMapGenerator.prototype.applySourceMap(sourceMapConsumer[, sourceFile[, sourceMapPath]])](#sourcemapgeneratorprototypeapplysourcemapsourcemapconsumer-sourcefile-sourcemappath)\n - [SourceMapGenerator.prototype.toString()](#sourcemapgeneratorprototypetostring)\n - [SourceNode](#sourcenode)\n - [new SourceNode([line, column, source[, chunk[, name]]])](#new-sourcenodeline-column-source-chunk-name)\n - [SourceNode.fromStringWithSourceMap(code, sourceMapConsumer[, relativePath])](#sourcenodefromstringwithsourcemapcode-sourcemapconsumer-relativepath)\n - [SourceNode.prototype.add(chunk)](#sourcenodeprototypeaddchunk)\n - [SourceNode.prototype.prepend(chunk)](#sourcenodeprototypeprependchunk)\n - [SourceNode.prototype.setSourceContent(sourceFile, sourceContent)](#sourcenodeprototypesetsourcecontentsourcefile-sourcecontent)\n - [SourceNode.prototype.walk(fn)](#sourcenodeprototypewalkfn)\n - [SourceNode.prototype.walkSourceContents(fn)](#sourcenodeprototypewalksourcecontentsfn)\n - [SourceNode.prototype.join(sep)](#sourcenodeprototypejoinsep)\n - [SourceNode.prototype.replaceRight(pattern, replacement)](#sourcenodeprototypereplacerightpattern-replacement)\n - [SourceNode.prototype.toString()](#sourcenodeprototypetostring)\n - [SourceNode.prototype.toStringWithSourceMap([startOfSourceMap])](#sourcenodeprototypetostringwithsourcemapstartofsourcemap)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n## Examples\n\n### Consuming a source map\n\n```js\nvar rawSourceMap = {\n version: 3,\n file: 'min.js',\n names: ['bar', 'baz', 'n'],\n sources: ['one.js', 'two.js'],\n sourceRoot: 'http://example.com/www/js/',\n mappings: 'CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA'\n};\n\nvar smc = new SourceMapConsumer(rawSourceMap);\n\nconsole.log(smc.sources);\n// [ 'http://example.com/www/js/one.js',\n// 'http://example.com/www/js/two.js' ]\n\nconsole.log(smc.originalPositionFor({\n line: 2,\n column: 28\n}));\n// { source: 'http://example.com/www/js/two.js',\n// line: 2,\n// column: 10,\n// name: 'n' }\n\nconsole.log(smc.generatedPositionFor({\n source: 'http://example.com/www/js/two.js',\n line: 2,\n column: 10\n}));\n// { line: 2, column: 28 }\n\nsmc.eachMapping(function (m) {\n // ...\n});\n```\n\n### Generating a source map\n\nIn depth guide:\n[**Compiling to JavaScript, and Debugging with Source Maps**](https://hacks.mozilla.org/2013/05/compiling-to-javascript-and-debugging-with-source-maps/)\n\n#### With SourceNode (high level API)\n\n```js\nfunction compile(ast) {\n switch (ast.type) {\n case 'BinaryExpression':\n return new SourceNode(\n ast.location.line,\n ast.location.column,\n ast.location.source,\n [compile(ast.left), \" + \", compile(ast.right)]\n );\n case 'Literal':\n return new SourceNode(\n ast.location.line,\n ast.location.column,\n ast.location.source,\n String(ast.value)\n );\n // ...\n default:\n throw new Error(\"Bad AST\");\n }\n}\n\nvar ast = parse(\"40 + 2\", \"add.js\");\nconsole.log(compile(ast).toStringWithSourceMap({\n file: 'add.js'\n}));\n// { code: '40 + 2',\n// map: [object SourceMapGenerator] }\n```\n\n#### With SourceMapGenerator (low level API)\n\n```js\nvar map = new SourceMapGenerator({\n file: \"source-mapped.js\"\n});\n\nmap.addMapping({\n generated: {\n line: 10,\n column: 35\n },\n source: \"foo.js\",\n original: {\n line: 33,\n column: 2\n },\n name: \"christopher\"\n});\n\nconsole.log(map.toString());\n// '{\"version\":3,\"file\":\"source-mapped.js\",\"sources\":[\"foo.js\"],\"names\":[\"christopher\"],\"mappings\":\";;;;;;;;;mCAgCEA\"}'\n```\n\n## API\n\nGet a reference to the module:\n\n```js\n// Node.js\nvar sourceMap = require('source-map');\n\n// Browser builds\nvar sourceMap = window.sourceMap;\n\n// Inside Firefox\nconst sourceMap = require(\"devtools/toolkit/sourcemap/source-map.js\");\n```\n\n### SourceMapConsumer\n\nA SourceMapConsumer instance represents a parsed source map which we can query\nfor information about the original file positions by giving it a file position\nin the generated source.\n\n#### new SourceMapConsumer(rawSourceMap)\n\nThe only parameter is the raw source map (either as a string which can be\n`JSON.parse`'d, or an object). According to the spec, source maps have the\nfollowing attributes:\n\n* `version`: Which version of the source map spec this map is following.\n\n* `sources`: An array of URLs to the original source files.\n\n* `names`: An array of identifiers which can be referenced by individual\n mappings.\n\n* `sourceRoot`: Optional. The URL root from which all sources are relative.\n\n* `sourcesContent`: Optional. An array of contents of the original source files.\n\n* `mappings`: A string of base64 VLQs which contain the actual mappings.\n\n* `file`: Optional. The generated filename this source map is associated with.\n\n```js\nvar consumer = new sourceMap.SourceMapConsumer(rawSourceMapJsonData);\n```\n\n#### SourceMapConsumer.prototype.computeColumnSpans()\n\nCompute the last column for each generated mapping. The last column is\ninclusive.\n\n```js\n// Before:\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" })\n// [ { line: 2,\n// column: 1 },\n// { line: 2,\n// column: 10 },\n// { line: 2,\n// column: 20 } ]\n\nconsumer.computeColumnSpans();\n\n// After:\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" })\n// [ { line: 2,\n// column: 1,\n// lastColumn: 9 },\n// { line: 2,\n// column: 10,\n// lastColumn: 19 },\n// { line: 2,\n// column: 20,\n// lastColumn: Infinity } ]\n\n```\n\n#### SourceMapConsumer.prototype.originalPositionFor(generatedPosition)\n\nReturns the original source, line, and column information for the generated\nsource's line and column positions provided. The only argument is an object with\nthe following properties:\n\n* `line`: The line number in the generated source. Line numbers in\n this library are 1-based (note that the underlying source map\n specification uses 0-based line numbers -- this library handles the\n translation).\n\n* `column`: The column number in the generated source. Column numbers\n in this library are 0-based.\n\n* `bias`: Either `SourceMapConsumer.GREATEST_LOWER_BOUND` or\n `SourceMapConsumer.LEAST_UPPER_BOUND`. Specifies whether to return the closest\n element that is smaller than or greater than the one we are searching for,\n respectively, if the exact element cannot be found. Defaults to\n `SourceMapConsumer.GREATEST_LOWER_BOUND`.\n\nand an object is returned with the following properties:\n\n* `source`: The original source file, or null if this information is not\n available.\n\n* `line`: The line number in the original source, or null if this information is\n not available. The line number is 1-based.\n\n* `column`: The column number in the original source, or null if this\n information is not available. The column number is 0-based.\n\n* `name`: The original identifier, or null if this information is not available.\n\n```js\nconsumer.originalPositionFor({ line: 2, column: 10 })\n// { source: 'foo.coffee',\n// line: 2,\n// column: 2,\n// name: null }\n\nconsumer.originalPositionFor({ line: 99999999999999999, column: 999999999999999 })\n// { source: null,\n// line: null,\n// column: null,\n// name: null }\n```\n\n#### SourceMapConsumer.prototype.generatedPositionFor(originalPosition)\n\nReturns the generated line and column information for the original source,\nline, and column positions provided. The only argument is an object with\nthe following properties:\n\n* `source`: The filename of the original source.\n\n* `line`: The line number in the original source. The line number is\n 1-based.\n\n* `column`: The column number in the original source. The column\n number is 0-based.\n\nand an object is returned with the following properties:\n\n* `line`: The line number in the generated source, or null. The line\n number is 1-based.\n\n* `column`: The column number in the generated source, or null. The\n column number is 0-based.\n\n```js\nconsumer.generatedPositionFor({ source: \"example.js\", line: 2, column: 10 })\n// { line: 1,\n// column: 56 }\n```\n\n#### SourceMapConsumer.prototype.allGeneratedPositionsFor(originalPosition)\n\nReturns all generated line and column information for the original source, line,\nand column provided. If no column is provided, returns all mappings\ncorresponding to a either the line we are searching for or the next closest line\nthat has any mappings. Otherwise, returns all mappings corresponding to the\ngiven line and either the column we are searching for or the next closest column\nthat has any offsets.\n\nThe only argument is an object with the following properties:\n\n* `source`: The filename of the original source.\n\n* `line`: The line number in the original source. The line number is\n 1-based.\n\n* `column`: Optional. The column number in the original source. The\n column number is 0-based.\n\nand an array of objects is returned, each with the following properties:\n\n* `line`: The line number in the generated source, or null. The line\n number is 1-based.\n\n* `column`: The column number in the generated source, or null. The\n column number is 0-based.\n\n```js\nconsumer.allGeneratedpositionsfor({ line: 2, source: \"foo.coffee\" })\n// [ { line: 2,\n// column: 1 },\n// { line: 2,\n// column: 10 },\n// { line: 2,\n// column: 20 } ]\n```\n\n#### SourceMapConsumer.prototype.hasContentsOfAllSources()\n\nReturn true if we have the embedded source content for every source listed in\nthe source map, false otherwise.\n\nIn other words, if this method returns `true`, then\n`consumer.sourceContentFor(s)` will succeed for every source `s` in\n`consumer.sources`.\n\n```js\n// ...\nif (consumer.hasContentsOfAllSources()) {\n consumerReadyCallback(consumer);\n} else {\n fetchSources(consumer, consumerReadyCallback);\n}\n// ...\n```\n\n#### SourceMapConsumer.prototype.sourceContentFor(source[, returnNullOnMissing])\n\nReturns the original source content for the source provided. The only\nargument is the URL of the original source file.\n\nIf the source content for the given source is not found, then an error is\nthrown. Optionally, pass `true` as the second param to have `null` returned\ninstead.\n\n```js\nconsumer.sources\n// [ \"my-cool-lib.clj\" ]\n\nconsumer.sourceContentFor(\"my-cool-lib.clj\")\n// \"...\"\n\nconsumer.sourceContentFor(\"this is not in the source map\");\n// Error: \"this is not in the source map\" is not in the source map\n\nconsumer.sourceContentFor(\"this is not in the source map\", true);\n// null\n```\n\n#### SourceMapConsumer.prototype.eachMapping(callback, context, order)\n\nIterate over each mapping between an original source/line/column and a\ngenerated line/column in this source map.\n\n* `callback`: The function that is called with each mapping. Mappings have the\n form `{ source, generatedLine, generatedColumn, originalLine, originalColumn,\n name }`\n\n* `context`: Optional. If specified, this object will be the value of `this`\n every time that `callback` is called.\n\n* `order`: Either `SourceMapConsumer.GENERATED_ORDER` or\n `SourceMapConsumer.ORIGINAL_ORDER`. Specifies whether you want to iterate over\n the mappings sorted by the generated file's line/column order or the\n original's source/line/column order, respectively. Defaults to\n `SourceMapConsumer.GENERATED_ORDER`.\n\n```js\nconsumer.eachMapping(function (m) { console.log(m); })\n// ...\n// { source: 'illmatic.js',\n// generatedLine: 1,\n// generatedColumn: 0,\n// originalLine: 1,\n// originalColumn: 0,\n// name: null }\n// { source: 'illmatic.js',\n// generatedLine: 2,\n// generatedColumn: 0,\n// originalLine: 2,\n// originalColumn: 0,\n// name: null }\n// ...\n```\n### SourceMapGenerator\n\nAn instance of the SourceMapGenerator represents a source map which is being\nbuilt incrementally.\n\n#### new SourceMapGenerator([startOfSourceMap])\n\nYou may pass an object with the following properties:\n\n* `file`: The filename of the generated source that this source map is\n associated with.\n\n* `sourceRoot`: A root for all relative URLs in this source map.\n\n* `skipValidation`: Optional. When `true`, disables validation of mappings as\n they are added. This can improve performance but should be used with\n discretion, as a last resort. Even then, one should avoid using this flag when\n running tests, if possible.\n\n```js\nvar generator = new sourceMap.SourceMapGenerator({\n file: \"my-generated-javascript-file.js\",\n sourceRoot: \"http://example.com/app/js/\"\n});\n```\n\n#### SourceMapGenerator.fromSourceMap(sourceMapConsumer)\n\nCreates a new `SourceMapGenerator` from an existing `SourceMapConsumer` instance.\n\n* `sourceMapConsumer` The SourceMap.\n\n```js\nvar generator = sourceMap.SourceMapGenerator.fromSourceMap(consumer);\n```\n\n#### SourceMapGenerator.prototype.addMapping(mapping)\n\nAdd a single mapping from original source line and column to the generated\nsource's line and column for this source map being created. The mapping object\nshould have the following properties:\n\n* `generated`: An object with the generated line and column positions.\n\n* `original`: An object with the original line and column positions.\n\n* `source`: The original source file (relative to the sourceRoot).\n\n* `name`: An optional original token name for this mapping.\n\n```js\ngenerator.addMapping({\n source: \"module-one.scm\",\n original: { line: 128, column: 0 },\n generated: { line: 3, column: 456 }\n})\n```\n\n#### SourceMapGenerator.prototype.setSourceContent(sourceFile, sourceContent)\n\nSet the source content for an original source file.\n\n* `sourceFile` the URL of the original source file.\n\n* `sourceContent` the content of the source file.\n\n```js\ngenerator.setSourceContent(\"module-one.scm\",\n fs.readFileSync(\"path/to/module-one.scm\"))\n```\n\n#### SourceMapGenerator.prototype.applySourceMap(sourceMapConsumer[, sourceFile[, sourceMapPath]])\n\nApplies a SourceMap for a source file to the SourceMap.\nEach mapping to the supplied source file is rewritten using the\nsupplied SourceMap. Note: The resolution for the resulting mappings\nis the minimum of this map and the supplied map.\n\n* `sourceMapConsumer`: The SourceMap to be applied.\n\n* `sourceFile`: Optional. The filename of the source file.\n If omitted, sourceMapConsumer.file will be used, if it exists.\n Otherwise an error will be thrown.\n\n* `sourceMapPath`: Optional. The dirname of the path to the SourceMap\n to be applied. If relative, it is relative to the SourceMap.\n\n This parameter is needed when the two SourceMaps aren't in the same\n directory, and the SourceMap to be applied contains relative source\n paths. If so, those relative source paths need to be rewritten\n relative to the SourceMap.\n\n If omitted, it is assumed that both SourceMaps are in the same directory,\n thus not needing any rewriting. (Supplying `'.'` has the same effect.)\n\n#### SourceMapGenerator.prototype.toString()\n\nRenders the source map being generated to a string.\n\n```js\ngenerator.toString()\n// '{\"version\":3,\"sources\":[\"module-one.scm\"],\"names\":[],\"mappings\":\"...snip...\",\"file\":\"my-generated-javascript-file.js\",\"sourceRoot\":\"http://example.com/app/js/\"}'\n```\n\n### SourceNode\n\nSourceNodes provide a way to abstract over interpolating and/or concatenating\nsnippets of generated JavaScript source code, while maintaining the line and\ncolumn information associated between those snippets and the original source\ncode. This is useful as the final intermediate representation a compiler might\nuse before outputting the generated JS and source map.\n\n#### new SourceNode([line, column, source[, chunk[, name]]])\n\n* `line`: The original line number associated with this source node, or null if\n it isn't associated with an original line. The line number is 1-based.\n\n* `column`: The original column number associated with this source node, or null\n if it isn't associated with an original column. The column number\n is 0-based.\n\n* `source`: The original source's filename; null if no filename is provided.\n\n* `chunk`: Optional. Is immediately passed to `SourceNode.prototype.add`, see\n below.\n\n* `name`: Optional. The original identifier.\n\n```js\nvar node = new SourceNode(1, 2, \"a.cpp\", [\n new SourceNode(3, 4, \"b.cpp\", \"extern int status;\\n\"),\n new SourceNode(5, 6, \"c.cpp\", \"std::string* make_string(size_t n);\\n\"),\n new SourceNode(7, 8, \"d.cpp\", \"int main(int argc, char** argv) {}\\n\"),\n]);\n```\n\n#### SourceNode.fromStringWithSourceMap(code, sourceMapConsumer[, relativePath])\n\nCreates a SourceNode from generated code and a SourceMapConsumer.\n\n* `code`: The generated code\n\n* `sourceMapConsumer` The SourceMap for the generated code\n\n* `relativePath` The optional path that relative sources in `sourceMapConsumer`\n should be relative to.\n\n```js\nvar consumer = new SourceMapConsumer(fs.readFileSync(\"path/to/my-file.js.map\", \"utf8\"));\nvar node = SourceNode.fromStringWithSourceMap(fs.readFileSync(\"path/to/my-file.js\"),\n consumer);\n```\n\n#### SourceNode.prototype.add(chunk)\n\nAdd a chunk of generated JS to this source node.\n\n* `chunk`: A string snippet of generated JS code, another instance of\n `SourceNode`, or an array where each member is one of those things.\n\n```js\nnode.add(\" + \");\nnode.add(otherNode);\nnode.add([leftHandOperandNode, \" + \", rightHandOperandNode]);\n```\n\n#### SourceNode.prototype.prepend(chunk)\n\nPrepend a chunk of generated JS to this source node.\n\n* `chunk`: A string snippet of generated JS code, another instance of\n `SourceNode`, or an array where each member is one of those things.\n\n```js\nnode.prepend(\"/** Build Id: f783haef86324gf **/\\n\\n\");\n```\n\n#### SourceNode.prototype.setSourceContent(sourceFile, sourceContent)\n\nSet the source content for a source file. This will be added to the\n`SourceMap` in the `sourcesContent` field.\n\n* `sourceFile`: The filename of the source file\n\n* `sourceContent`: The content of the source file\n\n```js\nnode.setSourceContent(\"module-one.scm\",\n fs.readFileSync(\"path/to/module-one.scm\"))\n```\n\n#### SourceNode.prototype.walk(fn)\n\nWalk over the tree of JS snippets in this node and its children. The walking\nfunction is called once for each snippet of JS and is passed that snippet and\nthe its original associated source's line/column location.\n\n* `fn`: The traversal function.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n new SourceNode(3, 4, \"b.js\", \"uno\"),\n \"dos\",\n [\n \"tres\",\n new SourceNode(5, 6, \"c.js\", \"quatro\")\n ]\n]);\n\nnode.walk(function (code, loc) { console.log(\"WALK:\", code, loc); })\n// WALK: uno { source: 'b.js', line: 3, column: 4, name: null }\n// WALK: dos { source: 'a.js', line: 1, column: 2, name: null }\n// WALK: tres { source: 'a.js', line: 1, column: 2, name: null }\n// WALK: quatro { source: 'c.js', line: 5, column: 6, name: null }\n```\n\n#### SourceNode.prototype.walkSourceContents(fn)\n\nWalk over the tree of SourceNodes. The walking function is called for each\nsource file content and is passed the filename and source content.\n\n* `fn`: The traversal function.\n\n```js\nvar a = new SourceNode(1, 2, \"a.js\", \"generated from a\");\na.setSourceContent(\"a.js\", \"original a\");\nvar b = new SourceNode(1, 2, \"b.js\", \"generated from b\");\nb.setSourceContent(\"b.js\", \"original b\");\nvar c = new SourceNode(1, 2, \"c.js\", \"generated from c\");\nc.setSourceContent(\"c.js\", \"original c\");\n\nvar node = new SourceNode(null, null, null, [a, b, c]);\nnode.walkSourceContents(function (source, contents) { console.log(\"WALK:\", source, \":\", contents); })\n// WALK: a.js : original a\n// WALK: b.js : original b\n// WALK: c.js : original c\n```\n\n#### SourceNode.prototype.join(sep)\n\nLike `Array.prototype.join` except for SourceNodes. Inserts the separator\nbetween each of this source node's children.\n\n* `sep`: The separator.\n\n```js\nvar lhs = new SourceNode(1, 2, \"a.rs\", \"my_copy\");\nvar operand = new SourceNode(3, 4, \"a.rs\", \"=\");\nvar rhs = new SourceNode(5, 6, \"a.rs\", \"orig.clone()\");\n\nvar node = new SourceNode(null, null, null, [ lhs, operand, rhs ]);\nvar joinedNode = node.join(\" \");\n```\n\n#### SourceNode.prototype.replaceRight(pattern, replacement)\n\nCall `String.prototype.replace` on the very right-most source snippet. Useful\nfor trimming white space from the end of a source node, etc.\n\n* `pattern`: The pattern to replace.\n\n* `replacement`: The thing to replace the pattern with.\n\n```js\n// Trim trailing white space.\nnode.replaceRight(/\\s*$/, \"\");\n```\n\n#### SourceNode.prototype.toString()\n\nReturn the string representation of this source node. Walks over the tree and\nconcatenates all the various snippets together to one string.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n new SourceNode(3, 4, \"b.js\", \"uno\"),\n \"dos\",\n [\n \"tres\",\n new SourceNode(5, 6, \"c.js\", \"quatro\")\n ]\n]);\n\nnode.toString()\n// 'unodostresquatro'\n```\n\n#### SourceNode.prototype.toStringWithSourceMap([startOfSourceMap])\n\nReturns the string representation of this tree of source nodes, plus a\nSourceMapGenerator which contains all the mappings between the generated and\noriginal sources.\n\nThe arguments are the same as those to `new SourceMapGenerator`.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n new SourceNode(3, 4, \"b.js\", \"uno\"),\n \"dos\",\n [\n \"tres\",\n new SourceNode(5, 6, \"c.js\", \"quatro\")\n ]\n]);\n\nnode.toStringWithSourceMap({ file: \"my-output-file.js\" })\n// { code: 'unodostresquatro',\n// map: [object SourceMapGenerator] }\n```\n# color-convert\n\n[](https://travis-ci.org/Qix-/color-convert)\n\nColor-convert is a color conversion library for JavaScript and node.\nIt converts all ways between `rgb`, `hsl`, `hsv`, `hwb`, `cmyk`, `ansi`, `ansi16`, `hex` strings, and CSS `keyword`s (will round to closest):\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hsl(140, 200, 100); // [96, 48, 59]\nconvert.keyword.rgb('blue'); // [0, 0, 255]\n\nvar rgbChannels = convert.rgb.channels; // 3\nvar cmykChannels = convert.cmyk.channels; // 4\nvar ansiChannels = convert.ansi16.channels; // 1\n```\n\n# Install\n\n```console\n$ npm install color-convert\n```\n\n# API\n\nSimply get the property of the _from_ and _to_ conversion that you're looking for.\n\nAll functions have a rounded and unrounded variant. By default, return values are rounded. To get the unrounded (raw) results, simply tack on `.raw` to the function.\n\nAll 'from' functions have a hidden property called `.channels` that indicates the number of channels the function expects (not including alpha).\n\n```js\nvar convert = require('color-convert');\n\n// Hex to LAB\nconvert.hex.lab('DEADBF'); // [ 76, 21, -2 ]\nconvert.hex.lab.raw('DEADBF'); // [ 75.56213190997677, 20.653827952644754, -2.290532499330533 ]\n\n// RGB to CMYK\nconvert.rgb.cmyk(167, 255, 4); // [ 35, 0, 98, 0 ]\nconvert.rgb.cmyk.raw(167, 255, 4); // [ 34.509803921568626, 0, 98.43137254901961, 0 ]\n```\n\n### Arrays\nAll functions that accept multiple arguments also support passing an array.\n\nNote that this does **not** apply to functions that convert from a color that only requires one value (e.g. `keyword`, `ansi256`, `hex`, etc.)\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hex(123, 45, 67); // '7B2D43'\nconvert.rgb.hex([123, 45, 67]); // '7B2D43'\n```\n\n## Routing\n\nConversions that don't have an _explicitly_ defined conversion (in [conversions.js](conversions.js)), but can be converted by means of sub-conversions (e.g. XYZ -> **RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex).\n\nKeep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of \"direct\" (single-step) conversions, see [conversions.js](conversions.js).\n\n# Contribute\n\nIf there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.\n\n# License\nCopyright © 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE).\n# v8-to-istanbul\n\n[](https://travis-ci.org/istanbuljs/v8-to-istanbul)\n[](https://conventionalcommits.org)\n\n\nconverts from v8 coverage format to [istanbul's coverage format](https://github.com/gotwarlost/istanbul/blob/master/coverage.json.md).\n\n## Usage\n\n```js\nconst v8toIstanbul = require('v8-to-istanbul')\n// the path to the original source-file is required, as its contents are\n// used during the conversion algorithm.\nconst converter = v8toIstanbul('./path-to-instrumented-file.js')\nawait converter.load() // this is required due to the async source-map dependency.\n// provide an array of coverage information in v8 format.\nconverter.applyCoverage([\n {\n \"functionName\": \"\",\n \"ranges\": [\n {\n \"startOffset\": 0,\n \"endOffset\": 520,\n \"count\": 1\n }\n ],\n \"isBlockCoverage\": true\n },\n // ...\n])\n// output coverage information in a form that can\n// be consumed by Istanbul.\nconsole.info(JSON.stringify(converter.toIstanbul()))\n```\n\n## Ignoring Uncovered Lines\n\nSometimes you might find yourself wanting to ignore uncovered lines\nin your application (for example, perhaps you run your tests in Linux, but\nthere's code that only executes on Windows).\n\nTo ignore lines, use the special comment `/* c8 ignore next */`.\n\n### ignoring the next line\n\n```js\nconst myVariable = 99\n/* c8 ignore next */\nif (process.platform === 'win32') console.info('hello world')\n```\n\n### ignoring the next N lines\n\n```js\nconst myVariable = 99\n/* c8 ignore next 3 */\nif (process.platform === 'win32') {\n console.info('hello world')\n}\n```\n\n### ignoring the same line as the comment\n\n```js\nconst myVariable = 99\nconst os = process.platform === 'darwin' ? 'OSXy' /* c8 ignore next */ : 'Windowsy' \n```\n\n## Testing\n\nTo execute tests, simply run:\n\n```bash\nnpm test\n```\n# capture-exit\n\n[](https://ci.appveyor.com/project/embercli/capture-exit/branch/master)\n[](https://travis-ci.org/ember-cli/capture-exit)\n\nAllow cooprative async exit handlers, we unfortunately must hijack\nprocess.exit.\n\nIt allows a handler to ensure exit, without that exit handler impeding other\nsimilar handlers\n\nfor example, see: [sindresorhus/ora#27](https://github.com/sindresorhus/ora/issues/27)\n\nDifferences between `process.on('exit')` and `captureExit.onExit(...)` => https://github.com/ember-cli/capture-exit/issues/12\n\n### Installation\n\n```sh\nyarn add capture-exit\n// or\nnpm install --save capture-exit\n```\n\n### Usage\n\n```js\n// as early in startup as possible\nrequire('capture-exit').captureExit();\n\n// when you want to schedule some work on exit:\nfunction onExit() {\n return something.processWillExit(); // you can return promises, which will pause exit until fulfilled\n}\n\nrequire('capture-exit').onExit(onExit); // add an exit handler\nrequire('capture-exit').offExit(onExit); // allows one to remove an exit handle if it is not longer required\n```\nsshpk\n=========\n\nParse, convert, fingerprint and use SSH keys (both public and private) in pure\nnode -- no `ssh-keygen` or other external dependencies.\n\nSupports RSA, DSA, ECDSA (nistp-\\*) and ED25519 key types, in PEM (PKCS#1, \nPKCS#8) and OpenSSH formats.\n\nThis library has been extracted from\n[`node-http-signature`](https://github.com/joyent/node-http-signature)\n(work by [Mark Cavage](https://github.com/mcavage) and\n[Dave Eddy](https://github.com/bahamas10)) and\n[`node-ssh-fingerprint`](https://github.com/bahamas10/node-ssh-fingerprint)\n(work by Dave Eddy), with additions (including ECDSA support) by\n[Alex Wilson](https://github.com/arekinath).\n\nInstall\n-------\n\n```\nnpm install sshpk\n```\n\nExamples\n--------\n\n```js\nvar sshpk = require('sshpk');\n\nvar fs = require('fs');\n\n/* Read in an OpenSSH-format public key */\nvar keyPub = fs.readFileSync('id_rsa.pub');\nvar key = sshpk.parseKey(keyPub, 'ssh');\n\n/* Get metadata about the key */\nconsole.log('type => %s', key.type);\nconsole.log('size => %d bits', key.size);\nconsole.log('comment => %s', key.comment);\n\n/* Compute key fingerprints, in new OpenSSH (>6.7) format, and old MD5 */\nconsole.log('fingerprint => %s', key.fingerprint().toString());\nconsole.log('old-style fingerprint => %s', key.fingerprint('md5').toString());\n```\n\nExample output:\n\n```\ntype => rsa\nsize => 2048 bits\ncomment => foo@foo.com\nfingerprint => SHA256:PYC9kPVC6J873CSIbfp0LwYeczP/W4ffObNCuDJ1u5w\nold-style fingerprint => a0:c8:ad:6c:32:9a:32:fa:59:cc:a9:8c:0a:0d:6e:bd\n```\n\nMore examples: converting between formats:\n\n```js\n/* Read in a PEM public key */\nvar keyPem = fs.readFileSync('id_rsa.pem');\nvar key = sshpk.parseKey(keyPem, 'pem');\n\n/* Convert to PEM PKCS#8 public key format */\nvar pemBuf = key.toBuffer('pkcs8');\n\n/* Convert to SSH public key format (and return as a string) */\nvar sshKey = key.toString('ssh');\n```\n\nSigning and verifying:\n\n```js\n/* Read in an OpenSSH/PEM *private* key */\nvar keyPriv = fs.readFileSync('id_ecdsa');\nvar key = sshpk.parsePrivateKey(keyPriv, 'pem');\n\nvar data = 'some data';\n\n/* Sign some data with the key */\nvar s = key.createSign('sha1');\ns.update(data);\nvar signature = s.sign();\n\n/* Now load the public key (could also use just key.toPublic()) */\nvar keyPub = fs.readFileSync('id_ecdsa.pub');\nkey = sshpk.parseKey(keyPub, 'ssh');\n\n/* Make a crypto.Verifier with this key */\nvar v = key.createVerify('sha1');\nv.update(data);\nvar valid = v.verify(signature);\n/* => true! */\n```\n\nMatching fingerprints with keys:\n\n```js\nvar fp = sshpk.parseFingerprint('SHA256:PYC9kPVC6J873CSIbfp0LwYeczP/W4ffObNCuDJ1u5w');\n\nvar keys = [sshpk.parseKey(...), sshpk.parseKey(...), ...];\n\nkeys.forEach(function (key) {\n\tif (fp.matches(key))\n\t\tconsole.log('found it!');\n});\n```\n\nUsage\n-----\n\n## Public keys\n\n### `parseKey(data[, format = 'auto'[, options]])`\n\nParses a key from a given data format and returns a new `Key` object.\n\nParameters\n\n- `data` -- Either a Buffer or String, containing the key\n- `format` -- String name of format to use, valid options are:\n - `auto`: choose automatically from all below\n - `pem`: supports both PKCS#1 and PKCS#8\n - `ssh`: standard OpenSSH format,\n - `pkcs1`, `pkcs8`: variants of `pem`\n - `rfc4253`: raw OpenSSH wire format\n - `openssh`: new post-OpenSSH 6.5 internal format, produced by \n `ssh-keygen -o`\n - `dnssec`: `.key` file format output by `dnssec-keygen` etc\n - `putty`: the PuTTY `.ppk` file format (supports truncated variant without\n all the lines from `Private-Lines:` onwards)\n- `options` -- Optional Object, extra options, with keys:\n - `filename` -- Optional String, name for the key being parsed \n (eg. the filename that was opened). Used to generate\n Error messages\n - `passphrase` -- Optional String, encryption passphrase used to decrypt an\n encrypted PEM file\n\n### `Key.isKey(obj)`\n\nReturns `true` if the given object is a valid `Key` object created by a version\nof `sshpk` compatible with this one.\n\nParameters\n\n- `obj` -- Object to identify\n\n### `Key#type`\n\nString, the type of key. Valid options are `rsa`, `dsa`, `ecdsa`.\n\n### `Key#size`\n\nInteger, \"size\" of the key in bits. For RSA/DSA this is the size of the modulus;\nfor ECDSA this is the bit size of the curve in use.\n\n### `Key#comment`\n\nOptional string, a key comment used by some formats (eg the `ssh` format).\n\n### `Key#curve`\n\nOnly present if `this.type === 'ecdsa'`, string containing the name of the\nnamed curve used with this key. Possible values include `nistp256`, `nistp384`\nand `nistp521`.\n\n### `Key#toBuffer([format = 'ssh'])`\n\nConvert the key into a given data format and return the serialized key as\na Buffer.\n\nParameters\n\n- `format` -- String name of format to use, for valid options see `parseKey()`\n\n### `Key#toString([format = 'ssh])`\n\nSame as `this.toBuffer(format).toString()`.\n\n### `Key#fingerprint([algorithm = 'sha256'[, hashType = 'ssh']])`\n\nCreates a new `Fingerprint` object representing this Key's fingerprint.\n\nParameters\n\n- `algorithm` -- String name of hash algorithm to use, valid options are `md5`,\n `sha1`, `sha256`, `sha384`, `sha512`\n- `hashType` -- String name of fingerprint hash type to use, valid options are\n `ssh` (the type of fingerprint used by OpenSSH, e.g. in\n `ssh-keygen`), `spki` (used by HPKP, some OpenSSL applications)\n\n### `Key#createVerify([hashAlgorithm])`\n\nCreates a `crypto.Verifier` specialized to use this Key (and the correct public\nkey algorithm to match it). The returned Verifier has the same API as a regular\none, except that the `verify()` function takes only the target signature as an\nargument.\n\nParameters\n\n- `hashAlgorithm` -- optional String name of hash algorithm to use, any\n supported by OpenSSL are valid, usually including\n `sha1`, `sha256`.\n\n`v.verify(signature[, format])` Parameters\n\n- `signature` -- either a Signature object, or a Buffer or String\n- `format` -- optional String, name of format to interpret given String with.\n Not valid if `signature` is a Signature or Buffer.\n\n### `Key#createDiffieHellman()`\n### `Key#createDH()`\n\nCreates a Diffie-Hellman key exchange object initialized with this key and all\nnecessary parameters. This has the same API as a `crypto.DiffieHellman`\ninstance, except that functions take `Key` and `PrivateKey` objects as\narguments, and return them where indicated for.\n\nThis is only valid for keys belonging to a cryptosystem that supports DHE\nor a close analogue (i.e. `dsa`, `ecdsa` and `curve25519` keys). An attempt\nto call this function on other keys will yield an `Error`.\n\n## Private keys\n\n### `parsePrivateKey(data[, format = 'auto'[, options]])`\n\nParses a private key from a given data format and returns a new\n`PrivateKey` object.\n\nParameters\n\n- `data` -- Either a Buffer or String, containing the key\n- `format` -- String name of format to use, valid options are:\n - `auto`: choose automatically from all below\n - `pem`: supports both PKCS#1 and PKCS#8\n - `ssh`, `openssh`: new post-OpenSSH 6.5 internal format, produced by\n `ssh-keygen -o`\n - `pkcs1`, `pkcs8`: variants of `pem`\n - `rfc4253`: raw OpenSSH wire format\n - `dnssec`: `.private` format output by `dnssec-keygen` etc.\n- `options` -- Optional Object, extra options, with keys:\n - `filename` -- Optional String, name for the key being parsed\n (eg. the filename that was opened). Used to generate\n Error messages\n - `passphrase` -- Optional String, encryption passphrase used to decrypt an\n encrypted PEM file\n\n### `generatePrivateKey(type[, options])`\n\nGenerates a new private key of a certain key type, from random data.\n\nParameters\n\n- `type` -- String, type of key to generate. Currently supported are `'ecdsa'`\n and `'ed25519'`\n- `options` -- optional Object, with keys:\n - `curve` -- optional String, for `'ecdsa'` keys, specifies the curve to use.\n If ECDSA is specified and this option is not given, defaults to\n using `'nistp256'`.\n\n### `PrivateKey.isPrivateKey(obj)`\n\nReturns `true` if the given object is a valid `PrivateKey` object created by a\nversion of `sshpk` compatible with this one.\n\nParameters\n\n- `obj` -- Object to identify\n\n### `PrivateKey#type`\n\nString, the type of key. Valid options are `rsa`, `dsa`, `ecdsa`.\n\n### `PrivateKey#size`\n\nInteger, \"size\" of the key in bits. For RSA/DSA this is the size of the modulus;\nfor ECDSA this is the bit size of the curve in use.\n\n### `PrivateKey#curve`\n\nOnly present if `this.type === 'ecdsa'`, string containing the name of the\nnamed curve used with this key. Possible values include `nistp256`, `nistp384`\nand `nistp521`.\n\n### `PrivateKey#toBuffer([format = 'pkcs1'])`\n\nConvert the key into a given data format and return the serialized key as\na Buffer.\n\nParameters\n\n- `format` -- String name of format to use, valid options are listed under \n `parsePrivateKey`. Note that ED25519 keys default to `openssh`\n format instead (as they have no `pkcs1` representation).\n\n### `PrivateKey#toString([format = 'pkcs1'])`\n\nSame as `this.toBuffer(format).toString()`.\n\n### `PrivateKey#toPublic()`\n\nExtract just the public part of this private key, and return it as a `Key`\nobject.\n\n### `PrivateKey#fingerprint([algorithm = 'sha256'])`\n\nSame as `this.toPublic().fingerprint()`.\n\n### `PrivateKey#createVerify([hashAlgorithm])`\n\nSame as `this.toPublic().createVerify()`.\n\n### `PrivateKey#createSign([hashAlgorithm])`\n\nCreates a `crypto.Sign` specialized to use this PrivateKey (and the correct\nkey algorithm to match it). The returned Signer has the same API as a regular\none, except that the `sign()` function takes no arguments, and returns a\n`Signature` object.\n\nParameters\n\n- `hashAlgorithm` -- optional String name of hash algorithm to use, any\n supported by OpenSSL are valid, usually including\n `sha1`, `sha256`.\n\n`v.sign()` Parameters\n\n- none\n\n### `PrivateKey#derive(newType)`\n\nDerives a related key of type `newType` from this key. Currently this is\nonly supported to change between `ed25519` and `curve25519` keys which are\nstored with the same private key (but usually distinct public keys in order\nto avoid degenerate keys that lead to a weak Diffie-Hellman exchange).\n\nParameters\n\n- `newType` -- String, type of key to derive, either `ed25519` or `curve25519`\n\n## Fingerprints\n\n### `parseFingerprint(fingerprint[, options])`\n\nPre-parses a fingerprint, creating a `Fingerprint` object that can be used to\nquickly locate a key by using the `Fingerprint#matches` function.\n\nParameters\n\n- `fingerprint` -- String, the fingerprint value, in any supported format\n- `options` -- Optional Object, with properties:\n - `algorithms` -- Array of strings, names of hash algorithms to limit\n support to. If `fingerprint` uses a hash algorithm not on\n this list, throws `InvalidAlgorithmError`.\n - `hashType` -- String, the type of hash the fingerprint uses, either `ssh`\n or `spki` (normally auto-detected based on the format, but\n can be overridden)\n - `type` -- String, the entity this fingerprint identifies, either `key` or\n `certificate`\n\n### `Fingerprint.isFingerprint(obj)`\n\nReturns `true` if the given object is a valid `Fingerprint` object created by a\nversion of `sshpk` compatible with this one.\n\nParameters\n\n- `obj` -- Object to identify\n\n### `Fingerprint#toString([format])`\n\nReturns a fingerprint as a string, in the given format.\n\nParameters\n\n- `format` -- Optional String, format to use, valid options are `hex` and\n `base64`. If this `Fingerprint` uses the `md5` algorithm, the\n default format is `hex`. Otherwise, the default is `base64`.\n\n### `Fingerprint#matches(keyOrCertificate)`\n\nVerifies whether or not this `Fingerprint` matches a given `Key` or\n`Certificate`. This function uses double-hashing to avoid leaking timing\ninformation. Returns a boolean.\n\nNote that a `Key`-type Fingerprint will always return `false` if asked to match\na `Certificate` and vice versa.\n\nParameters\n\n- `keyOrCertificate` -- a `Key` object or `Certificate` object, the entity to\n match this fingerprint against\n\n## Signatures\n\n### `parseSignature(signature, algorithm, format)`\n\nParses a signature in a given format, creating a `Signature` object. Useful\nfor converting between the SSH and ASN.1 (PKCS/OpenSSL) signature formats, and\nalso returned as output from `PrivateKey#createSign().sign()`.\n\nA Signature object can also be passed to a verifier produced by\n`Key#createVerify()` and it will automatically be converted internally into the\ncorrect format for verification.\n\nParameters\n\n- `signature` -- a Buffer (binary) or String (base64), data of the actual\n signature in the given format\n- `algorithm` -- a String, name of the algorithm to be used, possible values\n are `rsa`, `dsa`, `ecdsa`\n- `format` -- a String, either `asn1` or `ssh`\n\n### `Signature.isSignature(obj)`\n\nReturns `true` if the given object is a valid `Signature` object created by a\nversion of `sshpk` compatible with this one.\n\nParameters\n\n- `obj` -- Object to identify\n\n### `Signature#toBuffer([format = 'asn1'])`\n\nConverts a Signature to the given format and returns it as a Buffer.\n\nParameters\n\n- `format` -- a String, either `asn1` or `ssh`\n\n### `Signature#toString([format = 'asn1'])`\n\nSame as `this.toBuffer(format).toString('base64')`.\n\n## Certificates\n\n`sshpk` includes basic support for parsing certificates in X.509 (PEM) format\nand the OpenSSH certificate format. This feature is intended to be used mainly\nto access basic metadata about certificates, extract public keys from them, and\nalso to generate simple self-signed certificates from an existing key.\n\nNotably, there is no implementation of CA chain-of-trust verification, and only\nvery minimal support for key usage restrictions. Please do the security world\na favour, and DO NOT use this code for certificate verification in the\ntraditional X.509 CA chain style.\n\n### `parseCertificate(data, format)`\n\nParameters\n\n - `data` -- a Buffer or String\n - `format` -- a String, format to use, one of `'openssh'`, `'pem'` (X.509 in a\n PEM wrapper), or `'x509'` (raw DER encoded)\n\n### `createSelfSignedCertificate(subject, privateKey[, options])`\n\nParameters\n\n - `subject` -- an Identity, the subject of the certificate\n - `privateKey` -- a PrivateKey, the key of the subject: will be used both to be\n placed in the certificate and also to sign it (since this is\n a self-signed certificate)\n - `options` -- optional Object, with keys:\n - `lifetime` -- optional Number, lifetime of the certificate from now in\n seconds\n - `validFrom`, `validUntil` -- optional Dates, beginning and end of\n certificate validity period. If given\n `lifetime` will be ignored\n - `serial` -- optional Buffer, the serial number of the certificate\n - `purposes` -- optional Array of String, X.509 key usage restrictions\n\n### `createCertificate(subject, key, issuer, issuerKey[, options])`\n\nParameters\n\n - `subject` -- an Identity, the subject of the certificate\n - `key` -- a Key, the public key of the subject\n - `issuer` -- an Identity, the issuer of the certificate who will sign it\n - `issuerKey` -- a PrivateKey, the issuer's private key for signing\n - `options` -- optional Object, with keys:\n - `lifetime` -- optional Number, lifetime of the certificate from now in\n seconds\n - `validFrom`, `validUntil` -- optional Dates, beginning and end of\n certificate validity period. If given\n `lifetime` will be ignored\n - `serial` -- optional Buffer, the serial number of the certificate\n - `purposes` -- optional Array of String, X.509 key usage restrictions\n\n### `Certificate#subjects`\n\nArray of `Identity` instances describing the subject of this certificate.\n\n### `Certificate#issuer`\n\nThe `Identity` of the Certificate's issuer (signer).\n\n### `Certificate#subjectKey`\n\nThe public key of the subject of the certificate, as a `Key` instance.\n\n### `Certificate#issuerKey`\n\nThe public key of the signing issuer of this certificate, as a `Key` instance.\nMay be `undefined` if the issuer's key is unknown (e.g. on an X509 certificate).\n\n### `Certificate#serial`\n\nThe serial number of the certificate. As this is normally a 64-bit or wider\ninteger, it is returned as a Buffer.\n\n### `Certificate#purposes`\n\nArray of Strings indicating the X.509 key usage purposes that this certificate\nis valid for. The possible strings at the moment are:\n\n * `'signature'` -- key can be used for digital signatures\n * `'identity'` -- key can be used to attest about the identity of the signer\n (X.509 calls this `nonRepudiation`)\n * `'codeSigning'` -- key can be used to sign executable code\n * `'keyEncryption'` -- key can be used to encrypt other keys\n * `'encryption'` -- key can be used to encrypt data (only applies for RSA)\n * `'keyAgreement'` -- key can be used for key exchange protocols such as\n Diffie-Hellman\n * `'ca'` -- key can be used to sign other certificates (is a Certificate\n Authority)\n * `'crl'` -- key can be used to sign Certificate Revocation Lists (CRLs)\n\n### `Certificate#getExtension(nameOrOid)`\n\nRetrieves information about a certificate extension, if present, or returns\n`undefined` if not. The string argument `nameOrOid` should be either the OID\n(for X509 extensions) or the name (for OpenSSH extensions) of the extension\nto retrieve.\n\nThe object returned will have the following properties:\n\n * `format` -- String, set to either `'x509'` or `'openssh'`\n * `name` or `oid` -- String, only one set based on value of `format`\n * `data` -- Buffer, the raw data inside the extension\n\n### `Certificate#getExtensions()`\n\nReturns an Array of all present certificate extensions, in the same manner and\nformat as `getExtension()`.\n\n### `Certificate#isExpired([when])`\n\nTests whether the Certificate is currently expired (i.e. the `validFrom` and\n`validUntil` dates specify a range of time that does not include the current\ntime).\n\nParameters\n\n - `when` -- optional Date, if specified, tests whether the Certificate was or\n will be expired at the specified time instead of now\n\nReturns a Boolean.\n\n### `Certificate#isSignedByKey(key)`\n\nTests whether the Certificate was validly signed by the given (public) Key.\n\nParameters\n\n - `key` -- a Key instance\n\nReturns a Boolean.\n\n### `Certificate#isSignedBy(certificate)`\n\nTests whether this Certificate was validly signed by the subject of the given\ncertificate. Also tests that the issuer Identity of this Certificate and the\nsubject Identity of the other Certificate are equivalent.\n\nParameters\n\n - `certificate` -- another Certificate instance\n\nReturns a Boolean.\n\n### `Certificate#fingerprint([hashAlgo])`\n\nReturns the X509-style fingerprint of the entire certificate (as a Fingerprint\ninstance). This matches what a web-browser or similar would display as the\ncertificate fingerprint and should not be confused with the fingerprint of the\nsubject's public key.\n\nParameters\n\n - `hashAlgo` -- an optional String, any hash function name\n\n### `Certificate#toBuffer([format])`\n\nSerializes the Certificate to a Buffer and returns it.\n\nParameters\n\n - `format` -- an optional String, output format, one of `'openssh'`, `'pem'` or\n `'x509'`. Defaults to `'x509'`.\n\nReturns a Buffer.\n\n### `Certificate#toString([format])`\n\n - `format` -- an optional String, output format, one of `'openssh'`, `'pem'` or\n `'x509'`. Defaults to `'pem'`.\n\nReturns a String.\n\n## Certificate identities\n\n### `identityForHost(hostname)`\n\nConstructs a host-type Identity for a given hostname.\n\nParameters\n\n - `hostname` -- the fully qualified DNS name of the host\n\nReturns an Identity instance.\n\n### `identityForUser(uid)`\n\nConstructs a user-type Identity for a given UID.\n\nParameters\n\n - `uid` -- a String, user identifier (login name)\n\nReturns an Identity instance.\n\n### `identityForEmail(email)`\n\nConstructs an email-type Identity for a given email address.\n\nParameters\n\n - `email` -- a String, email address\n\nReturns an Identity instance.\n\n### `identityFromDN(dn)`\n\nParses an LDAP-style DN string (e.g. `'CN=foo, C=US'`) and turns it into an\nIdentity instance.\n\nParameters\n\n - `dn` -- a String\n\nReturns an Identity instance.\n\n### `identityFromArray(arr)`\n\nConstructs an Identity from an array of DN components (see `Identity#toArray()`\nfor the format).\n\nParameters\n\n - `arr` -- an Array of Objects, DN components with `name` and `value`\n\nReturns an Identity instance.\n\nSupported attributes in DNs:\n\n| Attribute name | OID |\n| -------------- | --- |\n| `cn` | `2.5.4.3` |\n| `o` | `2.5.4.10` |\n| `ou` | `2.5.4.11` |\n| `l` | `2.5.4.7` |\n| `s` | `2.5.4.8` |\n| `c` | `2.5.4.6` |\n| `sn` | `2.5.4.4` |\n| `postalCode` | `2.5.4.17` |\n| `serialNumber` | `2.5.4.5` |\n| `street` | `2.5.4.9` |\n| `x500UniqueIdentifier` | `2.5.4.45` |\n| `role` | `2.5.4.72` |\n| `telephoneNumber` | `2.5.4.20` |\n| `description` | `2.5.4.13` |\n| `dc` | `0.9.2342.19200300.100.1.25` |\n| `uid` | `0.9.2342.19200300.100.1.1` |\n| `mail` | `0.9.2342.19200300.100.1.3` |\n| `title` | `2.5.4.12` |\n| `gn` | `2.5.4.42` |\n| `initials` | `2.5.4.43` |\n| `pseudonym` | `2.5.4.65` |\n\n### `Identity#toString()`\n\nReturns the identity as an LDAP-style DN string.\ne.g. `'CN=foo, O=bar corp, C=us'`\n\n### `Identity#type`\n\nThe type of identity. One of `'host'`, `'user'`, `'email'` or `'unknown'`\n\n### `Identity#hostname`\n### `Identity#uid`\n### `Identity#email`\n\nSet when `type` is `'host'`, `'user'`, or `'email'`, respectively. Strings.\n\n### `Identity#cn`\n\nThe value of the first `CN=` in the DN, if any. It's probably better to use\nthe `#get()` method instead of this property.\n\n### `Identity#get(name[, asArray])`\n\nReturns the value of a named attribute in the Identity DN. If there is no\nattribute of the given name, returns `undefined`. If multiple components\nof the DN contain an attribute of this name, an exception is thrown unless\nthe `asArray` argument is given as `true` -- then they will be returned as\nan Array in the same order they appear in the DN.\n\nParameters\n\n - `name` -- a String\n - `asArray` -- an optional Boolean\n\n### `Identity#toArray()`\n\nReturns the Identity as an Array of DN component objects. This looks like:\n\n```js\n[ {\n \"name\": \"cn\",\n \"value\": \"Joe Bloggs\"\n},\n{\n \"name\": \"o\",\n \"value\": \"Organisation Ltd\"\n} ]\n```\n\nEach object has a `name` and a `value` property. The returned objects may be\nsafely modified.\n\nErrors\n------\n\n### `InvalidAlgorithmError`\n\nThe specified algorithm is not valid, either because it is not supported, or\nbecause it was not included on a list of allowed algorithms.\n\nThrown by `Fingerprint.parse`, `Key#fingerprint`.\n\nProperties\n\n- `algorithm` -- the algorithm that could not be validated\n\n### `FingerprintFormatError`\n\nThe fingerprint string given could not be parsed as a supported fingerprint\nformat, or the specified fingerprint format is invalid.\n\nThrown by `Fingerprint.parse`, `Fingerprint#toString`.\n\nProperties\n\n- `fingerprint` -- if caused by a fingerprint, the string value given\n- `format` -- if caused by an invalid format specification, the string value given\n\n### `KeyParseError`\n\nThe key data given could not be parsed as a valid key.\n\nProperties\n\n- `keyName` -- `filename` that was given to `parseKey`\n- `format` -- the `format` that was trying to parse the key (see `parseKey`)\n- `innerErr` -- the inner Error thrown by the format parser\n\n### `KeyEncryptedError`\n\nThe key is encrypted with a symmetric key (ie, it is password protected). The\nparsing operation would succeed if it was given the `passphrase` option.\n\nProperties\n\n- `keyName` -- `filename` that was given to `parseKey`\n- `format` -- the `format` that was trying to parse the key (currently can only\n be `\"pem\"`)\n\n### `CertificateParseError`\n\nThe certificate data given could not be parsed as a valid certificate.\n\nProperties\n\n- `certName` -- `filename` that was given to `parseCertificate`\n- `format` -- the `format` that was trying to parse the key\n (see `parseCertificate`)\n- `innerErr` -- the inner Error thrown by the format parser\n\nFriends of sshpk\n----------------\n\n * [`sshpk-agent`](https://github.com/arekinath/node-sshpk-agent) is a library\n for speaking the `ssh-agent` protocol from node.js, which uses `sshpk`\nBrowser-friendly inheritance fully compatible with standard node.js\n[inherits](http://nodejs.org/api/util.html#util_util_inherits_constructor_superconstructor).\n\nThis package exports standard `inherits` from node.js `util` module in\nnode environment, but also provides alternative browser-friendly\nimplementation through [browser\nfield](https://gist.github.com/shtylman/4339901). Alternative\nimplementation is a literal copy of standard one located in standalone\nmodule to avoid requiring of `util`. It also has a shim for old\nbrowsers with no `Object.create` support.\n\nWhile keeping you sure you are using standard `inherits`\nimplementation in node.js environment, it allows bundlers such as\n[browserify](https://github.com/substack/node-browserify) to not\ninclude full `util` package to your client code if all you need is\njust `inherits` function. It worth, because browser shim for `util`\npackage is large and `inherits` is often the single function you need\nfrom it.\n\nIt's recommended to use this package instead of\n`require('util').inherits` for any code that has chances to be used\nnot only in node.js but in browser too.\n\n## usage\n\n```js\nvar inherits = require('inherits');\n// then use exactly as the standard one\n```\n\n## note on version ~1.0\n\nVersion ~1.0 had completely different motivation and is not compatible\nneither with 2.0 nor with standard node.js `inherits`.\n\nIf you are using version ~1.0 and planning to switch to ~2.0, be\ncareful:\n\n* new version uses `super_` instead of `super` for referencing\n superclass\n* new version overwrites current prototype while old one preserves any\n existing fields on it\n# Web IDL Type Conversions on JavaScript Values\n\nThis package implements, in JavaScript, the algorithms to convert a given JavaScript value according to a given [Web IDL](http://heycam.github.io/webidl/) [type](http://heycam.github.io/webidl/#idl-types).\n\nThe goal is that you should be able to write code like\n\n```js\n\"use strict\";\nconst conversions = require(\"webidl-conversions\");\n\nfunction doStuff(x, y) {\n x = conversions[\"boolean\"](x);\n y = conversions[\"unsigned long\"](y);\n // actual algorithm code here\n}\n```\n\nand your function `doStuff` will behave the same as a Web IDL operation declared as\n\n```webidl\nvoid doStuff(boolean x, unsigned long y);\n```\n\n## API\n\nThis package's main module's default export is an object with a variety of methods, each corresponding to a different Web IDL type. Each method, when invoked on a JavaScript value, will give back the new JavaScript value that results after passing through the Web IDL conversion rules. (See below for more details on what that means.) Alternately, the method could throw an error, if the Web IDL algorithm is specified to do so: for example `conversions[\"float\"](NaN)` [will throw a `TypeError`](http://heycam.github.io/webidl/#es-float).\n\nEach method also accepts a second, optional, parameter for miscellaneous options. For conversion methods that throw errors, a string option `{ context }` may be provided to provide more information in the error message. (For example, `conversions[\"float\"](NaN, { context: \"Argument 1 of Interface's operation\" })` will throw an error with message `\"Argument 1 of Interface's operation is not a finite floating-point value.\"`) Specific conversions may also accept other options, the details of which can be found below.\n\n## Conversions implemented\n\nConversions for all of the basic types from the Web IDL specification are implemented:\n\n- [`any`](https://heycam.github.io/webidl/#es-any)\n- [`void`](https://heycam.github.io/webidl/#es-void)\n- [`boolean`](https://heycam.github.io/webidl/#es-boolean)\n- [Integer types](https://heycam.github.io/webidl/#es-integer-types), which can additionally be provided the boolean options `{ clamp, enforceRange }` as a second parameter\n- [`float`](https://heycam.github.io/webidl/#es-float), [`unrestricted float`](https://heycam.github.io/webidl/#es-unrestricted-float)\n- [`double`](https://heycam.github.io/webidl/#es-double), [`unrestricted double`](https://heycam.github.io/webidl/#es-unrestricted-double)\n- [`DOMString`](https://heycam.github.io/webidl/#es-DOMString), which can additionally be provided the boolean option `{ treatNullAsEmptyString }` as a second parameter\n- [`ByteString`](https://heycam.github.io/webidl/#es-ByteString), [`USVString`](https://heycam.github.io/webidl/#es-USVString)\n- [`object`](https://heycam.github.io/webidl/#es-object)\n- [Buffer source types](https://heycam.github.io/webidl/#es-buffer-source-types)\n\nAdditionally, for convenience, the following derived type definitions are implemented:\n\n- [`ArrayBufferView`](https://heycam.github.io/webidl/#ArrayBufferView)\n- [`BufferSource`](https://heycam.github.io/webidl/#BufferSource)\n- [`DOMTimeStamp`](https://heycam.github.io/webidl/#DOMTimeStamp)\n- [`Function`](https://heycam.github.io/webidl/#Function)\n- [`VoidFunction`](https://heycam.github.io/webidl/#VoidFunction) (although it will not censor the return type)\n\nDerived types, such as nullable types, promise types, sequences, records, etc. are not handled by this library. You may wish to investigate the [webidl2js](https://github.com/jsdom/webidl2js) project.\n\n### A note on the `long long` types\n\nThe `long long` and `unsigned long long` Web IDL types can hold values that cannot be stored in JavaScript numbers, so the conversion is imperfect. For example, converting the JavaScript number `18446744073709552000` to a Web IDL `long long` is supposed to produce the Web IDL value `-18446744073709551232`. Since we are representing our Web IDL values in JavaScript, we can't represent `-18446744073709551232`, so we instead the best we could do is `-18446744073709552000` as the output.\n\nThis library actually doesn't even get that far. Producing those results would require doing accurate modular arithmetic on 64-bit intermediate values, but JavaScript does not make this easy. We could pull in a big-integer library as a dependency, but in lieu of that, we for now have decided to just produce inaccurate results if you pass in numbers that are not strictly between `Number.MIN_SAFE_INTEGER` and `Number.MAX_SAFE_INTEGER`.\n\n## Background\n\nWhat's actually going on here, conceptually, is pretty weird. Let's try to explain.\n\nWeb IDL, as part of its madness-inducing design, has its own type system. When people write algorithms in web platform specs, they usually operate on Web IDL values, i.e. instances of Web IDL types. For example, if they were specifying the algorithm for our `doStuff` operation above, they would treat `x` as a Web IDL value of [Web IDL type `boolean`](http://heycam.github.io/webidl/#idl-boolean). Crucially, they would _not_ treat `x` as a JavaScript variable whose value is either the JavaScript `true` or `false`. They're instead working in a different type system altogether, with its own rules.\n\nSeparately from its type system, Web IDL defines a [\"binding\"](http://heycam.github.io/webidl/#ecmascript-binding) of the type system into JavaScript. This contains rules like: when you pass a JavaScript value to the JavaScript method that manifests a given Web IDL operation, how does that get converted into a Web IDL value? For example, a JavaScript `true` passed in the position of a Web IDL `boolean` argument becomes a Web IDL `true`. But, a JavaScript `true` passed in the position of a [Web IDL `unsigned long`](http://heycam.github.io/webidl/#idl-unsigned-long) becomes a Web IDL `1`. And so on.\n\nFinally, we have the actual implementation code. This is usually C++, although these days [some smart people are using Rust](https://github.com/servo/servo). The implementation, of course, has its own type system. So when they implement the Web IDL algorithms, they don't actually use Web IDL values, since those aren't \"real\" outside of specs. Instead, implementations apply the Web IDL binding rules in such a way as to convert incoming JavaScript values into C++ values. For example, if code in the browser called `doStuff(true, true)`, then the implementation code would eventually receive a C++ `bool` containing `true` and a C++ `uint32_t` containing `1`.\n\nThe upside of all this is that implementations can abstract all the conversion logic away, letting Web IDL handle it, and focus on implementing the relevant methods in C++ with values of the correct type already provided. That is payoff of Web IDL, in a nutshell.\n\nAnd getting to that payoff is the goal of _this_ project—but for JavaScript implementations, instead of C++ ones. That is, this library is designed to make it easier for JavaScript developers to write functions that behave like a given Web IDL operation. So conceptually, the conversion pipeline, which in its general form is JavaScript values ↦ Web IDL values ↦ implementation-language values, in this case becomes JavaScript values ↦ Web IDL values ↦ JavaScript values. And that intermediate step is where all the logic is performed: a JavaScript `true` becomes a Web IDL `1` in an unsigned long context, which then becomes a JavaScript `1`.\n\n## Don't use this\n\nSeriously, why would you ever use this? You really shouldn't. Web IDL is … strange, and you shouldn't be emulating its semantics. If you're looking for a generic argument-processing library, you should find one with better rules than those from Web IDL. In general, your JavaScript should not be trying to become more like Web IDL; if anything, we should fix Web IDL to make it more like JavaScript.\n\nThe _only_ people who should use this are those trying to create faithful implementations (or polyfills) of web platform interfaces defined in Web IDL. Its main consumer is the [jsdom](https://github.com/jsdom/jsdom) project.\n[](http://travis-ci.org/kriskowal/q)\n[](https://cdnjs.com/libraries/q.js)\n\n<a href=\"http://promises-aplus.github.com/promises-spec\">\n <img src=\"http://kriskowal.github.io/q/q.png\" align=\"right\" alt=\"Q logo\" />\n</a>\n\nIf a function cannot return a value or throw an exception without\nblocking, it can return a promise instead. A promise is an object\nthat represents the return value or the thrown exception that the\nfunction may eventually provide. A promise can also be used as a\nproxy for a [remote object][Q-Connection] to overcome latency.\n\n[Q-Connection]: https://github.com/kriskowal/q-connection\n\nOn the first pass, promises can mitigate the “[Pyramid of\nDoom][POD]”: the situation where code marches to the right faster\nthan it marches forward.\n\n[POD]: http://calculist.org/blog/2011/12/14/why-coroutines-wont-work-on-the-web/\n\n```javascript\nstep1(function (value1) {\n step2(value1, function(value2) {\n step3(value2, function(value3) {\n step4(value3, function(value4) {\n // Do something with value4\n });\n });\n });\n});\n```\n\nWith a promise library, you can flatten the pyramid.\n\n```javascript\nQ.fcall(promisedStep1)\n.then(promisedStep2)\n.then(promisedStep3)\n.then(promisedStep4)\n.then(function (value4) {\n // Do something with value4\n})\n.catch(function (error) {\n // Handle any error from all above steps\n})\n.done();\n```\n\nWith this approach, you also get implicit error propagation, just like `try`,\n`catch`, and `finally`. An error in `promisedStep1` will flow all the way to\nthe `catch` function, where it’s caught and handled. (Here `promisedStepN` is\na version of `stepN` that returns a promise.)\n\nThe callback approach is called an “inversion of control”.\nA function that accepts a callback instead of a return value\nis saying, “Don’t call me, I’ll call you.”. Promises\n[un-invert][IOC] the inversion, cleanly separating the input\narguments from control flow arguments. This simplifies the\nuse and creation of API’s, particularly variadic,\nrest and spread arguments.\n\n[IOC]: http://www.slideshare.net/domenicdenicola/callbacks-promises-and-coroutines-oh-my-the-evolution-of-asynchronicity-in-javascript\n\n## Getting Started\n\nThe Q module can be loaded as:\n\n- A ``<script>`` tag (creating a ``Q`` global variable): ~2.5 KB minified and\n gzipped.\n- A Node.js and CommonJS module, available in [npm](https://npmjs.org/) as\n the [q](https://npmjs.org/package/q) package\n- An AMD module\n- A [component](https://github.com/component/component) as ``microjs/q``\n- Using [bower](http://bower.io/) as `q#^1.4.1`\n- Using [NuGet](http://nuget.org/) as [Q](https://nuget.org/packages/q)\n\nQ can exchange promises with jQuery, Dojo, When.js, WinJS, and more.\n\n## Resources\n\nOur [wiki][] contains a number of useful resources, including:\n\n- A method-by-method [Q API reference][reference].\n- A growing [examples gallery][examples], showing how Q can be used to make\n everything better. From XHR to database access to accessing the Flickr API,\n Q is there for you.\n- There are many libraries that produce and consume Q promises for everything\n from file system/database access or RPC to templating. For a list of some of\n the more popular ones, see [Libraries][].\n- If you want materials that introduce the promise concept generally, and the\n below tutorial isn't doing it for you, check out our collection of\n [presentations, blog posts, and podcasts][resources].\n- A guide for those [coming from jQuery's `$.Deferred`][jquery].\n\nWe'd also love to have you join the Q-Continuum [mailing list][].\n\n[wiki]: https://github.com/kriskowal/q/wiki\n[reference]: https://github.com/kriskowal/q/wiki/API-Reference\n[examples]: https://github.com/kriskowal/q/wiki/Examples-Gallery\n[Libraries]: https://github.com/kriskowal/q/wiki/Libraries\n[resources]: https://github.com/kriskowal/q/wiki/General-Promise-Resources\n[jquery]: https://github.com/kriskowal/q/wiki/Coming-from-jQuery\n[mailing list]: https://groups.google.com/forum/#!forum/q-continuum\n\n## Tutorial\n\nPromises have a ``then`` method, which you can use to get the eventual\nreturn value (fulfillment) or thrown exception (rejection).\n\n```javascript\npromiseMeSomething()\n.then(function (value) {\n}, function (reason) {\n});\n```\n\nIf ``promiseMeSomething`` returns a promise that gets fulfilled later\nwith a return value, the first function (the fulfillment handler) will be\ncalled with the value. However, if the ``promiseMeSomething`` function\ngets rejected later by a thrown exception, the second function (the\nrejection handler) will be called with the exception.\n\nNote that resolution of a promise is always asynchronous: that is, the\nfulfillment or rejection handler will always be called in the next turn of the\nevent loop (i.e. `process.nextTick` in Node). This gives you a nice\nguarantee when mentally tracing the flow of your code, namely that\n``then`` will always return before either handler is executed.\n\nIn this tutorial, we begin with how to consume and work with promises. We'll\ntalk about how to create them, and thus create functions like\n`promiseMeSomething` that return promises, [below](#the-beginning).\n\n### Propagation\n\nThe ``then`` method returns a promise, which in this example, I’m\nassigning to ``outputPromise``.\n\n```javascript\nvar outputPromise = getInputPromise()\n.then(function (input) {\n}, function (reason) {\n});\n```\n\nThe ``outputPromise`` variable becomes a new promise for the return\nvalue of either handler. Since a function can only either return a\nvalue or throw an exception, only one handler will ever be called and it\nwill be responsible for resolving ``outputPromise``.\n\n- If you return a value in a handler, ``outputPromise`` will get\n fulfilled.\n\n- If you throw an exception in a handler, ``outputPromise`` will get\n rejected.\n\n- If you return a **promise** in a handler, ``outputPromise`` will\n “become” that promise. Being able to become a new promise is useful\n for managing delays, combining results, or recovering from errors.\n\nIf the ``getInputPromise()`` promise gets rejected and you omit the\nrejection handler, the **error** will go to ``outputPromise``:\n\n```javascript\nvar outputPromise = getInputPromise()\n.then(function (value) {\n});\n```\n\nIf the input promise gets fulfilled and you omit the fulfillment handler, the\n**value** will go to ``outputPromise``:\n\n```javascript\nvar outputPromise = getInputPromise()\n.then(null, function (error) {\n});\n```\n\nQ promises provide a ``fail`` shorthand for ``then`` when you are only\ninterested in handling the error:\n\n```javascript\nvar outputPromise = getInputPromise()\n.fail(function (error) {\n});\n```\n\nIf you are writing JavaScript for modern engines only or using\nCoffeeScript, you may use `catch` instead of `fail`.\n\nPromises also have a ``fin`` function that is like a ``finally`` clause.\nThe final handler gets called, with no arguments, when the promise\nreturned by ``getInputPromise()`` either returns a value or throws an\nerror. The value returned or error thrown by ``getInputPromise()``\npasses directly to ``outputPromise`` unless the final handler fails, and\nmay be delayed if the final handler returns a promise.\n\n```javascript\nvar outputPromise = getInputPromise()\n.fin(function () {\n // close files, database connections, stop servers, conclude tests\n});\n```\n\n- If the handler returns a value, the value is ignored\n- If the handler throws an error, the error passes to ``outputPromise``\n- If the handler returns a promise, ``outputPromise`` gets postponed. The\n eventual value or error has the same effect as an immediate return\n value or thrown error: a value would be ignored, an error would be\n forwarded.\n\nIf you are writing JavaScript for modern engines only or using\nCoffeeScript, you may use `finally` instead of `fin`.\n\n### Chaining\n\nThere are two ways to chain promises. You can chain promises either\ninside or outside handlers. The next two examples are equivalent.\n\n```javascript\nreturn getUsername()\n.then(function (username) {\n return getUser(username)\n .then(function (user) {\n // if we get here without an error,\n // the value returned here\n // or the exception thrown here\n // resolves the promise returned\n // by the first line\n })\n});\n```\n\n```javascript\nreturn getUsername()\n.then(function (username) {\n return getUser(username);\n})\n.then(function (user) {\n // if we get here without an error,\n // the value returned here\n // or the exception thrown here\n // resolves the promise returned\n // by the first line\n});\n```\n\nThe only difference is nesting. It’s useful to nest handlers if you\nneed to capture multiple input values in your closure.\n\n```javascript\nfunction authenticate() {\n return getUsername()\n .then(function (username) {\n return getUser(username);\n })\n // chained because we will not need the user name in the next event\n .then(function (user) {\n return getPassword()\n // nested because we need both user and password next\n .then(function (password) {\n if (user.passwordHash !== hash(password)) {\n throw new Error(\"Can't authenticate\");\n }\n });\n });\n}\n```\n\n### Combination\n\nYou can turn an array of promises into a promise for the whole,\nfulfilled array using ``all``.\n\n```javascript\nreturn Q.all([\n eventualAdd(2, 2),\n eventualAdd(10, 20)\n]);\n```\n\nIf you have a promise for an array, you can use ``spread`` as a\nreplacement for ``then``. The ``spread`` function “spreads” the\nvalues over the arguments of the fulfillment handler. The rejection handler\nwill get called at the first sign of failure. That is, whichever of\nthe received promises fails first gets handled by the rejection handler.\n\n```javascript\nfunction eventualAdd(a, b) {\n return Q.spread([a, b], function (a, b) {\n return a + b;\n })\n}\n```\n\nBut ``spread`` calls ``all`` initially, so you can skip it in chains.\n\n```javascript\nreturn getUsername()\n.then(function (username) {\n return [username, getUser(username)];\n})\n.spread(function (username, user) {\n});\n```\n\nThe ``all`` function returns a promise for an array of values. When this\npromise is fulfilled, the array contains the fulfillment values of the original\npromises, in the same order as those promises. If one of the given promises\nis rejected, the returned promise is immediately rejected, not waiting for the\nrest of the batch. If you want to wait for all of the promises to either be\nfulfilled or rejected, you can use ``allSettled``.\n\n```javascript\nQ.allSettled(promises)\n.then(function (results) {\n results.forEach(function (result) {\n if (result.state === \"fulfilled\") {\n var value = result.value;\n } else {\n var reason = result.reason;\n }\n });\n});\n```\n\nThe ``any`` function accepts an array of promises and returns a promise that is\nfulfilled by the first given promise to be fulfilled, or rejected if all of the\ngiven promises are rejected.\n\n```javascript\nQ.any(promises)\n.then(function (first) {\n // Any of the promises was fulfilled.\n}, function (error) {\n // All of the promises were rejected.\n});\n```\n\n### Sequences\n\nIf you have a number of promise-producing functions that need\nto be run sequentially, you can of course do so manually:\n\n```javascript\nreturn foo(initialVal).then(bar).then(baz).then(qux);\n```\n\nHowever, if you want to run a dynamically constructed sequence of\nfunctions, you'll want something like this:\n\n```javascript\nvar funcs = [foo, bar, baz, qux];\n\nvar result = Q(initialVal);\nfuncs.forEach(function (f) {\n result = result.then(f);\n});\nreturn result;\n```\n\nYou can make this slightly more compact using `reduce`:\n\n```javascript\nreturn funcs.reduce(function (soFar, f) {\n return soFar.then(f);\n}, Q(initialVal));\n```\n\nOr, you could use the ultra-compact version:\n\n```javascript\nreturn funcs.reduce(Q.when, Q(initialVal));\n```\n\n### Handling Errors\n\nOne sometimes-unintuitive aspect of promises is that if you throw an\nexception in the fulfillment handler, it will not be caught by the error\nhandler.\n\n```javascript\nreturn foo()\n.then(function (value) {\n throw new Error(\"Can't bar.\");\n}, function (error) {\n // We only get here if \"foo\" fails\n});\n```\n\nTo see why this is, consider the parallel between promises and\n``try``/``catch``. We are ``try``-ing to execute ``foo()``: the error\nhandler represents a ``catch`` for ``foo()``, while the fulfillment handler\nrepresents code that happens *after* the ``try``/``catch`` block.\nThat code then needs its own ``try``/``catch`` block.\n\nIn terms of promises, this means chaining your rejection handler:\n\n```javascript\nreturn foo()\n.then(function (value) {\n throw new Error(\"Can't bar.\");\n})\n.fail(function (error) {\n // We get here with either foo's error or bar's error\n});\n```\n\n### Progress Notification\n\nIt's possible for promises to report their progress, e.g. for tasks that take a\nlong time like a file upload. Not all promises will implement progress\nnotifications, but for those that do, you can consume the progress values using\na third parameter to ``then``:\n\n```javascript\nreturn uploadFile()\n.then(function () {\n // Success uploading the file\n}, function (err) {\n // There was an error, and we get the reason for error\n}, function (progress) {\n // We get notified of the upload's progress as it is executed\n});\n```\n\nLike `fail`, Q also provides a shorthand for progress callbacks\ncalled `progress`:\n\n```javascript\nreturn uploadFile().progress(function (progress) {\n // We get notified of the upload's progress\n});\n```\n\n### The End\n\nWhen you get to the end of a chain of promises, you should either\nreturn the last promise or end the chain. Since handlers catch\nerrors, it’s an unfortunate pattern that the exceptions can go\nunobserved.\n\nSo, either return it,\n\n```javascript\nreturn foo()\n.then(function () {\n return \"bar\";\n});\n```\n\nOr, end it.\n\n```javascript\nfoo()\n.then(function () {\n return \"bar\";\n})\n.done();\n```\n\nEnding a promise chain makes sure that, if an error doesn’t get\nhandled before the end, it will get rethrown and reported.\n\nThis is a stopgap. We are exploring ways to make unhandled errors\nvisible without any explicit handling.\n\n### The Beginning\n\nEverything above assumes you get a promise from somewhere else. This\nis the common case. Every once in a while, you will need to create a\npromise from scratch.\n\n#### Using ``Q.fcall``\n\nYou can create a promise from a value using ``Q.fcall``. This returns a\npromise for 10.\n\n```javascript\nreturn Q.fcall(function () {\n return 10;\n});\n```\n\nYou can also use ``fcall`` to get a promise for an exception.\n\n```javascript\nreturn Q.fcall(function () {\n throw new Error(\"Can't do it\");\n});\n```\n\nAs the name implies, ``fcall`` can call functions, or even promised\nfunctions. This uses the ``eventualAdd`` function above to add two\nnumbers.\n\n```javascript\nreturn Q.fcall(eventualAdd, 2, 2);\n```\n\n#### Using Deferreds\n\nIf you have to interface with asynchronous functions that are callback-based\ninstead of promise-based, Q provides a few shortcuts (like ``Q.nfcall`` and\nfriends). But much of the time, the solution will be to use *deferreds*.\n\n```javascript\nvar deferred = Q.defer();\nFS.readFile(\"foo.txt\", \"utf-8\", function (error, text) {\n if (error) {\n deferred.reject(new Error(error));\n } else {\n deferred.resolve(text);\n }\n});\nreturn deferred.promise;\n```\n\nNote that a deferred can be resolved with a value or a promise. The\n``reject`` function is a shorthand for resolving with a rejected\npromise.\n\n```javascript\n// this:\ndeferred.reject(new Error(\"Can't do it\"));\n\n// is shorthand for:\nvar rejection = Q.fcall(function () {\n throw new Error(\"Can't do it\");\n});\ndeferred.resolve(rejection);\n```\n\nThis is a simplified implementation of ``Q.delay``.\n\n```javascript\nfunction delay(ms) {\n var deferred = Q.defer();\n setTimeout(deferred.resolve, ms);\n return deferred.promise;\n}\n```\n\nThis is a simplified implementation of ``Q.timeout``\n\n```javascript\nfunction timeout(promise, ms) {\n var deferred = Q.defer();\n Q.when(promise, deferred.resolve);\n delay(ms).then(function () {\n deferred.reject(new Error(\"Timed out\"));\n });\n return deferred.promise;\n}\n```\n\nFinally, you can send a progress notification to the promise with\n``deferred.notify``.\n\nFor illustration, this is a wrapper for XML HTTP requests in the browser. Note\nthat a more [thorough][XHR] implementation would be in order in practice.\n\n[XHR]: https://github.com/montagejs/mr/blob/71e8df99bb4f0584985accd6f2801ef3015b9763/browser.js#L29-L73\n\n```javascript\nfunction requestOkText(url) {\n var request = new XMLHttpRequest();\n var deferred = Q.defer();\n\n request.open(\"GET\", url, true);\n request.onload = onload;\n request.onerror = onerror;\n request.onprogress = onprogress;\n request.send();\n\n function onload() {\n if (request.status === 200) {\n deferred.resolve(request.responseText);\n } else {\n deferred.reject(new Error(\"Status code was \" + request.status));\n }\n }\n\n function onerror() {\n deferred.reject(new Error(\"Can't XHR \" + JSON.stringify(url)));\n }\n\n function onprogress(event) {\n deferred.notify(event.loaded / event.total);\n }\n\n return deferred.promise;\n}\n```\n\nBelow is an example of how to use this ``requestOkText`` function:\n\n```javascript\nrequestOkText(\"http://localhost:3000\")\n.then(function (responseText) {\n // If the HTTP response returns 200 OK, log the response text.\n console.log(responseText);\n}, function (error) {\n // If there's an error or a non-200 status code, log the error.\n console.error(error);\n}, function (progress) {\n // Log the progress as it comes in.\n console.log(\"Request progress: \" + Math.round(progress * 100) + \"%\");\n});\n```\n\n#### Using `Q.Promise`\n\nThis is an alternative promise-creation API that has the same power as\nthe deferred concept, but without introducing another conceptual entity.\n\nRewriting the `requestOkText` example above using `Q.Promise`:\n\n```javascript\nfunction requestOkText(url) {\n return Q.Promise(function(resolve, reject, notify) {\n var request = new XMLHttpRequest();\n\n request.open(\"GET\", url, true);\n request.onload = onload;\n request.onerror = onerror;\n request.onprogress = onprogress;\n request.send();\n\n function onload() {\n if (request.status === 200) {\n resolve(request.responseText);\n } else {\n reject(new Error(\"Status code was \" + request.status));\n }\n }\n\n function onerror() {\n reject(new Error(\"Can't XHR \" + JSON.stringify(url)));\n }\n\n function onprogress(event) {\n notify(event.loaded / event.total);\n }\n });\n}\n```\n\nIf `requestOkText` were to throw an exception, the returned promise would be\nrejected with that thrown exception as the rejection reason.\n\n### The Middle\n\nIf you are using a function that may return a promise, but just might\nreturn a value if it doesn’t need to defer, you can use the “static”\nmethods of the Q library.\n\nThe ``when`` function is the static equivalent for ``then``.\n\n```javascript\nreturn Q.when(valueOrPromise, function (value) {\n}, function (error) {\n});\n```\n\nAll of the other methods on a promise have static analogs with the\nsame name.\n\nThe following are equivalent:\n\n```javascript\nreturn Q.all([a, b]);\n```\n\n```javascript\nreturn Q.fcall(function () {\n return [a, b];\n})\n.all();\n```\n\nWhen working with promises provided by other libraries, you should\nconvert it to a Q promise. Not all promise libraries make the same\nguarantees as Q and certainly don’t provide all of the same methods.\nMost libraries only provide a partially functional ``then`` method.\nThis thankfully is all we need to turn them into vibrant Q promises.\n\n```javascript\nreturn Q($.ajax(...))\n.then(function () {\n});\n```\n\nIf there is any chance that the promise you receive is not a Q promise\nas provided by your library, you should wrap it using a Q function.\nYou can even use ``Q.invoke`` as a shorthand.\n\n```javascript\nreturn Q.invoke($, 'ajax', ...)\n.then(function () {\n});\n```\n\n### Over the Wire\n\nA promise can serve as a proxy for another object, even a remote\nobject. There are methods that allow you to optimistically manipulate\nproperties or call functions. All of these interactions return\npromises, so they can be chained.\n\n```\ndirect manipulation using a promise as a proxy\n-------------------------- -------------------------------\nvalue.foo promise.get(\"foo\")\nvalue.foo = value promise.put(\"foo\", value)\ndelete value.foo promise.del(\"foo\")\nvalue.foo(...args) promise.post(\"foo\", [args])\nvalue.foo(...args) promise.invoke(\"foo\", ...args)\nvalue(...args) promise.fapply([args])\nvalue(...args) promise.fcall(...args)\n```\n\nIf the promise is a proxy for a remote object, you can shave\nround-trips by using these functions instead of ``then``. To take\nadvantage of promises for remote objects, check out [Q-Connection][].\n\n[Q-Connection]: https://github.com/kriskowal/q-connection\n\nEven in the case of non-remote objects, these methods can be used as\nshorthand for particularly-simple fulfillment handlers. For example, you\ncan replace\n\n```javascript\nreturn Q.fcall(function () {\n return [{ foo: \"bar\" }, { foo: \"baz\" }];\n})\n.then(function (value) {\n return value[0].foo;\n});\n```\n\nwith\n\n```javascript\nreturn Q.fcall(function () {\n return [{ foo: \"bar\" }, { foo: \"baz\" }];\n})\n.get(0)\n.get(\"foo\");\n```\n\n### Adapting Node\n\nIf you're working with functions that make use of the Node.js callback pattern,\nwhere callbacks are in the form of `function(err, result)`, Q provides a few\nuseful utility functions for converting between them. The most straightforward\nare probably `Q.nfcall` and `Q.nfapply` (\"Node function call/apply\") for calling\nNode.js-style functions and getting back a promise:\n\n```javascript\nreturn Q.nfcall(FS.readFile, \"foo.txt\", \"utf-8\");\nreturn Q.nfapply(FS.readFile, [\"foo.txt\", \"utf-8\"]);\n```\n\nIf you are working with methods, instead of simple functions, you can easily\nrun in to the usual problems where passing a method to another function—like\n`Q.nfcall`—\"un-binds\" the method from its owner. To avoid this, you can either\nuse `Function.prototype.bind` or some nice shortcut methods we provide:\n\n```javascript\nreturn Q.ninvoke(redisClient, \"get\", \"user:1:id\");\nreturn Q.npost(redisClient, \"get\", [\"user:1:id\"]);\n```\n\nYou can also create reusable wrappers with `Q.denodeify` or `Q.nbind`:\n\n```javascript\nvar readFile = Q.denodeify(FS.readFile);\nreturn readFile(\"foo.txt\", \"utf-8\");\n\nvar redisClientGet = Q.nbind(redisClient.get, redisClient);\nreturn redisClientGet(\"user:1:id\");\n```\n\nFinally, if you're working with raw deferred objects, there is a\n`makeNodeResolver` method on deferreds that can be handy:\n\n```javascript\nvar deferred = Q.defer();\nFS.readFile(\"foo.txt\", \"utf-8\", deferred.makeNodeResolver());\nreturn deferred.promise;\n```\n\n### Long Stack Traces\n\nQ comes with optional support for “long stack traces,” wherein the `stack`\nproperty of `Error` rejection reasons is rewritten to be traced along\nasynchronous jumps instead of stopping at the most recent one. As an example:\n\n```js\nfunction theDepthsOfMyProgram() {\n Q.delay(100).done(function explode() {\n throw new Error(\"boo!\");\n });\n}\n\ntheDepthsOfMyProgram();\n```\n\nusually would give a rather unhelpful stack trace looking something like\n\n```\nError: boo!\n at explode (/path/to/test.js:3:11)\n at _fulfilled (/path/to/test.js:q:54)\n at resolvedValue.promiseDispatch.done (/path/to/q.js:823:30)\n at makePromise.promise.promiseDispatch (/path/to/q.js:496:13)\n at pending (/path/to/q.js:397:39)\n at process.startup.processNextTick.process._tickCallback (node.js:244:9)\n```\n\nBut, if you turn this feature on by setting\n\n```js\nQ.longStackSupport = true;\n```\n\nthen the above code gives a nice stack trace to the tune of\n\n```\nError: boo!\n at explode (/path/to/test.js:3:11)\nFrom previous event:\n at theDepthsOfMyProgram (/path/to/test.js:2:16)\n at Object.<anonymous> (/path/to/test.js:7:1)\n```\n\nNote how you can see the function that triggered the async operation in the\nstack trace! This is very helpful for debugging, as otherwise you end up getting\nonly the first line, plus a bunch of Q internals, with no sign of where the\noperation started.\n\nIn node.js, this feature can also be enabled through the Q_DEBUG environment\nvariable:\n\n```\nQ_DEBUG=1 node server.js\n```\n\nThis will enable long stack support in every instance of Q.\n\nThis feature does come with somewhat-serious performance and memory overhead,\nhowever. If you're working with lots of promises, or trying to scale a server\nto many users, you should probably keep it off. But in development, go for it!\n\n## Tests\n\nYou can view the results of the Q test suite [in your browser][tests]!\n\n[tests]: https://rawgithub.com/kriskowal/q/v1/spec/q-spec.html\n\n## License\n\nCopyright 2009–2017 Kristopher Michael Kowal and contributors\nMIT License (enclosed)\n# CSS Modules: css-selector-tokenizer\n[](https://travis-ci.org/css-modules/css-selector-tokenizer)\n[](https://coveralls.io/r/css-modules/css-selector-tokenizer?branch=master)\n[](https://codecov.io/github/css-modules/css-selector-tokenizer?branch=master)\n\nParses and stringifies CSS selectors.\n\n``` js\nimport Tokenizer from \"css-selector-tokenizer\";\n\nlet input = \"a#content.active > div::first-line [data-content], a:not(:visited)\";\n\nTokenizer.parse(input); // === expected\nlet expected = {\n type: \"selectors\",\n nodes: [\n {\n type: \"selector\",\n nodes: [\n { type: \"element\", name: \"a\" },\n { type: \"id\", name: \"content\" },\n { type: \"class\", name: \"active\" },\n { type: \"operator\", operator: \">\", before: \" \", after: \" \" },\n { type: \"element\", name: \"div\" },\n { type: \"pseudo-element\", name: \"first-line\" },\n { type: \"spacing\", value: \" \" },\n { type: \"attribute\", content: \"data-content\" },\n ]\n },\n {\n type: \"selector\",\n nodes: [\n { type: \"element\", name: \"a\" },\n { type: \"nested-pseudo-class\", name: \"not\", nodes: [\n {\n type: \"selector\",\n nodes: [\n { type: \"pseudo-class\", name: \"visited\" }\n ]\n }\n ] }\n ],\n before: \" \"\n }\n ]\n}\n\nTokenizer.stringify(expected) // === input\n\n// * => { type: \"universal\" }\n// foo|element = { type: \"element\", name: \"element\", namespace: \"foo\" }\n// *|* = { type: \"universal\", namespace: \"*\" }\n// :has(h1, h2) => { type: \"nested-pseudo-class\", name: \"has\", nodes: [\n// {\n// type: \"selector\",\n// nodes: [\n// { type: \"element\", name: \"h1\" }\n// ]\n// },\n// {\n// type: \"selector\",\n// nodes: [\n// { type: \"element\", name: \"h2\" }\n// ],\n// before: \" \"\n// }\n// ] }\n```\n\n## Building\n\n```\nnpm install\nnpm test\n```\n\n## Development\n\n- `npm test -- -w` will watch `lib` and `test` for changes and retest\n\n## License\n\nMIT\n\n## With thanks\n\n- Mark Dalgleish\n- Glen Maddern\n- Guy Bedford\n\n---\nTobias Koppers, 2015.\n# babel-plugin-dynamic-import-node\n\nBabel plugin to transpile `import()` to a deferred `require()`, for node. Matches the [proposed spec](https://github.com/domenic/proposal-import-function).\n\n**NOTE:** Babylon >= v6.12.0 is required to correctly parse dynamic imports.\n\n## Installation\n\n```sh\nnpm install babel-plugin-dynamic-import-node --save-dev\n```\n\n## Usage\n\n### Via `.babelrc` (Recommended)\n\n**.babelrc**\n\n```json\n{\n \"plugins\": [\"dynamic-import-node\"]\n}\n```\n\n#### Options\n\n- *`noInterop`* - A boolean value, that if true will not interop the require calls. Useful to avoid using `require('module').default` on commonjs modules.\n\n```json\n{\n \"plugins\": [\n [\"dynamic-import-node\", { \"noInterop\": true }]\n ]\n}\n```\n\n### Via CLI\n\n```sh\n$ babel --plugins dynamic-import-node script.js\n```\n\n### Via Node API\n\n```javascript\nrequire('babel-core').transform('code', {\n plugins: ['dynamic-import-node']\n});\n```\n\n### Code Example\n```javascript\nPromise.all([\n import('./lib/import1'),\n import('./lib/import2')\n ]).then(([\n Import1,\n Import2\n ]) => {\n console.log(Import1);\n /* CODE HERE*/\n });\n```\n# JSON5 – JSON for Humans\n\n[][Build Status]\n[][Coverage\nStatus]\n\nThe JSON5 Data Interchange Format (JSON5) is a superset of [JSON] that aims to\nalleviate some of the limitations of JSON by expanding its syntax to include\nsome productions from [ECMAScript 5.1].\n\nThis JavaScript library is the official reference implementation for JSON5\nparsing and serialization libraries.\n\n[Build Status]: https://travis-ci.org/json5/json5\n\n[Coverage Status]: https://coveralls.io/github/json5/json5\n\n[JSON]: https://tools.ietf.org/html/rfc7159\n\n[ECMAScript 5.1]: https://www.ecma-international.org/ecma-262/5.1/\n\n## Summary of Features\nThe following ECMAScript 5.1 features, which are not supported in JSON, have\nbeen extended to JSON5.\n\n### Objects\n- Object keys may be an ECMAScript 5.1 _[IdentifierName]_.\n- Objects may have a single trailing comma.\n\n### Arrays\n- Arrays may have a single trailing comma.\n\n### Strings\n- Strings may be single quoted.\n- Strings may span multiple lines by escaping new line characters.\n- Strings may include character escapes.\n\n### Numbers\n- Numbers may be hexadecimal.\n- Numbers may have a leading or trailing decimal point.\n- Numbers may be [IEEE 754] positive infinity, negative infinity, and NaN.\n- Numbers may begin with an explicit plus sign.\n\n### Comments\n- Single and multi-line comments are allowed.\n\n### White Space\n- Additional white space characters are allowed.\n\n[IdentifierName]: https://www.ecma-international.org/ecma-262/5.1/#sec-7.6\n\n[IEEE 754]: http://ieeexplore.ieee.org/servlet/opac?punumber=4610933\n\n## Short Example\n```js\n{\n // comments\n unquoted: 'and you can quote me on that',\n singleQuotes: 'I can use \"double quotes\" here',\n lineBreaks: \"Look, Mom! \\\nNo \\\\n's!\",\n hexadecimal: 0xdecaf,\n leadingDecimalPoint: .8675309, andTrailing: 8675309.,\n positiveSign: +1,\n trailingComma: 'in objects', andIn: ['arrays',],\n \"backwardsCompatible\": \"with JSON\",\n}\n```\n\n## Specification\nFor a detailed explanation of the JSON5 format, please read the [official\nspecification](https://json5.github.io/json5-spec/).\n\n## Installation\n### Node.js\n```sh\nnpm install json5\n```\n\n```js\nconst JSON5 = require('json5')\n```\n\n### Browsers\n```html\n<script src=\"https://unpkg.com/json5@^1.0.0\"></script>\n```\n\nThis will create a global `JSON5` variable.\n\n## API\nThe JSON5 API is compatible with the [JSON API].\n\n[JSON API]:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON\n\n### JSON5.parse()\nParses a JSON5 string, constructing the JavaScript value or object described by\nthe string. An optional reviver function can be provided to perform a\ntransformation on the resulting object before it is returned.\n\n#### Syntax\n JSON5.parse(text[, reviver])\n\n#### Parameters\n- `text`: The string to parse as JSON5.\n- `reviver`: If a function, this prescribes how the value originally produced by\n parsing is transformed, before being returned.\n\n#### Return value\nThe object corresponding to the given JSON5 text.\n\n### JSON5.stringify()\nConverts a JavaScript value to a JSON5 string, optionally replacing values if a\nreplacer function is specified, or optionally including only the specified\nproperties if a replacer array is specified.\n\n#### Syntax\n JSON5.stringify(value[, replacer[, space]])\n JSON5.stringify(value[, options])\n\n#### Parameters\n- `value`: The value to convert to a JSON5 string.\n- `replacer`: A function that alters the behavior of the stringification\n process, or an array of String and Number objects that serve as a whitelist\n for selecting/filtering the properties of the value object to be included in\n the JSON5 string. If this value is null or not provided, all properties of the\n object are included in the resulting JSON5 string.\n- `space`: A String or Number object that's used to insert white space into the\n output JSON5 string for readability purposes. If this is a Number, it\n indicates the number of space characters to use as white space; this number is\n capped at 10 (if it is greater, the value is just 10). Values less than 1\n indicate that no space should be used. If this is a String, the string (or the\n first 10 characters of the string, if it's longer than that) is used as white\n space. If this parameter is not provided (or is null), no white space is used.\n If white space is used, trailing commas will be used in objects and arrays.\n- `options`: An object with the following properties:\n - `replacer`: Same as the `replacer` parameter.\n - `space`: Same as the `space` parameter.\n - `quote`: A String representing the quote character to use when serializing\n strings.\n\n#### Return value\nA JSON5 string representing the value.\n\n### Node.js `require()` JSON5 files\nWhen using Node.js, you can `require()` JSON5 files by adding the following\nstatement.\n\n```js\nrequire('json5/lib/register')\n```\n\nThen you can load a JSON5 file with a Node.js `require()` statement. For\nexample:\n\n```js\nconst config = require('./config.json5')\n```\n\n## CLI\nSince JSON is more widely used than JSON5, this package includes a CLI for\nconverting JSON5 to JSON and for validating the syntax of JSON5 documents.\n\n### Installation\n```sh\nnpm install --global json5\n```\n\n### Usage\n```sh\njson5 [options] <file>\n```\n\nIf `<file>` is not provided, then STDIN is used.\n\n#### Options:\n- `-s`, `--space`: The number of spaces to indent or `t` for tabs\n- `-o`, `--out-file [file]`: Output to the specified file, otherwise STDOUT\n- `-v`, `--validate`: Validate JSON5 but do not output JSON\n- `-V`, `--version`: Output the version number\n- `-h`, `--help`: Output usage information\n\n## Contibuting\n### Development\n```sh\ngit clone https://github.com/json5/json5\ncd json5\nnpm install\n```\n\nWhen contributing code, please write relevant tests and run `npm test` and `npm\nrun lint` before submitting pull requests. Please use an editor that supports\n[EditorConfig](http://editorconfig.org/).\n\n### Issues\nTo report bugs or request features regarding the JSON5 data format, please\nsubmit an issue to the [official specification\nrepository](https://github.com/json5/json5-spec).\n\nTo report bugs or request features regarding the JavaScript implentation of\nJSON5, please submit an issue to this repository.\n\n## License\nMIT. See [LICENSE.md](./LICENSE.md) for details.\n\n## Credits\n[Assem Kishore](https://github.com/aseemk) founded this project.\n\n[Michael Bolin](http://bolinfest.com/) independently arrived at and published\nsome of these same ideas with awesome explanations and detail. Recommended\nreading: [Suggested Improvements to JSON](http://bolinfest.com/essays/json.html)\n\n[Douglas Crockford](http://www.crockford.com/) of course designed and built\nJSON, but his state machine diagrams on the [JSON website](http://json.org/), as\ncheesy as it may sound, gave us motivation and confidence that building a new\nparser to implement these ideas was within reach! The original\nimplementation of JSON5 was also modeled directly off of Doug’s open-source\n[json_parse.js] parser. We’re grateful for that clean and well-documented\ncode.\n\n[json_parse.js]:\nhttps://github.com/douglascrockford/JSON-js/blob/master/json_parse.js\n\n[Max Nanasy](https://github.com/MaxNanasy) has been an early and prolific\nsupporter, contributing multiple patches and ideas.\n\n[Andrew Eisenberg](https://github.com/aeisenberg) contributed the original\n`stringify` method.\n\n[Jordan Tucker](https://github.com/jordanbtucker) has aligned JSON5 more closely\nwith ES5, wrote the official JSON5 specification, completely rewrote the\ncodebase from the ground up, and is actively maintaining this project.\ndiscontinuous-range\n===================\n\n```\nDiscontinuousRange(1, 10).subtract(4, 6); // [ 1-3, 7-10 ]\n```\n\n [](https://travis-ci.org/dtudury/discontinuous-range)\n\nthis is a pretty simple module, but it exists to service another project\nso this'll be pretty lacking documentation. \nreading the test to see how this works may help. otherwise, here's an example\nthat I think pretty much sums it up\n\n###Example\n```\nvar all_numbers = new DiscontinuousRange(1, 100);\nvar bad_numbers = DiscontinuousRange(13).add(8).add(60,80);\nvar good_numbers = all_numbers.clone().subtract(bad_numbers);\nconsole.log(good_numbers.toString()); //[ 1-7, 9-12, 14-59, 81-100 ]\nvar random_good_number = good_numbers.index(Math.floor(Math.random() * good_numbers.length));\n```\n# stream-http [](https://travis-ci.org/jhiesey/stream-http)\n\n[](https://saucelabs.com/u/stream-http)\n\nThis module is an implementation of Node's native `http` module for the browser.\nIt tries to match Node's API and behavior as closely as possible, but some features\naren't available, since browsers don't give nearly as much control over requests.\n\nThis is heavily inspired by, and intended to replace, [http-browserify](https://github.com/substack/http-browserify).\n\n## What does it do?\n\nIn accordance with its name, `stream-http` tries to provide data to its caller before\nthe request has completed whenever possible.\n\nBackpressure, allowing the browser to only pull data from the server as fast as it is\nconsumed, is supported in:\n* Chrome >= 58 (using `fetch` and `WritableStream`)\n\nThe following browsers support true streaming, where only a small amount of the request\nhas to be held in memory at once:\n* Chrome >= 43 (using the `fetch` API)\n* Firefox >= 9 (using `moz-chunked-arraybuffer` responseType with xhr)\n\nThe following browsers support pseudo-streaming, where the data is available before the\nrequest finishes, but the entire response must be held in memory:\n* Chrome\n* Safari >= 5, and maybe older\n* IE >= 10\n* Most other Webkit-based browsers, including the default Android browser\n\nAll browsers newer than IE8 support binary responses. All of the above browsers that\nsupport true streaming or pseudo-streaming support that for binary data as well\nexcept for IE10. Old (presto-based) Opera also does not support binary streaming either.\n\n### IE8 note:\nAs of version 2.0.0, IE8 support requires the user to supply polyfills for\n`Object.keys`, `Array.prototype.forEach`, and `Array.prototype.indexOf`. Example\nimplementations are provided in [ie8-polyfill.js](ie8-polyfill.js); alternately,\nyou may want to consider using [es5-shim](https://github.com/es-shims/es5-shim).\nAll browsers with full ES5 support shouldn't require any polyfills.\n\n## How do you use it?\n\nThe intent is to have the same API as the client part of the\n[Node HTTP module](https://nodejs.org/api/http.html). The interfaces are the same wherever\npractical, although limitations in browsers make an exact clone of the Node API impossible.\n\nThis module implements `http.request`, `http.get`, and most of `http.ClientRequest`\nand `http.IncomingMessage` in addition to `http.METHODS` and `http.STATUS_CODES`. See the\nNode docs for how these work.\n\n### Extra features compared to Node\n\n* The `message.url` property provides access to the final URL after all redirects. This\nis useful since the browser follows all redirects silently, unlike Node. It is available\nin Chrome 37 and newer, Firefox 32 and newer, and Safari 9 and newer.\n\n* The `options.withCredentials` boolean flag, used to indicate if the browser should send\ncookies or authentication information with a CORS request. Default false.\n\nThis module has to make some tradeoffs to support binary data and/or streaming. Generally,\nthe module can make a fairly good decision about which underlying browser features to use,\nbut sometimes it helps to get a little input from the developer.\n\n* The `options.mode` field passed into `http.request` or `http.get` can take on one of the\nfollowing values:\n * 'default' (or any falsy value, including `undefined`): Try to provide partial data before\nthe request completes, but not at the cost of correctness for binary data or correctness of\nthe 'content-type' response header. This mode will also avoid slower code paths whenever\npossible, which is particularly useful when making large requests in a browser like Safari\nthat has a weaker JavaScript engine.\n * 'allow-wrong-content-type': Provides partial data in more cases than 'default', but\nat the expense of causing the 'content-type' response header to be incorrectly reported\n(as 'text/plain; charset=x-user-defined') in some browsers, notably Safari and Chrome 42\nand older. Preserves binary data whenever possible. In some cases the implementation may\nalso be a bit slow. This was the default in versions of this module before 1.5.\n * 'prefer-stream': Provide data before the request completes even if binary data (anything\nthat isn't a single-byte ASCII or UTF8 character) will be corrupted. Of course, this option\nis only safe for text data. May also cause the 'content-type' response header to be\nincorrectly reported (as 'text/plain; charset=x-user-defined').\n * 'disable-fetch': Force the use of plain XHR regardless of the browser declaring a fetch\ncapability. Preserves the correctness of binary data and the 'content-type' response header.\n * 'prefer-fast': Deprecated; now a synonym for 'default', which has the same performance\ncharacteristics as this mode did in versions before 1.5.\n\n* `options.requestTimeout` allows setting a timeout in millisecionds for XHR and fetch (if\nsupported by the browser). This is a limit on how long the entire process takes from\nbeginning to end. Note that this is not the same as the node `setTimeout` functions,\nwhich apply to pauses in data transfer over the underlying socket, or the node `timeout`\noption, which applies to opening the connection.\n\n### Features missing compared to Node\n\n* `http.Agent` is only a stub\n* The 'socket', 'connect', 'upgrade', and 'continue' events on `http.ClientRequest`.\n* Any operations, including `request.setTimeout`, that operate directly on the underlying\nsocket.\n* Any options that are disallowed for security reasons. This includes setting or getting\ncertain headers.\n* `message.httpVersion`\n* `message.rawHeaders` is modified by the browser, and may not quite match what is sent by\nthe server.\n* `message.trailers` and `message.rawTrailers` will remain empty.\n* Redirects are followed silently by the browser, so it isn't possible to access the 301/302\nredirect pages.\n* The `timeout` event/option and `setTimeout` functions, which operate on the underlying\nsocket, are not available. However, see `options.requestTimeout` above.\n\n## Example\n\n``` js\nhttp.get('/bundle.js', function (res) {\n\tvar div = document.getElementById('result');\n\tdiv.innerHTML += 'GET /beep<br>';\n\n\tres.on('data', function (buf) {\n\t\tdiv.innerHTML += buf;\n\t});\n\n\tres.on('end', function () {\n\t\tdiv.innerHTML += '<br>__END__';\n\t});\n})\n```\n\n## Running tests\n\nThere are two sets of tests: the tests that run in Node (found in `test/node`) and the tests\nthat run in the browser (found in `test/browser`). Normally the browser tests run on\n[Sauce Labs](http://saucelabs.com/).\n\nRunning `npm test` will run both sets of tests, but in order for the Sauce Labs tests to run\nyou will need to sign up for an account (free for open source projects) and put the\ncredentials in a [`.zuulrc` file](https://github.com/defunctzombie/zuul/wiki/zuulrc).\n\nTo run just the Node tests, run `npm run test-node`.\n\nTo run the browser tests locally, run `npm run test-browser-local` and point your browser to\n`http://localhost:8080/__zuul`\n\n## License\n\nMIT. Copyright (C) John Hiesey and other contributors.\nargparse\n========\n\n[](http://travis-ci.org/nodeca/argparse)\n[](https://www.npmjs.org/package/argparse)\n\nCLI arguments parser for node.js. Javascript port of python's\n[argparse](http://docs.python.org/dev/library/argparse.html) module\n(original version 3.2). That's a full port, except some very rare options,\nrecorded in issue tracker.\n\n**NB. Difference with original.**\n\n- Method names changed to camelCase. See [generated docs](http://nodeca.github.com/argparse/).\n- Use `defaultValue` instead of `default`.\n- Use `argparse.Const.REMAINDER` instead of `argparse.REMAINDER`, and\n similarly for constant values `OPTIONAL`, `ZERO_OR_MORE`, and `ONE_OR_MORE`\n (aliases for `nargs` values `'?'`, `'*'`, `'+'`, respectively), and\n `SUPPRESS`.\n\nExample\n=======\n\ntest.js file:\n\n```javascript\n#!/usr/bin/env node\n'use strict';\n\nvar ArgumentParser = require('../lib/argparse').ArgumentParser;\nvar parser = new ArgumentParser({\n version: '0.0.1',\n addHelp:true,\n description: 'Argparse example'\n});\nparser.addArgument(\n [ '-f', '--foo' ],\n {\n help: 'foo bar'\n }\n);\nparser.addArgument(\n [ '-b', '--bar' ],\n {\n help: 'bar foo'\n }\n);\nparser.addArgument(\n '--baz',\n {\n help: 'baz bar'\n }\n);\nvar args = parser.parseArgs();\nconsole.dir(args);\n```\n\nDisplay help:\n\n```\n$ ./test.js -h\nusage: example.js [-h] [-v] [-f FOO] [-b BAR] [--baz BAZ]\n\nArgparse example\n\nOptional arguments:\n -h, --help Show this help message and exit.\n -v, --version Show program's version number and exit.\n -f FOO, --foo FOO foo bar\n -b BAR, --bar BAR bar foo\n --baz BAZ baz bar\n```\n\nParse arguments:\n\n```\n$ ./test.js -f=3 --bar=4 --baz 5\n{ foo: '3', bar: '4', baz: '5' }\n```\n\nMore [examples](https://github.com/nodeca/argparse/tree/master/examples).\n\nArgumentParser objects\n======================\n\n```\nnew ArgumentParser({parameters hash});\n```\n\nCreates a new ArgumentParser object.\n\n**Supported params:**\n\n- ```description``` - Text to display before the argument help.\n- ```epilog``` - Text to display after the argument help.\n- ```addHelp``` - Add a -h/–help option to the parser. (default: true)\n- ```argumentDefault``` - Set the global default value for arguments. (default: null)\n- ```parents``` - A list of ArgumentParser objects whose arguments should also be included.\n- ```prefixChars``` - The set of characters that prefix optional arguments. (default: ‘-‘)\n- ```formatterClass``` - A class for customizing the help output.\n- ```prog``` - The name of the program (default: `path.basename(process.argv[1])`)\n- ```usage``` - The string describing the program usage (default: generated)\n- ```conflictHandler``` - Usually unnecessary, defines strategy for resolving conflicting optionals.\n\n**Not supported yet**\n\n- ```fromfilePrefixChars``` - The set of characters that prefix files from which additional arguments should be read.\n\nDetails in [original ArgumentParser guide](http://docs.python.org/dev/library/argparse.html#argumentparser-objects)\n\naddArgument() method\n====================\n\n```\nArgumentParser.addArgument(name or flag or [name] or [flags...], {options})\n```\n\nDefines how a single command-line argument should be parsed.\n\n- ```name or flag or [name] or [flags...]``` - Either a positional name\n (e.g., `'foo'`), a single option (e.g., `'-f'` or `'--foo'`), an array\n of a single positional name (e.g., `['foo']`), or an array of options\n (e.g., `['-f', '--foo']`).\n\nOptions:\n\n- ```action``` - The basic type of action to be taken when this argument is encountered at the command line.\n- ```nargs```- The number of command-line arguments that should be consumed.\n- ```constant``` - A constant value required by some action and nargs selections.\n- ```defaultValue``` - The value produced if the argument is absent from the command line.\n- ```type``` - The type to which the command-line argument should be converted.\n- ```choices``` - A container of the allowable values for the argument.\n- ```required``` - Whether or not the command-line option may be omitted (optionals only).\n- ```help``` - A brief description of what the argument does.\n- ```metavar``` - A name for the argument in usage messages.\n- ```dest``` - The name of the attribute to be added to the object returned by parseArgs().\n\nDetails in [original add_argument guide](http://docs.python.org/dev/library/argparse.html#the-add-argument-method)\n\nAction (some details)\n================\n\nArgumentParser objects associate command-line arguments with actions.\nThese actions can do just about anything with the command-line arguments associated\nwith them, though most actions simply add an attribute to the object returned by\nparseArgs(). The action keyword argument specifies how the command-line arguments\nshould be handled. The supported actions are:\n\n- ```store``` - Just stores the argument’s value. This is the default action.\n- ```storeConst``` - Stores value, specified by the const keyword argument.\n (Note that the const keyword argument defaults to the rather unhelpful None.)\n The 'storeConst' action is most commonly used with optional arguments, that\n specify some sort of flag.\n- ```storeTrue``` and ```storeFalse``` - Stores values True and False\n respectively. These are special cases of 'storeConst'.\n- ```append``` - Stores a list, and appends each argument value to the list.\n This is useful to allow an option to be specified multiple times.\n- ```appendConst``` - Stores a list, and appends value, specified by the\n const keyword argument to the list. (Note, that the const keyword argument defaults\n is None.) The 'appendConst' action is typically used when multiple arguments need\n to store constants to the same list.\n- ```count``` - Counts the number of times a keyword argument occurs. For example,\n used for increasing verbosity levels.\n- ```help``` - Prints a complete help message for all the options in the current\n parser and then exits. By default a help action is automatically added to the parser.\n See ArgumentParser for details of how the output is created.\n- ```version``` - Prints version information and exit. Expects a `version=`\n keyword argument in the addArgument() call.\n\nDetails in [original action guide](http://docs.python.org/dev/library/argparse.html#action)\n\nSub-commands\n============\n\nArgumentParser.addSubparsers()\n\nMany programs split their functionality into a number of sub-commands, for\nexample, the svn program can invoke sub-commands like `svn checkout`, `svn update`,\nand `svn commit`. Splitting up functionality this way can be a particularly good\nidea when a program performs several different functions which require different\nkinds of command-line arguments. `ArgumentParser` supports creation of such\nsub-commands with `addSubparsers()` method. The `addSubparsers()` method is\nnormally called with no arguments and returns an special action object.\nThis object has a single method `addParser()`, which takes a command name and\nany `ArgumentParser` constructor arguments, and returns an `ArgumentParser` object\nthat can be modified as usual.\n\nExample:\n\nsub_commands.js\n```javascript\n#!/usr/bin/env node\n'use strict';\n\nvar ArgumentParser = require('../lib/argparse').ArgumentParser;\nvar parser = new ArgumentParser({\n version: '0.0.1',\n addHelp:true,\n description: 'Argparse examples: sub-commands',\n});\n\nvar subparsers = parser.addSubparsers({\n title:'subcommands',\n dest:\"subcommand_name\"\n});\n\nvar bar = subparsers.addParser('c1', {addHelp:true});\nbar.addArgument(\n [ '-f', '--foo' ],\n {\n action: 'store',\n help: 'foo3 bar3'\n }\n);\nvar bar = subparsers.addParser(\n 'c2',\n {aliases:['co'], addHelp:true}\n);\nbar.addArgument(\n [ '-b', '--bar' ],\n {\n action: 'store',\n type: 'int',\n help: 'foo3 bar3'\n }\n);\n\nvar args = parser.parseArgs();\nconsole.dir(args);\n\n```\n\nDetails in [original sub-commands guide](http://docs.python.org/dev/library/argparse.html#sub-commands)\n\nContributors\n============\n\n- [Eugene Shkuropat](https://github.com/shkuropat)\n- [Paul Jacobson](https://github.com/hpaulj)\n\n[others](https://github.com/nodeca/argparse/graphs/contributors)\n\nLicense\n=======\n\nCopyright (c) 2012 [Vitaly Puzrin](https://github.com/puzrin).\nReleased under the MIT license. See\n[LICENSE](https://github.com/nodeca/argparse/blob/master/LICENSE) for details.\nOverview [](https://travis-ci.org/lydell/js-tokens)\n========\n\nA regex that tokenizes JavaScript.\n\n```js\nvar jsTokens = require(\"js-tokens\").default\n\nvar jsString = \"var foo=opts.foo;\\n...\"\n\njsString.match(jsTokens)\n// [\"var\", \" \", \"foo\", \"=\", \"opts\", \".\", \"foo\", \";\", \"\\n\", ...]\n```\n\nInstallation\n============\n\n`npm install js-tokens`\n\n```js\nimport jsTokens from \"js-tokens\"\n// or:\nvar jsTokens = require(\"js-tokens\").default\n```\n\nUsage\n=====\n\n### `jsTokens` ###\n\nA regex with the `g` flag that matches JavaScript tokens.\n\nThe regex _always_ matches, even invalid JavaScript and the empty string.\n\nThe next match is always directly after the previous.\n\n### `var token = matchToToken(match)` ###\n\n```js\nimport {matchToToken} from \"js-tokens\"\n// or:\nvar matchToToken = require(\"js-tokens\").matchToToken\n```\n\nTakes a `match` returned by `jsTokens.exec(string)`, and returns a `{type:\nString, value: String}` object. The following types are available:\n\n- string\n- comment\n- regex\n- number\n- name\n- punctuator\n- whitespace\n- invalid\n\nMulti-line comments and strings also have a `closed` property indicating if the\ntoken was closed or not (see below).\n\nComments and strings both come in several flavors. To distinguish them, check if\nthe token starts with `//`, `/*`, `'`, `\"` or `` ` ``.\n\nNames are ECMAScript IdentifierNames, that is, including both identifiers and\nkeywords. You may use [is-keyword-js] to tell them apart.\n\nWhitespace includes both line terminators and other whitespace.\n\n[is-keyword-js]: https://github.com/crissdev/is-keyword-js\n\nECMAScript support\n==================\n\nThe intention is to always support the latest ECMAScript version whose feature\nset has been finalized.\n\nIf adding support for a newer version requires changes, a new version with a\nmajor verion bump will be released.\n\nCurrently, ECMAScript 2018 is supported.\n\nInvalid code handling\n=====================\n\nUnterminated strings are still matched as strings. JavaScript strings cannot\ncontain (unescaped) newlines, so unterminated strings simply end at the end of\nthe line. Unterminated template strings can contain unescaped newlines, though,\nso they go on to the end of input.\n\nUnterminated multi-line comments are also still matched as comments. They\nsimply go on to the end of the input.\n\nUnterminated regex literals are likely matched as division and whatever is\ninside the regex.\n\nInvalid ASCII characters have their own capturing group.\n\nInvalid non-ASCII characters are treated as names, to simplify the matching of\nnames (except unicode spaces which are treated as whitespace). Note: See also\nthe [ES2018](#es2018) section.\n\nRegex literals may contain invalid regex syntax. They are still matched as\nregex literals. They may also contain repeated regex flags, to keep the regex\nsimple.\n\nStrings may contain invalid escape sequences.\n\nLimitations\n===========\n\nTokenizing JavaScript using regexes—in fact, _one single regex_—won’t be\nperfect. But that’s not the point either.\n\nYou may compare jsTokens with [esprima] by using `esprima-compare.js`.\nSee `npm run esprima-compare`!\n\n[esprima]: http://esprima.org/\n\n### Template string interpolation ###\n\nTemplate strings are matched as single tokens, from the starting `` ` `` to the\nending `` ` ``, including interpolations (whose tokens are not matched\nindividually).\n\nMatching template string interpolations requires recursive balancing of `{` and\n`}`—something that JavaScript regexes cannot do. Only one level of nesting is\nsupported.\n\n### Division and regex literals collision ###\n\nConsider this example:\n\n```js\nvar g = 9.82\nvar number = bar / 2/g\n\nvar regex = / 2/g\n```\n\nA human can easily understand that in the `number` line we’re dealing with\ndivision, and in the `regex` line we’re dealing with a regex literal. How come?\nBecause humans can look at the whole code to put the `/` characters in context.\nA JavaScript regex cannot. It only sees forwards. (Well, ES2018 regexes can also\nlook backwards. See the [ES2018](#es2018) section).\n\nWhen the `jsTokens` regex scans throught the above, it will see the following\nat the end of both the `number` and `regex` rows:\n\n```js\n/ 2/g\n```\n\nIt is then impossible to know if that is a regex literal, or part of an\nexpression dealing with division.\n\nHere is a similar case:\n\n```js\nfoo /= 2/g\nfoo(/= 2/g)\n```\n\nThe first line divides the `foo` variable with `2/g`. The second line calls the\n`foo` function with the regex literal `/= 2/g`. Again, since `jsTokens` only\nsees forwards, it cannot tell the two cases apart.\n\nThere are some cases where we _can_ tell division and regex literals apart,\nthough.\n\nFirst off, we have the simple cases where there’s only one slash in the line:\n\n```js\nvar foo = 2/g\nfoo /= 2\n```\n\nRegex literals cannot contain newlines, so the above cases are correctly\nidentified as division. Things are only problematic when there are more than\none non-comment slash in a single line.\n\nSecondly, not every character is a valid regex flag.\n\n```js\nvar number = bar / 2/e\n```\n\nThe above example is also correctly identified as division, because `e` is not a\nvalid regex flag. I initially wanted to future-proof by allowing `[a-zA-Z]*`\n(any letter) as flags, but it is not worth it since it increases the amount of\nambigous cases. So only the standard `g`, `m`, `i`, `y` and `u` flags are\nallowed. This means that the above example will be identified as division as\nlong as you don’t rename the `e` variable to some permutation of `gmiyus` 1 to 6\ncharacters long.\n\nLastly, we can look _forward_ for information.\n\n- If the token following what looks like a regex literal is not valid after a\n regex literal, but is valid in a division expression, then the regex literal\n is treated as division instead. For example, a flagless regex cannot be\n followed by a string, number or name, but all of those three can be the\n denominator of a division.\n- Generally, if what looks like a regex literal is followed by an operator, the\n regex literal is treated as division instead. This is because regexes are\n seldomly used with operators (such as `+`, `*`, `&&` and `==`), but division\n could likely be part of such an expression.\n\nPlease consult the regex source and the test cases for precise information on\nwhen regex or division is matched (should you need to know). In short, you\ncould sum it up as:\n\nIf the end of a statement looks like a regex literal (even if it isn’t), it\nwill be treated as one. Otherwise it should work as expected (if you write sane\ncode).\n\n### ES2018 ###\n\nES2018 added some nice regex improvements to the language.\n\n- [Unicode property escapes] should allow telling names and invalid non-ASCII\n characters apart without blowing up the regex size.\n- [Lookbehind assertions] should allow matching telling division and regex\n literals apart in more cases.\n- [Named capture groups] might simplify some things.\n\nThese things would be nice to do, but are not critical. They probably have to\nwait until the oldest maintained Node.js LTS release supports those features.\n\n[Unicode property escapes]: http://2ality.com/2017/07/regexp-unicode-property-escapes.html\n[Lookbehind assertions]: http://2ality.com/2017/05/regexp-lookbehind-assertions.html\n[Named capture groups]: http://2ality.com/2017/05/regexp-named-capture-groups.html\n\nLicense\n=======\n\n[MIT](LICENSE).\nA JSON with color names and its values. Based on http://dev.w3.org/csswg/css-color/#named-colors.\n\n[](https://nodei.co/npm/color-name/)\n\n```js\nvar colors = require('color-name');\ncolors.red //[255,0,0]\n```\n\n<a href=\"LICENSE\"><img src=\"https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg\" width=\"120\"/></a>\n# <img src=\"./logo.png\" alt=\"bn.js\" width=\"160\" height=\"160\" />\n\n> BigNum in pure javascript\n\n[](http://travis-ci.org/indutny/bn.js)\n\n## Install\n`npm install --save bn.js`\n\n## Usage\n\n```js\nconst BN = require('bn.js');\n\nvar a = new BN('dead', 16);\nvar b = new BN('101010', 2);\n\nvar res = a.add(b);\nconsole.log(res.toString(10)); // 57047\n```\n\n**Note**: decimals are not supported in this library.\n\n## Notation\n\n### Prefixes\n\nThere are several prefixes to instructions that affect the way the work. Here\nis the list of them in the order of appearance in the function name:\n\n* `i` - perform operation in-place, storing the result in the host object (on\n which the method was invoked). Might be used to avoid number allocation costs\n* `u` - unsigned, ignore the sign of operands when performing operation, or\n always return positive value. Second case applies to reduction operations\n like `mod()`. In such cases if the result will be negative - modulo will be\n added to the result to make it positive\n\n### Postfixes\n\nThe only available postfix at the moment is:\n\n* `n` - which means that the argument of the function must be a plain JavaScript\n Number. Decimals are not supported.\n\n### Examples\n\n* `a.iadd(b)` - perform addition on `a` and `b`, storing the result in `a`\n* `a.umod(b)` - reduce `a` modulo `b`, returning positive value\n* `a.iushln(13)` - shift bits of `a` left by 13\n\n## Instructions\n\nPrefixes/postfixes are put in parens at the of the line. `endian` - could be\neither `le` (little-endian) or `be` (big-endian).\n\n### Utilities\n\n* `a.clone()` - clone number\n* `a.toString(base, length)` - convert to base-string and pad with zeroes\n* `a.toNumber()` - convert to Javascript Number (limited to 53 bits)\n* `a.toJSON()` - convert to JSON compatible hex string (alias of `toString(16)`)\n* `a.toArray(endian, length)` - convert to byte `Array`, and optionally zero\n pad to length, throwing if already exceeding\n* `a.toArrayLike(type, endian, length)` - convert to an instance of `type`,\n which must behave like an `Array`\n* `a.toBuffer(endian, length)` - convert to Node.js Buffer (if available). For\n compatibility with browserify and similar tools, use this instead:\n `a.toArrayLike(Buffer, endian, length)`\n* `a.bitLength()` - get number of bits occupied\n* `a.zeroBits()` - return number of less-significant consequent zero bits\n (example: `1010000` has 4 zero bits)\n* `a.byteLength()` - return number of bytes occupied\n* `a.isNeg()` - true if the number is negative\n* `a.isEven()` - no comments\n* `a.isOdd()` - no comments\n* `a.isZero()` - no comments\n* `a.cmp(b)` - compare numbers and return `-1` (a `<` b), `0` (a `==` b), or `1` (a `>` b)\n depending on the comparison result (`ucmp`, `cmpn`)\n* `a.lt(b)` - `a` less than `b` (`n`)\n* `a.lte(b)` - `a` less than or equals `b` (`n`)\n* `a.gt(b)` - `a` greater than `b` (`n`)\n* `a.gte(b)` - `a` greater than or equals `b` (`n`)\n* `a.eq(b)` - `a` equals `b` (`n`)\n* `a.toTwos(width)` - convert to two's complement representation, where `width` is bit width\n* `a.fromTwos(width)` - convert from two's complement representation, where `width` is the bit width\n* `BN.isBN(object)` - returns true if the supplied `object` is a BN.js instance\n\n### Arithmetics\n\n* `a.neg()` - negate sign (`i`)\n* `a.abs()` - absolute value (`i`)\n* `a.add(b)` - addition (`i`, `n`, `in`)\n* `a.sub(b)` - subtraction (`i`, `n`, `in`)\n* `a.mul(b)` - multiply (`i`, `n`, `in`)\n* `a.sqr()` - square (`i`)\n* `a.pow(b)` - raise `a` to the power of `b`\n* `a.div(b)` - divide (`divn`, `idivn`)\n* `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`)\n* `a.divRound(b)` - rounded division\n\n### Bit operations\n\n* `a.or(b)` - or (`i`, `u`, `iu`)\n* `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced\n with `andn` in future)\n* `a.xor(b)` - xor (`i`, `u`, `iu`)\n* `a.setn(b)` - set specified bit to `1`\n* `a.shln(b)` - shift left (`i`, `u`, `iu`)\n* `a.shrn(b)` - shift right (`i`, `u`, `iu`)\n* `a.testn(b)` - test if specified bit is set\n* `a.maskn(b)` - clear bits with indexes higher or equal to `b` (`i`)\n* `a.bincn(b)` - add `1 << b` to the number\n* `a.notn(w)` - not (for the width specified by `w`) (`i`)\n\n### Reduction\n\n* `a.gcd(b)` - GCD\n* `a.egcd(b)` - Extended GCD results (`{ a: ..., b: ..., gcd: ... }`)\n* `a.invm(b)` - inverse `a` modulo `b`\n\n## Fast reduction\n\nWhen doing lots of reductions using the same modulo, it might be beneficial to\nuse some tricks: like [Montgomery multiplication][0], or using special algorithm\nfor [Mersenne Prime][1].\n\n### Reduction context\n\nTo enable this tricks one should create a reduction context:\n\n```js\nvar red = BN.red(num);\n```\nwhere `num` is just a BN instance.\n\nOr:\n\n```js\nvar red = BN.red(primeName);\n```\n\nWhere `primeName` is either of these [Mersenne Primes][1]:\n\n* `'k256'`\n* `'p224'`\n* `'p192'`\n* `'p25519'`\n\nOr:\n\n```js\nvar red = BN.mont(num);\n```\n\nTo reduce numbers with [Montgomery trick][0]. `.mont()` is generally faster than\n`.red(num)`, but slower than `BN.red(primeName)`.\n\n### Converting numbers\n\nBefore performing anything in reduction context - numbers should be converted\nto it. Usually, this means that one should:\n\n* Convert inputs to reducted ones\n* Operate on them in reduction context\n* Convert outputs back from the reduction context\n\nHere is how one may convert numbers to `red`:\n\n```js\nvar redA = a.toRed(red);\n```\nWhere `red` is a reduction context created using instructions above\n\nHere is how to convert them back:\n\n```js\nvar a = redA.fromRed();\n```\n\n### Red instructions\n\nMost of the instructions from the very start of this readme have their\ncounterparts in red context:\n\n* `a.redAdd(b)`, `a.redIAdd(b)`\n* `a.redSub(b)`, `a.redISub(b)`\n* `a.redShl(num)`\n* `a.redMul(b)`, `a.redIMul(b)`\n* `a.redSqr()`, `a.redISqr()`\n* `a.redSqrt()` - square root modulo reduction context's prime\n* `a.redInvm()` - modular inverse of the number\n* `a.redNeg()`\n* `a.redPow(b)` - modular exponentiation\n\n## LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2015.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication\n[1]: https://en.wikipedia.org/wiki/Mersenne_prime\n# minizlib\n\nA fast zlib stream built on [minipass](http://npm.im/minipass) and\nNode.js's zlib binding.\n\nThis module was created to serve the needs of\n[node-tar](http://npm.im/tar) and\n[minipass-fetch](http://npm.im/minipass-fetch).\n\nBrotli is supported in versions of node with a Brotli binding.\n\n## How does this differ from the streams in `require('zlib')`?\n\nFirst, there are no convenience methods to compress or decompress a\nbuffer. If you want those, use the built-in `zlib` module. This is\nonly streams. That being said, Minipass streams to make it fairly easy to\nuse as one-liners: `new zlib.Deflate().end(data).read()` will return the\ndeflate compressed result.\n\nThis module compresses and decompresses the data as fast as you feed\nit in. It is synchronous, and runs on the main process thread. Zlib\nand Brotli operations can be high CPU, but they're very fast, and doing it\nthis way means much less bookkeeping and artificial deferral.\n\nNode's built in zlib streams are built on top of `stream.Transform`.\nThey do the maximally safe thing with respect to consistent\nasynchrony, buffering, and backpressure.\n\nSee [Minipass](http://npm.im/minipass) for more on the differences between\nNode.js core streams and Minipass streams, and the convenience methods\nprovided by that class.\n\n## Classes\n\n- Deflate\n- Inflate\n- Gzip\n- Gunzip\n- DeflateRaw\n- InflateRaw\n- Unzip\n- BrotliCompress (Node v10 and higher)\n- BrotliDecompress (Node v10 and higher)\n\n## USAGE\n\n```js\nconst zlib = require('minizlib')\nconst input = sourceOfCompressedData()\nconst decode = new zlib.BrotliDecompress()\nconst output = whereToWriteTheDecodedData()\ninput.pipe(decode).pipe(output)\n```\n\n## REPRODUCIBLE BUILDS\n\nTo create reproducible gzip compressed files across different operating\nsystems, set `portable: true` in the options. This causes minizlib to set\nthe `OS` indicator in byte 9 of the extended gzip header to `0xFF` for\n'unknown'.\n# cacheable-request\n\n> Wrap native HTTP requests with RFC compliant cache support\n\n[](https://travis-ci.org/lukechilds/cacheable-request)\n[](https://coveralls.io/github/lukechilds/cacheable-request?branch=master)\n[](https://www.npmjs.com/package/cacheable-request)\n[](https://www.npmjs.com/package/cacheable-request)\n\n[RFC 7234](http://httpwg.org/specs/rfc7234.html) compliant HTTP caching for native Node.js HTTP/HTTPS requests. Caching works out of the box in memory or is easily pluggable with a wide range of storage adapters.\n\n**Note:** This is a low level wrapper around the core HTTP modules, it's not a high level request library.\n\n## Features\n\n- Only stores cacheable responses as defined by RFC 7234\n- Fresh cache entries are served directly from cache\n- Stale cache entries are revalidated with `If-None-Match`/`If-Modified-Since` headers\n- 304 responses from revalidation requests use cached body\n- Updates `Age` header on cached responses\n- Can completely bypass cache on a per request basis\n- In memory cache by default\n- Official support for Redis, MongoDB, SQLite, PostgreSQL and MySQL storage adapters\n- Easily plug in your own or third-party storage adapters\n- If DB connection fails, cache is automatically bypassed ([disabled by default](#optsautomaticfailover))\n- Adds cache support to any existing HTTP code with minimal changes\n- Uses [http-cache-semantics](https://github.com/pornel/http-cache-semantics) internally for HTTP RFC 7234 compliance\n\n## Install\n\n```shell\nnpm install cacheable-request\n```\n\n## Usage\n\n```js\nconst http = require('http');\nconst CacheableRequest = require('cacheable-request');\n\n// Then instead of\nconst req = http.request('http://example.com', cb);\nreq.end();\n\n// You can do\nconst cacheableRequest = new CacheableRequest(http.request);\nconst cacheReq = cacheableRequest('http://example.com', cb);\ncacheReq.on('request', req => req.end());\n// Future requests to 'example.com' will be returned from cache if still valid\n\n// You pass in any other http.request API compatible method to be wrapped with cache support:\nconst cacheableRequest = new CacheableRequest(https.request);\nconst cacheableRequest = new CacheableRequest(electron.net);\n```\n\n## Storage Adapters\n\n`cacheable-request` uses [Keyv](https://github.com/lukechilds/keyv) to support a wide range of storage adapters.\n\nFor example, to use Redis as a cache backend, you just need to install the official Redis Keyv storage adapter:\n\n```\nnpm install @keyv/redis\n```\n\nAnd then you can pass `CacheableRequest` your connection string:\n\n```js\nconst cacheableRequest = new CacheableRequest(http.request, 'redis://user:pass@localhost:6379');\n```\n\n[View all official Keyv storage adapters.](https://github.com/lukechilds/keyv#official-storage-adapters)\n\nKeyv also supports anything that follows the Map API so it's easy to write your own storage adapter or use a third-party solution.\n\ne.g The following are all valid storage adapters\n\n```js\nconst storageAdapter = new Map();\n// or\nconst storageAdapter = require('./my-storage-adapter');\n// or\nconst QuickLRU = require('quick-lru');\nconst storageAdapter = new QuickLRU({ maxSize: 1000 });\n\nconst cacheableRequest = new CacheableRequest(http.request, storageAdapter);\n```\n\nView the [Keyv docs](https://github.com/lukechilds/keyv) for more information on how to use storage adapters.\n\n## API\n\n### new cacheableRequest(request, [storageAdapter])\n\nReturns the provided request function wrapped with cache support.\n\n#### request\n\nType: `function`\n\nRequest function to wrap with cache support. Should be [`http.request`](https://nodejs.org/api/http.html#http_http_request_options_callback) or a similar API compatible request function.\n\n#### storageAdapter\n\nType: `Keyv storage adapter`<br>\nDefault: `new Map()`\n\nA [Keyv](https://github.com/lukechilds/keyv) storage adapter instance, or connection string if using with an official Keyv storage adapter.\n\n### Instance\n\n#### cacheableRequest(opts, [cb])\n\nReturns an event emitter.\n\n##### opts\n\nType: `object`, `string`\n\n- Any of the default request functions options.\n- Any [`http-cache-semantics`](https://github.com/kornelski/http-cache-semantics#constructor-options) options.\n- Any of the following:\n\n###### opts.cache\n\nType: `boolean`<br>\nDefault: `true`\n\nIf the cache should be used. Setting this to false will completely bypass the cache for the current request.\n\n###### opts.strictTtl\n\nType: `boolean`<br>\nDefault: `false`\n\nIf set to `true` once a cached resource has expired it is deleted and will have to be re-requested.\n\nIf set to `false` (default), after a cached resource's TTL expires it is kept in the cache and will be revalidated on the next request with `If-None-Match`/`If-Modified-Since` headers.\n\n###### opts.maxTtl\n\nType: `number`<br>\nDefault: `undefined`\n\nLimits TTL. The `number` represents milliseconds.\n\n###### opts.automaticFailover\n\nType: `boolean`<br>\nDefault: `false`\n\nWhen set to `true`, if the DB connection fails we will automatically fallback to a network request. DB errors will still be emitted to notify you of the problem even though the request callback may succeed.\n\n###### opts.forceRefresh\n\nType: `boolean`<br>\nDefault: `false`\n\nForces refreshing the cache. If the response could be retrieved from the cache, it will perform a new request and override the cache instead.\n\n##### cb\n\nType: `function`\n\nThe callback function which will receive the response as an argument.\n\nThe response can be either a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage) or a [responselike object](https://github.com/lukechilds/responselike). The response will also have a `fromCache` property set with a boolean value.\n\n##### .on('request', request)\n\n`request` event to get the request object of the request.\n\n**Note:** This event will only fire if an HTTP request is actually made, not when a response is retrieved from cache. However, you should always handle the `request` event to end the request and handle any potential request errors.\n\n##### .on('response', response)\n\n`response` event to get the response object from the HTTP request or cache.\n\n##### .on('error', error)\n\n`error` event emitted in case of an error with the cache.\n\nErrors emitted here will be an instance of `CacheableRequest.RequestError` or `CacheableRequest.CacheError`. You will only ever receive a `RequestError` if the request function throws (normally caused by invalid user input). Normal request errors should be handled inside the `request` event.\n\nTo properly handle all error scenarios you should use the following pattern:\n\n```js\ncacheableRequest('example.com', cb)\n .on('error', err => {\n if (err instanceof CacheableRequest.CacheError) {\n handleCacheError(err); // Cache error\n } else if (err instanceof CacheableRequest.RequestError) {\n handleRequestError(err); // Request function thrown\n }\n })\n .on('request', req => {\n req.on('error', handleRequestError); // Request error emitted\n req.end();\n });\n```\n\n**Note:** Database connection errors are emitted here, however `cacheable-request` will attempt to re-request the resource and bypass the cache on a connection error. Therefore a database connection error doesn't necessarily mean the request won't be fulfilled.\n\n## License\n\nMIT © Luke Childs\n# lodash.memoize v4.1.2\n\nThe [lodash](https://lodash.com/) method `_.memoize` exported as a [Node.js](https://nodejs.org/) module.\n\n## Installation\n\nUsing npm:\n```bash\n$ {sudo -H} npm i -g npm\n$ npm i --save lodash.memoize\n```\n\nIn Node.js:\n```js\nvar memoize = require('lodash.memoize');\n```\n\nSee the [documentation](https://lodash.com/docs#memoize) or [package source](https://github.com/lodash/lodash/blob/4.1.2-npm-packages/lodash.memoize) for more details.\nNative Abstractions for Node.js\n===============================\n\n**A header file filled with macro and utility goodness for making add-on development for Node.js easier across versions 0.8, 0.10, 0.12, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 and 14.**\n\n***Current version: 2.14.1***\n\n*(See [CHANGELOG.md](https://github.com/nodejs/nan/blob/master/CHANGELOG.md) for complete ChangeLog)*\n\n[](https://nodei.co/npm/nan/) [](https://nodei.co/npm/nan/)\n\n[](https://travis-ci.org/nodejs/nan)\n[](https://ci.appveyor.com/project/RodVagg/nan)\n\nThanks to the crazy changes in V8 (and some in Node core), keeping native addons compiling happily across versions, particularly 0.10 to 0.12 to 4.0, is a minor nightmare. The goal of this project is to store all logic necessary to develop native Node.js addons without having to inspect `NODE_MODULE_VERSION` and get yourself into a macro-tangle.\n\nThis project also contains some helper utilities that make addon development a bit more pleasant.\n\n * **[News & Updates](#news)**\n * **[Usage](#usage)**\n * **[Example](#example)**\n * **[API](#api)**\n * **[Tests](#tests)**\n * **[Known issues](#issues)**\n * **[Governance & Contributing](#governance)**\n\n<a name=\"news\"></a>\n\n## News & Updates\n\n<a name=\"usage\"></a>\n\n## Usage\n\nSimply add **NAN** as a dependency in the *package.json* of your Node addon:\n\n``` bash\n$ npm install --save nan\n```\n\nPull in the path to **NAN** in your *binding.gyp* so that you can use `#include <nan.h>` in your *.cpp* files:\n\n``` python\n\"include_dirs\" : [\n \"<!(node -e \\\"require('nan')\\\")\"\n]\n```\n\nThis works like a `-I<path-to-NAN>` when compiling your addon.\n\n<a name=\"example\"></a>\n\n## Example\n\nJust getting started with Nan? Take a look at the **[Node Add-on Examples](https://github.com/nodejs/node-addon-examples)**.\n\nRefer to a [quick-start **Nan** Boilerplate](https://github.com/fcanas/node-native-boilerplate) for a ready-to-go project that utilizes basic Nan functionality.\n\nFor a simpler example, see the **[async pi estimation example](https://github.com/nodejs/nan/tree/master/examples/async_pi_estimate)** in the examples directory for full code and an explanation of what this Monte Carlo Pi estimation example does. Below are just some parts of the full example that illustrate the use of **NAN**.\n\nYet another example is **[nan-example-eol](https://github.com/CodeCharmLtd/nan-example-eol)**. It shows newline detection implemented as a native addon.\n\nAlso take a look at our comprehensive **[C++ test suite](https://github.com/nodejs/nan/tree/master/test/cpp)** which has a plethora of code snippets for your pasting pleasure.\n\n<a name=\"api\"></a>\n\n## API\n\nAdditional to the NAN documentation below, please consult:\n\n* [The V8 Getting Started * Guide](https://v8.dev/docs/embed)\n* [V8 API Documentation](https://v8docs.nodesource.com/)\n* [Node Add-on Documentation](https://nodejs.org/api/addons.html)\n\n<!-- START API -->\n\n### JavaScript-accessible methods\n\nA _template_ is a blueprint for JavaScript functions and objects in a context. You can use a template to wrap C++ functions and data structures within JavaScript objects so that they can be manipulated from JavaScript. See the V8 Embedders Guide section on [Templates](https://github.com/v8/v8/wiki/Embedder%27s-Guide#templates) for further information.\n\nIn order to expose functionality to JavaScript via a template, you must provide it to V8 in a form that it understands. Across the versions of V8 supported by NAN, JavaScript-accessible method signatures vary widely, NAN fully abstracts method declaration and provides you with an interface that is similar to the most recent V8 API but is backward-compatible with older versions that still use the now-deceased `v8::Argument` type.\n\n* **Method argument types**\n - <a href=\"doc/methods.md#api_nan_function_callback_info\"><b><code>Nan::FunctionCallbackInfo</code></b></a>\n - <a href=\"doc/methods.md#api_nan_property_callback_info\"><b><code>Nan::PropertyCallbackInfo</code></b></a>\n - <a href=\"doc/methods.md#api_nan_return_value\"><b><code>Nan::ReturnValue</code></b></a>\n* **Method declarations**\n - <a href=\"doc/methods.md#api_nan_method\"><b>Method declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_getter\"><b>Getter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_setter\"><b>Setter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_getter\"><b>Property getter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_setter\"><b>Property setter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_enumerator\"><b>Property enumerator declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_deleter\"><b>Property deleter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_property_query\"><b>Property query declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_getter\"><b>Index getter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_setter\"><b>Index setter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_enumerator\"><b>Index enumerator declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_deleter\"><b>Index deleter declaration</b></a>\n - <a href=\"doc/methods.md#api_nan_index_query\"><b>Index query declaration</b></a>\n* Method and template helpers\n - <a href=\"doc/methods.md#api_nan_set_method\"><b><code>Nan::SetMethod()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_prototype_method\"><b><code>Nan::SetPrototypeMethod()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_accessor\"><b><code>Nan::SetAccessor()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_named_property_handler\"><b><code>Nan::SetNamedPropertyHandler()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_indexed_property_handler\"><b><code>Nan::SetIndexedPropertyHandler()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_template\"><b><code>Nan::SetTemplate()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_prototype_template\"><b><code>Nan::SetPrototypeTemplate()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_instance_template\"><b><code>Nan::SetInstanceTemplate()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_call_handler\"><b><code>Nan::SetCallHandler()</code></b></a>\n - <a href=\"doc/methods.md#api_nan_set_call_as_function_handler\"><b><code>Nan::SetCallAsFunctionHandler()</code></b></a>\n\n### Scopes\n\nA _local handle_ is a pointer to an object. All V8 objects are accessed using handles, they are necessary because of the way the V8 garbage collector works.\n\nA handle scope can be thought of as a container for any number of handles. When you've finished with your handles, instead of deleting each one individually you can simply delete their scope.\n\nThe creation of `HandleScope` objects is different across the supported versions of V8. Therefore, NAN provides its own implementations that can be used safely across these.\n\n - <a href=\"doc/scopes.md#api_nan_handle_scope\"><b><code>Nan::HandleScope</code></b></a>\n - <a href=\"doc/scopes.md#api_nan_escapable_handle_scope\"><b><code>Nan::EscapableHandleScope</code></b></a>\n\nAlso see the V8 Embedders Guide section on [Handles and Garbage Collection](https://github.com/v8/v8/wiki/Embedder%27s%20Guide#handles-and-garbage-collection).\n\n### Persistent references\n\nAn object reference that is independent of any `HandleScope` is a _persistent_ reference. Where a `Local` handle only lives as long as the `HandleScope` in which it was allocated, a `Persistent` handle remains valid until it is explicitly disposed.\n\nDue to the evolution of the V8 API, it is necessary for NAN to provide a wrapper implementation of the `Persistent` classes to supply compatibility across the V8 versions supported.\n\n - <a href=\"doc/persistent.md#api_nan_persistent_base\"><b><code>Nan::PersistentBase & v8::PersistentBase</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_non_copyable_persistent_traits\"><b><code>Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_copyable_persistent_traits\"><b><code>Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_persistent\"><b><code>Nan::Persistent</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_global\"><b><code>Nan::Global</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_weak_callback_info\"><b><code>Nan::WeakCallbackInfo</code></b></a>\n - <a href=\"doc/persistent.md#api_nan_weak_callback_type\"><b><code>Nan::WeakCallbackType</code></b></a>\n\nAlso see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).\n\n### New\n\nNAN provides a `Nan::New()` helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.\n\n - <a href=\"doc/new.md#api_nan_new\"><b><code>Nan::New()</code></b></a>\n - <a href=\"doc/new.md#api_nan_undefined\"><b><code>Nan::Undefined()</code></b></a>\n - <a href=\"doc/new.md#api_nan_null\"><b><code>Nan::Null()</code></b></a>\n - <a href=\"doc/new.md#api_nan_true\"><b><code>Nan::True()</code></b></a>\n - <a href=\"doc/new.md#api_nan_false\"><b><code>Nan::False()</code></b></a>\n - <a href=\"doc/new.md#api_nan_empty_string\"><b><code>Nan::EmptyString()</code></b></a>\n\n### Converters\n\nNAN contains functions that convert `v8::Value`s to other `v8::Value` types and native types. Since type conversion is not guaranteed to succeed, they return `Nan::Maybe` types. These converters can be used in place of `value->ToX()` and `value->XValue()` (where `X` is one of the types, e.g. `Boolean`) in a way that provides a consistent interface across V8 versions. Newer versions of V8 use the new `v8::Maybe` and `v8::MaybeLocal` types for these conversions, older versions don't have this functionality so it is provided by NAN.\n\n - <a href=\"doc/converters.md#api_nan_to\"><b><code>Nan::To()</code></b></a>\n\n### Maybe Types\n\nThe `Nan::MaybeLocal` and `Nan::Maybe` types are monads that encapsulate `v8::Local` handles that _may be empty_.\n\n* **Maybe Types**\n - <a href=\"doc/maybe_types.md#api_nan_maybe_local\"><b><code>Nan::MaybeLocal</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_maybe\"><b><code>Nan::Maybe</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_nothing\"><b><code>Nan::Nothing</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_just\"><b><code>Nan::Just</code></b></a>\n* **Maybe Helpers**\n - <a href=\"doc/maybe_types.md#api_nan_call\"><b><code>Nan::Call()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_to_detail_string\"><b><code>Nan::ToDetailString()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_to_array_index\"><b><code>Nan::ToArrayIndex()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_equals\"><b><code>Nan::Equals()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_new_instance\"><b><code>Nan::NewInstance()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_function\"><b><code>Nan::GetFunction()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_set\"><b><code>Nan::Set()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_define_own_property\"><b><code>Nan::DefineOwnProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_force_set\"><del><b><code>Nan::ForceSet()</code></b></del></a>\n - <a href=\"doc/maybe_types.md#api_nan_get\"><b><code>Nan::Get()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_property_attribute\"><b><code>Nan::GetPropertyAttributes()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has\"><b><code>Nan::Has()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_delete\"><b><code>Nan::Delete()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_property_names\"><b><code>Nan::GetPropertyNames()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_own_property_names\"><b><code>Nan::GetOwnPropertyNames()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_set_prototype\"><b><code>Nan::SetPrototype()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_object_proto_to_string\"><b><code>Nan::ObjectProtoToString()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_own_property\"><b><code>Nan::HasOwnProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_real_named_property\"><b><code>Nan::HasRealNamedProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_real_indexed_property\"><b><code>Nan::HasRealIndexedProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_real_named_callback_property\"><b><code>Nan::HasRealNamedCallbackProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_real_named_property_in_prototype_chain\"><b><code>Nan::GetRealNamedPropertyInPrototypeChain()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_real_named_property\"><b><code>Nan::GetRealNamedProperty()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_call_as_function\"><b><code>Nan::CallAsFunction()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_call_as_constructor\"><b><code>Nan::CallAsConstructor()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_source_line\"><b><code>Nan::GetSourceLine()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_line_number\"><b><code>Nan::GetLineNumber()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_start_column\"><b><code>Nan::GetStartColumn()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_end_column\"><b><code>Nan::GetEndColumn()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_clone_element_at\"><b><code>Nan::CloneElementAt()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_has_private\"><b><code>Nan::HasPrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_get_private\"><b><code>Nan::GetPrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_set_private\"><b><code>Nan::SetPrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_delete_private\"><b><code>Nan::DeletePrivate()</code></b></a>\n - <a href=\"doc/maybe_types.md#api_nan_make_maybe\"><b><code>Nan::MakeMaybe()</code></b></a>\n\n### Script\n\nNAN provides a `v8::Script` helpers as the API has changed over the supported versions of V8.\n\n - <a href=\"doc/script.md#api_nan_compile_script\"><b><code>Nan::CompileScript()</code></b></a>\n - <a href=\"doc/script.md#api_nan_run_script\"><b><code>Nan::RunScript()</code></b></a>\n\n### JSON\n\nThe _JSON_ object provides the c++ versions of the methods offered by the `JSON` object in javascript. V8 exposes these methods via the `v8::JSON` object.\n\n - <a href=\"doc/json.md#api_nan_json_parse\"><b><code>Nan::JSON.Parse</code></b></a>\n - <a href=\"doc/json.md#api_nan_json_stringify\"><b><code>Nan::JSON.Stringify</code></b></a>\n\nRefer to the V8 JSON object in the [V8 documentation](https://v8docs.nodesource.com/node-8.16/da/d6f/classv8_1_1_j_s_o_n.html) for more information about these methods and their arguments.\n\n### Errors\n\nNAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.\n\nNote that an Error object is simply a specialized form of `v8::Value`.\n\nAlso consult the V8 Embedders Guide section on [Exceptions](https://developers.google.com/v8/embed#exceptions) for more information.\n\n - <a href=\"doc/errors.md#api_nan_error\"><b><code>Nan::Error()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_range_error\"><b><code>Nan::RangeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_reference_error\"><b><code>Nan::ReferenceError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_syntax_error\"><b><code>Nan::SyntaxError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_type_error\"><b><code>Nan::TypeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_error\"><b><code>Nan::ThrowError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_range_error\"><b><code>Nan::ThrowRangeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_reference_error\"><b><code>Nan::ThrowReferenceError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_syntax_error\"><b><code>Nan::ThrowSyntaxError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_throw_type_error\"><b><code>Nan::ThrowTypeError()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_fatal_exception\"><b><code>Nan::FatalException()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_errno_exception\"><b><code>Nan::ErrnoException()</code></b></a>\n - <a href=\"doc/errors.md#api_nan_try_catch\"><b><code>Nan::TryCatch</code></b></a>\n\n### Buffers\n\nNAN's `node::Buffer` helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.\n\n - <a href=\"doc/buffers.md#api_nan_new_buffer\"><b><code>Nan::NewBuffer()</code></b></a>\n - <a href=\"doc/buffers.md#api_nan_copy_buffer\"><b><code>Nan::CopyBuffer()</code></b></a>\n - <a href=\"doc/buffers.md#api_nan_free_callback\"><b><code>Nan::FreeCallback()</code></b></a>\n\n### Nan::Callback\n\n`Nan::Callback` makes it easier to use `v8::Function` handles as callbacks. A class that wraps a `v8::Function` handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.\n\n - <a href=\"doc/callback.md#api_nan_callback\"><b><code>Nan::Callback</code></b></a>\n\n### Asynchronous work helpers\n\n`Nan::AsyncWorker`, `Nan::AsyncProgressWorker` and `Nan::AsyncProgressQueueWorker` are helper classes that make working with asynchronous code easier.\n\n - <a href=\"doc/asyncworker.md#api_nan_async_worker\"><b><code>Nan::AsyncWorker</code></b></a>\n - <a href=\"doc/asyncworker.md#api_nan_async_progress_worker\"><b><code>Nan::AsyncProgressWorkerBase & Nan::AsyncProgressWorker</code></b></a>\n - <a href=\"doc/asyncworker.md#api_nan_async_progress_queue_worker\"><b><code>Nan::AsyncProgressQueueWorker</code></b></a>\n - <a href=\"doc/asyncworker.md#api_nan_async_queue_worker\"><b><code>Nan::AsyncQueueWorker</code></b></a>\n\n### Strings & Bytes\n\nMiscellaneous string & byte encoding and decoding functionality provided for compatibility across supported versions of V8 and Node. Implemented by NAN to ensure that all encoding types are supported, even for older versions of Node where they are missing.\n\n - <a href=\"doc/string_bytes.md#api_nan_encoding\"><b><code>Nan::Encoding</code></b></a>\n - <a href=\"doc/string_bytes.md#api_nan_encode\"><b><code>Nan::Encode()</code></b></a>\n - <a href=\"doc/string_bytes.md#api_nan_decode_bytes\"><b><code>Nan::DecodeBytes()</code></b></a>\n - <a href=\"doc/string_bytes.md#api_nan_decode_write\"><b><code>Nan::DecodeWrite()</code></b></a>\n\n### Object Wrappers\n\nThe `ObjectWrap` class can be used to make wrapped C++ objects and a factory of wrapped objects.\n\n - <a href=\"doc/object_wrappers.md#api_nan_object_wrap\"><b><code>Nan::ObjectWrap</code></b></a>\n\n### V8 internals\n\nThe hooks to access V8 internals—including GC and statistics—are different across the supported versions of V8, therefore NAN provides its own hooks that call the appropriate V8 methods.\n\n - <a href=\"doc/v8_internals.md#api_nan_gc_callback\"><b><code>NAN_GC_CALLBACK()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_add_gc_epilogue_callback\"><b><code>Nan::AddGCEpilogueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_remove_gc_epilogue_callback\"><b><code>Nan::RemoveGCEpilogueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_add_gc_prologue_callback\"><b><code>Nan::AddGCPrologueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_remove_gc_prologue_callback\"><b><code>Nan::RemoveGCPrologueCallback()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_get_heap_statistics\"><b><code>Nan::GetHeapStatistics()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_counter_function\"><b><code>Nan::SetCounterFunction()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_create_histogram_function\"><b><code>Nan::SetCreateHistogramFunction()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_add_histogram_sample_function\"><b><code>Nan::SetAddHistogramSampleFunction()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_idle_notification\"><b><code>Nan::IdleNotification()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_low_memory_notification\"><b><code>Nan::LowMemoryNotification()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_context_disposed_notification\"><b><code>Nan::ContextDisposedNotification()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_get_internal_field_pointer\"><b><code>Nan::GetInternalFieldPointer()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_set_internal_field_pointer\"><b><code>Nan::SetInternalFieldPointer()</code></b></a>\n - <a href=\"doc/v8_internals.md#api_nan_adjust_external_memory\"><b><code>Nan::AdjustExternalMemory()</code></b></a>\n\n### Miscellaneous V8 Helpers\n\n - <a href=\"doc/v8_misc.md#api_nan_utf8_string\"><b><code>Nan::Utf8String</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_get_current_context\"><b><code>Nan::GetCurrentContext()</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_set_isolate_data\"><b><code>Nan::SetIsolateData()</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_get_isolate_data\"><b><code>Nan::GetIsolateData()</code></b></a>\n - <a href=\"doc/v8_misc.md#api_nan_typedarray_contents\"><b><code>Nan::TypedArrayContents</code></b></a>\n\n### Miscellaneous Node Helpers\n\n - <a href=\"doc/node_misc.md#api_nan_asyncresource\"><b><code>Nan::AsyncResource</code></b></a>\n - <a href=\"doc/node_misc.md#api_nan_make_callback\"><b><code>Nan::MakeCallback()</code></b></a>\n - <a href=\"doc/node_misc.md#api_nan_module_init\"><b><code>NAN_MODULE_INIT()</code></b></a>\n - <a href=\"doc/node_misc.md#api_nan_export\"><b><code>Nan::Export()</code></b></a>\n\n<!-- END API -->\n\n<a name=\"tests\"></a>\n\n### Tests\n\nTo run the NAN tests do:\n\n``` sh\nnpm install\nnpm run-script rebuild-tests\nnpm test\n```\n\nOr just:\n\n``` sh\nnpm install\nmake test\n```\n\n<a name=\"issues\"></a>\n\n## Known issues\n\n### Compiling against Node.js 0.12 on OSX\n\nWith new enough compilers available on OSX, the versions of V8 headers corresponding to Node.js 0.12\ndo not compile anymore. The error looks something like:\n\n```\n❯ CXX(target) Release/obj.target/accessors/cpp/accessors.o\nIn file included from ../cpp/accessors.cpp:9:\nIn file included from ../../nan.h:51:\nIn file included from /Users/ofrobots/.node-gyp/0.12.18/include/node/node.h:61:\n/Users/ofrobots/.node-gyp/0.12.18/include/node/v8.h:5800:54: error: 'CreateHandle' is a protected member of 'v8::HandleScope'\n return Handle<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(\n ~~~~~~~~~~~~~^~~~~~~~~~~~\n```\n\nThis can be worked around by patching your local versions of v8.h corresponding to Node 0.12 to make\n`v8::Handle` a friend of `v8::HandleScope`. Since neither Node.js not V8 support this release line anymore\nthis patch cannot be released by either project in an official release.\n\nFor this reason, we do not test against Node.js 0.12 on OSX in this project's CI. If you need to support\nthat configuration, you will need to either get an older compiler, or apply a source patch to the version\nof V8 headers as a workaround.\n\n<a name=\"governance\"></a>\n\n## Governance & Contributing\n\nNAN is governed by the [Node.js Addon API Working Group](https://github.com/nodejs/CTC/blob/master/WORKING_GROUPS.md#addon-api)\n\n### Addon API Working Group (WG)\n\nThe NAN project is jointly governed by a Working Group which is responsible for high-level guidance of the project.\n\nMembers of the WG are also known as Collaborators, there is no distinction between the two, unlike other Node.js projects.\n\nThe WG has final authority over this project including:\n\n* Technical direction\n* Project governance and process (including this policy)\n* Contribution policy\n* GitHub repository hosting\n* Maintaining the list of additional Collaborators\n\nFor the current list of WG members, see the project [README.md](./README.md#collaborators).\n\nIndividuals making significant and valuable contributions are made members of the WG and given commit-access to the project. These individuals are identified by the WG and their addition to the WG is discussed via GitHub and requires unanimous consensus amongst those WG members participating in the discussion with a quorum of 50% of WG members required for acceptance of the vote.\n\n_Note:_ If you make a significant contribution and are not considered for commit-access log an issue or contact a WG member directly.\n\nFor the current list of WG members / Collaborators, see the project [README.md](./README.md#collaborators).\n\n### Consensus Seeking Process\n\nThe WG follows a [Consensus Seeking](https://en.wikipedia.org/wiki/Consensus-seeking_decision-making) decision making model.\n\nModifications of the contents of the NAN repository are made on a collaborative basis. Anybody with a GitHub account may propose a modification via pull request and it will be considered by the WG. All pull requests must be reviewed and accepted by a WG member with sufficient expertise who is able to take full responsibility for the change. In the case of pull requests proposed by an existing WG member, an additional WG member is required for sign-off. Consensus should be sought if additional WG members participate and there is disagreement around a particular modification.\n\nIf a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.\n\n<a id=\"developers-certificate-of-origin\"></a>\n\n## Developer's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n* (a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n* (b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n* (c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n* (d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n\n<a name=\"collaborators\"></a>\n\n### WG Members / Collaborators\n\n<table><tbody>\n<tr><th align=\"left\">Rod Vagg</th><td><a href=\"https://github.com/rvagg\">GitHub/rvagg</a></td><td><a href=\"http://twitter.com/rvagg\">Twitter/@rvagg</a></td></tr>\n<tr><th align=\"left\">Benjamin Byholm</th><td><a href=\"https://github.com/kkoopa/\">GitHub/kkoopa</a></td><td>-</td></tr>\n<tr><th align=\"left\">Trevor Norris</th><td><a href=\"https://github.com/trevnorris\">GitHub/trevnorris</a></td><td><a href=\"http://twitter.com/trevnorris\">Twitter/@trevnorris</a></td></tr>\n<tr><th align=\"left\">Nathan Rajlich</th><td><a href=\"https://github.com/TooTallNate\">GitHub/TooTallNate</a></td><td><a href=\"http://twitter.com/TooTallNate\">Twitter/@TooTallNate</a></td></tr>\n<tr><th align=\"left\">Brett Lawson</th><td><a href=\"https://github.com/brett19\">GitHub/brett19</a></td><td><a href=\"http://twitter.com/brett19x\">Twitter/@brett19x</a></td></tr>\n<tr><th align=\"left\">Ben Noordhuis</th><td><a href=\"https://github.com/bnoordhuis\">GitHub/bnoordhuis</a></td><td><a href=\"http://twitter.com/bnoordhuis\">Twitter/@bnoordhuis</a></td></tr>\n<tr><th align=\"left\">David Siegel</th><td><a href=\"https://github.com/agnat\">GitHub/agnat</a></td><td><a href=\"http://twitter.com/agnat\">Twitter/@agnat</a></td></tr>\n<tr><th align=\"left\">Michael Ira Krufky</th><td><a href=\"https://github.com/mkrufky\">GitHub/mkrufky</a></td><td><a href=\"http://twitter.com/mkrufky\">Twitter/@mkrufky</a></td></tr>\n</tbody></table>\n\n## Licence & copyright\n\nCopyright (c) 2018 NAN WG Members / Collaborators (listed above).\n\nNative Abstractions for Node.js is licensed under an MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.\n# repeat-element [](https://www.npmjs.com/package/repeat-element) [](https://npmjs.org/package/repeat-element) [](https://npmjs.org/package/repeat-element) [](https://travis-ci.org/jonschlinkert/repeat-element)\n\n> Create an array by repeating the given value n times.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save repeat-element\n```\n\n## Usage\n\n```js\nconst repeat = require('repeat-element');\n\nrepeat('a', 5);\n//=> ['a', 'a', 'a', 'a', 'a']\n\nrepeat('a', 1);\n//=> ['a']\n\nrepeat('a', 0);\n//=> []\n\nrepeat(null, 5)\n//» [ null, null, null, null, null ]\n\nrepeat({some: 'object'}, 5)\n//» [ { some: 'object' },\n// { some: 'object' },\n// { some: 'object' },\n// { some: 'object' },\n// { some: 'object' } ]\n\nrepeat(5, 5)\n//» [ 5, 5, 5, 5, 5 ]\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 17 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 3 | [LinusU](https://github.com/LinusU) |\n| 1 | [architectcodes](https://github.com/architectcodes) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 19, 2018._\n# to-regex [](https://www.npmjs.com/package/to-regex) [](https://npmjs.org/package/to-regex) [](https://npmjs.org/package/to-regex) [](https://travis-ci.org/jonschlinkert/to-regex)\n\n> Generate a regex from a string or array of strings.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n- [Install](#install)\n- [Usage](#usage)\n- [Options](#options)\n * [options.contains](#optionscontains)\n * [options.negate](#optionsnegate)\n * [options.nocase](#optionsnocase)\n * [options.flags](#optionsflags)\n * [options.cache](#optionscache)\n * [options.safe](#optionssafe)\n- [About](#about)\n * [Related projects](#related-projects)\n * [Author](#author)\n * [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save to-regex\n```\n\n## Usage\n\n```js\nvar toRegex = require('to-regex');\n\nconsole.log(toRegex('foo'));\n//=> /^(?:foo)$/\n\nconsole.log(toRegex('foo', {negate: true}));\n//=> /^(?:(?:(?!^(?:foo)$).)*)$/\n\nconsole.log(toRegex('foo', {contains: true}));\n//=> /(?:foo)/\n\nconsole.log(toRegex(['foo', 'bar'], {negate: true}));\n//=> /^(?:(?:(?!^(?:(?:foo)|(?:bar))$).)*)$/\n\nconsole.log(toRegex(['foo', 'bar'], {negate: true, contains: true}));\n//=> /^(?:(?:(?!(?:(?:foo)|(?:bar))).)*)$/\n```\n\n## Options\n\n### options.contains\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\nGenerate a regex that will match any string that _contains_ the given pattern. By default, regex is strict will only return true for exact matches.\n\n```js\nvar toRegex = require('to-regex');\nconsole.log(toRegex('foo', {contains: true}));\n//=> /(?:foo)/\n```\n\n### options.negate\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\nCreate a regex that will match everything except the given pattern.\n\n```js\nvar toRegex = require('to-regex');\nconsole.log(toRegex('foo', {negate: true}));\n//=> /^(?:(?:(?!^(?:foo)$).)*)$/\n```\n\n### options.nocase\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\nAdds the `i` flag, to enable case-insensitive matching.\n\n```js\nvar toRegex = require('to-regex');\nconsole.log(toRegex('foo', {nocase: true}));\n//=> /^(?:foo)$/i\n```\n\nAlternatively you can pass the flags you want directly on [options.flags](#options.flags).\n\n### options.flags\n\n**Type**: `String`\n\n**Default**: `undefined`\n\nDefine the flags you want to use on the generated regex.\n\n```js\nvar toRegex = require('to-regex');\nconsole.log(toRegex('foo', {flags: 'gm'}));\n//=> /^(?:foo)$/gm\nconsole.log(toRegex('foo', {flags: 'gmi', nocase: true})); //<= handles redundancy\n//=> /^(?:foo)$/gmi\n```\n\n### options.cache\n\n**Type**: `Boolean`\n\n**Default**: `true`\n\nGenerated regex is cached based on the provided string and options. As a result, runtime compilation only happens once per pattern (as long as options are also the same), which can result in dramatic speed improvements.\n\nThis also helps with debugging, since adding options and pattern are added to the generated regex.\n\n**Disable caching**\n\n```js\ntoRegex('foo', {cache: false});\n```\n\n### options.safe\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\nCheck the generated regular expression with [safe-regex](https://github.com/substack/safe-regex) and throw an error if the regex is potentially unsafe.\n\n**Examples**\n\n```js\nconsole.log(toRegex('(x+x+)+y'));\n//=> /^(?:(x+x+)+y)$/\n\n// The following would throw an error\ntoRegex('(x+x+)+y', {safe: true});\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [has-glob](https://www.npmjs.com/package/has-glob): Returns `true` if an array has a glob pattern. | [homepage](https://github.com/jonschlinkert/has-glob \"Returns `true` if an array has a glob pattern.\")\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [path-regex](https://www.npmjs.com/package/path-regex): Regular expression for matching the parts of a file path. | [homepage](https://github.com/regexps/path-regex \"Regular expression for matching the parts of a file path.\")\n* [to-regex-range](https://www.npmjs.com/package/to-regex-range): Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… [more](https://github.com/micromatch/to-regex-range) | [homepage](https://github.com/micromatch/to-regex-range \"Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.78 million test assertions.\")\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 24, 2018._\n# MDN data\n\n[https://github.com/mdn/data](https://github.com/mdn/data)\n\nMaintained by the [MDN team at Mozilla](https://wiki.mozilla.org/MDN).\n\nThis repository contains general data for Web technologies.\n\nThis data is used in MDN documentation, to build\n[information boxes](https://developer.mozilla.org/en-US/docs/Web/CSS/background)\nor [sidebar navigation](https://developer.mozilla.org/en-US/docs/Web/API/Window).\nExternal tools have started to make use of this data as well.\nFor example, the [CSSTree](https://github.com/csstree/csstree/) CSS parser.\n\n[](https://www.npmjs.com/package/mdn-data)\n[](https://travis-ci.org/mdn/data)\n\n## Repository contents\n\nThere's a top-level directory for each broad area covered: for example, \"api\",\n\"css\", \"svg\". Inside each of these directories is one or more\nJSON files containing the data.\n\n### api\nContains data about Web APIs:\n* API inheritance (interface inheritance and mixin implementations)\n\n### css\n Contains data about:\n* CSS at-rules\n* CSS properties\n* CSS selectors\n* CSS syntaxes\n* CSS types\n* CSS units\n\nRead more about [CSS data](https://github.com/mdn/data/blob/master/css/readme.md) and the format of the files.\n\n### l10n\nThe l10n folder contains localization strings that are used in the various\njson files throughout this repository.\n\n## Problems?\n\nIf you find a problem, please [file an issue](https://github.com/mdn/data/issues/new).\n\n## Contributing\n\nWe're very happy to accept contributions to this data. Please familiarize yourself\nwith the schema for the data you're editing, and send us a pull request. See also the [Contributing file](https://github.com/mdn/data/blob/master/CONTRIBUTING.md) for more information.\n\n## See also\n* [https://github.com/mdn/browser-compat-data](https://github.com/mdn/browser-compat-data)\nfor compatibility data for Web technologies.\n# fill-range [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [](https://www.npmjs.com/package/fill-range) [](https://npmjs.org/package/fill-range) [](https://npmjs.org/package/fill-range) [](https://travis-ci.org/jonschlinkert/fill-range)\n\n> Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save fill-range\n```\n\n## Usage\n\nExpands numbers and letters, optionally using a `step` as the last argument. _(Numbers may be defined as JavaScript numbers or strings)_.\n\n```js\nconst fill = require('fill-range');\n// fill(from, to[, step, options]);\n\nconsole.log(fill('1', '10')); //=> ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10']\nconsole.log(fill('1', '10', { toRegex: true })); //=> [1-9]|10\n```\n\n**Params**\n\n* `from`: **{String|Number}** the number or letter to start with\n* `to`: **{String|Number}** the number or letter to end with\n* `step`: **{String|Number|Object|Function}** Optionally pass a [step](#optionsstep) to use.\n* `options`: **{Object|Function}**: See all available [options](#options)\n\n## Examples\n\nBy default, an array of values is returned.\n\n**Alphabetical ranges**\n\n```js\nconsole.log(fill('a', 'e')); //=> ['a', 'b', 'c', 'd', 'e']\nconsole.log(fill('A', 'E')); //=> [ 'A', 'B', 'C', 'D', 'E' ]\n```\n\n**Numerical ranges**\n\nNumbers can be defined as actual numbers or strings.\n\n```js\nconsole.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]\nconsole.log(fill('1', '5')); //=> [ 1, 2, 3, 4, 5 ]\n```\n\n**Negative ranges**\n\nNumbers can be defined as actual numbers or strings.\n\n```js\nconsole.log(fill('-5', '-1')); //=> [ '-5', '-4', '-3', '-2', '-1' ]\nconsole.log(fill('-5', '5')); //=> [ '-5', '-4', '-3', '-2', '-1', '0', '1', '2', '3', '4', '5' ]\n```\n\n**Steps (increments)**\n\n```js\n// numerical ranges with increments\nconsole.log(fill('0', '25', 4)); //=> [ '0', '4', '8', '12', '16', '20', '24' ]\nconsole.log(fill('0', '25', 5)); //=> [ '0', '5', '10', '15', '20', '25' ]\nconsole.log(fill('0', '25', 6)); //=> [ '0', '6', '12', '18', '24' ]\n\n// alphabetical ranges with increments\nconsole.log(fill('a', 'z', 4)); //=> [ 'a', 'e', 'i', 'm', 'q', 'u', 'y' ]\nconsole.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]\nconsole.log(fill('a', 'z', 6)); //=> [ 'a', 'g', 'm', 's', 'y' ]\n```\n\n## Options\n\n### options.step\n\n**Type**: `number` (formatted as a string or number)\n\n**Default**: `undefined`\n\n**Description**: The increment to use for the range. Can be used with letters or numbers.\n\n**Example(s)**\n\n```js\n// numbers\nconsole.log(fill('1', '10', 2)); //=> [ '1', '3', '5', '7', '9' ]\nconsole.log(fill('1', '10', 3)); //=> [ '1', '4', '7', '10' ]\nconsole.log(fill('1', '10', 4)); //=> [ '1', '5', '9' ]\n\n// letters\nconsole.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]\nconsole.log(fill('a', 'z', 7)); //=> [ 'a', 'h', 'o', 'v' ]\nconsole.log(fill('a', 'z', 9)); //=> [ 'a', 'j', 's' ]\n```\n\n### options.strictRanges\n\n**Type**: `boolean`\n\n**Default**: `false`\n\n**Description**: By default, `null` is returned when an invalid range is passed. Enable this option to throw a `RangeError` on invalid ranges.\n\n**Example(s)**\n\nThe following are all invalid:\n\n```js\nfill('1.1', '2'); // decimals not supported in ranges\nfill('a', '2'); // incompatible range values\nfill(1, 10, 'foo'); // invalid \"step\" argument\n```\n\n### options.stringify\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\n**Description**: Cast all returned values to strings. By default, integers are returned as numbers.\n\n**Example(s)**\n\n```js\nconsole.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]\nconsole.log(fill(1, 5, { stringify: true })); //=> [ '1', '2', '3', '4', '5' ]\n```\n\n### options.toRegex\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\n**Description**: Create a regex-compatible source string, instead of expanding values to an array.\n\n**Example(s)**\n\n```js\n// alphabetical range\nconsole.log(fill('a', 'e', { toRegex: true })); //=> '[a-e]'\n// alphabetical with step\nconsole.log(fill('a', 'z', 3, { toRegex: true })); //=> 'a|d|g|j|m|p|s|v|y'\n// numerical range\nconsole.log(fill('1', '100', { toRegex: true })); //=> '[1-9]|[1-9][0-9]|100'\n// numerical range with zero padding\nconsole.log(fill('000001', '100000', { toRegex: true }));\n//=> '0{5}[1-9]|0{4}[1-9][0-9]|0{3}[1-9][0-9]{2}|0{2}[1-9][0-9]{3}|0[1-9][0-9]{4}|100000'\n```\n\n### options.transform\n\n**Type**: `function`\n\n**Default**: `undefined`\n\n**Description**: Customize each value in the returned array (or [string](#optionstoRegex)). _(you can also pass this function as the last argument to `fill()`)_.\n\n**Example(s)**\n\n```js\n// add zero padding\nconsole.log(fill(1, 5, value => String(value).padStart(4, '0')));\n//=> ['0001', '0002', '0003', '0004', '0005']\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 116 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 4 | [paulmillr](https://github.com/paulmillr) | \n| 2 | [realityking](https://github.com/realityking) | \n| 2 | [bluelovers](https://github.com/bluelovers) | \n| 1 | [edorivai](https://github.com/edorivai) | \n| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | \n\n### Author\n\n**Jon Schlinkert**\n\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n\nPlease consider supporting me on Patreon, or [start your own Patreon page](https://patreon.com/invite/bxpbvm)!\n\n<a href=\"https://www.patreon.com/jonschlinkert\">\n<img src=\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\" height=\"50\">\n</a>\n\n### License\n\nCopyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 08, 2019._\nString.prototype.trimEnd <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![Build Status][travis-svg]][travis-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\n[![browser support][testling-svg]][testling-url]\n\nAn ES2019-spec-compliant `String.prototype.trimEnd` shim. Invoke its \"shim\" method to shim `String.prototype.trimEnd` if it is unavailable.\n\nThis package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec](http://www.ecma-international.org/ecma-262/6.0/#sec-object.assign). In an ES6 environment, it will also work properly with `Symbol`s.\n\nMost common usage:\n```js\nvar trimEnd = require('string.prototype.trimend');\n\nassert(trimEnd(' \\t\\na \\t\\n') === 'a \\t\\n');\n\nif (!String.prototype.trimEnd) {\n\ttrimEnd.shim();\n}\n\nassert(trimEnd(' \\t\\na \\t\\n ') === ' \\t\\na \\t\\n '.trimEnd());\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[package-url]: https://npmjs.com/package/string.prototype.trimend\n[npm-version-svg]: http://vb.teelaun.ch/es-shims/String.prototype.trimEnd.svg\n[travis-svg]: https://travis-ci.org/es-shims/String.prototype.trimEnd.svg\n[travis-url]: https://travis-ci.org/es-shims/String.prototype.trimEnd\n[deps-svg]: https://david-dm.org/es-shims/String.prototype.trimEnd.svg\n[deps-url]: https://david-dm.org/es-shims/String.prototype.trimEnd\n[dev-deps-svg]: https://david-dm.org/es-shims/String.prototype.trimEnd/dev-status.svg\n[dev-deps-url]: https://david-dm.org/es-shims/String.prototype.trimEnd#info=devDependencies\n[testling-svg]: https://ci.testling.com/es-shims/String.prototype.trimEnd.png\n[testling-url]: https://ci.testling.com/es-shims/String.prototype.trimEnd\n[npm-badge-png]: https://nodei.co/npm/string.prototype.trimend.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/string.prototype.trimend.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/string.prototype.trimend.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=string.prototype.trimend\n# fast-deep-equal\nThe fastest deep equal with ES6 Map, Set and Typed arrays support.\n\n[](https://travis-ci.org/epoberezkin/fast-deep-equal)\n[](https://www.npmjs.com/package/fast-deep-equal)\n[](https://coveralls.io/github/epoberezkin/fast-deep-equal?branch=master)\n\n## Install\n\n```bash\nnpm install fast-deep-equal\n```\n\n## Features\n\n- ES5 compatible\n- works in node.js (8+) and browsers (IE9+)\n- checks equality of Date and RegExp objects by value.\n\nES6 equal (`require('fast-deep-equal/es6')`) also supports:\n- Maps\n- Sets\n- Typed arrays\n\n## Usage\n\n```javascript\nvar equal = require('fast-deep-equal');\nconsole.log(equal({foo: 'bar'}, {foo: 'bar'})); // true\n```\n\nTo support ES6 Maps, Sets and Typed arrays equality use:\n\n```javascript\nvar equal = require('fast-deep-equal/es6');\nconsole.log(equal(Int16Array([1, 2]), Int16Array([1, 2]))); // true\n```\n\nTo use with React (avoiding the traversal of React elements' _owner\nproperty that contains circular references and is not needed when\ncomparing the elements - borrowed from [react-fast-compare](https://github.com/FormidableLabs/react-fast-compare)):\n\n```javascript\nvar equal = require('fast-deep-equal/react');\nvar equal = require('fast-deep-equal/es6/react');\n```\n\n## Performance benchmark\n\nNode.js v12.6.0:\n\n```\nfast-deep-equal x 261,950 ops/sec ±0.52% (89 runs sampled)\nfast-deep-equal/es6 x 212,991 ops/sec ±0.34% (92 runs sampled)\nfast-equals x 230,957 ops/sec ±0.83% (85 runs sampled)\nnano-equal x 187,995 ops/sec ±0.53% (88 runs sampled)\nshallow-equal-fuzzy x 138,302 ops/sec ±0.49% (90 runs sampled)\nunderscore.isEqual x 74,423 ops/sec ±0.38% (89 runs sampled)\nlodash.isEqual x 36,637 ops/sec ±0.72% (90 runs sampled)\ndeep-equal x 2,310 ops/sec ±0.37% (90 runs sampled)\ndeep-eql x 35,312 ops/sec ±0.67% (91 runs sampled)\nramda.equals x 12,054 ops/sec ±0.40% (91 runs sampled)\nutil.isDeepStrictEqual x 46,440 ops/sec ±0.43% (90 runs sampled)\nassert.deepStrictEqual x 456 ops/sec ±0.71% (88 runs sampled)\n\nThe fastest is fast-deep-equal\n```\n\nTo run benchmark (requires node.js 6+):\n\n```bash\nnpm run benchmark\n```\n\n__Please note__: this benchmark runs against the available test cases. To choose the most performant library for your application, it is recommended to benchmark against your data and to NOT expect this benchmark to reflect the performance difference in your application.\n\n## Enterprise support\n\nfast-deep-equal package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-fast-deep-equal?utm_source=npm-fast-deep-equal&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers.\n\n## Security contact\n\nTo report a security vulnerability, please use the\n[Tidelift security contact](https://tidelift.com/security).\nTidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues.\n\n## License\n\n[MIT](https://github.com/epoberezkin/fast-deep-equal/blob/master/LICENSE)\n# universal-url [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Monitor][greenkeeper-image]][greenkeeper-url]\n\n> WHATWG [`URL`](https://developer.mozilla.org/en/docs/Web/API/URL) for Node & Browser.\n\n* For Node.js versions `>= 8`, the native implementation will be used.\n* For Node.js versions `< 8`, a [shim](https://npmjs.com/whatwg-url) will be used.\n* For web browsers without a native implementation, the same shim will be used.\n\n## Installation\n\n[Node.js](http://nodejs.org/) `>= 6` is required. To install, type this at the command line:\n```shell\nnpm install universal-url\n```\n\n## Usage\n\n```js\nconst {URL, URLSearchParams} = require('universal-url');\n\nconst url = new URL('http://domain/');\nconst params = new URLSearchParams('?param=value');\n```\n\nGlobal shim:\n```js\nrequire('universal-url').shim();\n\nconst url = new URL('http://domain/');\nconst params = new URLSearchParams('?param=value');\n```\n\n## Browserify/etc\n\nThe bundled file size of this library can be large for a web browser. If this is a problem, try using [universal-url-lite](https://npmjs.com/universal-url-lite) in your build as an alias for this module.\n\n[npm-image]: https://img.shields.io/npm/v/universal-url.svg\n[npm-url]: https://npmjs.org/package/universal-url\n[travis-image]: https://img.shields.io/travis/stevenvachon/universal-url.svg\n[travis-url]: https://travis-ci.org/stevenvachon/universal-url\n[greenkeeper-image]: https://badges.greenkeeper.io/stevenvachon/universal-url.svg\n[greenkeeper-url]: https://greenkeeper.io/\n# debug\n[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers)\n[](#sponsors)\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nA tiny JavaScript debugging utility modelled after Node.js core's debugging\ntechnique. Works in Node.js and web browsers.\n\n## Installation\n\n```bash\n$ npm install debug\n```\n\n## Usage\n\n`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.\n\nExample [_app.js_](./examples/node/app.js):\n\n```js\nvar debug = require('debug')('http')\n , http = require('http')\n , name = 'My App';\n\n// fake app\n\ndebug('booting %o', name);\n\nhttp.createServer(function(req, res){\n debug(req.method + ' ' + req.url);\n res.end('hello\\n');\n}).listen(3000, function(){\n debug('listening');\n});\n\n// fake worker of some kind\n\nrequire('./worker');\n```\n\nExample [_worker.js_](./examples/node/worker.js):\n\n```js\nvar a = require('debug')('worker:a')\n , b = require('debug')('worker:b');\n\nfunction work() {\n a('doing lots of uninteresting work');\n setTimeout(work, Math.random() * 1000);\n}\n\nwork();\n\nfunction workb() {\n b('doing some work');\n setTimeout(workb, Math.random() * 2000);\n}\n\nworkb();\n```\n\nThe `DEBUG` environment variable is then used to enable these based on space or\ncomma-delimited names.\n\nHere are some examples:\n\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 04 pm\" src=\"https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 38 pm\" src=\"https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 25 pm\" src=\"https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png\">\n\n#### Windows command prompt notes\n\n##### CMD\n\nOn Windows the environment variable is set using the `set` command.\n\n```cmd\nset DEBUG=*,-not_this\n```\n\nExample:\n\n```cmd\nset DEBUG=* & node app.js\n```\n\n##### PowerShell (VS Code default)\n\nPowerShell uses different syntax to set environment variables.\n\n```cmd\n$env:DEBUG = \"*,-not_this\"\n```\n\nExample:\n\n```cmd\n$env:DEBUG='app';node app.js\n```\n\nThen, run the program to be debugged as usual.\n\nnpm script example:\n```js\n \"windowsDebug\": \"@powershell -Command $env:DEBUG='*';node app.js\",\n```\n\n## Namespace Colors\n\nEvery debug instance has a color generated for it based on its namespace name.\nThis helps when visually parsing the debug output to identify which debug instance\na debug line belongs to.\n\n#### Node.js\n\nIn Node.js, colors are enabled when stderr is a TTY. You also _should_ install\nthe [`supports-color`](https://npmjs.org/supports-color) module alongside debug,\notherwise debug will only use a small handful of basic colors.\n\n<img width=\"521\" src=\"https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png\">\n\n#### Web Browser\n\nColors are also enabled on \"Web Inspectors\" that understand the `%c` formatting\noption. These are WebKit web inspectors, Firefox ([since version\n31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))\nand the Firebug plugin for Firefox (any version).\n\n<img width=\"524\" src=\"https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png\">\n\n## Millisecond diff\n\nWhen actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the \"+NNNms\" will show you how much time was spent between calls.\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nWhen stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png\">\n\n## Conventions\n\nIf you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use \":\" to separate features. For example \"bodyParser\" from Connect would then be \"connect:bodyParser\". If you append a \"*\" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.\n\n## Wildcards\n\nThe `*` character may be used as a wildcard. Suppose for example your library has\ndebuggers named \"connect:bodyParser\", \"connect:compress\", \"connect:session\",\ninstead of listing all three with\n`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do\n`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.\n\nYou can also exclude specific debuggers by prefixing them with a \"-\" character.\nFor example, `DEBUG=*,-connect:*` would include all debuggers except those\nstarting with \"connect:\".\n\n## Environment Variables\n\nWhen running through Node.js, you can set a few environment variables that will\nchange the behavior of the debug logging:\n\n| Name | Purpose |\n|-----------|-------------------------------------------------|\n| `DEBUG` | Enables/disables specific debugging namespaces. |\n| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |\n| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |\n| `DEBUG_DEPTH` | Object inspection depth. |\n| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |\n\n__Note:__ The environment variables beginning with `DEBUG_` end up being\nconverted into an Options object that gets used with `%o`/`%O` formatters.\nSee the Node.js documentation for\n[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)\nfor the complete list.\n\n## Formatters\n\nDebug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.\nBelow are the officially supported formatters:\n\n| Formatter | Representation |\n|-----------|----------------|\n| `%O` | Pretty-print an Object on multiple lines. |\n| `%o` | Pretty-print an Object all on a single line. |\n| `%s` | String. |\n| `%d` | Number (both integer and float). |\n| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |\n| `%%` | Single percent sign ('%'). This does not consume an argument. |\n\n### Custom formatters\n\nYou can add custom formatters by extending the `debug.formatters` object.\nFor example, if you wanted to add support for rendering a Buffer as hex with\n`%h`, you could do something like:\n\n```js\nconst createDebug = require('debug')\ncreateDebug.formatters.h = (v) => {\n return v.toString('hex')\n}\n\n// …elsewhere\nconst debug = createDebug('foo')\ndebug('this is hex: %h', new Buffer('hello world'))\n// foo this is hex: 68656c6c6f20776f726c6421 +0ms\n```\n\n## Browser Support\n\nYou can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),\nor just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),\nif you don't want to build it yourself.\n\nDebug's enable state is currently persisted by `localStorage`.\nConsider the situation shown below where you have `worker:a` and `worker:b`,\nand wish to debug both. You can enable this using `localStorage.debug`:\n\n```js\nlocalStorage.debug = 'worker:*'\n```\n\nAnd then refresh the page.\n\n```js\na = debug('worker:a');\nb = debug('worker:b');\n\nsetInterval(function(){\n a('doing some work');\n}, 1000);\n\nsetInterval(function(){\n b('doing some work');\n}, 1200);\n```\n\n## Output streams\n\n By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:\n\nExample [_stdout.js_](./examples/node/stdout.js):\n\n```js\nvar debug = require('debug');\nvar error = debug('app:error');\n\n// by default stderr is used\nerror('goes to stderr!');\n\nvar log = debug('app:log');\n// set this namespace to log via console.log\nlog.log = console.log.bind(console); // don't forget to bind to console!\nlog('goes to stdout');\nerror('still goes to stderr!');\n\n// set all output to go via console.info\n// overrides all per-namespace log settings\ndebug.log = console.info.bind(console);\nerror('now goes to stdout via console.info');\nlog('still goes to stdout, but via console.info now');\n```\n\n## Extend\nYou can simply extend debugger \n```js\nconst log = require('debug')('auth');\n\n//creates new debug instance with extended namespace\nconst logSign = log.extend('sign');\nconst logLogin = log.extend('login');\n\nlog('hello'); // auth hello\nlogSign('hello'); //auth:sign hello\nlogLogin('hello'); //auth:login hello\n```\n\n## Set dynamically\n\nYou can also enable debug dynamically by calling the `enable()` method :\n\n```js\nlet debug = require('debug');\n\nconsole.log(1, debug.enabled('test'));\n\ndebug.enable('test');\nconsole.log(2, debug.enabled('test'));\n\ndebug.disable();\nconsole.log(3, debug.enabled('test'));\n\n```\n\nprint : \n```\n1 false\n2 true\n3 false\n```\n\nUsage : \n`enable(namespaces)` \n`namespaces` can include modes separated by a colon and wildcards.\n \nNote that calling `enable()` completely overrides previously set DEBUG variable : \n\n```\n$ DEBUG=foo node -e 'var dbg = require(\"debug\"); dbg.enable(\"bar\"); console.log(dbg.enabled(\"foo\"))'\n=> false\n```\n\n## Checking whether a debug target is enabled\n\nAfter you've created a debug instance, you can determine whether or not it is\nenabled by checking the `enabled` property:\n\n```javascript\nconst debug = require('debug')('http');\n\nif (debug.enabled) {\n // do stuff...\n}\n```\n\nYou can also manually toggle this property to force the debug instance to be\nenabled or disabled.\n\n## Authors\n\n - TJ Holowaychuk\n - Nathan Rajlich\n - Andrew Rhyne\n\n## Backers\n\nSupport us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]\n\n<a href=\"https://opencollective.com/debug/backer/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/29/avatar.svg\"></a>\n\n## Sponsors\n\nBecome a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]\n\n<a href=\"https://opencollective.com/debug/sponsor/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/29/avatar.svg\"></a>\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# is-yarn-global\n\n[](https://travis-ci.org/LitoMore/is-yarn-global)\n[](https://www.npmjs.com/package/is-yarn-global)\n[](https://github.com/LitoMore/is-yarn-global/blob/master/LICENSE)\n[](https://github.com/sindresorhus/xo)\n\nCheck if installed by yarn globally without any `fs` calls\n\n## Install\n\n```bash\n$ npm install is-yarn-global\n```\n\n## Usage\n\nJust require it in your package.\n\n```javascript\nconst isYarnGlobal = require('is-yarn-global');\n\nconsole.log(isYarnGlobal());\n```\n\n## License\n\nMIT © [LitoMore](https://github.com/LitoMore)\n# has-values [](https://www.npmjs.com/package/has-values) [](https://npmjs.org/package/has-values) [](https://npmjs.org/package/has-values) [](https://travis-ci.org/jonschlinkert/has-values)\n\n> Returns true if any values exist, false if empty. Works for booleans, functions, numbers, strings, nulls, objects and arrays.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save has-values\n```\n\n## Usage\n\n```js\nvar hasValue = require('has-values');\n\nhasValue('a');\n//=> true\n\nhasValue('');\n//=> false\n\nhasValue(1);\n//=> true\n\nhasValue(0);\n//=> false\n\nhasValue({a: 'a'}});\n//=> true\n\nhasValue({});\nhasValue({foo: undefined});\n//=> false\n\nhasValue({foo: null});\n//=> true\n\nhasValue(['a']);\n//=> true\n\nhasValue([]);\nhasValue([[], []]);\nhasValue([[[]]]);\n//=> false\n\nhasValue(['foo']);\nhasValue([0]);\n//=> true\n\nhasValue(function(foo) {}); \n//=> true\n\nhasValue(function() {});\n//=> true\n\nhasValue(true);\n//=> true\n\nhasValue(false);\n//=> true\n```\n\n## isEmpty\n\nTo test for empty values, do:\n\n```js\nfunction isEmpty(o, isZero) {\n return !hasValue(o, isZero);\n}\n```\n\n## Release history\n\n### v1.0.0\n\n* `zero` always returns true\n* `array` now recurses, so that an array of empty arrays will return `false`\n* `null` now returns true\n\n## About\n\n### Related projects\n\n* [has-value](https://www.npmjs.com/package/has-value): Returns true if a value exists, false if empty. Works with deeply nested values using… [more](https://github.com/jonschlinkert/has-value) | [homepage](https://github.com/jonschlinkert/has-value \"Returns true if a value exists, false if empty. Works with deeply nested values using object paths.\")\n* [is-number](https://www.npmjs.com/package/is-number): Returns true if the value is a number. comprehensive tests. | [homepage](https://github.com/jonschlinkert/is-number \"Returns true if the value is a number. comprehensive tests.\")\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object \"Returns true if an object was created by the `Object` constructor.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 19, 2017._\n[](https://travis-ci.org/toddbluhm/env-cmd)\n[](https://coveralls.io/github/toddbluhm/env-cmd?branch=master)\n[](https://www.npmjs.com/package/env-cmd)\n[](https://www.npmjs.com/package/env-cmd)\n[](https://www.npmjs.com/package/env-cmd)\n[](https://github.com/toddbluhm/ts-standard)\n[](https://greenkeeper.io/)\n\n# env-cmd\n\nA simple node program for executing commands using an environment from an env file.\n\n## 💾 Install\n\n`npm install env-cmd` or `npm install -g env-cmd`\n\n## ⌨️ Basic Usage\n\n**Environment file `./.env`**\n\n```text\n# This is a comment\nENV1=THANKS\nENV2=FOR ALL\nENV3=THE FISH\n```\n\n**Package.json**\n\n```json\n{\n \"scripts\": {\n \"test\": \"env-cmd mocha -R spec\"\n }\n}\n```\n\n**Terminal**\n\n```sh\n./node_modules/.bin/env-cmd node index.js\n```\n\n### Using custom env file path\n\nTo use a custom env filename or path, pass the `-f` flag. This is a major breaking change from prior versions < 9.0.0\n\n**Terminal**\n\n```sh\n./node_modules/.bin/env-cmd -f ./custom/path/.env node index.js\n```\n\n## 📜 Help\n\n```text\nUsage: _ [options] <command> [...args]\n\nOptions:\n -v, --version output the version number\n -e, --environments [env1,env2,...] The rc file environment(s) to use\n -f, --file [path] Custom env file path (default path: ./.env)\n --fallback Fallback to default env file path, if custom env file path not found\n --no-override Do not override existing environment variables\n -r, --rc-file [path] Custom rc file path (default path: ./.env-cmdrc(|.js|.json)\n --silent Ignore any env-cmd errors and only fail on executed program failure.\n --use-shell Execute the command in a new shell with the given environment\n --verbose Print helpful debugging information\n -x, --expand-envs Replace $var in args and command with environment variables\n -h, --help output usage information\n```\n\n## 🔬 Advanced Usage\n\n### `.rc` file usage\n\nFor more complex projects, a `.env-cmdrc` file can be defined in the root directory and supports\nas many environments as you want. Simply use the `-e` flag and provide which environments you wish to\nuse from the `.env-cmdrc` file. Using multiple environment names will merge the environment variables\ntogether. Later environments overwrite earlier ones in the list if conflicting environment variables\nare found.\n\n**.rc file `./.env-cmdrc`**\n\n```json\n{\n \"development\": {\n \"ENV1\": \"Thanks\",\n \"ENV2\": \"For All\"\n },\n \"test\": {\n \"ENV1\": \"No Thanks\",\n \"ENV3\": \"!\"\n },\n \"production\": {\n \"ENV1\": \"The Fish\"\n }\n}\n```\n\n**Terminal**\n\n```sh\n./node_modules/.bin/env-cmd -e production node index.js\n# Or for multiple environments (where `production` vars override `test` vars,\n# but both are included)\n./node_modules/.bin/env-cmd -e test,production node index.js\n```\n\n### `--no-override` option\n\nPrevents overriding of existing environment variables on `process.env` and within the current\nenvironment.\n\n### `--fallback` file usage option\n\nIf the `.env` file does not exist at the provided custom path, then use the default\nfallback location `./.env` env file instead.\n\n### `--use-shell`\n\nExecutes the command within a new shell environment. This is useful if you want to string multiple\ncommands together that share the same environment variables.\n\n**Terminal**\n\n```sh\n./node_modules/.bin/env-cmd -f ./test/.env --use-shell \"npm run lint && npm test\"\n```\n\n### Asynchronous env file support\n \n EnvCmd supports reading from asynchronous `.env` files. Instead of using a `.env` file, pass in a `.js`\n file that exports either an object or a `Promise` resolving to an object (`{ ENV_VAR_NAME: value, ... }`). Asynchronous `.rc`\n files are also supported using `.js` file extension and resolving to an object with top level environment\n names (`{ production: { ENV_VAR_NAME: value, ... } }`).\n \n **Terminal**\n \n ```sh\n ./node_modules/.bin/env-cmd -f ./async-file.js node index.js\n ```\n\n### `-x` expands vars in arguments\n\nEnvCmd supports expanding `$var` values passed in as arguments to the command. The allows a user\nto provide arguments to a command that are based on environment variable values at runtime.\n\n**Terminal**\n\n```sh\n# $USER will be expanded into the env value it contains at runtime\n./node_modules/.bin/env-cmd -x node index.js --user=$USER\n```\n\n### `--silent` suppresses env-cmd errors\n\nEnvCmd supports the `--silent` flag the suppresses all errors generated by `env-cmd`\nwhile leaving errors generated by the child process and cli signals still usable. This\nflag is primarily used to allow `env-cmd` to run in environments where the `.env`\nfile might not be present, but still execute the child process without failing\ndue to a missing file.\n\n## 💿 Examples\n\nYou can find examples of how to use the various options above by visiting\nthe examples repo [env-cmd-examples](https://github.com/toddbluhm/env-cmd-examples).\n\n## 💽️ Environment File Formats\n\nThese are the currently accepted environment file formats. If any other formats are desired please create an issue.\n\n- `.env` as `key=value`\n- `.env.json` Key/value pairs as JSON\n- `.env.js` JavaScript file exporting an `object` or a `Promise` that resolves to an `object`\n- `.env-cmdrc` as valid json or `.env-cmdrc.json` in execution directory with at least one environment `{ \"dev\": { \"key1\": \"val1\" } }`\n- `.env-cmdrc.js` JavaScript file exporting an `object` or a `Promise` that resolves to an `object` that contains at least one environment\n\n## 🗂 Path Rules\n\nThis lib attempts to follow standard `bash` path rules. The rules are as followed:\n\nHome Directory = `/Users/test`\n\nWorking Directory = `/Users/test/Development/app`\n\n| Type | Input Path | Expanded Path |\n| -- | -- | ------------- |\n| Absolute | `/some/absolute/path.env` | `/some/absolute/path.env` |\n| Home Directory with `~` | `~/starts/on/homedir/path.env` | `/Users/test/starts/on/homedir/path.env` |\n| Relative | `./some/relative/path.env` or `some/relative/path.env` | `/Users/test/Development/app/some/relative/path.env` |\n| Relative with parent dir | `../some/relative/path.env` | `/Users/test/Development/some/relative/path.env` |\n\n## 🛠 API Usage\n\n### `EnvCmd`\n\nA function that executes a given command in a new child process with the given environment and options\n\n- **`options`** { `object` }\n - **`command`** { `string` }: The command to execute (`node`, `mocha`, ...)\n - **`commandArgs`** { `string[]` }: List of arguments to pass to the `command` (`['-R', 'Spec']`)\n - **`envFile`** { `object` }\n - **`filePath`** { `string` }: Custom path to .env file to read from (defaults to: `./.env`)\n - **`fallback`** { `boolean` }: Should fall back to default `./.env` file if custom path does not exist\n - **`rc`** { `object` }\n - **`environments`** { `string[]` }: List of environment to read from the `.rc` file\n - **`filePath`** { `string` }: Custom path to the `.rc` file (defaults to: `./.env-cmdrc(|.js|.json)`)\n - **`options`** { `object` }\n - **`expandEnvs`** { `boolean` }: Expand `$var` values passed to `commandArgs` (default: `false`)\n - **`noOverride`** { `boolean` }: Prevent `.env` file vars from overriding existing `process.env` vars (default: `false`)\n - **`silent`** { `boolean` }: Ignore any errors thrown by env-cmd, used to ignore missing file errors (default: `false`)\n - **`useShell`** { `boolean` }: Runs command inside a new shell instance (default: `false`)\n - **`verbose`** { `boolean` }: Prints extra debug logs to `console.info` (default: `false`)\n - **Returns** { `Promise<object>` }: key is env var name and value is the env var value\n\n### `GetEnvVars`\n\nA function that parses environment variables from a `.env` or a `.rc` file\n\n- **`options`** { `object` }\n - **`envFile`** { `object` }\n - **`filePath`** { `string` }: Custom path to .env file to read from (defaults to: `./.env`)\n - **`fallback`** { `boolean` }: Should fall back to default `./.env` file if custom path does not exist\n - **`rc`** { `object` }\n - **`environments`** { `string[]` }: List of environment to read from the `.rc` file\n - **`filePath`** { `string` }: Custom path to the `.rc` file (defaults to: `./.env-cmdrc(|.js|.json)`)\n - **`verbose`** { `boolean` }: Prints extra debug logs to `console.info` (default: `false`)\n- **Returns** { `Promise<object>` }: key is env var name and value is the env var value\n\n## 🧙 Why\n\nBecause sometimes it is just too cumbersome passing a lot of environment variables to scripts. It is\nusually just easier to have a file with all the vars in them, especially for development and testing.\n\n🚨**Do not commit sensitive environment data to a public git repo!** 🚨\n\n## 🧬 Related Projects\n\n[`cross-env`](https://github.com/kentcdodds/cross-env) - Cross platform setting of environment scripts\n\n## 🎊 Special Thanks\n\nSpecial thanks to [`cross-env`](https://github.com/kentcdodds/cross-env) for inspiration (uses the\nsame `cross-spawn` lib underneath too).\n\n## 📋 Contributing Guide\n\nI welcome all pull requests. Please make sure you add appropriate test cases for any features\nadded. Before opening a PR please make sure to run the following scripts:\n\n- `npm run lint` checks for code errors and format according to [ts-standard](https://github.com/toddbluhm/ts-standard)\n- `npm test` make sure all tests pass\n- `npm run test-cover` make sure the coverage has not decreased from current master\n# braces [](https://www.npmjs.com/package/braces) [](https://npmjs.org/package/braces) [](https://npmjs.org/package/braces) [](https://travis-ci.org/micromatch/braces) [](https://ci.appveyor.com/project/micromatch/braces)\n\n> Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support for the Bash 4.3 braces specification, without sacrificing speed.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save braces\n```\n\n## Why use braces?\n\nBrace patterns are great for matching ranges. Users (and implementors) shouldn't have to think about whether or not they will break their application (or yours) from accidentally defining an aggressive brace pattern. _Braces is the only library that offers a [solution to this problem](#performance)_.\n\n* **Safe(r)**: Braces isn't vulnerable to DoS attacks like [brace-expansion](https://github.com/juliangruber/brace-expansion), [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch) (a different bug than the [other regex DoS bug](https://medium.com/node-security/minimatch-redos-vulnerability-590da24e6d3c#.jew0b6mpc)).\n* **Accurate**: complete support for the [Bash 4.3 Brace Expansion](www.gnu.org/software/bash/) specification (passes all of the Bash braces tests)\n* **[fast and performant](#benchmarks)**: Starts fast, runs fast and [scales well](#performance) as patterns increase in complexity.\n* **Organized code base**: with parser and compiler that are eas(y|ier) to maintain and update when edge cases crop up.\n* **Well-tested**: thousands of test assertions. Passes 100% of the [minimatch](https://github.com/isaacs/minimatch) and [brace-expansion](https://github.com/juliangruber/brace-expansion) unit tests as well (as of the writing of this).\n\n## Usage\n\nThe main export is a function that takes one or more brace `patterns` and `options`.\n\n```js\nvar braces = require('braces');\nbraces(pattern[, options]);\n```\n\nBy default, braces returns an optimized regex-source string. To get an array of brace patterns, use `brace.expand()`.\n\nThe following section explains the difference in more detail. _(If you're curious about \"why\" braces does this by default, see [brace matching pitfalls](#brace-matching-pitfalls)_.\n\n### Optimized vs. expanded braces\n\n**Optimized**\n\nBy default, patterns are optimized for regex and matching:\n\n```js\nconsole.log(braces('a/{x,y,z}/b'));\n//=> ['a/(x|y|z)/b']\n```\n\n**Expanded**\n\nTo expand patterns the same way as Bash or [minimatch](https://github.com/isaacs/minimatch), use the [.expand](#expand) method:\n\n```js\nconsole.log(braces.expand('a/{x,y,z}/b'));\n//=> ['a/x/b', 'a/y/b', 'a/z/b']\n```\n\nOr use [options.expand](#optionsexpand):\n\n```js\nconsole.log(braces('a/{x,y,z}/b', {expand: true}));\n//=> ['a/x/b', 'a/y/b', 'a/z/b']\n```\n\n## Features\n\n* [lists](#lists): Supports \"lists\": `a/{b,c}/d` => `['a/b/d', 'a/c/d']`\n* [sequences](#sequences): Supports alphabetical or numerical \"sequences\" (ranges): `{1..3}` => `['1', '2', '3']`\n* [steps](#steps): Supports \"steps\" or increments: `{2..10..2}` => `['2', '4', '6', '8', '10']`\n* [escaping](#escaping)\n* [options](#options)\n\n### Lists\n\nUses [fill-range](https://github.com/jonschlinkert/fill-range) for expanding alphabetical or numeric lists:\n\n```js\nconsole.log(braces('a/{foo,bar,baz}/*.js'));\n//=> ['a/(foo|bar|baz)/*.js']\n\nconsole.log(braces.expand('a/{foo,bar,baz}/*.js'));\n//=> ['a/foo/*.js', 'a/bar/*.js', 'a/baz/*.js']\n```\n\n### Sequences\n\nUses [fill-range](https://github.com/jonschlinkert/fill-range) for expanding alphabetical or numeric ranges (bash \"sequences\"):\n\n```js\nconsole.log(braces.expand('{1..3}')); // ['1', '2', '3']\nconsole.log(braces.expand('a{01..03}b')); // ['a01b', 'a02b', 'a03b']\nconsole.log(braces.expand('a{1..3}b')); // ['a1b', 'a2b', 'a3b']\nconsole.log(braces.expand('{a..c}')); // ['a', 'b', 'c']\nconsole.log(braces.expand('foo/{a..c}')); // ['foo/a', 'foo/b', 'foo/c']\n\n// supports padded ranges\nconsole.log(braces('a{01..03}b')); //=> [ 'a(0[1-3])b' ]\nconsole.log(braces('a{001..300}b')); //=> [ 'a(0{2}[1-9]|0[1-9][0-9]|[12][0-9]{2}|300)b' ]\n```\n\n### Steps\n\nSteps, or increments, may be used with ranges:\n\n```js\nconsole.log(braces.expand('{2..10..2}'));\n//=> ['2', '4', '6', '8', '10']\n\nconsole.log(braces('{2..10..2}'));\n//=> ['(2|4|6|8|10)']\n```\n\nWhen the [.optimize](#optimize) method is used, or [options.optimize](#optionsoptimize) is set to true, sequences are passed to [to-regex-range](https://github.com/jonschlinkert/to-regex-range) for expansion.\n\n### Nesting\n\nBrace patterns may be nested. The results of each expanded string are not sorted, and left to right order is preserved.\n\n**\"Expanded\" braces**\n\n```js\nconsole.log(braces.expand('a{b,c,/{x,y}}/e'));\n//=> ['ab/e', 'ac/e', 'a/x/e', 'a/y/e']\n\nconsole.log(braces.expand('a/{x,{1..5},y}/c'));\n//=> ['a/x/c', 'a/1/c', 'a/2/c', 'a/3/c', 'a/4/c', 'a/5/c', 'a/y/c']\n```\n\n**\"Optimized\" braces**\n\n```js\nconsole.log(braces('a{b,c,/{x,y}}/e'));\n//=> ['a(b|c|/(x|y))/e']\n\nconsole.log(braces('a/{x,{1..5},y}/c'));\n//=> ['a/(x|([1-5])|y)/c']\n```\n\n### Escaping\n\n**Escaping braces**\n\nA brace pattern will not be expanded or evaluted if _either the opening or closing brace is escaped_:\n\n```js\nconsole.log(braces.expand('a\\\\{d,c,b}e'));\n//=> ['a{d,c,b}e']\n\nconsole.log(braces.expand('a{d,c,b\\\\}e'));\n//=> ['a{d,c,b}e']\n```\n\n**Escaping commas**\n\nCommas inside braces may also be escaped:\n\n```js\nconsole.log(braces.expand('a{b\\\\,c}d'));\n//=> ['a{b,c}d']\n\nconsole.log(braces.expand('a{d\\\\,c,b}e'));\n//=> ['ad,ce', 'abe']\n```\n\n**Single items**\n\nFollowing bash conventions, a brace pattern is also not expanded when it contains a single character:\n\n```js\nconsole.log(braces.expand('a{b}c'));\n//=> ['a{b}c']\n```\n\n## Options\n\n### options.maxLength\n\n**Type**: `Number`\n\n**Default**: `65,536`\n\n**Description**: Limit the length of the input string. Useful when the input string is generated or your application allows users to pass a string, et cetera.\n\n```js\nconsole.log(braces('a/{b,c}/d', { maxLength: 3 })); //=> throws an error\n```\n\n### options.expand\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\n**Description**: Generate an \"expanded\" brace pattern (this option is unncessary with the `.expand` method, which does the same thing).\n\n```js\nconsole.log(braces('a/{b,c}/d', {expand: true}));\n//=> [ 'a/b/d', 'a/c/d' ]\n```\n\n### options.optimize\n\n**Type**: `Boolean`\n\n**Default**: `true`\n\n**Description**: Enabled by default.\n\n```js\nconsole.log(braces('a/{b,c}/d'));\n//=> [ 'a/(b|c)/d' ]\n```\n\n### options.nodupes\n\n**Type**: `Boolean`\n\n**Default**: `true`\n\n**Description**: Duplicates are removed by default. To keep duplicates, pass `{nodupes: false}` on the options\n\n### options.rangeLimit\n\n**Type**: `Number`\n\n**Default**: `250`\n\n**Description**: When `braces.expand()` is used, or `options.expand` is true, brace patterns will automatically be [optimized](#optionsoptimize) when the difference between the range minimum and range maximum exceeds the `rangeLimit`. This is to prevent huge ranges from freezing your application.\n\nYou can set this to any number, or change `options.rangeLimit` to `Inifinity` to disable this altogether.\n\n**Examples**\n\n```js\n// pattern exceeds the \"rangeLimit\", so it's optimized automatically\nconsole.log(braces.expand('{1..1000}'));\n//=> ['([1-9]|[1-9][0-9]{1,2}|1000)']\n\n// pattern does not exceed \"rangeLimit\", so it's NOT optimized\nconsole.log(braces.expand('{1..100}'));\n//=> ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '100']\n```\n\n### options.transform\n\n**Type**: `Function`\n\n**Default**: `undefined`\n\n**Description**: Customize range expansion.\n\n```js\nvar range = braces.expand('x{a..e}y', {\n transform: function(str) {\n return 'foo' + str;\n }\n});\n\nconsole.log(range);\n//=> [ 'xfooay', 'xfooby', 'xfoocy', 'xfoody', 'xfooey' ]\n```\n\n### options.quantifiers\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\n**Description**: In regular expressions, quanitifiers can be used to specify how many times a token can be repeated. For example, `a{1,3}` will match the letter `a` one to three times.\n\nUnfortunately, regex quantifiers happen to share the same syntax as [Bash lists](#lists)\n\nThe `quantifiers` option tells braces to detect when [regex quantifiers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#quantifiers) are defined in the given pattern, and not to try to expand them as lists.\n\n**Examples**\n\n```js\nvar braces = require('braces');\nconsole.log(braces('a/b{1,3}/{x,y,z}'));\n//=> [ 'a/b(1|3)/(x|y|z)' ]\nconsole.log(braces('a/b{1,3}/{x,y,z}', {quantifiers: true}));\n//=> [ 'a/b{1,3}/(x|y|z)' ]\nconsole.log(braces('a/b{1,3}/{x,y,z}', {quantifiers: true, expand: true}));\n//=> [ 'a/b{1,3}/x', 'a/b{1,3}/y', 'a/b{1,3}/z' ]\n```\n\n### options.unescape\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\n**Description**: Strip backslashes that were used for escaping from the result.\n\n## What is \"brace expansion\"?\n\nBrace expansion is a type of parameter expansion that was made popular by unix shells for generating lists of strings, as well as regex-like matching when used alongside wildcards (globs).\n\nIn addition to \"expansion\", braces are also used for matching. In other words:\n\n* [brace expansion](#brace-expansion) is for generating new lists\n* [brace matching](#brace-matching) is for filtering existing lists\n\n<details>\n<summary><strong>More about brace expansion</strong> (click to expand)</summary>\n\nThere are two main types of brace expansion:\n\n1. **lists**: which are defined using comma-separated values inside curly braces: `{a,b,c}`\n2. **sequences**: which are defined using a starting value and an ending value, separated by two dots: `a{1..3}b`. Optionally, a third argument may be passed to define a \"step\" or increment to use: `a{1..100..10}b`. These are also sometimes referred to as \"ranges\".\n\nHere are some example brace patterns to illustrate how they work:\n\n**Sets**\n\n```\n{a,b,c} => a b c\n{a,b,c}{1,2} => a1 a2 b1 b2 c1 c2\n```\n\n**Sequences**\n\n```\n{1..9} => 1 2 3 4 5 6 7 8 9\n{4..-4} => 4 3 2 1 0 -1 -2 -3 -4\n{1..20..3} => 1 4 7 10 13 16 19\n{a..j} => a b c d e f g h i j\n{j..a} => j i h g f e d c b a\n{a..z..3} => a d g j m p s v y\n```\n\n**Combination**\n\nSets and sequences can be mixed together or used along with any other strings.\n\n```\n{a,b,c}{1..3} => a1 a2 a3 b1 b2 b3 c1 c2 c3\nfoo/{a,b,c}/bar => foo/a/bar foo/b/bar foo/c/bar\n```\n\nThe fact that braces can be \"expanded\" from relatively simple patterns makes them ideal for quickly generating test fixtures, file paths, and similar use cases.\n\n## Brace matching\n\nIn addition to _expansion_, brace patterns are also useful for performing regular-expression-like matching.\n\nFor example, the pattern `foo/{1..3}/bar` would match any of following strings:\n\n```\nfoo/1/bar\nfoo/2/bar\nfoo/3/bar\n```\n\nBut not:\n\n```\nbaz/1/qux\nbaz/2/qux\nbaz/3/qux\n```\n\nBraces can also be combined with [glob patterns](https://github.com/jonschlinkert/micromatch) to perform more advanced wildcard matching. For example, the pattern `*/{1..3}/*` would match any of following strings:\n\n```\nfoo/1/bar\nfoo/2/bar\nfoo/3/bar\nbaz/1/qux\nbaz/2/qux\nbaz/3/qux\n```\n\n## Brace matching pitfalls\n\nAlthough brace patterns offer a user-friendly way of matching ranges or sets of strings, there are also some major disadvantages and potential risks you should be aware of.\n\n### tldr\n\n**\"brace bombs\"**\n\n* brace expansion can eat up a huge amount of processing resources\n* as brace patterns increase _linearly in size_, the system resources required to expand the pattern increase exponentially\n* users can accidentally (or intentially) exhaust your system's resources resulting in the equivalent of a DoS attack (bonus: no programming knowledge is required!)\n\nFor a more detailed explanation with examples, see the [geometric complexity](#geometric-complexity) section.\n\n### The solution\n\nJump to the [performance section](#performance) to see how Braces solves this problem in comparison to other libraries.\n\n### Geometric complexity\n\nAt minimum, brace patterns with sets limited to two elements have quadradic or `O(n^2)` complexity. But the complexity of the algorithm increases exponentially as the number of sets, _and elements per set_, increases, which is `O(n^c)`.\n\nFor example, the following sets demonstrate quadratic (`O(n^2)`) complexity:\n\n```\n{1,2}{3,4} => (2X2) => 13 14 23 24\n{1,2}{3,4}{5,6} => (2X2X2) => 135 136 145 146 235 236 245 246\n```\n\nBut add an element to a set, and we get a n-fold Cartesian product with `O(n^c)` complexity:\n\n```\n{1,2,3}{4,5,6}{7,8,9} => (3X3X3) => 147 148 149 157 158 159 167 168 169 247 248 \n 249 257 258 259 267 268 269 347 348 349 357 \n 358 359 367 368 369\n```\n\nNow, imagine how this complexity grows given that each element is a n-tuple:\n\n```\n{1..100}{1..100} => (100X100) => 10,000 elements (38.4 kB)\n{1..100}{1..100}{1..100} => (100X100X100) => 1,000,000 elements (5.76 MB)\n```\n\nAlthough these examples are clearly contrived, they demonstrate how brace patterns can quickly grow out of control.\n\n**More information**\n\nInterested in learning more about brace expansion?\n\n* [linuxjournal/bash-brace-expansion](http://www.linuxjournal.com/content/bash-brace-expansion)\n* [rosettacode/Brace_expansion](https://rosettacode.org/wiki/Brace_expansion)\n* [cartesian product](https://en.wikipedia.org/wiki/Cartesian_product)\n\n</details>\n\n## Performance\n\nBraces is not only screaming fast, it's also more accurate the other brace expansion libraries.\n\n### Better algorithms\n\nFortunately there is a solution to the [\"brace bomb\" problem](#brace-matching-pitfalls): _don't expand brace patterns into an array when they're used for matching_.\n\nInstead, convert the pattern into an optimized regular expression. This is easier said than done, and braces is the only library that does this currently.\n\n**The proof is in the numbers**\n\nMinimatch gets exponentially slower as patterns increase in complexity, braces does not. The following results were generated using `braces()` and `minimatch.braceExpand()`, respectively.\n\n| **Pattern** | **braces** | **[minimatch](https://github.com/isaacs/minimatch)** | \n| --- | --- | --- |\n| `{1..9007199254740991}`<sup class=\"footnote-ref\"><a href=\"#fn1\" id=\"fnref1\">[1]</a></sup> | `298 B` (5ms 459μs) | N/A (freezes) |\n| `{1..1000000000000000}` | `41 B` (1ms 15μs) | N/A (freezes) |\n| `{1..100000000000000}` | `40 B` (890μs) | N/A (freezes) |\n| `{1..10000000000000}` | `39 B` (2ms 49μs) | N/A (freezes) |\n| `{1..1000000000000}` | `38 B` (608μs) | N/A (freezes) |\n| `{1..100000000000}` | `37 B` (397μs) | N/A (freezes) |\n| `{1..10000000000}` | `35 B` (983μs) | N/A (freezes) |\n| `{1..1000000000}` | `34 B` (798μs) | N/A (freezes) |\n| `{1..100000000}` | `33 B` (733μs) | N/A (freezes) |\n| `{1..10000000}` | `32 B` (5ms 632μs) | `78.89 MB` (16s 388ms 569μs) |\n| `{1..1000000}` | `31 B` (1ms 381μs) | `6.89 MB` (1s 496ms 887μs) |\n| `{1..100000}` | `30 B` (950μs) | `588.89 kB` (146ms 921μs) |\n| `{1..10000}` | `29 B` (1ms 114μs) | `48.89 kB` (14ms 187μs) |\n| `{1..1000}` | `28 B` (760μs) | `3.89 kB` (1ms 453μs) |\n| `{1..100}` | `22 B` (345μs) | `291 B` (196μs) |\n| `{1..10}` | `10 B` (533μs) | `20 B` (37μs) |\n| `{1..3}` | `7 B` (190μs) | `5 B` (27μs) |\n\n### Faster algorithms\n\nWhen you need expansion, braces is still much faster.\n\n_(the following results were generated using `braces.expand()` and `minimatch.braceExpand()`, respectively)_\n\n| **Pattern** | **braces** | **[minimatch](https://github.com/isaacs/minimatch)** | \n| --- | --- | --- |\n| `{1..10000000}` | `78.89 MB` (2s 698ms 642μs) | `78.89 MB` (18s 601ms 974μs) |\n| `{1..1000000}` | `6.89 MB` (458ms 576μs) | `6.89 MB` (1s 491ms 621μs) |\n| `{1..100000}` | `588.89 kB` (20ms 728μs) | `588.89 kB` (156ms 919μs) |\n| `{1..10000}` | `48.89 kB` (2ms 202μs) | `48.89 kB` (13ms 641μs) |\n| `{1..1000}` | `3.89 kB` (1ms 796μs) | `3.89 kB` (1ms 958μs) |\n| `{1..100}` | `291 B` (424μs) | `291 B` (211μs) |\n| `{1..10}` | `20 B` (487μs) | `20 B` (72μs) |\n| `{1..3}` | `5 B` (166μs) | `5 B` (27μs) |\n\nIf you'd like to run these comparisons yourself, see [test/support/generate.js](test/support/generate.js).\n\n## Benchmarks\n\n### Running benchmarks\n\nInstall dev dependencies:\n\n```bash\nnpm i -d && npm benchmark\n```\n\n### Latest results\n\n```bash\nBenchmarking: (8 of 8)\n · combination-nested\n · combination\n · escaped\n · list-basic\n · list-multiple\n · no-braces\n · sequence-basic\n · sequence-multiple\n\n# benchmark/fixtures/combination-nested.js (52 bytes)\n brace-expansion x 4,756 ops/sec ±1.09% (86 runs sampled)\n braces x 11,202,303 ops/sec ±1.06% (88 runs sampled)\n minimatch x 4,816 ops/sec ±0.99% (87 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/combination.js (51 bytes)\n brace-expansion x 625 ops/sec ±0.87% (87 runs sampled)\n braces x 11,031,884 ops/sec ±0.72% (90 runs sampled)\n minimatch x 637 ops/sec ±0.84% (88 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/escaped.js (44 bytes)\n brace-expansion x 163,325 ops/sec ±1.05% (87 runs sampled)\n braces x 10,655,071 ops/sec ±1.22% (88 runs sampled)\n minimatch x 147,495 ops/sec ±0.96% (88 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/list-basic.js (40 bytes)\n brace-expansion x 99,726 ops/sec ±1.07% (83 runs sampled)\n braces x 10,596,584 ops/sec ±0.98% (88 runs sampled)\n minimatch x 100,069 ops/sec ±1.17% (86 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/list-multiple.js (52 bytes)\n brace-expansion x 34,348 ops/sec ±1.08% (88 runs sampled)\n braces x 9,264,131 ops/sec ±1.12% (88 runs sampled)\n minimatch x 34,893 ops/sec ±0.87% (87 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/no-braces.js (48 bytes)\n brace-expansion x 275,368 ops/sec ±1.18% (89 runs sampled)\n braces x 9,134,677 ops/sec ±0.95% (88 runs sampled)\n minimatch x 3,755,954 ops/sec ±1.13% (89 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/sequence-basic.js (41 bytes)\n brace-expansion x 5,492 ops/sec ±1.35% (87 runs sampled)\n braces x 8,485,034 ops/sec ±1.28% (89 runs sampled)\n minimatch x 5,341 ops/sec ±1.17% (87 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/sequence-multiple.js (51 bytes)\n brace-expansion x 116 ops/sec ±0.77% (77 runs sampled)\n braces x 9,445,118 ops/sec ±1.32% (84 runs sampled)\n minimatch x 109 ops/sec ±1.16% (76 runs sampled)\n\n fastest is braces\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets \"Expand POSIX bracket expressions (character classes) in glob patterns.\")\n* [extglob](https://www.npmjs.com/package/extglob): Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob… [more](https://github.com/micromatch/extglob) | [homepage](https://github.com/micromatch/extglob \"Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.\")\n* [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or `step` to… [more](https://github.com/jonschlinkert/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range \"Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n* [nanomatch](https://www.npmjs.com/package/nanomatch): Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… [more](https://github.com/micromatch/nanomatch) | [homepage](https://github.com/micromatch/nanomatch \"Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 188 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 4 | [doowb](https://github.com/doowb) |\n| 1 | [es128](https://github.com/es128) |\n| 1 | [eush77](https://github.com/eush77) |\n| 1 | [hemanth](https://github.com/hemanth) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 17, 2018._\n\n<hr class=\"footnotes-sep\">\n<section class=\"footnotes\">\n<ol class=\"footnotes-list\">\n<li id=\"fn1\" class=\"footnote-item\">this is the largest safe integer allowed in JavaScript. <a href=\"#fnref1\" class=\"footnote-backref\">↩</a>\n\n</li>\n</ol>\n</section>\n# Can I cache this? [](https://travis-ci.org/kornelski/http-cache-semantics)\n\n`CachePolicy` tells when responses can be reused from a cache, taking into account [HTTP RFC 7234](http://httpwg.org/specs/rfc7234.html) rules for user agents and shared caches.\nIt also implements [RFC 5861](https://tools.ietf.org/html/rfc5861), implementing `stale-if-error` and `stale-while-revalidate`.\nIt's aware of many tricky details such as the `Vary` header, proxy revalidation, and authenticated responses.\n\n## Usage\n\nCacheability of an HTTP response depends on how it was requested, so both `request` and `response` are required to create the policy.\n\n```js\nconst policy = new CachePolicy(request, response, options);\n\nif (!policy.storable()) {\n // throw the response away, it's not usable at all\n return;\n}\n\n// Cache the data AND the policy object in your cache\n// (this is pseudocode, roll your own cache (lru-cache package works))\nletsPretendThisIsSomeCache.set(\n request.url,\n { policy, response },\n policy.timeToLive()\n);\n```\n\n```js\n// And later, when you receive a new request:\nconst { policy, response } = letsPretendThisIsSomeCache.get(newRequest.url);\n\n// It's not enough that it exists in the cache, it has to match the new request, too:\nif (policy && policy.satisfiesWithoutRevalidation(newRequest)) {\n // OK, the previous response can be used to respond to the `newRequest`.\n // Response headers have to be updated, e.g. to add Age and remove uncacheable headers.\n response.headers = policy.responseHeaders();\n return response;\n}\n```\n\nIt may be surprising, but it's not enough for an HTTP response to be [fresh](#yo-fresh) to satisfy a request. It may need to match request headers specified in `Vary`. Even a matching fresh response may still not be usable if the new request restricted cacheability, etc.\n\nThe key method is `satisfiesWithoutRevalidation(newRequest)`, which checks whether the `newRequest` is compatible with the original request and whether all caching conditions are met.\n\n### Constructor options\n\nRequest and response must have a `headers` property with all header names in lower case. `url`, `status` and `method` are optional (defaults are any URL, status `200`, and `GET` method).\n\n```js\nconst request = {\n url: '/',\n method: 'GET',\n headers: {\n accept: '*/*',\n },\n};\n\nconst response = {\n status: 200,\n headers: {\n 'cache-control': 'public, max-age=7234',\n },\n};\n\nconst options = {\n shared: true,\n cacheHeuristic: 0.1,\n immutableMinTimeToLive: 24 * 3600 * 1000, // 24h\n ignoreCargoCult: false,\n};\n```\n\nIf `options.shared` is `true` (default), then the response is evaluated from a perspective of a shared cache (i.e. `private` is not cacheable and `s-maxage` is respected). If `options.shared` is `false`, then the response is evaluated from a perspective of a single-user cache (i.e. `private` is cacheable and `s-maxage` is ignored). `shared: true` is recommended for HTTP clients.\n\n`options.cacheHeuristic` is a fraction of response's age that is used as a fallback cache duration. The default is 0.1 (10%), e.g. if a file hasn't been modified for 100 days, it'll be cached for 100\\*0.1 = 10 days.\n\n`options.immutableMinTimeToLive` is a number of milliseconds to assume as the default time to cache responses with `Cache-Control: immutable`. Note that [per RFC](http://httpwg.org/http-extensions/immutable.html) these can become stale, so `max-age` still overrides the default.\n\nIf `options.ignoreCargoCult` is true, common anti-cache directives will be completely ignored if the non-standard `pre-check` and `post-check` directives are present. These two useless directives are most commonly found in bad StackOverflow answers and PHP's \"session limiter\" defaults.\n\n### `storable()`\n\nReturns `true` if the response can be stored in a cache. If it's `false` then you MUST NOT store either the request or the response.\n\n### `satisfiesWithoutRevalidation(newRequest)`\n\nThis is the most important method. Use this method to check whether the cached response is still fresh in the context of the new request.\n\nIf it returns `true`, then the given `request` matches the original response this cache policy has been created with, and the response can be reused without contacting the server. Note that the old response can't be returned without being updated, see `responseHeaders()`.\n\nIf it returns `false`, then the response may not be matching at all (e.g. it's for a different URL or method), or may require to be refreshed first (see `revalidationHeaders()`).\n\n### `responseHeaders()`\n\nReturns updated, filtered set of response headers to return to clients receiving the cached response. This function is necessary, because proxies MUST always remove hop-by-hop headers (such as `TE` and `Connection`) and update response's `Age` to avoid doubling cache time.\n\n```js\ncachedResponse.headers = cachePolicy.responseHeaders(cachedResponse);\n```\n\n### `timeToLive()`\n\nReturns approximate time in _milliseconds_ until the response becomes stale (i.e. not fresh).\n\nAfter that time (when `timeToLive() <= 0`) the response might not be usable without revalidation. However, there are exceptions, e.g. a client can explicitly allow stale responses, so always check with `satisfiesWithoutRevalidation()`.\n`stale-if-error` and `stale-while-revalidate` extend the time to live of the cache, that can still be used if stale.\n\n### `toObject()`/`fromObject(json)`\n\nChances are you'll want to store the `CachePolicy` object along with the cached response. `obj = policy.toObject()` gives a plain JSON-serializable object. `policy = CachePolicy.fromObject(obj)` creates an instance from it.\n\n### Refreshing stale cache (revalidation)\n\nWhen a cached response has expired, it can be made fresh again by making a request to the origin server. The server may respond with status 304 (Not Modified) without sending the response body again, saving bandwidth.\n\nThe following methods help perform the update efficiently and correctly.\n\n#### `revalidationHeaders(newRequest)`\n\nReturns updated, filtered set of request headers to send to the origin server to check if the cached response can be reused. These headers allow the origin server to return status 304 indicating the response is still fresh. All headers unrelated to caching are passed through as-is.\n\nUse this method when updating cache from the origin server.\n\n```js\nupdateRequest.headers = cachePolicy.revalidationHeaders(updateRequest);\n```\n\n#### `revalidatedPolicy(revalidationRequest, revalidationResponse)`\n\nUse this method to update the cache after receiving a new response from the origin server. It returns an object with two keys:\n\n- `policy` — A new `CachePolicy` with HTTP headers updated from `revalidationResponse`. You can always replace the old cached `CachePolicy` with the new one.\n- `modified` — Boolean indicating whether the response body has changed.\n - If `false`, then a valid 304 Not Modified response has been received, and you can reuse the old cached response body. This is also affected by `stale-if-error`.\n - If `true`, you should use new response's body (if present), or make another request to the origin server without any conditional headers (i.e. don't use `revalidationHeaders()` this time) to get the new resource.\n\n```js\n// When serving requests from cache:\nconst { oldPolicy, oldResponse } = letsPretendThisIsSomeCache.get(\n newRequest.url\n);\n\nif (!oldPolicy.satisfiesWithoutRevalidation(newRequest)) {\n // Change the request to ask the origin server if the cached response can be used\n newRequest.headers = oldPolicy.revalidationHeaders(newRequest);\n\n // Send request to the origin server. The server may respond with status 304\n const newResponse = await makeRequest(newRequest);\n\n // Create updated policy and combined response from the old and new data\n const { policy, modified } = oldPolicy.revalidatedPolicy(\n newRequest,\n newResponse\n );\n const response = modified ? newResponse : oldResponse;\n\n // Update the cache with the newer/fresher response\n letsPretendThisIsSomeCache.set(\n newRequest.url,\n { policy, response },\n policy.timeToLive()\n );\n\n // And proceed returning cached response as usual\n response.headers = policy.responseHeaders();\n return response;\n}\n```\n\n# Yo, FRESH\n\n\n\n## Used by\n\n- [ImageOptim API](https://imageoptim.com/api), [make-fetch-happen](https://github.com/zkat/make-fetch-happen), [cacheable-request](https://www.npmjs.com/package/cacheable-request) ([got](https://www.npmjs.com/package/got)), [npm/registry-fetch](https://github.com/npm/registry-fetch), [etc.](https://github.com/kornelski/http-cache-semantics/network/dependents)\n\n## Implemented\n\n- `Cache-Control` response header with all the quirks.\n- `Expires` with check for bad clocks.\n- `Pragma` response header.\n- `Age` response header.\n- `Vary` response header.\n- Default cacheability of statuses and methods.\n- Requests for stale data.\n- Filtering of hop-by-hop headers.\n- Basic revalidation request\n- `stale-if-error`\n\n## Unimplemented\n\n- Merging of range requests, `If-Range` (but correctly supports them as non-cacheable)\n- Revalidation of multiple representations\n\n### Trusting server `Date`\n\nPer the RFC, the cache should take into account the time between server-supplied `Date` and the time it received the response. The RFC-mandated behavior creates two problems:\n\n * Servers with incorrectly set timezone may add several hours to cache age (or more, if the clock is completely wrong).\n * Even reasonably correct clocks may be off by a couple of seconds, breaking `max-age=1` trick (which is useful for reverse proxies on high-traffic servers).\n\nPrevious versions of this library had an option to ignore the server date if it was \"too inaccurate\". To support the `max-age=1` trick the library also has to ignore dates that pretty accurate. There's no point of having an option to trust dates that are only a bit inaccurate, so this library won't trust any server dates. `max-age` will be interpreted from the time the response has been received, not from when it has been sent. This will affect only [RFC 1149 networks](https://tools.ietf.org/html/rfc1149).\n# <img src=\"./logo.png\" alt=\"bn.js\" width=\"160\" height=\"160\" />\n\n> BigNum in pure javascript\n\n[](http://travis-ci.org/indutny/bn.js)\n\n## Install\n`npm install --save bn.js`\n\n## Usage\n\n```js\nconst BN = require('bn.js');\n\nvar a = new BN('dead', 16);\nvar b = new BN('101010', 2);\n\nvar res = a.add(b);\nconsole.log(res.toString(10)); // 57047\n```\n\n**Note**: decimals are not supported in this library.\n\n## Notation\n\n### Prefixes\n\nThere are several prefixes to instructions that affect the way the work. Here\nis the list of them in the order of appearance in the function name:\n\n* `i` - perform operation in-place, storing the result in the host object (on\n which the method was invoked). Might be used to avoid number allocation costs\n* `u` - unsigned, ignore the sign of operands when performing operation, or\n always return positive value. Second case applies to reduction operations\n like `mod()`. In such cases if the result will be negative - modulo will be\n added to the result to make it positive\n\n### Postfixes\n\nThe only available postfix at the moment is:\n\n* `n` - which means that the argument of the function must be a plain JavaScript\n Number. Decimals are not supported.\n\n### Examples\n\n* `a.iadd(b)` - perform addition on `a` and `b`, storing the result in `a`\n* `a.umod(b)` - reduce `a` modulo `b`, returning positive value\n* `a.iushln(13)` - shift bits of `a` left by 13\n\n## Instructions\n\nPrefixes/postfixes are put in parens at the of the line. `endian` - could be\neither `le` (little-endian) or `be` (big-endian).\n\n### Utilities\n\n* `a.clone()` - clone number\n* `a.toString(base, length)` - convert to base-string and pad with zeroes\n* `a.toNumber()` - convert to Javascript Number (limited to 53 bits)\n* `a.toJSON()` - convert to JSON compatible hex string (alias of `toString(16)`)\n* `a.toArray(endian, length)` - convert to byte `Array`, and optionally zero\n pad to length, throwing if already exceeding\n* `a.toArrayLike(type, endian, length)` - convert to an instance of `type`,\n which must behave like an `Array`\n* `a.toBuffer(endian, length)` - convert to Node.js Buffer (if available). For\n compatibility with browserify and similar tools, use this instead:\n `a.toArrayLike(Buffer, endian, length)`\n* `a.bitLength()` - get number of bits occupied\n* `a.zeroBits()` - return number of less-significant consequent zero bits\n (example: `1010000` has 4 zero bits)\n* `a.byteLength()` - return number of bytes occupied\n* `a.isNeg()` - true if the number is negative\n* `a.isEven()` - no comments\n* `a.isOdd()` - no comments\n* `a.isZero()` - no comments\n* `a.cmp(b)` - compare numbers and return `-1` (a `<` b), `0` (a `==` b), or `1` (a `>` b)\n depending on the comparison result (`ucmp`, `cmpn`)\n* `a.lt(b)` - `a` less than `b` (`n`)\n* `a.lte(b)` - `a` less than or equals `b` (`n`)\n* `a.gt(b)` - `a` greater than `b` (`n`)\n* `a.gte(b)` - `a` greater than or equals `b` (`n`)\n* `a.eq(b)` - `a` equals `b` (`n`)\n* `a.toTwos(width)` - convert to two's complement representation, where `width` is bit width\n* `a.fromTwos(width)` - convert from two's complement representation, where `width` is the bit width\n* `BN.isBN(object)` - returns true if the supplied `object` is a BN.js instance\n\n### Arithmetics\n\n* `a.neg()` - negate sign (`i`)\n* `a.abs()` - absolute value (`i`)\n* `a.add(b)` - addition (`i`, `n`, `in`)\n* `a.sub(b)` - subtraction (`i`, `n`, `in`)\n* `a.mul(b)` - multiply (`i`, `n`, `in`)\n* `a.sqr()` - square (`i`)\n* `a.pow(b)` - raise `a` to the power of `b`\n* `a.div(b)` - divide (`divn`, `idivn`)\n* `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`)\n* `a.divRound(b)` - rounded division\n\n### Bit operations\n\n* `a.or(b)` - or (`i`, `u`, `iu`)\n* `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced\n with `andn` in future)\n* `a.xor(b)` - xor (`i`, `u`, `iu`)\n* `a.setn(b)` - set specified bit to `1`\n* `a.shln(b)` - shift left (`i`, `u`, `iu`)\n* `a.shrn(b)` - shift right (`i`, `u`, `iu`)\n* `a.testn(b)` - test if specified bit is set\n* `a.maskn(b)` - clear bits with indexes higher or equal to `b` (`i`)\n* `a.bincn(b)` - add `1 << b` to the number\n* `a.notn(w)` - not (for the width specified by `w`) (`i`)\n\n### Reduction\n\n* `a.gcd(b)` - GCD\n* `a.egcd(b)` - Extended GCD results (`{ a: ..., b: ..., gcd: ... }`)\n* `a.invm(b)` - inverse `a` modulo `b`\n\n## Fast reduction\n\nWhen doing lots of reductions using the same modulo, it might be beneficial to\nuse some tricks: like [Montgomery multiplication][0], or using special algorithm\nfor [Mersenne Prime][1].\n\n### Reduction context\n\nTo enable this tricks one should create a reduction context:\n\n```js\nvar red = BN.red(num);\n```\nwhere `num` is just a BN instance.\n\nOr:\n\n```js\nvar red = BN.red(primeName);\n```\n\nWhere `primeName` is either of these [Mersenne Primes][1]:\n\n* `'k256'`\n* `'p224'`\n* `'p192'`\n* `'p25519'`\n\nOr:\n\n```js\nvar red = BN.mont(num);\n```\n\nTo reduce numbers with [Montgomery trick][0]. `.mont()` is generally faster than\n`.red(num)`, but slower than `BN.red(primeName)`.\n\n### Converting numbers\n\nBefore performing anything in reduction context - numbers should be converted\nto it. Usually, this means that one should:\n\n* Convert inputs to reducted ones\n* Operate on them in reduction context\n* Convert outputs back from the reduction context\n\nHere is how one may convert numbers to `red`:\n\n```js\nvar redA = a.toRed(red);\n```\nWhere `red` is a reduction context created using instructions above\n\nHere is how to convert them back:\n\n```js\nvar a = redA.fromRed();\n```\n\n### Red instructions\n\nMost of the instructions from the very start of this readme have their\ncounterparts in red context:\n\n* `a.redAdd(b)`, `a.redIAdd(b)`\n* `a.redSub(b)`, `a.redISub(b)`\n* `a.redShl(num)`\n* `a.redMul(b)`, `a.redIMul(b)`\n* `a.redSqr()`, `a.redISqr()`\n* `a.redSqrt()` - square root modulo reduction context's prime\n* `a.redInvm()` - modular inverse of the number\n* `a.redNeg()`\n* `a.redPow(b)` - modular exponentiation\n\n## LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2015.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication\n[1]: https://en.wikipedia.org/wiki/Mersenne_prime\n# postcss-selector-parser [](https://travis-ci.org/postcss/postcss-selector-parser)\n\n> Selector parser with built in methods for working with selector strings.\n\n## Install\n\nWith [npm](https://npmjs.com/package/postcss-selector-parser) do:\n\n```\nnpm install postcss-selector-parser\n```\n\n## Quick Start\n\n```js\nconst parser = require('postcss-selector-parser');\nconst transform = selectors => {\n selectors.walk(selector => {\n // do something with the selector\n console.log(String(selector))\n });\n};\n\nconst transformed = parser(transform).processSync('h1, h2, h3');\n```\n\nTo normalize selector whitespace:\n\n```js\nconst parser = require('postcss-selector-parser');\nconst normalized = parser().processSync('h1, h2, h3', {lossless: false});\n// -> h1,h2,h3\n```\n\nAsync support is provided through `parser.process` and will resolve a Promise\nwith the resulting selector string.\n\n## API\n\nPlease see [API.md](API.md).\n\n## Credits\n\n* Huge thanks to Andrey Sitnik (@ai) for work on PostCSS which helped\n accelerate this module's development.\n\n## License\n\nMIT\n# is-resolvable\n\n[](https://www.npmjs.com/package/is-resolvable)\n[](https://travis-ci.org/shinnn/is-resolvable)\n[](https://ci.appveyor.com/project/ShinnosukeWatanabe/is-resolvable)\n[](https://coveralls.io/r/shinnn/is-resolvable)\n\nA [Node.js](https://nodejs.org/) module to check if a given module ID is resolvable with [`require()`](https://nodejs.org/api/globals.html#globals_require)\n\n```javascript\nconst isResolvable = require('is-resolvable');\n\nisResolvable('fs'); //=> true\nisResolvable('path'); //=> true\n\n// When ./index.js exists\nisResolvable('./index.js') //=> true\nisResolvable('./index') //=> true\nisResolvable('.') //=> true\n```\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```\nnpm install is-resolvable\n```\n\n## API\n\n```javascript\nconst isResolvable = require('is-resolvable');\n```\n\n### isResolvable(*moduleId* [, *options*])\n\n*moduleId*: `string` (module ID) \n*options*: `Object` ([`require.resolve`](https://nodejs.org/api/modules.html#modules_require_resolve_request_options) options) \nReturn: `boolean`\n\nIt returns `true` if `require()` can load a file form a given module ID, otherwise `false`.\n\n```javascript\nconst isResolvable = require('is-resolvable');\n\n// When ./foo.json exists\nisResolvable('./foo.json'); //=> true\nisResolvable('./foo'); //=> true\n\nisResolvable('./foo.js'); //=> false\n\n// When `eslint` module is installed but `jshint` isn't\nisResolvable('eslint'); //=> true\nisResolvable('jshint'); //=> false\n\n// When `lodash` module is installed\nisResolvable('lodash/isObject'); //=> true\nisResolvable('lodash/fp/reject.js'); //=> true\n```\n\nThe second argument accepts an options object for `require.resolve()`.\n\n```javascript\n// When ./bar/baz.js exists\n\nisResolvable('./baz.js'); //=> false\nisResolvable('./baz.js', {paths: ['bar']}); //=> true\n```\n\n## License\n\n[ISC License](./LICENSE) © 2018 Shinnosuke Watanabe\nA JSON with color names and its values. Based on http://dev.w3.org/csswg/css-color/#named-colors.\n\n[](https://nodei.co/npm/color-name/)\n\n```js\nvar colors = require('color-name');\ncolors.red //[255,0,0]\n```\n\n<a href=\"LICENSE\"><img src=\"https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg\" width=\"120\"/></a>\n# [postcss][postcss]-reduce-transforms\n\n> Reduce transform functions with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-reduce-transforms) do:\n\n```\nnpm install postcss-reduce-transforms --save\n```\n\n## Example\n\nThis module will reduce transform functions where possible. For more examples,\nsee the [tests](src/__tests__/index.js).\n\n### Input\n\n```css\nh1 {\n transform: rotate3d(0, 0, 1, 20deg);\n}\n```\n\n### Output\n\n```css\nh1 {\n transform: rotate(20deg);\n}\n```\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# util\n\n[](https://travis-ci.org/defunctzombie/node-util)\n\nnode.js [util](http://nodejs.org/api/util.html) module as a module\n\n## install via [npm](npmjs.org)\n\n```shell\nnpm install util\n```\n\n## browser support\n\nThis module also works in modern browsers. If you need legacy browser support you will need to polyfill ES5 features.\ntext-encoding-utf-8\n==============\n\nThis is a **partial** polyfill for the [Encoding Living Standard](https://encoding.spec.whatwg.org/)\nAPI for the Web, allowing encoding and decoding of textual data to and from Typed Array\nbuffers for binary data in JavaScript.\n\nThis is fork of [text-encoding](https://github.com/inexorabletash/text-encoding)\nthat **only** support **UTF-8**.\n\nBasic examples and tests are included.\n\n### Install ###\n\nThere are a few ways you can get the `text-encoding-utf-8` library.\n\n#### Node ####\n\n`text-encoding-utf-8` is on `npm`. Simply run:\n\n```js\nnpm install text-encoding-utf-8\n```\n\nOr add it to your `package.json` dependencies.\n\n### HTML Page Usage ###\n\n```html\n <script src=\"encoding.js\"></script>\n```\n\n### API Overview ###\n\nBasic Usage\n\n```js\n var uint8array = TextEncoder(encoding).encode(string);\n var string = TextDecoder(encoding).decode(uint8array);\n```\n\nStreaming Decode\n\n```js\n var string = \"\", decoder = TextDecoder(encoding), buffer;\n while (buffer = next_chunk()) {\n string += decoder.decode(buffer, {stream:true});\n }\n string += decoder.decode(); // finish the stream\n```\n\n### Encodings ###\n\nOnly `utf-8` and `UTF-8` are supported.\n\n### Non-Standard Behavior ###\n\nOnly `utf-8` and `UTF-8` are supported.\n\n### Motivation\n\nBinary size matters, especially on a mobile phone. Safari on iOS does not\nsupport TextDecoder or TextEncoder.\n# define-property [](http://badge.fury.io/js/define-property)\n\n> Define a non-enumerable property on an object.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i define-property --save\n```\n\n## Usage\n\n**Params**\n\n* `obj`: The object on which to define the property.\n* `prop`: The name of the property to be defined or modified.\n* `descriptor`: The descriptor for the property being defined or modified.\n\n```js\nvar define = require('define-property');\nvar obj = {};\ndefine(obj, 'foo', function(val) {\n return val.toUpperCase();\n});\n\nconsole.log(obj);\n//=> {}\n\nconsole.log(obj.foo('bar'));\n//=> 'BAR'\n```\n\n**get/set**\n\n```js\ndefine(obj, 'foo', {\n get: function() {},\n set: function() {}\n});\n```\n\n## Related projects\n\n* [delegate-object](https://www.npmjs.com/package/delegate-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/delegate-object) | [homepage](https://github.com/doowb/delegate-object)\n* [forward-object](https://www.npmjs.com/package/forward-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/forward-object) | [homepage](https://github.com/doowb/forward-object)\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)\n* [mixin-object](https://www.npmjs.com/package/mixin-object): Mixin the own and inherited properties of other objects onto the first object. Pass an… [more](https://www.npmjs.com/package/mixin-object) | [homepage](https://github.com/jonschlinkert/mixin-object)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/define-property/issues/new).\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 31, 2015._\n# PostCSS Calc [<img src=\"https://postcss.github.io/postcss/logo.svg\" alt=\"PostCSS\" width=\"90\" height=\"90\" align=\"right\">][PostCSS]\n\n[![NPM Version][npm-img]][npm-url]\n[![Build Status][cli-img]][cli-url]\n[![Support Chat][git-img]][git-url]\n\n[PostCSS Calc] lets you reduce `calc()` references whenever it's possible. This\ncan be particularly useful with the [PostCSS Custom Properties] plugin.\n\nWhen multiple units are mixed together in the same expression, the `calc()`\nstatement is left as is, to fallback to the [W3C calc() implementation].\n\n## Installation\n\n```bash\nnpm install postcss-calc\n```\n\n## Usage\n\n```js\n// dependencies\nvar fs = require(\"fs\")\nvar postcss = require(\"postcss\")\nvar calc = require(\"postcss-calc\")\n\n// css to be processed\nvar css = fs.readFileSync(\"input.css\", \"utf8\")\n\n// process css\nvar output = postcss()\n .use(calc())\n .process(css)\n .css\n```\n\n**Example** (with [PostCSS Custom Properties] enabled as well):\n\n```js\n// dependencies\nvar fs = require(\"fs\")\nvar postcss = require(\"postcss\")\nvar customProperties = require(\"postcss-custom-properties\")\nvar calc = require(\"postcss-calc\")\n\n// css to be processed\nvar css = fs.readFileSync(\"input.css\", \"utf8\")\n\n// process css\nvar output = postcss()\n .use(customProperties())\n .use(calc())\n .process(css)\n .css\n```\n\nUsing this `input.css`:\n\n```css\n:root {\n --main-font-size: 16px;\n}\n\nbody {\n font-size: var(--main-font-size);\n}\n\nh1 {\n font-size: calc(var(--main-font-size) * 2);\n height: calc(100px - 2em);\n margin-bottom: calc(\n var(--main-font-size)\n * 1.5\n )\n}\n```\n\nyou will get:\n\n```css\nbody {\n font-size: 16px\n}\n\nh1 {\n font-size: 32px;\n height: calc(100px - 2em);\n margin-bottom: 24px\n}\n```\n\nCheckout [tests] for more examples.\n\n### Options\n\n#### `precision` (default: `5`)\n\nAllow you to define the precision for decimal numbers.\n\n```js\nvar out = postcss()\n .use(calc({precision: 10}))\n .process(css)\n .css\n```\n\n#### `preserve` (default: `false`)\n\nAllow you to preserve calc() usage in output so browsers will handle decimal\nprecision themselves.\n\n```js\nvar out = postcss()\n .use(calc({preserve: true}))\n .process(css)\n .css\n```\n\n#### `warnWhenCannotResolve` (default: `false`)\n\nAdds warnings when calc() are not reduced to a single value.\n\n```js\nvar out = postcss()\n .use(calc({warnWhenCannotResolve: true}))\n .process(css)\n .css\n```\n\n#### `mediaQueries` (default: `false`)\n\nAllows calc() usage as part of media query declarations.\n\n```js\nvar out = postcss()\n .use(calc({mediaQueries: true}))\n .process(css)\n .css\n```\n\n#### `selectors` (default: `false`)\n\nAllows calc() usage as part of selectors.\n\n```js\nvar out = postcss()\n .use(calc({selectors: true}))\n .process(css)\n .css\n```\n\nExample:\n\n```css\ndiv[data-size=\"calc(3*3)\"] {\n width: 100px;\n}\n```\n\n---\n\n## Contributing\n\nWork on a branch, install dev-dependencies, respect coding style & run tests\nbefore submitting a bug fix or a feature.\n\n```bash\ngit clone git@github.com:postcss/postcss-calc.git\ngit checkout -b patch-1\nnpm install\nnpm test\n```\n\n## [Changelog](CHANGELOG.md)\n\n## [License](LICENSE)\n\n[cli-img]: https://img.shields.io/travis/postcss/postcss-calc/master.svg\n[cli-url]: https://travis-ci.org/postcss/postcss-calc\n[git-img]: https://img.shields.io/badge/support-chat-blue.svg\n[git-url]: https://gitter.im/postcss/postcss\n[npm-img]: https://img.shields.io/npm/v/postcss-calc.svg\n[npm-url]: https://www.npmjs.com/package/postcss-calc\n\n[PostCSS]: https://github.com/postcss\n[PostCSS Calc]: https://github.com/postcss/postcss-calc\n[PostCSS Custom Properties]: https://github.com/postcss/postcss-custom-properties\n[tests]: src/__tests__/index.js\n[W3C calc() implementation]: https://www.w3.org/TR/css3-values/#calc-notation\n# postcss-selector-parser [](https://travis-ci.org/postcss/postcss-selector-parser)\n\n> Selector parser with built in methods for working with selector strings.\n\n## Install\n\nWith [npm](https://npmjs.com/package/postcss-selector-parser) do:\n\n```\nnpm install postcss-selector-parser\n```\n\n## Quick Start\n\n```js\nconst parser = require('postcss-selector-parser');\nconst transform = selectors => {\n selectors.walk(selector => {\n // do something with the selector\n console.log(String(selector))\n });\n};\n\nconst transformed = parser(transform).processSync('h1, h2, h3');\n```\n\nTo normalize selector whitespace:\n\n```js\nconst parser = require('postcss-selector-parser');\nconst normalized = parser().processSync('h1, h2, h3', {lossless: false});\n// -> h1,h2,h3\n```\n\nAsync support is provided through `parser.process` and will resolve a Promise\nwith the resulting selector string.\n\n## API\n\nPlease see [API.md](API.md).\n\n## Credits\n\n* Huge thanks to Andrey Sitnik (@ai) for work on PostCSS which helped\n accelerate this module's development.\n\n## License\n\nMIT\n# define-property [](https://www.npmjs.com/package/define-property) [](https://npmjs.org/package/define-property) [](https://npmjs.org/package/define-property) [](https://travis-ci.org/jonschlinkert/define-property)\n\n> Define a non-enumerable property on an object.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save define-property\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add define-property\n```\n\n## Usage\n\n**Params**\n\n* `obj`: The object on which to define the property.\n* `prop`: The name of the property to be defined or modified.\n* `descriptor`: The descriptor for the property being defined or modified.\n\n```js\nvar define = require('define-property');\nvar obj = {};\ndefine(obj, 'foo', function(val) {\n return val.toUpperCase();\n});\n\nconsole.log(obj);\n//=> {}\n\nconsole.log(obj.foo('bar'));\n//=> 'BAR'\n```\n\n**get/set**\n\n```js\ndefine(obj, 'foo', {\n get: function() {},\n set: function() {}\n});\n```\n\n## About\n\n### Related projects\n\n* [assign-deep](https://www.npmjs.com/package/assign-deep): Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… [more](https://github.com/jonschlinkert/assign-deep) | [homepage](https://github.com/jonschlinkert/assign-deep \"Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target (first) object.\")\n* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow \"Extend an object with the properties of additional objects. node.js/javascript util.\")\n* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep \"Recursively merge values in a javascript object.\")\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep \"Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 20, 2017._\n# snapdragon [](https://www.npmjs.com/package/snapdragon) [](https://npmjs.org/package/snapdragon) [](https://travis-ci.org/jonschlinkert/snapdragon)\n\n> Fast, pluggable and easy-to-use parser-renderer factory.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save snapdragon\n```\n\nCreated by [jonschlinkert](https://github.com/jonschlinkert) and [doowb](https://github.com/doowb).\n\n**Features**\n\n* Bootstrap your own parser, get sourcemap support for free\n* All parsing and compiling is handled by simple, reusable middleware functions\n* Inspired by the parsers in [pug](http://jade-lang.com) and [css](https://github.com/reworkcss/css).\n\n## History\n\n### v0.5.0\n\n**Breaking changes**\n\nSubstantial breaking changes were made in v0.5.0! Most of these changes are part of a larger refactor that will be finished in 0.6.0, including the introduction of a `Lexer` class.\n\n* Renderer was renamed to `Compiler`\n* the `.render` method was renamed to `.compile`\n* Many other smaller changes. A more detailed overview will be provided in 0.6.0. If you don't have to time review code, I recommend you wait for the 0.6.0 release.\n\n## Usage examples\n\n```js\nvar Snapdragon = require('snapdragon');\nvar snapdragon = new Snapdragon();\n```\n\n**Parse**\n\n```js\nvar ast = snapdragon.parser('some string', options)\n // parser middleware that can be called by other middleware\n .set('foo', function () {})\n // parser middleware, runs immediately in the order defined\n .use(bar())\n .use(baz())\n```\n\n**Render**\n\n```js\n// pass the `ast` from the parse method\nvar res = snapdragon.compiler(ast)\n // compiler middleware, called when the name of the middleware\n // matches the `node.type` (defined in a parser middleware)\n .set('bar', function () {})\n .set('baz', function () {})\n .compile()\n```\n\nSee the [examples](./examples/).\n\n## Getting started\n\n**Parsers**\n\nParsers are middleware functions used for parsing a string into an ast node.\n\n```js\nvar ast = snapdragon.parser(str, options)\n .use(function() {\n var pos = this.position();\n var m = this.match(/^\\./);\n if (!m) return;\n return pos({\n // `type` specifies the compiler to use\n type: 'dot',\n val: m[0]\n });\n })\n```\n\n**AST node**\n\nWhen the parser finds a match, `pos()` is called, pushing a token for that node onto the ast that looks something like:\n\n```js\n{ type: 'dot',\n val: '.',\n position:\n { start: { lineno: 1, column: 1 },\n end: { lineno: 1, column: 2 } }}\n```\n\n**Renderers**\n\nRenderers are _named_ middleware functions that visit over an array of ast nodes to compile a string.\n\n```js\nvar res = snapdragon.compiler(ast)\n .set('dot', function (node) {\n console.log(node.val)\n //=> '.'\n return this.emit(node.val);\n })\n```\n\n**Source maps**\n\nIf you want source map support, make sure to emit the position as well.\n\n```js\nvar res = snapdragon.compiler(ast)\n .set('dot', function (node) {\n return this.emit(node.val, node.position);\n })\n```\n\n## Docs\n\n### Parser middleware\n\nA parser middleware is a function that returns an abject called a `token`. This token is pushed onto the AST as a node.\n\n**Example token**\n\n```js\n{ type: 'dot',\n val: '.',\n position:\n { start: { lineno: 1, column: 1 },\n end: { lineno: 1, column: 2 } }}\n```\n\n**Example parser middleware**\n\nMatch a single `.` in a string:\n\n1. Get the starting position by calling `this.position()`\n2. pass a regex for matching a single dot to the `.match` method\n3. if **no match** is found, return `undefined`\n4. if a **match** is found, `pos()` is called, which returns a token with:\n - `type`: the name of the [compiler] to use\n - `val`: The actual value captured by the regex. In this case, a `.`. Note that you can capture and return whatever will be needed by the corresponding [compiler].\n - The ending position: automatically calculated by adding the length of the first capture group to the starting position.\n\n## Renderer middleware\n\nRenderers are run when the name of the compiler middleware matches the `type` defined on an ast `node` (which is defined in a parser).\n\n**Example**\n\nExercise: Parse a dot, then compile it as an escaped dot.\n\n```js\nvar ast = snapdragon.parser('.')\n .use(function () {\n var pos = this.position();\n var m = this.match(/^\\./);\n if (!m) return;\n return pos({\n // define the `type` of compiler to use\n type: 'dot',\n val: m[0]\n })\n })\n\nvar result = snapdragon.compiler(ast)\n .set('dot', function (node) {\n return this.emit('\\\\' + node.val);\n })\n .compile()\n\nconsole.log(result.output);\n//=> '\\.'\n```\n\n## API\n\n### [Parser](lib/parser.js#L19)\n\nCreate a new `Parser` with the given `input` and `options`.\n\n**Params**\n\n* `input` **{String}**\n* `options` **{Object}**\n\n### [.define](lib/parser.js#L103)\n\nDefine a non-enumberable property on the `Parser` instance.\n\n**Example**\n\n```js\nparser.define('foo', 'bar');\n```\n\n**Params**\n\n* `key` **{String}**: propery name\n* `val` **{any}**: property value\n* `returns` **{Object}**: Returns the Parser instance for chaining.\n\nSet parser `name` with the given `fn`\n\n**Params**\n\n* `name` **{String}**\n* `fn` **{Function}**\n\nGet parser `name`\n\n**Params**\n\n* `name` **{String}**\n\nPush a `token` onto the `type` stack.\n\n**Params**\n\n* `type` **{String}**\n* `returns` **{Object}** `token`\n\nPop a token off of the `type` stack\n\n**Params**\n\n* `type` **{String}**\n* `returns` **{Object}**: Returns a token\n\nReturn true if inside a `stack` node. Types are `braces`, `parens` or `brackets`.\n\n**Params**\n\n* `type` **{String}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nparser.isType(node, 'brace');\n```\n\n**Params**\n\n* `node` **{Object}**\n* `type` **{String}**\n* `returns` **{Boolean}**\n\n### [.define](lib/compiler.js#L71)\n\nDefine a non-enumberable property on the `Compiler` instance.\n\n**Example**\n\n```js\ncompiler.define('foo', 'bar');\n```\n\n**Params**\n\n* `key` **{String}**: propery name\n* `val` **{any}**: property value\n* `returns` **{Object}**: Returns the Compiler instance for chaining.\n\n## About\n\n### Related projects\n\n* [braces](https://www.npmjs.com/package/braces): Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces… [more](https://github.com/jonschlinkert/braces) | [homepage](https://github.com/jonschlinkert/braces \"Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces specification.\")\n* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets \"Expand POSIX bracket expressions (character classes) in glob patterns.\")\n* [extglob](https://www.npmjs.com/package/extglob): Convert extended globs to regex-compatible strings. Add (almost) the expressive power of regular expressions to… [more](https://github.com/jonschlinkert/extglob) | [homepage](https://github.com/jonschlinkert/extglob \"Convert extended globs to regex-compatible strings. Add (almost) the expressive power of regular expressions to glob patterns.\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor**<br/> | \n| --- | --- |\n| 106 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [doowb](https://github.com/doowb) |\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/snapdragon/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on October 10, 2016._\n# css-select [](https://npmjs.org/package/css-select) [](http://travis-ci.org/fb55/css-select) [](https://npmjs.org/package/css-select) [](https://coveralls.io/r/fb55/css-select)\n\na CSS selector compiler/engine\n\n## What?\n\ncss-select turns CSS selectors into functions that tests if elements match them. When searching for elements, testing is executed \"from the top\", similar to how browsers execute CSS selectors.\n\nIn its default configuration, css-select queries the DOM structure of the [`domhandler`](https://github.com/fb55/domhandler) module (also known as htmlparser2 DOM).\nIt uses [`domutils`](https://github.com/fb55/domutils) as its default adapter over the DOM structure. See Options below for details on querying alternative DOM structures.\n\n__Features:__\n\n- Full implementation of CSS3 selectors\n- Partial implementation of jQuery/Sizzle extensions\n- Very high test coverage\n- Pretty good performance\n\n## Why?\n\nThe traditional approach of executing CSS selectors, named left-to-right execution, is to execute every component of the selector in order, from left to right _(duh)_. The execution of the selector `a b` for example will first query for `a` elements, then search these for `b` elements. (That's the approach of eg. [`Sizzle`](https://github.com/jquery/sizzle), [`nwmatcher`](https://github.com/dperini/nwmatcher/) and [`qwery`](https://github.com/ded/qwery).)\n\nWhile this works, it has some downsides: Children of `a`s will be checked multiple times; first, to check if they are also `a`s, then, for every superior `a` once, if they are `b`s. Using [Big O notation](http://en.wikipedia.org/wiki/Big_O_notation), that would be `O(n^(k+1))`, where `k` is the number of descendant selectors (that's the space in the example above).\n\nThe far more efficient approach is to first look for `b` elements, then check if they have superior `a` elements: Using big O notation again, that would be `O(n)`. That's called right-to-left execution.\n\nAnd that's what css-select does – and why it's quite performant.\n\n## How does it work?\n\nBy building a stack of functions.\n\n_Wait, what?_\n\nOkay, so let's suppose we want to compile the selector `a b` again, for right-to-left execution. We start by _parsing_ the selector, which means we turn the selector into an array of the building-blocks of the selector, so we can distinguish them easily. That's what the [`css-what`](https://github.com/fb55/css-what) module is for, if you want to have a look.\n\nAnyway, after parsing, we end up with an array like this one:\n\n```js\n[\n { type: 'tag', name: 'a' },\n { type: 'descendant' },\n { type: 'tag', name: 'b' }\n]\n```\n\nActually, this array is wrapped in another array, but that's another story (involving commas in selectors).\n\nNow that we know the meaning of every part of the selector, we can compile it. That's where it becomes interesting.\n\nThe basic idea is to turn every part of the selector into a function, which takes an element as its only argument. The function checks whether a passed element matches its part of the selector: If it does, the element is passed to the next turned-into-a-function part of the selector, which does the same. If an element is accepted by all parts of the selector, it _matches_ the selector and double rainbow ALL THE WAY.\n\nAs said before, we want to do right-to-left execution with all the big O improvements nonsense, so elements are passed from the rightmost part of the selector (`b` in our example) to the leftmost (~~which would be `c`~~ of course `a`).\n\n_//TODO: More in-depth description. Implementation details. Build a spaceship._\n\n## API\n\n```js\nconst CSSselect = require(\"css-select\");\n```\n\n__Note:__ css-select throws errors when invalid selectors are passed to it, contrary to the behavior in browsers, which swallow them. This is done to aid with writing css selectors, but can be unexpected when processing arbitrary strings.\n\n#### `CSSselect(query, elems, options)`\n\nQueries `elems`, returns an array containing all matches.\n\n- `query` can be either a CSS selector or a function.\n- `elems` can be either an array of elements, or a single element. If it is an element, its children will be queried.\n- `options` is described below.\n\nAliases: `CSSselect.selectAll(query, elems)`, `CSSselect.iterate(query, elems)`.\n\n#### `CSSselect.compile(query)`\n\nCompiles the query, returns a function.\n\n#### `CSSselect.is(elem, query, options)`\n\nTests whether or not an element is matched by `query`. `query` can be either a CSS selector or a function.\n\n#### `CSSselect.selectOne(query, elems, options)`\n\nArguments are the same as for `CSSselect(query, elems)`. Only returns the first match, or `null` if there was no match.\n\n### Options\n\n- `xmlMode`: When enabled, tag names will be case-sensitive. Default: `false`.\n- `strict`: Limits the module to only use CSS3 selectors. Default: `false`.\n- `rootFunc`: The last function in the stack, will be called with the last element that's looked at. Should return `true`.\n- `adapter`: The adapter to use when interacting with the backing DOM structure. By default it uses [`domutils`](https://github.com/fb55/domutils).\n\n#### Custom Adapters\n\nA custom adapter must implement the following functions:\n\n```\nisTag, existsOne, getAttributeValue, getChildren, getName, getParent,\ngetSiblings, getText, hasAttrib, removeSubsets, findAll, findOne\n```\n\nThe method signature notation used below should be fairly intuitive - if not,\nsee the [`rtype`](https://github.com/ericelliott/rtype) or\n[`TypeScript`](https://www.typescriptlang.org/) docs, as it is very similar to\nboth of those. You may also want to look at\n-[`domutils`](https://github.com/fb55/domutils) to see the default \n-implementation, or at \n-[`css-select-browser-adapter`](https://github.com/nrkn/css-select-browser-adapter/blob/master/index.js) \n-for an implementation backed by the DOM.\n\n```ts\n{\n // is the node a tag?\n isTag: ( node:Node ) => isTag:Boolean,\n\n // does at least one of passed element nodes pass the test predicate?\n existsOne: ( test:Predicate, elems:[ElementNode] ) => existsOne:Boolean,\n\n // get the attribute value\n getAttributeValue: ( elem:ElementNode, name:String ) => value:String,\n\n // get the node's children\n getChildren: ( node:Node ) => children:[Node],\n\n // get the name of the tag\n getName: ( elem:ElementNode ) => tagName:String,\n\n // get the parent of the node\n getParent: ( node:Node ) => parentNode:Node,\n\n /*\n get the siblings of the node. Note that unlike jQuery's `siblings` method,\n this is expected to include the current node as well\n */\n getSiblings: ( node:Node ) => siblings:[Node],\n\n // get the text content of the node, and its children if it has any\n getText: ( node:Node ) => text:String,\n\n // does the element have the named attribute?\n hasAttrib: ( elem:ElementNode, name:String ) => hasAttrib:Boolean,\n\n // takes an array of nodes, and removes any duplicates, as well as any nodes\n // whose ancestors are also in the array\n removeSubsets: ( nodes:[Node] ) => unique:[Node],\n\n // finds all of the element nodes in the array that match the test predicate,\n // as well as any of their children that match it\n findAll: ( test:Predicate, nodes:[Node] ) => elems:[ElementNode],\n\n // finds the first node in the array that matches the test predicate, or one\n // of its children \n findOne: ( test:Predicate, elems:[ElementNode] ) => findOne:ElementNode,\n\n /*\n The adapter can also optionally include an equals method, if your DOM\n structure needs a custom equality test to compare two objects which refer\n to the same underlying node. If not provided, `css-select` will fall back to\n `a === b`.\n */\n equals: ( a:Node, b:Node ) => Boolean\n}\n```\n\n## Supported selectors\n\n_As defined by CSS 4 and / or jQuery._\n\n* Universal (`*`)\n* Tag (`<tagname>`)\n* Descendant (` `)\n* Child (`>`)\n* Parent (`<`) *\n* Sibling (`+`)\n* Adjacent (`~`)\n* Attribute (`[attr=foo]`), with supported comparisons:\n * `[attr]` (existential)\n * `=`\n * `~=`\n * `|=`\n * `*=`\n * `^=`\n * `$=`\n * `!=` *\n * Also, `i` can be added after the comparison to make the comparison case-insensitive (eg. `[attr=foo i]`) *\n* Pseudos:\n * `:not`\n * `:contains` *\n * `:icontains` * (case-insensitive version of `:contains`)\n * `:has` *\n * `:root`\n * `:empty`\n * `:parent` *\n * `:[first|last]-child[-of-type]`\n * `:only-of-type`, `:only-child`\n * `:nth-[last-]child[-of-type]`\n * `:link`\n * `:visited`, `:hover`, `:active` * (these depend on optional Adapter methods, so these will work only if implemented in Adapter)\n * `:selected` *, `:checked`\n * `:enabled`, `:disabled`\n * `:required`, `:optional`\n * `:header`, `:button`, `:input`, `:text`, `:checkbox`, `:file`, `:password`, `:reset`, `:radio` etc. *\n * `:matches` *\n\n__*__: Not part of CSS3\n\n---\n\nLicense: BSD-2-Clause\n\n## Security contact information\n\nTo report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).\nTidelift will coordinate the fix and disclosure.\n\n## `css-select` for enterprise\n\nAvailable as part of the Tidelift Subscription\n\nThe maintainers of `css-select` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-css-select?utm_source=npm-css-select&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)\n# mustache.js - Logic-less {{mustache}} templates with JavaScript\n\n> What could be more logical awesome than no logic at all?\n\n[](https://travis-ci.org/janl/mustache.js) [](https://gitter.im/janl/mustache.js)\n\n[mustache.js](http://github.com/janl/mustache.js) is a zero-dependency implementation of the [mustache](http://mustache.github.com/) template system in JavaScript.\n\n[Mustache](http://mustache.github.com/) is a logic-less template syntax. It can be used for HTML, config files, source code - anything. It works by expanding tags in a template using values provided in a hash or object.\n\nWe call it \"logic-less\" because there are no if statements, else clauses, or for loops. Instead there are only tags. Some tags are replaced with a value, some nothing, and others a series of values.\n\nFor a language-agnostic overview of mustache's template syntax, see the `mustache(5)` [manpage](http://mustache.github.com/mustache.5.html).\n\n## Where to use mustache.js?\n\nYou can use mustache.js to render mustache templates anywhere you can use JavaScript. This includes web browsers, server-side environments such as [Node.js](http://nodejs.org/), and [CouchDB](http://couchdb.apache.org/) views.\n\nmustache.js ships with support for the [CommonJS](http://www.commonjs.org/) module API, the [Asynchronous Module Definition](https://github.com/amdjs/amdjs-api/wiki/AMD) API (AMD) and [ECMAScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).\n\nIn addition to being a package to be used programmatically, you can use it as a [command line tool](#command-line-tool).\n\nAnd this will be your templates after you use Mustache:\n\n\n\n## Install\n\nYou can get Mustache via [npm](http://npmjs.com).\n\n```bash\n$ npm install mustache --save\n```\n\n## Usage\n\nBelow is a quick example how to use mustache.js:\n\n```js\nvar view = {\n title: \"Joe\",\n calc: function () {\n return 2 + 4;\n }\n};\n\nvar output = Mustache.render(\"{{title}} spends {{calc}}\", view);\n```\n\nIn this example, the `Mustache.render` function takes two parameters: 1) the [mustache](http://mustache.github.com/) template and 2) a `view` object that contains the data and code needed to render the template.\n\n## Templates\n\nA [mustache](http://mustache.github.com/) template is a string that contains any number of mustache tags. Tags are indicated by the double mustaches that surround them. `{{person}}` is a tag, as is `{{#person}}`. In both examples we refer to `person` as the tag's key. There are several types of tags available in mustache.js, described below.\n\nThere are several techniques that can be used to load templates and hand them to mustache.js, here are two of them:\n\n#### Include Templates\n\nIf you need a template for a dynamic part in a static website, you can consider including the template in the static HTML file to avoid loading templates separately. Here's a small example:\n\n```js\n// file: render.js\n\nfunction renderHello() {\n var template = document.getElementById('template').innerHTML;\n var rendered = Mustache.render(template, { name: 'Luke' });\n document.getElementById('target').innerHTML = rendered;\n}\n```\n\n```html\n<html>\n <body onload=\"renderHello()\">\n <div id=\"target\">Loading...</div>\n <script id=\"template\" type=\"x-tmpl-mustache\">\n Hello {{ name }}!\n </script>\n\n <script src=\"https://unpkg.com/mustache@latest\"></script>\n <script src=\"render.js\"></script>\n </body>\n</html>\n```\n\n#### Load External Templates\n\nIf your templates reside in individual files, you can load them asynchronously and render them when they arrive. Another example using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch):\n\n```js\nfunction renderHello() {\n fetch('template.mustache')\n .then((response) => response.text())\n .then((template) => {\n var rendered = Mustache.render(template, { name: 'Luke' });\n document.getElementById('target').innerHTML = rendered; \n });\n}\n```\n\n### Variables\n\nThe most basic tag type is a simple variable. A `{{name}}` tag renders the value of the `name` key in the current context. If there is no such key, nothing is rendered.\n\nAll variables are HTML-escaped by default. If you want to render unescaped HTML, use the triple mustache: `{{{name}}}`. You can also use `&` to unescape a variable.\n\nIf you'd like to change HTML-escaping behavior globally (for example, to template non-HTML formats), you can override Mustache's escape function. For example, to disable all escaping: `Mustache.escape = function(text) {return text;};`.\n\nIf you want `{{name}}` _not_ to be interpreted as a mustache tag, but rather to appear exactly as `{{name}}` in the output, you must change and then restore the default delimiter. See the [Custom Delimiters](#custom-delimiters) section for more information.\n\nView:\n\n```json\n{\n \"name\": \"Chris\",\n \"company\": \"<b>GitHub</b>\"\n}\n```\n\nTemplate:\n\n```\n* {{name}}\n* {{age}}\n* {{company}}\n* {{{company}}}\n* {{&company}}\n{{=<% %>=}}\n* {{company}}\n<%={{ }}=%>\n```\n\nOutput:\n\n```html\n* Chris\n*\n* <b>GitHub</b>\n* <b>GitHub</b>\n* <b>GitHub</b>\n* {{company}}\n```\n\nJavaScript's dot notation may be used to access keys that are properties of objects in a view.\n\nView:\n\n```json\n{\n \"name\": {\n \"first\": \"Michael\",\n \"last\": \"Jackson\"\n },\n \"age\": \"RIP\"\n}\n```\n\nTemplate:\n\n```html\n* {{name.first}} {{name.last}}\n* {{age}}\n```\n\nOutput:\n\n```html\n* Michael Jackson\n* RIP\n```\n\n### Sections\n\nSections render blocks of text one or more times, depending on the value of the key in the current context.\n\nA section begins with a pound and ends with a slash. That is, `{{#person}}` begins a `person` section, while `{{/person}}` ends it. The text between the two tags is referred to as that section's \"block\".\n\nThe behavior of the section is determined by the value of the key.\n\n#### False Values or Empty Lists\n\nIf the `person` key does not exist, or exists and has a value of `null`, `undefined`, `false`, `0`, or `NaN`, or is an empty string or an empty list, the block will not be rendered.\n\nView:\n\n```json\n{\n \"person\": false\n}\n```\n\nTemplate:\n\n```html\nShown.\n{{#person}}\nNever shown!\n{{/person}}\n```\n\nOutput:\n\n```html\nShown.\n```\n\n#### Non-Empty Lists\n\nIf the `person` key exists and is not `null`, `undefined`, or `false`, and is not an empty list the block will be rendered one or more times.\n\nWhen the value is a list, the block is rendered once for each item in the list. The context of the block is set to the current item in the list for each iteration. In this way we can loop over collections.\n\nView:\n\n```json\n{\n \"stooges\": [\n { \"name\": \"Moe\" },\n { \"name\": \"Larry\" },\n { \"name\": \"Curly\" }\n ]\n}\n```\n\nTemplate:\n\n```html\n{{#stooges}}\n<b>{{name}}</b>\n{{/stooges}}\n```\n\nOutput:\n\n```html\n<b>Moe</b>\n<b>Larry</b>\n<b>Curly</b>\n```\n\nWhen looping over an array of strings, a `.` can be used to refer to the current item in the list.\n\nView:\n\n```json\n{\n \"musketeers\": [\"Athos\", \"Aramis\", \"Porthos\", \"D'Artagnan\"]\n}\n```\n\nTemplate:\n\n```html\n{{#musketeers}}\n* {{.}}\n{{/musketeers}}\n```\n\nOutput:\n\n```html\n* Athos\n* Aramis\n* Porthos\n* D'Artagnan\n```\n\nIf the value of a section variable is a function, it will be called in the context of the current item in the list on each iteration.\n\nView:\n\n```js\n{\n \"beatles\": [\n { \"firstName\": \"John\", \"lastName\": \"Lennon\" },\n { \"firstName\": \"Paul\", \"lastName\": \"McCartney\" },\n { \"firstName\": \"George\", \"lastName\": \"Harrison\" },\n { \"firstName\": \"Ringo\", \"lastName\": \"Starr\" }\n ],\n \"name\": function () {\n return this.firstName + \" \" + this.lastName;\n }\n}\n```\n\nTemplate:\n\n```html\n{{#beatles}}\n* {{name}}\n{{/beatles}}\n```\n\nOutput:\n\n```html\n* John Lennon\n* Paul McCartney\n* George Harrison\n* Ringo Starr\n```\n\n#### Functions\n\nIf the value of a section key is a function, it is called with the section's literal block of text, un-rendered, as its first argument. The second argument is a special rendering function that uses the current view as its view argument. It is called in the context of the current view object.\n\nView:\n\n```js\n{\n \"name\": \"Tater\",\n \"bold\": function () {\n return function (text, render) {\n return \"<b>\" + render(text) + \"</b>\";\n }\n }\n}\n```\n\nTemplate:\n\n```html\n{{#bold}}Hi {{name}}.{{/bold}}\n```\n\nOutput:\n\n```html\n<b>Hi Tater.</b>\n```\n\n### Inverted Sections\n\nAn inverted section opens with `{{^section}}` instead of `{{#section}}`. The block of an inverted section is rendered only if the value of that section's tag is `null`, `undefined`, `false`, *falsy* or an empty list.\n\nView:\n\n```json\n{\n \"repos\": []\n}\n```\n\nTemplate:\n\n```html\n{{#repos}}<b>{{name}}</b>{{/repos}}\n{{^repos}}No repos :({{/repos}}\n```\n\nOutput:\n\n```html\nNo repos :(\n```\n\n### Comments\n\nComments begin with a bang and are ignored. The following template:\n\n```html\n<h1>Today{{! ignore me }}.</h1>\n```\n\nWill render as follows:\n\n```html\n<h1>Today.</h1>\n```\n\nComments may contain newlines.\n\n### Partials\n\nPartials begin with a greater than sign, like {{> box}}.\n\nPartials are rendered at runtime (as opposed to compile time), so recursive partials are possible. Just avoid infinite loops.\n\nThey also inherit the calling context. Whereas in ERB you may have this:\n\n```html+erb\n<%= partial :next_more, :start => start, :size => size %>\n```\n\nMustache requires only this:\n\n```html\n{{> next_more}}\n```\n\nWhy? Because the `next_more.mustache` file will inherit the `size` and `start` variables from the calling context. In this way you may want to think of partials as includes, imports, template expansion, nested templates, or subtemplates, even though those aren't literally the case here.\n\nFor example, this template and partial:\n\n base.mustache:\n <h2>Names</h2>\n {{#names}}\n {{> user}}\n {{/names}}\n\n user.mustache:\n <strong>{{name}}</strong>\n\nCan be thought of as a single, expanded template:\n\n```html\n<h2>Names</h2>\n{{#names}}\n <strong>{{name}}</strong>\n{{/names}}\n```\n\nIn mustache.js an object of partials may be passed as the third argument to `Mustache.render`. The object should be keyed by the name of the partial, and its value should be the partial text.\n\n```js\nMustache.render(template, view, {\n user: userTemplate\n});\n```\n\n### Custom Delimiters\n\nCustom delimiters can be used in place of `{{` and `}}` by setting the new values in JavaScript or in templates.\n\n#### Setting in JavaScript\n\nThe `Mustache.tags` property holds an array consisting of the opening and closing tag values. Set custom values by passing a new array of tags to `render()`, which gets honored over the default values, or by overriding the `Mustache.tags` property itself:\n\n```js\nvar customTags = [ '<%', '%>' ];\n```\n\n##### Pass Value into Render Method\n```js\nMustache.render(template, view, {}, customTags);\n```\n\n##### Override Tags Property\n```js\nMustache.tags = customTags;\n// Subsequent parse() and render() calls will use customTags\n```\n\n#### Setting in Templates\n\nSet Delimiter tags start with an equals sign and change the tag delimiters from `{{` and `}}` to custom strings.\n\nConsider the following contrived example:\n\n```html+erb\n* {{ default_tags }}\n{{=<% %>=}}\n* <% erb_style_tags %>\n<%={{ }}=%>\n* {{ default_tags_again }}\n```\n\nHere we have a list with three items. The first item uses the default tag style, the second uses ERB style as defined by the Set Delimiter tag, and the third returns to the default style after yet another Set Delimiter declaration.\n\nAccording to [ctemplates](https://htmlpreview.github.io/?https://raw.githubusercontent.com/OlafvdSpek/ctemplate/master/doc/howto.html), this \"is useful for languages like TeX, where double-braces may occur in the text and are awkward to use for markup.\"\n\nCustom delimiters may not contain whitespace or the equals sign.\n\n## Pre-parsing and Caching Templates\n\nBy default, when mustache.js first parses a template it keeps the full parsed token tree in a cache. The next time it sees that same template it skips the parsing step and renders the template much more quickly. If you'd like, you can do this ahead of time using `mustache.parse`.\n\n```js\nMustache.parse(template);\n\n// Then, sometime later.\nMustache.render(template, view);\n```\n\n## Command line tool\n\nmustache.js is shipped with a Node.js based command line tool. It might be installed as a global tool on your computer to render a mustache template of some kind\n\n```bash\n$ npm install -g mustache\n\n$ mustache dataView.json myTemplate.mustache > output.html\n```\n\nalso supports stdin.\n\n```bash\n$ cat dataView.json | mustache - myTemplate.mustache > output.html\n```\n\nor as a package.json `devDependency` in a build process maybe?\n\n```bash\n$ npm install mustache --save-dev\n```\n\n```json\n{\n \"scripts\": {\n \"build\": \"mustache dataView.json myTemplate.mustache > public/output.html\"\n }\n}\n```\n```bash\n$ npm run build\n```\n\nThe command line tool is basically a wrapper around `Mustache.render` so you get all the features.\n\nIf your templates use partials you should pass paths to partials using `-p` flag:\n\n```bash\n$ mustache -p path/to/partial1.mustache -p path/to/partial2.mustache dataView.json myTemplate.mustache\n```\n\n## Plugins for JavaScript Libraries\n\nmustache.js may be built specifically for several different client libraries, including the following:\n\n - [jQuery](http://jquery.com/)\n - [MooTools](http://mootools.net/)\n - [Dojo](http://www.dojotoolkit.org/)\n - [YUI](http://developer.yahoo.com/yui/)\n - [qooxdoo](http://qooxdoo.org/)\n\nThese may be built using [Rake](http://rake.rubyforge.org/) and one of the following commands:\n```bash\n$ rake jquery\n$ rake mootools\n$ rake dojo\n$ rake yui3\n$ rake qooxdoo\n```\n\n## TypeScript\n\nSince the source code of this package is written in JavaScript, we follow the [TypeScript publishing docs](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) preferred approach\nby having type definitions available via [@types/mustache](https://www.npmjs.com/package/@types/mustache).\n\n## Testing\n\nIn order to run the tests you'll need to install [Node.js](http://nodejs.org/).\n\nYou also need to install the sub module containing [Mustache specifications](http://github.com/mustache/spec) in the project root.\n```bash\n$ git submodule init\n$ git submodule update\n```\nInstall dependencies.\n```bash\n$ npm install\n```\nThen run the tests.\n```bash\n$ npm test\n```\nThe test suite consists of both unit and integration tests. If a template isn't rendering correctly for you, you can make a test for it by doing the following:\n\n 1. Create a template file named `mytest.mustache` in the `test/_files`\n directory. Replace `mytest` with the name of your test.\n 2. Create a corresponding view file named `mytest.js` in the same directory.\n This file should contain a JavaScript object literal enclosed in\n parentheses. See any of the other view files for an example.\n 3. Create a file with the expected output in `mytest.txt` in the same\n directory.\n\nThen, you can run the test with:\n```bash\n$ TEST=mytest npm run test-render\n```\n\n### Browser tests\n\nBrowser tests are not included in `npm test` as they run for too long, although they are ran automatically on Travis when merged into master. Run browser tests locally in any browser:\n```bash\n$ npm run test-browser-local\n```\nthen point your browser to `http://localhost:8080/__zuul`\n\n## Who uses mustache.js?\n\nAn updated list of mustache.js users is kept [on the Github wiki](https://github.com/janl/mustache.js/wiki/Beard-Competition). Add yourself or your company if you use mustache.js!\n\n## Contributing\n\nmustache.js is a mature project, but it continues to actively invite maintainers. You can help out a high-profile project that is used in a lot of places on the web. No big commitment required, if all you do is review a single [Pull Request](https://github.com/janl/mustache.js/pulls), you are a maintainer. And a hero.\n\n### Your First Contribution\n\n- review a [Pull Request](https://github.com/janl/mustache.js/pulls)\n- fix an [Issue](https://github.com/janl/mustache.js/issues)\n- update the [documentation](https://github.com/janl/mustache.js#usage)\n- make a website\n- write a tutorial\n\n## Thanks\n\nmustache.js wouldn't kick ass if it weren't for these fine souls:\n\n * Chris Wanstrath / defunkt\n * Alexander Lang / langalex\n * Sebastian Cohnen / tisba\n * J Chris Anderson / jchris\n * Tom Robinson / tlrobinson\n * Aaron Quint / quirkey\n * Douglas Crockford\n * Nikita Vasilyev / NV\n * Elise Wood / glytch\n * Damien Mathieu / dmathieu\n * Jakub Kuźma / qoobaa\n * Will Leinweber / will\n * dpree\n * Jason Smith / jhs\n * Aaron Gibralter / agibralter\n * Ross Boucher / boucher\n * Matt Sanford / mzsanford\n * Ben Cherry / bcherry\n * Michael Jackson / mjackson\n * Phillip Johnsen / phillipj\n * David da Silva Contín / dasilvacontin\n# Miller-Rabin\n\n#### LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2014.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n# [postcss][postcss]-discard-comments\n\n> Discard comments in your CSS files with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-discard-comments) do:\n\n```\nnpm install postcss-discard-comments --save\n```\n\n## Example\n\n### Input\n\n```css\nh1/* heading */{\n margin: 0 auto\n}\n```\n\n### Output\n\n```css\nh1 {\n margin: 0 auto\n}\n```\n\nThis module discards comments from your CSS files; by default, it will remove\nall regular comments (`/* comment */`) and preserve comments marked as important\n(`/*! important */`).\n\nNote that this module does not handle source map comments because they are not\navailable to it; PostCSS handles this internally, so if they are removed then\nyou will have to [configure source maps in PostCSS][maps].\n\n[maps]: https://github.com/postcss/postcss/blob/master/docs/source-maps.md\n\n## API\n\n### comments([options])\n\n#### options\n\n##### remove(function)\n\nType: `function`\nReturn: `boolean`\nVariable: `comment` contains a comment without `/**/`\n\nFor each comment, return true to remove, or false to keep the comment.\n\n```js\nfunction(comment) {}\n```\n\n```js\nvar css = '/* headings *//*@ h1 */h1{margin:0 auto}/*@ h2 */h2{color:red}';\nconsole.log(postcss(comments({\n remove: function(comment) { return comment[0] == \"@\"; }\n})).process(css).css);\n//=> /* headings */h1{margin:0 auto}h2{color:red}\n```\n**NOTE:** If you use the `remove` function other options will not be available.\n\n##### removeAll\n\nType: `boolean`\nDefault: `false`\n\nRemove all comments marked as important.\n\n```js\nvar css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}';\nconsole.log(postcss(comments({removeAll: true})).process(css).css);\n//=> h1{margin:0 auto}h2{color:red}\n```\n\n##### removeAllButFirst\n\nType: `boolean`\nDefault: `false`\n\nRemove all comments marked as important, but the first one.\n\n```js\nvar css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}';\nconsole.log(postcss(comments({removeAllButFirst: true})).process(css).css);\n//=> /*! heading */h1{margin:0 auto}h2{color:red}\n```\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# es-to-primitive <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![Build Status][travis-svg]][travis-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\nECMAScript “ToPrimitive” algorithm. Provides ES5 and ES2015 versions.\nWhen different versions of the spec conflict, the default export will be the latest version of the abstract operation.\nAlternative versions will also be available under an `es5`/`es2015` exported property if you require a specific version.\n\n## Example\n\n```js\nvar toPrimitive = require('es-to-primitive');\nvar assert = require('assert');\n\nassert(toPrimitive(function () {}) === String(function () {}));\n\nvar date = new Date();\nassert(toPrimitive(date) === String(date));\n\nassert(toPrimitive({ valueOf: function () { return 3; } }) === 3);\n\nassert(toPrimitive(['a', 'b', 3]) === String(['a', 'b', 3]));\n\nvar sym = Symbol();\nassert(toPrimitive(Object(sym)) === sym);\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[package-url]: https://npmjs.org/package/es-to-primitive\n[npm-version-svg]: http://versionbadg.es/ljharb/es-to-primitive.svg\n[travis-svg]: https://travis-ci.org/ljharb/es-to-primitive.svg\n[travis-url]: https://travis-ci.org/ljharb/es-to-primitive\n[deps-svg]: https://david-dm.org/ljharb/es-to-primitive.svg\n[deps-url]: https://david-dm.org/ljharb/es-to-primitive\n[dev-deps-svg]: https://david-dm.org/ljharb/es-to-primitive/dev-status.svg\n[dev-deps-url]: https://david-dm.org/ljharb/es-to-primitive#info=devDependencies\n[npm-badge-png]: https://nodei.co/npm/es-to-primitive.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/es-to-primitive.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/es-to-primitive.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=es-to-primitive\n[RFC6265](https://tools.ietf.org/html/rfc6265) Cookies and CookieJar for Node.js\n\n[](https://nodei.co/npm/tough-cookie/)\n\n[](https://travis-ci.org/salesforce/tough-cookie)\n\n# Synopsis\n\n``` javascript\nvar tough = require('tough-cookie');\nvar Cookie = tough.Cookie;\nvar cookie = Cookie.parse(header);\ncookie.value = 'somethingdifferent';\nheader = cookie.toString();\n\nvar cookiejar = new tough.CookieJar();\ncookiejar.setCookie(cookie, 'http://currentdomain.example.com/path', cb);\n// ...\ncookiejar.getCookies('http://example.com/otherpath',function(err,cookies) {\n res.headers['cookie'] = cookies.join('; ');\n});\n```\n\n# Installation\n\nIt's _so_ easy!\n\n`npm install tough-cookie`\n\nWhy the name? NPM modules `cookie`, `cookies` and `cookiejar` were already taken.\n\n## Version Support\n\nSupport for versions of node.js will follow that of the [request](https://www.npmjs.com/package/request) module.\n\n# API\n\n## tough\n\nFunctions on the module you get from `require('tough-cookie')`. All can be used as pure functions and don't need to be \"bound\".\n\n**Note**: prior to 1.0.x, several of these functions took a `strict` parameter. This has since been removed from the API as it was no longer necessary.\n\n### `parseDate(string)`\n\nParse a cookie date string into a `Date`. Parses according to RFC6265 Section 5.1.1, not `Date.parse()`.\n\n### `formatDate(date)`\n\nFormat a Date into a RFC1123 string (the RFC6265-recommended format).\n\n### `canonicalDomain(str)`\n\nTransforms a domain-name into a canonical domain-name. The canonical domain-name is a trimmed, lowercased, stripped-of-leading-dot and optionally punycode-encoded domain-name (Section 5.1.2 of RFC6265). For the most part, this function is idempotent (can be run again on its output without ill effects).\n\n### `domainMatch(str,domStr[,canonicalize=true])`\n\nAnswers \"does this real domain match the domain in a cookie?\". The `str` is the \"current\" domain-name and the `domStr` is the \"cookie\" domain-name. Matches according to RFC6265 Section 5.1.3, but it helps to think of it as a \"suffix match\".\n\nThe `canonicalize` parameter will run the other two parameters through `canonicalDomain` or not.\n\n### `defaultPath(path)`\n\nGiven a current request/response path, gives the Path apropriate for storing in a cookie. This is basically the \"directory\" of a \"file\" in the path, but is specified by Section 5.1.4 of the RFC.\n\nThe `path` parameter MUST be _only_ the pathname part of a URI (i.e. excludes the hostname, query, fragment, etc.). This is the `.pathname` property of node's `uri.parse()` output.\n\n### `pathMatch(reqPath,cookiePath)`\n\nAnswers \"does the request-path path-match a given cookie-path?\" as per RFC6265 Section 5.1.4. Returns a boolean.\n\nThis is essentially a prefix-match where `cookiePath` is a prefix of `reqPath`.\n\n### `parse(cookieString[, options])`\n\nalias for `Cookie.parse(cookieString[, options])`\n\n### `fromJSON(string)`\n\nalias for `Cookie.fromJSON(string)`\n\n### `getPublicSuffix(hostname)`\n\nReturns the public suffix of this hostname. The public suffix is the shortest domain-name upon which a cookie can be set. Returns `null` if the hostname cannot have cookies set for it.\n\nFor example: `www.example.com` and `www.subdomain.example.com` both have public suffix `example.com`.\n\nFor further information, see http://publicsuffix.org/. This module derives its list from that site. This call is currently a wrapper around [`psl`](https://www.npmjs.com/package/psl)'s [get() method](https://www.npmjs.com/package/psl#pslgetdomain).\n\n### `cookieCompare(a,b)`\n\nFor use with `.sort()`, sorts a list of cookies into the recommended order given in the RFC (Section 5.4 step 2). The sort algorithm is, in order of precedence:\n\n* Longest `.path`\n* oldest `.creation` (which has a 1ms precision, same as `Date`)\n* lowest `.creationIndex` (to get beyond the 1ms precision)\n\n``` javascript\nvar cookies = [ /* unsorted array of Cookie objects */ ];\ncookies = cookies.sort(cookieCompare);\n```\n\n**Note**: Since JavaScript's `Date` is limited to a 1ms precision, cookies within the same milisecond are entirely possible. This is especially true when using the `now` option to `.setCookie()`. The `.creationIndex` property is a per-process global counter, assigned during construction with `new Cookie()`. This preserves the spirit of the RFC sorting: older cookies go first. This works great for `MemoryCookieStore`, since `Set-Cookie` headers are parsed in order, but may not be so great for distributed systems. Sophisticated `Store`s may wish to set this to some other _logical clock_ such that if cookies A and B are created in the same millisecond, but cookie A is created before cookie B, then `A.creationIndex < B.creationIndex`. If you want to alter the global counter, which you probably _shouldn't_ do, it's stored in `Cookie.cookiesCreated`.\n\n### `permuteDomain(domain)`\n\nGenerates a list of all possible domains that `domainMatch()` the parameter. May be handy for implementing cookie stores.\n\n### `permutePath(path)`\n\nGenerates a list of all possible paths that `pathMatch()` the parameter. May be handy for implementing cookie stores.\n\n## Cookie\n\nExported via `tough.Cookie`.\n\n### `Cookie.parse(cookieString[, options])`\n\nParses a single Cookie or Set-Cookie HTTP header into a `Cookie` object. Returns `undefined` if the string can't be parsed.\n\nThe options parameter is not required and currently has only one property:\n\n * _loose_ - boolean - if `true` enable parsing of key-less cookies like `=abc` and `=`, which are not RFC-compliant.\n\nIf options is not an object, it is ignored, which means you can use `Array#map` with it.\n\nHere's how to process the Set-Cookie header(s) on a node HTTP/HTTPS response:\n\n``` javascript\nif (res.headers['set-cookie'] instanceof Array)\n cookies = res.headers['set-cookie'].map(Cookie.parse);\nelse\n cookies = [Cookie.parse(res.headers['set-cookie'])];\n```\n\n_Note:_ in version 2.3.3, tough-cookie limited the number of spaces before the `=` to 256 characters. This limitation has since been removed.\nSee [Issue 92](https://github.com/salesforce/tough-cookie/issues/92)\n\n### Properties\n\nCookie object properties:\n\n * _key_ - string - the name or key of the cookie (default \"\")\n * _value_ - string - the value of the cookie (default \"\")\n * _expires_ - `Date` - if set, the `Expires=` attribute of the cookie (defaults to the string `\"Infinity\"`). See `setExpires()`\n * _maxAge_ - seconds - if set, the `Max-Age=` attribute _in seconds_ of the cookie. May also be set to strings `\"Infinity\"` and `\"-Infinity\"` for non-expiry and immediate-expiry, respectively. See `setMaxAge()`\n * _domain_ - string - the `Domain=` attribute of the cookie\n * _path_ - string - the `Path=` of the cookie\n * _secure_ - boolean - the `Secure` cookie flag\n * _httpOnly_ - boolean - the `HttpOnly` cookie flag\n * _extensions_ - `Array` - any unrecognized cookie attributes as strings (even if equal-signs inside)\n * _creation_ - `Date` - when this cookie was constructed\n * _creationIndex_ - number - set at construction, used to provide greater sort precision (please see `cookieCompare(a,b)` for a full explanation)\n\nAfter a cookie has been passed through `CookieJar.setCookie()` it will have the following additional attributes:\n\n * _hostOnly_ - boolean - is this a host-only cookie (i.e. no Domain field was set, but was instead implied)\n * _pathIsDefault_ - boolean - if true, there was no Path field on the cookie and `defaultPath()` was used to derive one.\n * _creation_ - `Date` - **modified** from construction to when the cookie was added to the jar\n * _lastAccessed_ - `Date` - last time the cookie got accessed. Will affect cookie cleaning once implemented. Using `cookiejar.getCookies(...)` will update this attribute.\n\n### `Cookie([{properties}])`\n\nReceives an options object that can contain any of the above Cookie properties, uses the default for unspecified properties.\n\n### `.toString()`\n\nencode to a Set-Cookie header value. The Expires cookie field is set using `formatDate()`, but is omitted entirely if `.expires` is `Infinity`.\n\n### `.cookieString()`\n\nencode to a Cookie header value (i.e. the `.key` and `.value` properties joined with '=').\n\n### `.setExpires(String)`\n\nsets the expiry based on a date-string passed through `parseDate()`. If parseDate returns `null` (i.e. can't parse this date string), `.expires` is set to `\"Infinity\"` (a string) is set.\n\n### `.setMaxAge(number)`\n\nsets the maxAge in seconds. Coerces `-Infinity` to `\"-Infinity\"` and `Infinity` to `\"Infinity\"` so it JSON serializes correctly.\n\n### `.expiryTime([now=Date.now()])`\n\n### `.expiryDate([now=Date.now()])`\n\nexpiryTime() Computes the absolute unix-epoch milliseconds that this cookie expires. expiryDate() works similarly, except it returns a `Date` object. Note that in both cases the `now` parameter should be milliseconds.\n\nMax-Age takes precedence over Expires (as per the RFC). The `.creation` attribute -- or, by default, the `now` parameter -- is used to offset the `.maxAge` attribute.\n\nIf Expires (`.expires`) is set, that's returned.\n\nOtherwise, `expiryTime()` returns `Infinity` and `expiryDate()` returns a `Date` object for \"Tue, 19 Jan 2038 03:14:07 GMT\" (latest date that can be expressed by a 32-bit `time_t`; the common limit for most user-agents).\n\n### `.TTL([now=Date.now()])`\n\ncompute the TTL relative to `now` (milliseconds). The same precedence rules as for `expiryTime`/`expiryDate` apply.\n\nThe \"number\" `Infinity` is returned for cookies without an explicit expiry and `0` is returned if the cookie is expired. Otherwise a time-to-live in milliseconds is returned.\n\n### `.canonicalizedDomain()`\n\n### `.cdomain()`\n\nreturn the canonicalized `.domain` field. This is lower-cased and punycode (RFC3490) encoded if the domain has any non-ASCII characters.\n\n### `.toJSON()`\n\nFor convenience in using `JSON.serialize(cookie)`. Returns a plain-old `Object` that can be JSON-serialized.\n\nAny `Date` properties (i.e., `.expires`, `.creation`, and `.lastAccessed`) are exported in ISO format (`.toISOString()`).\n\n**NOTE**: Custom `Cookie` properties will be discarded. In tough-cookie 1.x, since there was no `.toJSON` method explicitly defined, all enumerable properties were captured. If you want a property to be serialized, add the property name to the `Cookie.serializableProperties` Array.\n\n### `Cookie.fromJSON(strOrObj)`\n\nDoes the reverse of `cookie.toJSON()`. If passed a string, will `JSON.parse()` that first.\n\nAny `Date` properties (i.e., `.expires`, `.creation`, and `.lastAccessed`) are parsed via `Date.parse()`, not the tough-cookie `parseDate`, since it's JavaScript/JSON-y timestamps being handled at this layer.\n\nReturns `null` upon JSON parsing error.\n\n### `.clone()`\n\nDoes a deep clone of this cookie, exactly implemented as `Cookie.fromJSON(cookie.toJSON())`.\n\n### `.validate()`\n\nStatus: *IN PROGRESS*. Works for a few things, but is by no means comprehensive.\n\nvalidates cookie attributes for semantic correctness. Useful for \"lint\" checking any Set-Cookie headers you generate. For now, it returns a boolean, but eventually could return a reason string -- you can future-proof with this construct:\n\n``` javascript\nif (cookie.validate() === true) {\n // it's tasty\n} else {\n // yuck!\n}\n```\n\n## CookieJar\n\nExported via `tough.CookieJar`.\n\n### `CookieJar([store],[options])`\n\nSimply use `new CookieJar()`. If you'd like to use a custom store, pass that to the constructor otherwise a `MemoryCookieStore` will be created and used.\n\nThe `options` object can be omitted and can have the following properties:\n\n * _rejectPublicSuffixes_ - boolean - default `true` - reject cookies with domains like \"com\" and \"co.uk\"\n * _looseMode_ - boolean - default `false` - accept malformed cookies like `bar` and `=bar`, which have an implied empty name.\n This is not in the standard, but is used sometimes on the web and is accepted by (most) browsers.\n\nSince eventually this module would like to support database/remote/etc. CookieJars, continuation passing style is used for CookieJar methods.\n\n### `.setCookie(cookieOrString, currentUrl, [{options},] cb(err,cookie))`\n\nAttempt to set the cookie in the cookie jar. If the operation fails, an error will be given to the callback `cb`, otherwise the cookie is passed through. The cookie will have updated `.creation`, `.lastAccessed` and `.hostOnly` properties.\n\nThe `options` object can be omitted and can have the following properties:\n\n * _http_ - boolean - default `true` - indicates if this is an HTTP or non-HTTP API. Affects HttpOnly cookies.\n * _secure_ - boolean - autodetect from url - indicates if this is a \"Secure\" API. If the currentUrl starts with `https:` or `wss:` then this is defaulted to `true`, otherwise `false`.\n * _now_ - Date - default `new Date()` - what to use for the creation/access time of cookies\n * _ignoreError_ - boolean - default `false` - silently ignore things like parse errors and invalid domains. `Store` errors aren't ignored by this option.\n\nAs per the RFC, the `.hostOnly` property is set if there was no \"Domain=\" parameter in the cookie string (or `.domain` was null on the Cookie object). The `.domain` property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a `domainMatch` as per usual).\n\n### `.setCookieSync(cookieOrString, currentUrl, [{options}])`\n\nSynchronous version of `setCookie`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.getCookies(currentUrl, [{options},] cb(err,cookies))`\n\nRetrieve the list of cookies that can be sent in a Cookie header for the current url.\n\nIf an error is encountered, that's passed as `err` to the callback, otherwise an `Array` of `Cookie` objects is passed. The array is sorted with `cookieCompare()` unless the `{sort:false}` option is given.\n\nThe `options` object can be omitted and can have the following properties:\n\n * _http_ - boolean - default `true` - indicates if this is an HTTP or non-HTTP API. Affects HttpOnly cookies.\n * _secure_ - boolean - autodetect from url - indicates if this is a \"Secure\" API. If the currentUrl starts with `https:` or `wss:` then this is defaulted to `true`, otherwise `false`.\n * _now_ - Date - default `new Date()` - what to use for the creation/access time of cookies\n * _expire_ - boolean - default `true` - perform expiry-time checking of cookies and asynchronously remove expired cookies from the store. Using `false` will return expired cookies and **not** remove them from the store (which is useful for replaying Set-Cookie headers, potentially).\n * _allPaths_ - boolean - default `false` - if `true`, do not scope cookies by path. The default uses RFC-compliant path scoping. **Note**: may not be supported by the underlying store (the default `MemoryCookieStore` supports it).\n\nThe `.lastAccessed` property of the returned cookies will have been updated.\n\n### `.getCookiesSync(currentUrl, [{options}])`\n\nSynchronous version of `getCookies`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.getCookieString(...)`\n\nAccepts the same options as `.getCookies()` but passes a string suitable for a Cookie header rather than an array to the callback. Simply maps the `Cookie` array via `.cookieString()`.\n\n### `.getCookieStringSync(...)`\n\nSynchronous version of `getCookieString`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.getSetCookieStrings(...)`\n\nReturns an array of strings suitable for **Set-Cookie** headers. Accepts the same options as `.getCookies()`. Simply maps the cookie array via `.toString()`.\n\n### `.getSetCookieStringsSync(...)`\n\nSynchronous version of `getSetCookieStrings`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.serialize(cb(err,serializedObject))`\n\nSerialize the Jar if the underlying store supports `.getAllCookies`.\n\n**NOTE**: Custom `Cookie` properties will be discarded. If you want a property to be serialized, add the property name to the `Cookie.serializableProperties` Array.\n\nSee [Serialization Format].\n\n### `.serializeSync()`\n\nSync version of .serialize\n\n### `.toJSON()`\n\nAlias of .serializeSync() for the convenience of `JSON.stringify(cookiejar)`.\n\n### `CookieJar.deserialize(serialized, [store], cb(err,object))`\n\nA new Jar is created and the serialized Cookies are added to the underlying store. Each `Cookie` is added via `store.putCookie` in the order in which they appear in the serialization.\n\nThe `store` argument is optional, but should be an instance of `Store`. By default, a new instance of `MemoryCookieStore` is created.\n\nAs a convenience, if `serialized` is a string, it is passed through `JSON.parse` first. If that throws an error, this is passed to the callback.\n\n### `CookieJar.deserializeSync(serialized, [store])`\n\nSync version of `.deserialize`. _Note_ that the `store` must be synchronous for this to work.\n\n### `CookieJar.fromJSON(string)`\n\nAlias of `.deserializeSync` to provide consistency with `Cookie.fromJSON()`.\n\n### `.clone([store,]cb(err,newJar))`\n\nProduces a deep clone of this jar. Modifications to the original won't affect the clone, and vice versa.\n\nThe `store` argument is optional, but should be an instance of `Store`. By default, a new instance of `MemoryCookieStore` is created. Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`.\n\n### `.cloneSync([store])`\n\nSynchronous version of `.clone`, returning a new `CookieJar` instance.\n\nThe `store` argument is optional, but must be a _synchronous_ `Store` instance if specified. If not passed, a new instance of `MemoryCookieStore` is used.\n\nThe _source_ and _destination_ must both be synchronous `Store`s. If one or both stores are asynchronous, use `.clone` instead. Recall that `MemoryCookieStore` supports both synchronous and asynchronous API calls.\n\n### `.removeAllCookies(cb(err))`\n\nRemoves all cookies from the jar.\n\nThis is a new backwards-compatible feature of `tough-cookie` version 2.5, so not all Stores will implement it efficiently. For Stores that do not implement `removeAllCookies`, the fallback is to call `removeCookie` after `getAllCookies`. If `getAllCookies` fails or isn't implemented in the Store, that error is returned. If one or more of the `removeCookie` calls fail, only the first error is returned.\n\n### `.removeAllCookiesSync()`\n\nSync version of `.removeAllCookies()`\n\n## Store\n\nBase class for CookieJar stores. Available as `tough.Store`.\n\n## Store API\n\nThe storage model for each `CookieJar` instance can be replaced with a custom implementation. The default is `MemoryCookieStore` which can be found in the `lib/memstore.js` file. The API uses continuation-passing-style to allow for asynchronous stores.\n\nStores should inherit from the base `Store` class, which is available as `require('tough-cookie').Store`.\n\nStores are asynchronous by default, but if `store.synchronous` is set to `true`, then the `*Sync` methods on the of the containing `CookieJar` can be used (however, the continuation-passing style\n\nAll `domain` parameters will have been normalized before calling.\n\nThe Cookie store must have all of the following methods.\n\n### `store.findCookie(domain, path, key, cb(err,cookie))`\n\nRetrieve a cookie with the given domain, path and key (a.k.a. name). The RFC maintains that exactly one of these cookies should exist in a store. If the store is using versioning, this means that the latest/newest such cookie should be returned.\n\nCallback takes an error and the resulting `Cookie` object. If no cookie is found then `null` MUST be passed instead (i.e. not an error).\n\n### `store.findCookies(domain, path, cb(err,cookies))`\n\nLocates cookies matching the given domain and path. This is most often called in the context of `cookiejar.getCookies()` above.\n\nIf no cookies are found, the callback MUST be passed an empty array.\n\nThe resulting list will be checked for applicability to the current request according to the RFC (domain-match, path-match, http-only-flag, secure-flag, expiry, etc.), so it's OK to use an optimistic search algorithm when implementing this method. However, the search algorithm used SHOULD try to find cookies that `domainMatch()` the domain and `pathMatch()` the path in order to limit the amount of checking that needs to be done.\n\nAs of version 0.9.12, the `allPaths` option to `cookiejar.getCookies()` above will cause the path here to be `null`. If the path is `null`, path-matching MUST NOT be performed (i.e. domain-matching only).\n\n### `store.putCookie(cookie, cb(err))`\n\nAdds a new cookie to the store. The implementation SHOULD replace any existing cookie with the same `.domain`, `.path`, and `.key` properties -- depending on the nature of the implementation, it's possible that between the call to `fetchCookie` and `putCookie` that a duplicate `putCookie` can occur.\n\nThe `cookie` object MUST NOT be modified; the caller will have already updated the `.creation` and `.lastAccessed` properties.\n\nPass an error if the cookie cannot be stored.\n\n### `store.updateCookie(oldCookie, newCookie, cb(err))`\n\nUpdate an existing cookie. The implementation MUST update the `.value` for a cookie with the same `domain`, `.path` and `.key`. The implementation SHOULD check that the old value in the store is equivalent to `oldCookie` - how the conflict is resolved is up to the store.\n\nThe `.lastAccessed` property will always be different between the two objects (to the precision possible via JavaScript's clock). Both `.creation` and `.creationIndex` are guaranteed to be the same. Stores MAY ignore or defer the `.lastAccessed` change at the cost of affecting how cookies are selected for automatic deletion (e.g., least-recently-used, which is up to the store to implement).\n\nStores may wish to optimize changing the `.value` of the cookie in the store versus storing a new cookie. If the implementation doesn't define this method a stub that calls `putCookie(newCookie,cb)` will be added to the store object.\n\nThe `newCookie` and `oldCookie` objects MUST NOT be modified.\n\nPass an error if the newCookie cannot be stored.\n\n### `store.removeCookie(domain, path, key, cb(err))`\n\nRemove a cookie from the store (see notes on `findCookie` about the uniqueness constraint).\n\nThe implementation MUST NOT pass an error if the cookie doesn't exist; only pass an error due to the failure to remove an existing cookie.\n\n### `store.removeCookies(domain, path, cb(err))`\n\nRemoves matching cookies from the store. The `path` parameter is optional, and if missing means all paths in a domain should be removed.\n\nPass an error ONLY if removing any existing cookies failed.\n\n### `store.removeAllCookies(cb(err))`\n\n_Optional_. Removes all cookies from the store.\n\nPass an error if one or more cookies can't be removed.\n\n**Note**: New method as of `tough-cookie` version 2.5, so not all Stores will implement this, plus some stores may choose not to implement this.\n\n### `store.getAllCookies(cb(err, cookies))`\n\n_Optional_. Produces an `Array` of all cookies during `jar.serialize()`. The items in the array can be true `Cookie` objects or generic `Object`s with the [Serialization Format] data structure.\n\nCookies SHOULD be returned in creation order to preserve sorting via `compareCookies()`. For reference, `MemoryCookieStore` will sort by `.creationIndex` since it uses true `Cookie` objects internally. If you don't return the cookies in creation order, they'll still be sorted by creation time, but this only has a precision of 1ms. See `compareCookies` for more detail.\n\nPass an error if retrieval fails.\n\n**Note**: not all Stores can implement this due to technical limitations, so it is optional.\n\n## MemoryCookieStore\n\nInherits from `Store`.\n\nA just-in-memory CookieJar synchronous store implementation, used by default. Despite being a synchronous implementation, it's usable with both the synchronous and asynchronous forms of the `CookieJar` API. Supports serialization, `getAllCookies`, and `removeAllCookies`.\n\n## Community Cookie Stores\n\nThese are some Store implementations authored and maintained by the community. They aren't official and we don't vouch for them but you may be interested to have a look:\n\n- [`db-cookie-store`](https://github.com/JSBizon/db-cookie-store): SQL including SQLite-based databases\n- [`file-cookie-store`](https://github.com/JSBizon/file-cookie-store): Netscape cookie file format on disk\n- [`redis-cookie-store`](https://github.com/benkroeger/redis-cookie-store): Redis\n- [`tough-cookie-filestore`](https://github.com/mitsuru/tough-cookie-filestore): JSON on disk\n- [`tough-cookie-web-storage-store`](https://github.com/exponentjs/tough-cookie-web-storage-store): DOM localStorage and sessionStorage\n\n# Serialization Format\n\n**NOTE**: if you want to have custom `Cookie` properties serialized, add the property name to `Cookie.serializableProperties`.\n\n```js\n {\n // The version of tough-cookie that serialized this jar.\n version: 'tough-cookie@1.x.y',\n\n // add the store type, to make humans happy:\n storeType: 'MemoryCookieStore',\n\n // CookieJar configuration:\n rejectPublicSuffixes: true,\n // ... future items go here\n\n // Gets filled from jar.store.getAllCookies():\n cookies: [\n {\n key: 'string',\n value: 'string',\n // ...\n /* other Cookie.serializableProperties go here */\n }\n ]\n }\n```\n\n# Copyright and License\n\nBSD-3-Clause:\n\n```text\n Copyright (c) 2015, Salesforce.com, Inc.\n All rights reserved.\n\n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n\n 1. Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n 3. Neither the name of Salesforce.com nor the names of its contributors may\n be used to endorse or promote products derived from this software without\n specific prior written permission.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\n ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE\n LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\n CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\n SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\n INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\n CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\n POSSIBILITY OF SUCH DAMAGE.\n```\n# Stealthy-Require\n\n[](https://travis-ci.org/analog-nico/stealthy-require)\n[](https://coveralls.io/r/analog-nico/stealthy-require)\n[](https://david-dm.org/analog-nico/stealthy-require)\n\nThis is probably the closest you can currently get to require something in node.js with completely bypassing the require cache.\n\n`stealthy-require` works like this:\n\n1. It clears the require cache.\n2. It calls a callback in which you require your module(s) without the cache kicking in.\n3. It clears the cache again and restores its old state.\n\nThe restrictions are:\n\n- [Native modules cannot be required twice.](https://github.com/nodejs/node/issues/5016) Thus this module bypasses the require cache only for non-native (e.g. JS) modules.\n- The require cache is only bypassed for all operations that happen synchronously when a module is required. If a module lazy loads another module at a later time that require call will not bypass the cache anymore.\n\nThis means you should have a close look at all internal require calls before you decide to use this library.\n\n## Installation\n\n[](https://npmjs.org/package/stealthy-require)\n\nThis is a module for node.js and is installed via npm:\n\n``` bash\nnpm install stealthy-require --save\n```\n\n## Usage\n\nLet's say you want to bypass the require cache for this require call:\n\n``` js\nvar request = require('request');\n```\n\nWith `stealthy-require` you can do that like this:\n\n``` js\nvar stealthyRequire = require('stealthy-require');\n\nvar requestFresh = stealthyRequire(require.cache, function () {\n return require('request');\n});\n```\n\nThe require cache is bypassed for the module you require (i.e. `request`) as well as all modules the module requires (i.e. `http` and many more).\n\nSometimes the require cache shall not be bypassed for specific modules. E.g. `request` is required but `tough-cookie` – on which `request` depends on – shall be required using the regular cache. For that you can pass two extra arguments to `stealthyRequire(...)`:\n\n- A callback that requires the modules that shall be required without bypassing the cache\n- The `module` variable\n\n``` js\nvar stealthyRequire = require('stealthy-require');\n\nvar requestFresh = stealthyRequire(require.cache, function () {\n return require('request');\n},\nfunction () {\n require('tough-cookie'); // No return needed\n // You can require multiple modules here\n}, module);\n```\n\n## Usage with Module Bundlers\n\n- [Webpack](https://webpack.github.io) works out-of-the-box like described in the [Usage section](#usage) above.\n- [Browserify](http://browserify.org) does not expose `require.cache`. However, as of `browserify@13.0.1` the cache is passed as the 6th argument to CommonJS modules. Thus you can pass this argument instead:\n\n``` js\n// Tweak for Browserify - using arguments[5] instead of require.cache\nvar requestFresh = stealthyRequire(arguments[5], function () {\n return require('request');\n});\n```\n\n## Preventing a Memory Leak When Repeatedly Requiring Fresh Module Instances in Node.js\n\nIf you are using `stealthy-require` in node.js and repeatedly require fresh module instances the `module.children` array will hold all module instances which prevents unneeded instances to be garbage collected.\n\nAssume your code calls `doSomething()` repeatedly.\n\n``` js\nvar stealthyRequire = require('stealthy-require');\n\nfunction doSomething() {\n\n var freshInstance = stealthyRequire(require.cache, function () {\n return require('some-module');\n });\n \n return freshInstance.calc();\n\n}\n```\n\nAfter `doSomething()` returns `freshInstance` is not used anymore but won’t be garbage collected because `module.children` still holds a reference. The solution is to truncate `module.children` accordingly:\n\n``` js\nvar stealthyRequire = require('stealthy-require');\n\nfunction doSomething() {\n\n var initialChildren = module.children.slice(); // Creates a shallow copy of the array\n\n var freshInstance = stealthyRequire(require.cache, function () {\n return require('some-module');\n });\n\n module.children = initialChildren;\n\n return freshInstance.calc();\n\n}\n```\n\nThe `slice` operation removes all new `module.children` entries created during the `stealthyRequire(...)` call and thus `freshInstance` gets garbage collected after `doSomething()` returns.\n\n## Technical Walkthrough\n\n``` js\n// 1. Load stealthy-require\nvar stealthyRequire = require('stealthy-require');\n// This does nothing but loading the code.\n// It has no side-effects like patching the module loader or anything.\n\n// Any regular require works as always.\nvar request1 = require('request');\n\n// 2. Call stealthyRequire with passing the require cache and a callback.\nvar requestFresh = stealthyRequire(require.cache, function () {\n\n // 2a. Before this callback gets called the require cache is cleared.\n\n // 2b. Any require taking place here takes place on a clean require cache.\n // Since the require call is part of the user's code it also works with module bundlers.\n return require('request');\n // Anything returned here will be returned by stealthyRequire(...).\n\n // 2c. After this callback gets called the require cache is\n // - cleared again and\n // - restored to its old state before step 2.\n\n});\n\n// Any regular require again works as always.\n// In this case require returns the cached request module instance.\nvar request2 = require('request');\n\n// And voilà:\nrequest1 === request2 // -> true\nrequest1 === requestFresh // -> false\n```\n\n## Contributing\n\nTo set up your development environment for `stealthy-require`:\n\n1. Clone this repo to your desktop,\n2. in the shell `cd` to the main folder,\n3. hit `npm install`,\n4. hit `npm install gulp -g` if you haven't installed gulp globally yet, and\n5. run `gulp dev`. (Or run `node ./node_modules/.bin/gulp dev` if you don't want to install gulp globally.)\n\n`gulp dev` watches all source files and if you save some changes it will lint the code and execute all tests. The test coverage report can be viewed from `./coverage/lcov-report/index.html`.\n\nIf you want to debug a test you should use `gulp test-without-coverage` to run all tests without obscuring the code by the test coverage instrumentation.\n\n## Change History\n\n- v1.1.1 (2017-05-08)\n - Fix that stops `undefined` entries from appearing in `require.cache` *(Thanks to @jasperjn from reporting this in [issue #4](https://github.com/analog-nico/stealthy-require/issues/4))*\n- v1.1.0 (2017-04-25)\n - Added ability to disable bypassing the cache for certain modules *(Thanks to @novemberborn for suggesting this in [issue #3](https://github.com/analog-nico/stealthy-require/issues/3))*\n - Added section in README about a [potential memory leak](#preventing-a-memory-leak-when-repeatedly-requiring-fresh-module-instances-in-nodejs) *(Thanks to @Flarna and @novemberborn for bringing that up in [issue #2](https://github.com/analog-nico/stealthy-require/issues/2))*\n - Performance optimizations *(Thanks to @jcready for [pull request #1](https://github.com/analog-nico/stealthy-require/pull/1))*\n- v1.0.0 (2016-07-18)\n - **Breaking Change:** API completely changed. Please read the [Usage section](#usage) again.\n - Redesigned library to support module bundlers like [Webpack](https://webpack.github.io) and [Browserify](http://browserify.org)\n- v0.1.0 (2016-05-26)\n - Initial version\n\n## License (ISC)\n\nIn case you never heard about the [ISC license](http://en.wikipedia.org/wiki/ISC_license) it is functionally equivalent to the MIT license.\n\nSee the [LICENSE file](LICENSE) for details.\n# readable-stream\n\n***Node.js core streams for userland*** [](https://travis-ci.com/nodejs/readable-stream)\n\n[](https://nodei.co/npm/readable-stream/)\n[](https://nodei.co/npm/readable-stream/)\n\n[](https://saucelabs.com/u/readabe-stream)\n\n```bash\nnpm install --save readable-stream\n```\n\nThis package is a mirror of the streams implementations in Node.js.\n\nFull documentation may be found on the [Node.js website](https://nodejs.org/dist/v10.19.0/docs/api/stream.html).\n\nIf you want to guarantee a stable streams base, regardless of what version of\nNode you, or the users of your libraries are using, use **readable-stream** *only* and avoid the *\"stream\"* module in Node-core, for background see [this blogpost](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).\n\nAs of version 2.0.0 **readable-stream** uses semantic versioning.\n\n## Version 3.x.x\n\nv3.x.x of `readable-stream` is a cut from Node 10. This version supports Node 6, 8, and 10, as well as evergreen browsers, IE 11 and latest Safari. The breaking changes introduced by v3 are composed by the combined breaking changes in [Node v9](https://nodejs.org/en/blog/release/v9.0.0/) and [Node v10](https://nodejs.org/en/blog/release/v10.0.0/), as follows:\n\n1. Error codes: https://github.com/nodejs/node/pull/13310,\n https://github.com/nodejs/node/pull/13291,\n https://github.com/nodejs/node/pull/16589,\n https://github.com/nodejs/node/pull/15042,\n https://github.com/nodejs/node/pull/15665,\n https://github.com/nodejs/readable-stream/pull/344\n2. 'readable' have precedence over flowing\n https://github.com/nodejs/node/pull/18994\n3. make virtual methods errors consistent\n https://github.com/nodejs/node/pull/18813\n4. updated streams error handling\n https://github.com/nodejs/node/pull/18438\n5. writable.end should return this.\n https://github.com/nodejs/node/pull/18780\n6. readable continues to read when push('')\n https://github.com/nodejs/node/pull/18211\n7. add custom inspect to BufferList\n https://github.com/nodejs/node/pull/17907\n8. always defer 'readable' with nextTick\n https://github.com/nodejs/node/pull/17979\n\n## Version 2.x.x\nv2.x.x of `readable-stream` is a cut of the stream module from Node 8 (there have been no semver-major changes from Node 4 to 8). This version supports all Node.js versions from 0.8, as well as evergreen browsers and IE 10 & 11.\n\n### Big Thanks\n\nCross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs][sauce]\n\n# Usage\n\nYou can swap your `require('stream')` with `require('readable-stream')`\nwithout any changes, if you are just using one of the main classes and\nfunctions.\n\n```js\nconst {\n Readable,\n Writable,\n Transform,\n Duplex,\n pipeline,\n finished\n} = require('readable-stream')\n````\n\nNote that `require('stream')` will return `Stream`, while\n`require('readable-stream')` will return `Readable`. We discourage using\nwhatever is exported directly, but rather use one of the properties as\nshown in the example above.\n\n# Streams Working Group\n\n`readable-stream` is maintained by the Streams Working Group, which\noversees the development and maintenance of the Streams API within\nNode.js. The responsibilities of the Streams Working Group include:\n\n* Addressing stream issues on the Node.js issue tracker.\n* Authoring and editing stream documentation within the Node.js project.\n* Reviewing changes to stream subclasses within the Node.js project.\n* Redirecting changes to streams from the Node.js project to this\n project.\n* Assisting in the implementation of stream providers within Node.js.\n* Recommending versions of `readable-stream` to be included in Node.js.\n* Messaging about the future of streams to give the community advance\n notice of changes.\n\n<a name=\"members\"></a>\n## Team Members\n\n* **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) <calvin.metcalf@gmail.com>\n - Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242\n* **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) <mathiasbuus@gmail.com>\n* **Matteo Collina** ([@mcollina](https://github.com/mcollina)) <matteo.collina@gmail.com>\n - Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E\n* **Irina Shestak** ([@lrlna](https://github.com/lrlna)) <shestak.irina@gmail.com>\n* **Yoshua Wyuts** ([@yoshuawuyts](https://github.com/yoshuawuyts)) <yoshuawuyts@gmail.com>\n\n[sauce]: https://saucelabs.com\n# readable-stream\n\n***Node.js core streams for userland*** [](https://travis-ci.com/nodejs/readable-stream)\n\n[](https://nodei.co/npm/readable-stream/)\n[](https://nodei.co/npm/readable-stream/)\n\n[](https://saucelabs.com/u/readabe-stream)\n\n```bash\nnpm install --save readable-stream\n```\n\nThis package is a mirror of the streams implementations in Node.js.\n\nFull documentation may be found on the [Node.js website](https://nodejs.org/dist/v10.19.0/docs/api/stream.html).\n\nIf you want to guarantee a stable streams base, regardless of what version of\nNode you, or the users of your libraries are using, use **readable-stream** *only* and avoid the *\"stream\"* module in Node-core, for background see [this blogpost](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).\n\nAs of version 2.0.0 **readable-stream** uses semantic versioning.\n\n## Version 3.x.x\n\nv3.x.x of `readable-stream` is a cut from Node 10. This version supports Node 6, 8, and 10, as well as evergreen browsers, IE 11 and latest Safari. The breaking changes introduced by v3 are composed by the combined breaking changes in [Node v9](https://nodejs.org/en/blog/release/v9.0.0/) and [Node v10](https://nodejs.org/en/blog/release/v10.0.0/), as follows:\n\n1. Error codes: https://github.com/nodejs/node/pull/13310,\n https://github.com/nodejs/node/pull/13291,\n https://github.com/nodejs/node/pull/16589,\n https://github.com/nodejs/node/pull/15042,\n https://github.com/nodejs/node/pull/15665,\n https://github.com/nodejs/readable-stream/pull/344\n2. 'readable' have precedence over flowing\n https://github.com/nodejs/node/pull/18994\n3. make virtual methods errors consistent\n https://github.com/nodejs/node/pull/18813\n4. updated streams error handling\n https://github.com/nodejs/node/pull/18438\n5. writable.end should return this.\n https://github.com/nodejs/node/pull/18780\n6. readable continues to read when push('')\n https://github.com/nodejs/node/pull/18211\n7. add custom inspect to BufferList\n https://github.com/nodejs/node/pull/17907\n8. always defer 'readable' with nextTick\n https://github.com/nodejs/node/pull/17979\n\n## Version 2.x.x\nv2.x.x of `readable-stream` is a cut of the stream module from Node 8 (there have been no semver-major changes from Node 4 to 8). This version supports all Node.js versions from 0.8, as well as evergreen browsers and IE 10 & 11.\n\n### Big Thanks\n\nCross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs][sauce]\n\n# Usage\n\nYou can swap your `require('stream')` with `require('readable-stream')`\nwithout any changes, if you are just using one of the main classes and\nfunctions.\n\n```js\nconst {\n Readable,\n Writable,\n Transform,\n Duplex,\n pipeline,\n finished\n} = require('readable-stream')\n````\n\nNote that `require('stream')` will return `Stream`, while\n`require('readable-stream')` will return `Readable`. We discourage using\nwhatever is exported directly, but rather use one of the properties as\nshown in the example above.\n\n# Streams Working Group\n\n`readable-stream` is maintained by the Streams Working Group, which\noversees the development and maintenance of the Streams API within\nNode.js. The responsibilities of the Streams Working Group include:\n\n* Addressing stream issues on the Node.js issue tracker.\n* Authoring and editing stream documentation within the Node.js project.\n* Reviewing changes to stream subclasses within the Node.js project.\n* Redirecting changes to streams from the Node.js project to this\n project.\n* Assisting in the implementation of stream providers within Node.js.\n* Recommending versions of `readable-stream` to be included in Node.js.\n* Messaging about the future of streams to give the community advance\n notice of changes.\n\n<a name=\"members\"></a>\n## Team Members\n\n* **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) <calvin.metcalf@gmail.com>\n - Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242\n* **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) <mathiasbuus@gmail.com>\n* **Matteo Collina** ([@mcollina](https://github.com/mcollina)) <matteo.collina@gmail.com>\n - Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E\n* **Irina Shestak** ([@lrlna](https://github.com/lrlna)) <shestak.irina@gmail.com>\n* **Yoshua Wyuts** ([@yoshuawuyts](https://github.com/yoshuawuyts)) <yoshuawuyts@gmail.com>\n\n[sauce]: https://saucelabs.com\n# [postcss][postcss]-ordered-values\n\n> Ensure values are ordered consistently in your CSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-ordered-values) do:\n\n```\nnpm install postcss-ordered-values --save\n```\n\n## Example\n\nSome CSS properties accept their values in an arbitrary order; for this reason,\nit is entirely possible that different developers will write their values in\ndifferent orders. This module normalizes the order, making it easier for other\nmodules to understand which declarations are duplicates.\n\n### Input\n\n```css\nh1 {\n border: solid 1px red;\n border: red solid .5em;\n border: rgba(0, 30, 105, 0.8) solid 1px;\n border: 1px solid red;\n}\n```\n\n### Output\n\n```css\nh1 {\n border: 1px solid red;\n border: .5em solid red;\n border: 1px solid rgba(0, 30, 105, 0.8);\n border: 1px solid red;\n}\n```\n\n## Support List\n\nFor more examples, see the [tests](src/__tests__/index.js).\n\n* `animation`, `-webkit-animation`\n* `border(border-left|right|top|bottom)`\n* `box-shadow`\n* `outline`\n* `flex-flow`\n* `transition`, `-webkit-transition`\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# debug\n[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers) \n[](#sponsors)\n\nA tiny node.js debugging utility modelled after node core's debugging technique.\n\n**Discussion around the V3 API is under way [here](https://github.com/visionmedia/debug/issues/370)**\n\n## Installation\n\n```bash\n$ npm install debug\n```\n\n## Usage\n\n`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.\n\nExample _app.js_:\n\n```js\nvar debug = require('debug')('http')\n , http = require('http')\n , name = 'My App';\n\n// fake app\n\ndebug('booting %s', name);\n\nhttp.createServer(function(req, res){\n debug(req.method + ' ' + req.url);\n res.end('hello\\n');\n}).listen(3000, function(){\n debug('listening');\n});\n\n// fake worker of some kind\n\nrequire('./worker');\n```\n\nExample _worker.js_:\n\n```js\nvar debug = require('debug')('worker');\n\nsetInterval(function(){\n debug('doing some work');\n}, 1000);\n```\n\n The __DEBUG__ environment variable is then used to enable these based on space or comma-delimited names. Here are some examples:\n\n \n\n \n\n#### Windows note\n\n On Windows the environment variable is set using the `set` command.\n\n ```cmd\n set DEBUG=*,-not_this\n ```\n\n Note that PowerShell uses different syntax to set environment variables.\n\n ```cmd\n $env:DEBUG = \"*,-not_this\"\n ```\n\nThen, run the program to be debugged as usual.\n\n## Millisecond diff\n\n When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the \"+NNNms\" will show you how much time was spent between calls.\n\n \n\n When stdout is not a TTY, `Date#toUTCString()` is used, making it more useful for logging the debug information as shown below:\n\n \n\n## Conventions\n\n If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use \":\" to separate features. For example \"bodyParser\" from Connect would then be \"connect:bodyParser\".\n\n## Wildcards\n\n The `*` character may be used as a wildcard. Suppose for example your library has debuggers named \"connect:bodyParser\", \"connect:compress\", \"connect:session\", instead of listing all three with `DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do `DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.\n\n You can also exclude specific debuggers by prefixing them with a \"-\" character. For example, `DEBUG=*,-connect:*` would include all debuggers except those starting with \"connect:\".\n\n## Environment Variables\n\n When running through Node.js, you can set a few environment variables that will\n change the behavior of the debug logging:\n\n| Name | Purpose |\n|-----------|-------------------------------------------------|\n| `DEBUG` | Enables/disables specific debugging namespaces. |\n| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |\n| `DEBUG_DEPTH` | Object inspection depth. |\n| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |\n\n __Note:__ The environment variables beginning with `DEBUG_` end up being\n converted into an Options object that gets used with `%o`/`%O` formatters.\n See the Node.js documentation for\n [`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)\n for the complete list.\n\n## Formatters\n\n Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting. Below are the officially supported formatters:\n\n| Formatter | Representation |\n|-----------|----------------|\n| `%O` | Pretty-print an Object on multiple lines. |\n| `%o` | Pretty-print an Object all on a single line. |\n| `%s` | String. |\n| `%d` | Number (both integer and float). |\n| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |\n| `%%` | Single percent sign ('%'). This does not consume an argument. |\n\n### Custom formatters\n\n You can add custom formatters by extending the `debug.formatters` object. For example, if you wanted to add support for rendering a Buffer as hex with `%h`, you could do something like:\n\n```js\nconst createDebug = require('debug')\ncreateDebug.formatters.h = (v) => {\n return v.toString('hex')\n}\n\n// …elsewhere\nconst debug = createDebug('foo')\ndebug('this is hex: %h', new Buffer('hello world'))\n// foo this is hex: 68656c6c6f20776f726c6421 +0ms\n```\n\n## Browser support\n You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),\n or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),\n if you don't want to build it yourself.\n\n Debug's enable state is currently persisted by `localStorage`.\n Consider the situation shown below where you have `worker:a` and `worker:b`,\n and wish to debug both. You can enable this using `localStorage.debug`:\n\n```js\nlocalStorage.debug = 'worker:*'\n```\n\nAnd then refresh the page.\n\n```js\na = debug('worker:a');\nb = debug('worker:b');\n\nsetInterval(function(){\n a('doing some work');\n}, 1000);\n\nsetInterval(function(){\n b('doing some work');\n}, 1200);\n```\n\n#### Web Inspector Colors\n\n Colors are also enabled on \"Web Inspectors\" that understand the `%c` formatting\n option. These are WebKit web inspectors, Firefox ([since version\n 31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))\n and the Firebug plugin for Firefox (any version).\n\n Colored output looks something like:\n\n \n\n## Output streams\n\n By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:\n\nExample _stdout.js_:\n\n```js\nvar debug = require('debug');\nvar error = debug('app:error');\n\n// by default stderr is used\nerror('goes to stderr!');\n\nvar log = debug('app:log');\n// set this namespace to log via console.log\nlog.log = console.log.bind(console); // don't forget to bind to console!\nlog('goes to stdout');\nerror('still goes to stderr!');\n\n// set all output to go via console.info\n// overrides all per-namespace log settings\ndebug.log = console.info.bind(console);\nerror('now goes to stdout via console.info');\nlog('still goes to stdout, but via console.info now');\n```\n\n## Authors\n\n - TJ Holowaychuk\n - Nathan Rajlich\n - Andrew Rhyne\n \n## Backers\n\nSupport us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]\n\n<a href=\"https://opencollective.com/debug/backer/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/29/avatar.svg\"></a>\n\n## Sponsors\n\nBecome a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]\n\n<a href=\"https://opencollective.com/debug/sponsor/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/29/avatar.svg\"></a>\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014-2016 TJ Holowaychuk <tj@vision-media.ca>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\nPort of the OpenBSD `bcrypt_pbkdf` function to pure Javascript. `npm`-ified\nversion of [Devi Mandiri's port](https://github.com/devi/tmp/blob/master/js/bcrypt_pbkdf.js),\nwith some minor performance improvements. The code is copied verbatim (and\nun-styled) from Devi's work.\n\nThis product includes software developed by Niels Provos.\n\n## API\n\n### `bcrypt_pbkdf.pbkdf(pass, passlen, salt, saltlen, key, keylen, rounds)`\n\nDerive a cryptographic key of arbitrary length from a given password and salt,\nusing the OpenBSD `bcrypt_pbkdf` function. This is a combination of Blowfish and\nSHA-512.\n\nSee [this article](http://www.tedunangst.com/flak/post/bcrypt-pbkdf) for\nfurther information.\n\nParameters:\n\n * `pass`, a Uint8Array of length `passlen`\n * `passlen`, an integer Number\n * `salt`, a Uint8Array of length `saltlen`\n * `saltlen`, an integer Number\n * `key`, a Uint8Array of length `keylen`, will be filled with output\n * `keylen`, an integer Number\n * `rounds`, an integer Number, number of rounds of the PBKDF to run\n\n### `bcrypt_pbkdf.hash(sha2pass, sha2salt, out)`\n\nCalculate a Blowfish hash, given SHA2-512 output of a password and salt. Used as\npart of the inner round function in the PBKDF.\n\nParameters:\n\n * `sha2pass`, a Uint8Array of length 64\n * `sha2salt`, a Uint8Array of length 64\n * `out`, a Uint8Array of length 32, will be filled with output\n\n## License\n\nThis source form is a 1:1 port from the OpenBSD `blowfish.c` and `bcrypt_pbkdf.c`.\nAs a result, it retains the original copyright and license. The two files are\nunder slightly different (but compatible) licenses, and are here combined in\none file. For each of the full license texts see `LICENSE`.\n# is-number [](https://www.npmjs.com/package/is-number) [](https://npmjs.org/package/is-number) [](https://travis-ci.org/jonschlinkert/is-number)\n\n> Returns true if the value is a number. comprehensive tests.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-number\n```\n\n## Usage\n\nTo understand some of the rationale behind the decisions made in this library (and to learn about some oddities of number evaluation in JavaScript), [see this gist](https://gist.github.com/jonschlinkert/e30c70c713da325d0e81).\n\n```js\nvar isNumber = require('is-number');\n```\n\n### true\n\nSee the [tests](./test.js) for more examples.\n\n```js\nisNumber(5e3) //=> 'true'\nisNumber(0xff) //=> 'true'\nisNumber(-1.1) //=> 'true'\nisNumber(0) //=> 'true'\nisNumber(1) //=> 'true'\nisNumber(1.1) //=> 'true'\nisNumber(10) //=> 'true'\nisNumber(10.10) //=> 'true'\nisNumber(100) //=> 'true'\nisNumber('-1.1') //=> 'true'\nisNumber('0') //=> 'true'\nisNumber('012') //=> 'true'\nisNumber('0xff') //=> 'true'\nisNumber('1') //=> 'true'\nisNumber('1.1') //=> 'true'\nisNumber('10') //=> 'true'\nisNumber('10.10') //=> 'true'\nisNumber('100') //=> 'true'\nisNumber('5e3') //=> 'true'\nisNumber(parseInt('012')) //=> 'true'\nisNumber(parseFloat('012')) //=> 'true'\n```\n\n### False\n\nSee the [tests](./test.js) for more examples.\n\n```js\nisNumber('foo') //=> 'false'\nisNumber([1]) //=> 'false'\nisNumber([]) //=> 'false'\nisNumber(function () {}) //=> 'false'\nisNumber(Infinity) //=> 'false'\nisNumber(NaN) //=> 'false'\nisNumber(new Array('abc')) //=> 'false'\nisNumber(new Array(2)) //=> 'false'\nisNumber(new Buffer('abc')) //=> 'false'\nisNumber(null) //=> 'false'\nisNumber(undefined) //=> 'false'\nisNumber({abc: 'abc'}) //=> 'false'\n```\n\n## About\n\n### Related projects\n\n* [even](https://www.npmjs.com/package/even): Get the even numbered items from an array. | [homepage](https://github.com/jonschlinkert/even \"Get the even numbered items from an array.\")\n* [is-even](https://www.npmjs.com/package/is-even): Return true if the given number is even. | [homepage](https://github.com/jonschlinkert/is-even \"Return true if the given number is even.\")\n* [is-odd](https://www.npmjs.com/package/is-odd): Returns true if the given number is odd. | [homepage](https://github.com/jonschlinkert/is-odd \"Returns true if the given number is odd.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n* [odd](https://www.npmjs.com/package/odd): Get the odd numbered items from an array. | [homepage](https://github.com/jonschlinkert/odd \"Get the odd numbered items from an array.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/is-number/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on September 10, 2016._\n# parseurl\n\n[![NPM Version][npm-version-image]][npm-url]\n[![NPM Downloads][npm-downloads-image]][npm-url]\n[![Node.js Version][node-image]][node-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n\nParse a URL with memoization.\n\n## Install\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```sh\n$ npm install parseurl\n```\n\n## API\n\n```js\nvar parseurl = require('parseurl')\n```\n\n### parseurl(req)\n\nParse the URL of the given request object (looks at the `req.url` property)\nand return the result. The result is the same as `url.parse` in Node.js core.\nCalling this function multiple times on the same `req` where `req.url` does\nnot change will return a cached parsed object, rather than parsing again.\n\n### parseurl.original(req)\n\nParse the original URL of the given request object and return the result.\nThis works by trying to parse `req.originalUrl` if it is a string, otherwise\nparses `req.url`. The result is the same as `url.parse` in Node.js core.\nCalling this function multiple times on the same `req` where `req.originalUrl`\ndoes not change will return a cached parsed object, rather than parsing again.\n\n## Benchmark\n\n```bash\n$ npm run-script bench\n\n> parseurl@1.3.3 bench nodejs-parseurl\n> node benchmark/index.js\n\n http_parser@2.8.0\n node@10.6.0\n v8@6.7.288.46-node.13\n uv@1.21.0\n zlib@1.2.11\n ares@1.14.0\n modules@64\n nghttp2@1.32.0\n napi@3\n openssl@1.1.0h\n icu@61.1\n unicode@10.0\n cldr@33.0\n tz@2018c\n\n> node benchmark/fullurl.js\n\n Parsing URL \"http://localhost:8888/foo/bar?user=tj&pet=fluffy\"\n\n 4 tests completed.\n\n fasturl x 2,207,842 ops/sec ±3.76% (184 runs sampled)\n nativeurl - legacy x 507,180 ops/sec ±0.82% (191 runs sampled)\n nativeurl - whatwg x 290,044 ops/sec ±1.96% (189 runs sampled)\n parseurl x 488,907 ops/sec ±2.13% (192 runs sampled)\n\n> node benchmark/pathquery.js\n\n Parsing URL \"/foo/bar?user=tj&pet=fluffy\"\n\n 4 tests completed.\n\n fasturl x 3,812,564 ops/sec ±3.15% (188 runs sampled)\n nativeurl - legacy x 2,651,631 ops/sec ±1.68% (189 runs sampled)\n nativeurl - whatwg x 161,837 ops/sec ±2.26% (189 runs sampled)\n parseurl x 4,166,338 ops/sec ±2.23% (184 runs sampled)\n\n> node benchmark/samerequest.js\n\n Parsing URL \"/foo/bar?user=tj&pet=fluffy\" on same request object\n\n 4 tests completed.\n\n fasturl x 3,821,651 ops/sec ±2.42% (185 runs sampled)\n nativeurl - legacy x 2,651,162 ops/sec ±1.90% (187 runs sampled)\n nativeurl - whatwg x 175,166 ops/sec ±1.44% (188 runs sampled)\n parseurl x 14,912,606 ops/sec ±3.59% (183 runs sampled)\n\n> node benchmark/simplepath.js\n\n Parsing URL \"/foo/bar\"\n\n 4 tests completed.\n\n fasturl x 12,421,765 ops/sec ±2.04% (191 runs sampled)\n nativeurl - legacy x 7,546,036 ops/sec ±1.41% (188 runs sampled)\n nativeurl - whatwg x 198,843 ops/sec ±1.83% (189 runs sampled)\n parseurl x 24,244,006 ops/sec ±0.51% (194 runs sampled)\n\n> node benchmark/slash.js\n\n Parsing URL \"/\"\n\n 4 tests completed.\n\n fasturl x 17,159,456 ops/sec ±3.25% (188 runs sampled)\n nativeurl - legacy x 11,635,097 ops/sec ±3.79% (184 runs sampled)\n nativeurl - whatwg x 240,693 ops/sec ±0.83% (189 runs sampled)\n parseurl x 42,279,067 ops/sec ±0.55% (190 runs sampled)\n```\n\n## License\n\n [MIT](LICENSE)\n\n[coveralls-image]: https://badgen.net/coveralls/c/github/pillarjs/parseurl/master\n[coveralls-url]: https://coveralls.io/r/pillarjs/parseurl?branch=master\n[node-image]: https://badgen.net/npm/node/parseurl\n[node-url]: https://nodejs.org/en/download\n[npm-downloads-image]: https://badgen.net/npm/dm/parseurl\n[npm-url]: https://npmjs.org/package/parseurl\n[npm-version-image]: https://badgen.net/npm/v/parseurl\n[travis-image]: https://badgen.net/travis/pillarjs/parseurl/master\n[travis-url]: https://travis-ci.org/pillarjs/parseurl\n# test-exclude\n\nThe file include/exclude logic used by [nyc] and [babel-plugin-istanbul].\n\n[](https://travis-ci.org/istanbuljs/test-exclude)\n[](https://coveralls.io/github/istanbuljs/test-exclude?branch=master)\n[](https://github.com/conventional-changelog/standard-version)\n[](https://greenkeeper.io/)\n\n## Usage\n\n```js\nconst TestExclude = require('test-exclude');\nconst exclude = new TestExclude();\nif (exclude().shouldInstrument('./foo.js')) {\n // let's instrument this file for test coverage!\n}\n```\n\n### TestExclude(options)\n\nThe test-exclude constructor accepts an options object. The defaults are taken from\n[@istanbuljs/schema].\n\n#### options.cwd\n\nThis is the base directory by which all comparisons are performed. Files outside `cwd`\nare not included.\n\nDefault: `process.cwd()`\n\n#### options.exclude\n\nArray of path globs to be ignored. Note this list does not include `node_modules` which\nis added separately. See [@istanbuljs/schema/default-excludes.js] for default list.\n\n#### options.excludeNodeModules\n\nBy default `node_modules` is excluded. Setting this option `true` allows `node_modules`\nto be included.\n\n#### options.include\n\nArray of path globs that can be included. By default this is unrestricted giving a result\nsimilar to `['**']` but more optimized.\n\n#### options.extension\n\nArray of extensions that can be included. This ensures that nyc only attempts to process\nfiles which it might understand. Note use of some formats may require adding parser\nplugins to your nyc or babel configuration.\n\nDefault: `['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx']`\n\n### TestExclude#shouldInstrument(filename): boolean\n\nTest if `filename` matches the rules of this test-exclude instance.\n\n```js\nconst exclude = new TestExclude();\nexclude.shouldInstrument('index.js'); // true\nexclude.shouldInstrument('test.js'); // false\nexclude.shouldInstrument('README.md'); // false\nexclude.shouldInstrument('node_modules/test-exclude/index.js'); // false\n```\n\nIn this example code:\n* `index.js` is true because it matches the default `options.extension` list\n and is not part of the default `options.exclude` list.\n* `test.js` is excluded because it matches the default `options.exclude` list.\n* `README.md` is not matched by the default `options.extension`\n* `node_modules/test-exclude/index.js` is excluded because `options.excludeNodeModules`\n is true by default.\n\n### TestExculde#globSync(cwd = options.cwd): Array[string]\n\nThis synchronously retrieves a list of files within `cwd` which should be instrumented.\nNote that setting `cwd` to a parent of `options.cwd` is ineffective, this argument can\nonly be used to further restrict the result.\n\n### TestExclude#glob(cwd = options.cwd): Promise<Array[string]>\n\nThis function does the same as `TestExclude#globSync` but does so asynchronously. The\nPromise resolves to an Array of strings.\n\n## `test-exclude` for enterprise\n\nAvailable as part of the Tidelift Subscription.\n\nThe maintainers of `test-exclude` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-test-exclude?utm_source=npm-test-exclude&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)\n\n[nyc]: https://github.com/istanbuljs/nyc\n[babel-plugin-istanbul]: https://github.com/istanbuljs/babel-plugin-istanbul\n[@istanbuljs/schema]: https://github.com/istanbuljs/schema\n[@istanbuljs/schema/default-excludes.js]: https://github.com/istanbuljs/schema/blob/master/default-exclude.js\n# qs <sup>[![Version Badge][2]][1]</sup>\n\n[![Build Status][3]][4]\n[![dependency status][5]][6]\n[![dev dependency status][7]][8]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][11]][1]\n\nA querystring parsing and stringifying library with some added security.\n\nLead Maintainer: [Jordan Harband](https://github.com/ljharb)\n\nThe **qs** module was originally created and maintained by [TJ Holowaychuk](https://github.com/visionmedia/node-querystring).\n\n## Usage\n\n```javascript\nvar qs = require('qs');\nvar assert = require('assert');\n\nvar obj = qs.parse('a=c');\nassert.deepEqual(obj, { a: 'c' });\n\nvar str = qs.stringify(obj);\nassert.equal(str, 'a=c');\n```\n\n### Parsing Objects\n\n[](#preventEval)\n```javascript\nqs.parse(string, [options]);\n```\n\n**qs** allows you to create nested objects within your query strings, by surrounding the name of sub-keys with square brackets `[]`.\nFor example, the string `'foo[bar]=baz'` converts to:\n\n```javascript\nassert.deepEqual(qs.parse('foo[bar]=baz'), {\n foo: {\n bar: 'baz'\n }\n});\n```\n\nWhen using the `plainObjects` option the parsed value is returned as a null object, created via `Object.create(null)` and as such you should be aware that prototype methods will not exist on it and a user may set those names to whatever value they like:\n\n```javascript\nvar nullObject = qs.parse('a[hasOwnProperty]=b', { plainObjects: true });\nassert.deepEqual(nullObject, { a: { hasOwnProperty: 'b' } });\n```\n\nBy default parameters that would overwrite properties on the object prototype are ignored, if you wish to keep the data from those fields either use `plainObjects` as mentioned above, or set `allowPrototypes` to `true` which will allow user input to overwrite those properties. *WARNING* It is generally a bad idea to enable this option as it can cause problems when attempting to use the properties that have been overwritten. Always be careful with this option.\n\n```javascript\nvar protoObject = qs.parse('a[hasOwnProperty]=b', { allowPrototypes: true });\nassert.deepEqual(protoObject, { a: { hasOwnProperty: 'b' } });\n```\n\nURI encoded strings work too:\n\n```javascript\nassert.deepEqual(qs.parse('a%5Bb%5D=c'), {\n a: { b: 'c' }\n});\n```\n\nYou can also nest your objects, like `'foo[bar][baz]=foobarbaz'`:\n\n```javascript\nassert.deepEqual(qs.parse('foo[bar][baz]=foobarbaz'), {\n foo: {\n bar: {\n baz: 'foobarbaz'\n }\n }\n});\n```\n\nBy default, when nesting objects **qs** will only parse up to 5 children deep. This means if you attempt to parse a string like\n`'a[b][c][d][e][f][g][h][i]=j'` your resulting object will be:\n\n```javascript\nvar expected = {\n a: {\n b: {\n c: {\n d: {\n e: {\n f: {\n '[g][h][i]': 'j'\n }\n }\n }\n }\n }\n }\n};\nvar string = 'a[b][c][d][e][f][g][h][i]=j';\nassert.deepEqual(qs.parse(string), expected);\n```\n\nThis depth can be overridden by passing a `depth` option to `qs.parse(string, [options])`:\n\n```javascript\nvar deep = qs.parse('a[b][c][d][e][f][g][h][i]=j', { depth: 1 });\nassert.deepEqual(deep, { a: { b: { '[c][d][e][f][g][h][i]': 'j' } } });\n```\n\nThe depth limit helps mitigate abuse when **qs** is used to parse user input, and it is recommended to keep it a reasonably small number.\n\nFor similar reasons, by default **qs** will only parse up to 1000 parameters. This can be overridden by passing a `parameterLimit` option:\n\n```javascript\nvar limited = qs.parse('a=b&c=d', { parameterLimit: 1 });\nassert.deepEqual(limited, { a: 'b' });\n```\n\nTo bypass the leading question mark, use `ignoreQueryPrefix`:\n\n```javascript\nvar prefixed = qs.parse('?a=b&c=d', { ignoreQueryPrefix: true });\nassert.deepEqual(prefixed, { a: 'b', c: 'd' });\n```\n\nAn optional delimiter can also be passed:\n\n```javascript\nvar delimited = qs.parse('a=b;c=d', { delimiter: ';' });\nassert.deepEqual(delimited, { a: 'b', c: 'd' });\n```\n\nDelimiters can be a regular expression too:\n\n```javascript\nvar regexed = qs.parse('a=b;c=d,e=f', { delimiter: /[;,]/ });\nassert.deepEqual(regexed, { a: 'b', c: 'd', e: 'f' });\n```\n\nOption `allowDots` can be used to enable dot notation:\n\n```javascript\nvar withDots = qs.parse('a.b=c', { allowDots: true });\nassert.deepEqual(withDots, { a: { b: 'c' } });\n```\n\n### Parsing Arrays\n\n**qs** can also parse arrays using a similar `[]` notation:\n\n```javascript\nvar withArray = qs.parse('a[]=b&a[]=c');\nassert.deepEqual(withArray, { a: ['b', 'c'] });\n```\n\nYou may specify an index as well:\n\n```javascript\nvar withIndexes = qs.parse('a[1]=c&a[0]=b');\nassert.deepEqual(withIndexes, { a: ['b', 'c'] });\n```\n\nNote that the only difference between an index in an array and a key in an object is that the value between the brackets must be a number\nto create an array. When creating arrays with specific indices, **qs** will compact a sparse array to only the existing values preserving\ntheir order:\n\n```javascript\nvar noSparse = qs.parse('a[1]=b&a[15]=c');\nassert.deepEqual(noSparse, { a: ['b', 'c'] });\n```\n\nNote that an empty string is also a value, and will be preserved:\n\n```javascript\nvar withEmptyString = qs.parse('a[]=&a[]=b');\nassert.deepEqual(withEmptyString, { a: ['', 'b'] });\n\nvar withIndexedEmptyString = qs.parse('a[0]=b&a[1]=&a[2]=c');\nassert.deepEqual(withIndexedEmptyString, { a: ['b', '', 'c'] });\n```\n\n**qs** will also limit specifying indices in an array to a maximum index of `20`. Any array members with an index of greater than `20` will\ninstead be converted to an object with the index as the key:\n\n```javascript\nvar withMaxIndex = qs.parse('a[100]=b');\nassert.deepEqual(withMaxIndex, { a: { '100': 'b' } });\n```\n\nThis limit can be overridden by passing an `arrayLimit` option:\n\n```javascript\nvar withArrayLimit = qs.parse('a[1]=b', { arrayLimit: 0 });\nassert.deepEqual(withArrayLimit, { a: { '1': 'b' } });\n```\n\nTo disable array parsing entirely, set `parseArrays` to `false`.\n\n```javascript\nvar noParsingArrays = qs.parse('a[]=b', { parseArrays: false });\nassert.deepEqual(noParsingArrays, { a: { '0': 'b' } });\n```\n\nIf you mix notations, **qs** will merge the two items into an object:\n\n```javascript\nvar mixedNotation = qs.parse('a[0]=b&a[b]=c');\nassert.deepEqual(mixedNotation, { a: { '0': 'b', b: 'c' } });\n```\n\nYou can also create arrays of objects:\n\n```javascript\nvar arraysOfObjects = qs.parse('a[][b]=c');\nassert.deepEqual(arraysOfObjects, { a: [{ b: 'c' }] });\n```\n\n### Stringifying\n\n[](#preventEval)\n```javascript\nqs.stringify(object, [options]);\n```\n\nWhen stringifying, **qs** by default URI encodes output. Objects are stringified as you would expect:\n\n```javascript\nassert.equal(qs.stringify({ a: 'b' }), 'a=b');\nassert.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');\n```\n\nThis encoding can be disabled by setting the `encode` option to `false`:\n\n```javascript\nvar unencoded = qs.stringify({ a: { b: 'c' } }, { encode: false });\nassert.equal(unencoded, 'a[b]=c');\n```\n\nEncoding can be disabled for keys by setting the `encodeValuesOnly` option to `true`:\n```javascript\nvar encodedValues = qs.stringify(\n { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },\n { encodeValuesOnly: true }\n);\nassert.equal(encodedValues,'a=b&c[0]=d&c[1]=e%3Df&f[0][0]=g&f[1][0]=h');\n```\n\nThis encoding can also be replaced by a custom encoding method set as `encoder` option:\n\n```javascript\nvar encoded = qs.stringify({ a: { b: 'c' } }, { encoder: function (str) {\n // Passed in values `a`, `b`, `c`\n return // Return encoded string\n}})\n```\n\n_(Note: the `encoder` option does not apply if `encode` is `false`)_\n\nAnalogue to the `encoder` there is a `decoder` option for `parse` to override decoding of properties and values:\n\n```javascript\nvar decoded = qs.parse('x=z', { decoder: function (str) {\n // Passed in values `x`, `z`\n return // Return decoded string\n}})\n```\n\nExamples beyond this point will be shown as though the output is not URI encoded for clarity. Please note that the return values in these cases *will* be URI encoded during real usage.\n\nWhen arrays are stringified, by default they are given explicit indices:\n\n```javascript\nqs.stringify({ a: ['b', 'c', 'd'] });\n// 'a[0]=b&a[1]=c&a[2]=d'\n```\n\nYou may override this by setting the `indices` option to `false`:\n\n```javascript\nqs.stringify({ a: ['b', 'c', 'd'] }, { indices: false });\n// 'a=b&a=c&a=d'\n```\n\nYou may use the `arrayFormat` option to specify the format of the output array:\n\n```javascript\nqs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' })\n// 'a[0]=b&a[1]=c'\nqs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' })\n// 'a[]=b&a[]=c'\nqs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' })\n// 'a=b&a=c'\n```\n\nWhen objects are stringified, by default they use bracket notation:\n\n```javascript\nqs.stringify({ a: { b: { c: 'd', e: 'f' } } });\n// 'a[b][c]=d&a[b][e]=f'\n```\n\nYou may override this to use dot notation by setting the `allowDots` option to `true`:\n\n```javascript\nqs.stringify({ a: { b: { c: 'd', e: 'f' } } }, { allowDots: true });\n// 'a.b.c=d&a.b.e=f'\n```\n\nEmpty strings and null values will omit the value, but the equals sign (=) remains in place:\n\n```javascript\nassert.equal(qs.stringify({ a: '' }), 'a=');\n```\n\nKey with no values (such as an empty object or array) will return nothing:\n\n```javascript\nassert.equal(qs.stringify({ a: [] }), '');\nassert.equal(qs.stringify({ a: {} }), '');\nassert.equal(qs.stringify({ a: [{}] }), '');\nassert.equal(qs.stringify({ a: { b: []} }), '');\nassert.equal(qs.stringify({ a: { b: {}} }), '');\n```\n\nProperties that are set to `undefined` will be omitted entirely:\n\n```javascript\nassert.equal(qs.stringify({ a: null, b: undefined }), 'a=');\n```\n\nThe query string may optionally be prepended with a question mark:\n\n```javascript\nassert.equal(qs.stringify({ a: 'b', c: 'd' }, { addQueryPrefix: true }), '?a=b&c=d');\n```\n\nThe delimiter may be overridden with stringify as well:\n\n```javascript\nassert.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');\n```\n\nIf you only want to override the serialization of `Date` objects, you can provide a `serializeDate` option:\n\n```javascript\nvar date = new Date(7);\nassert.equal(qs.stringify({ a: date }), 'a=1970-01-01T00:00:00.007Z'.replace(/:/g, '%3A'));\nassert.equal(\n qs.stringify({ a: date }, { serializeDate: function (d) { return d.getTime(); } }),\n 'a=7'\n);\n```\n\nYou may use the `sort` option to affect the order of parameter keys:\n\n```javascript\nfunction alphabeticalSort(a, b) {\n return a.localeCompare(b);\n}\nassert.equal(qs.stringify({ a: 'c', z: 'y', b : 'f' }, { sort: alphabeticalSort }), 'a=c&b=f&z=y');\n```\n\nFinally, you can use the `filter` option to restrict which keys will be included in the stringified output.\nIf you pass a function, it will be called for each key to obtain the replacement value. Otherwise, if you\npass an array, it will be used to select properties and array indices for stringification:\n\n```javascript\nfunction filterFunc(prefix, value) {\n if (prefix == 'b') {\n // Return an `undefined` value to omit a property.\n return;\n }\n if (prefix == 'e[f]') {\n return value.getTime();\n }\n if (prefix == 'e[g][0]') {\n return value * 2;\n }\n return value;\n}\nqs.stringify({ a: 'b', c: 'd', e: { f: new Date(123), g: [2] } }, { filter: filterFunc });\n// 'a=b&c=d&e[f]=123&e[g][0]=4'\nqs.stringify({ a: 'b', c: 'd', e: 'f' }, { filter: ['a', 'e'] });\n// 'a=b&e=f'\nqs.stringify({ a: ['b', 'c', 'd'], e: 'f' }, { filter: ['a', 0, 2] });\n// 'a[0]=b&a[2]=d'\n```\n\n### Handling of `null` values\n\nBy default, `null` values are treated like empty strings:\n\n```javascript\nvar withNull = qs.stringify({ a: null, b: '' });\nassert.equal(withNull, 'a=&b=');\n```\n\nParsing does not distinguish between parameters with and without equal signs. Both are converted to empty strings.\n\n```javascript\nvar equalsInsensitive = qs.parse('a&b=');\nassert.deepEqual(equalsInsensitive, { a: '', b: '' });\n```\n\nTo distinguish between `null` values and empty strings use the `strictNullHandling` flag. In the result string the `null`\nvalues have no `=` sign:\n\n```javascript\nvar strictNull = qs.stringify({ a: null, b: '' }, { strictNullHandling: true });\nassert.equal(strictNull, 'a&b=');\n```\n\nTo parse values without `=` back to `null` use the `strictNullHandling` flag:\n\n```javascript\nvar parsedStrictNull = qs.parse('a&b=', { strictNullHandling: true });\nassert.deepEqual(parsedStrictNull, { a: null, b: '' });\n```\n\nTo completely skip rendering keys with `null` values, use the `skipNulls` flag:\n\n```javascript\nvar nullsSkipped = qs.stringify({ a: 'b', c: null}, { skipNulls: true });\nassert.equal(nullsSkipped, 'a=b');\n```\n\n### Dealing with special character sets\n\nBy default the encoding and decoding of characters is done in `utf-8`. If you\nwish to encode querystrings to a different character set (i.e.\n[Shift JIS](https://en.wikipedia.org/wiki/Shift_JIS)) you can use the\n[`qs-iconv`](https://github.com/martinheidegger/qs-iconv) library:\n\n```javascript\nvar encoder = require('qs-iconv/encoder')('shift_jis');\nvar shiftJISEncoded = qs.stringify({ a: 'こんにちは！' }, { encoder: encoder });\nassert.equal(shiftJISEncoded, 'a=%82%B1%82%F1%82%C9%82%BF%82%CD%81I');\n```\n\nThis also works for decoding of query strings:\n\n```javascript\nvar decoder = require('qs-iconv/decoder')('shift_jis');\nvar obj = qs.parse('a=%82%B1%82%F1%82%C9%82%BF%82%CD%81I', { decoder: decoder });\nassert.deepEqual(obj, { a: 'こんにちは！' });\n```\n\n### RFC 3986 and RFC 1738 space encoding\n\nRFC3986 used as default option and encodes ' ' to *%20* which is backward compatible.\nIn the same time, output can be stringified as per RFC1738 with ' ' equal to '+'.\n\n```\nassert.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');\nassert.equal(qs.stringify({ a: 'b c' }, { format : 'RFC3986' }), 'a=b%20c');\nassert.equal(qs.stringify({ a: 'b c' }, { format : 'RFC1738' }), 'a=b+c');\n```\n\n[1]: https://npmjs.org/package/qs\n[2]: http://versionbadg.es/ljharb/qs.svg\n[3]: https://api.travis-ci.org/ljharb/qs.svg\n[4]: https://travis-ci.org/ljharb/qs\n[5]: https://david-dm.org/ljharb/qs.svg\n[6]: https://david-dm.org/ljharb/qs\n[7]: https://david-dm.org/ljharb/qs/dev-status.svg\n[8]: https://david-dm.org/ljharb/qs?type=dev\n[9]: https://ci.testling.com/ljharb/qs.png\n[10]: https://ci.testling.com/ljharb/qs\n[11]: https://nodei.co/npm/qs.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/qs.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/qs.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=qs\n# once\n\nOnly call a function once.\n\n## usage\n\n```javascript\nvar once = require('once')\n\nfunction load (file, cb) {\n cb = once(cb)\n loader.load('file')\n loader.once('load', cb)\n loader.once('error', cb)\n}\n```\n\nOr add to the Function.prototype in a responsible way:\n\n```javascript\n// only has to be done once\nrequire('once').proto()\n\nfunction load (file, cb) {\n cb = cb.once()\n loader.load('file')\n loader.once('load', cb)\n loader.once('error', cb)\n}\n```\n\nIronically, the prototype feature makes this module twice as\ncomplicated as necessary.\n\nTo check whether you function has been called, use `fn.called`. Once the\nfunction is called for the first time the return value of the original\nfunction is saved in `fn.value` and subsequent calls will continue to\nreturn this value.\n\n```javascript\nvar once = require('once')\n\nfunction load (cb) {\n cb = once(cb)\n var stream = createStream()\n stream.once('data', cb)\n stream.once('end', function () {\n if (!cb.called) cb(new Error('not found'))\n })\n}\n```\n\n## `once.strict(func)`\n\nThrow an error if the function is called twice.\n\nSome functions are expected to be called only once. Using `once` for them would\npotentially hide logical errors.\n\nIn the example below, the `greet` function has to call the callback only once:\n\n```javascript\nfunction greet (name, cb) {\n // return is missing from the if statement\n // when no name is passed, the callback is called twice\n if (!name) cb('Hello anonymous')\n cb('Hello ' + name)\n}\n\nfunction log (msg) {\n console.log(msg)\n}\n\n// this will print 'Hello anonymous' but the logical error will be missed\ngreet(null, once(msg))\n\n// once.strict will print 'Hello anonymous' and throw an error when the callback will be called the second time\ngreet(null, once.strict(msg))\n```\n# fast-json-stable-stringify\n\nDeterministic `JSON.stringify()` - a faster version of [@substack](https://github.com/substack)'s json-stable-strigify without [jsonify](https://github.com/substack/jsonify).\n\nYou can also pass in a custom comparison function.\n\n[](https://travis-ci.org/epoberezkin/fast-json-stable-stringify)\n[](https://coveralls.io/github/epoberezkin/fast-json-stable-stringify?branch=master)\n\n# example\n\n``` js\nvar stringify = require('fast-json-stable-stringify');\nvar obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };\nconsole.log(stringify(obj));\n```\n\noutput:\n\n```\n{\"a\":3,\"b\":[{\"x\":4,\"y\":5,\"z\":6},7],\"c\":8}\n```\n\n# methods\n\n``` js\nvar stringify = require('fast-json-stable-stringify')\n```\n\n## var str = stringify(obj, opts)\n\nReturn a deterministic stringified string `str` from the object `obj`.\n\n## options\n\n### cmp\n\nIf `opts` is given, you can supply an `opts.cmp` to have a custom comparison\nfunction for object keys. Your function `opts.cmp` is called with these\nparameters:\n\n``` js\nopts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })\n```\n\nFor example, to sort on the object key names in reverse order you could write:\n\n``` js\nvar stringify = require('fast-json-stable-stringify');\n\nvar obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };\nvar s = stringify(obj, function (a, b) {\n return a.key < b.key ? 1 : -1;\n});\nconsole.log(s);\n```\n\nwhich results in the output string:\n\n```\n{\"c\":8,\"b\":[{\"z\":6,\"y\":5,\"x\":4},7],\"a\":3}\n```\n\nOr if you wanted to sort on the object values in reverse order, you could write:\n\n```\nvar stringify = require('fast-json-stable-stringify');\n\nvar obj = { d: 6, c: 5, b: [{z:3,y:2,x:1},9], a: 10 };\nvar s = stringify(obj, function (a, b) {\n return a.value < b.value ? 1 : -1;\n});\nconsole.log(s);\n```\n\nwhich outputs:\n\n```\n{\"d\":6,\"c\":5,\"b\":[{\"z\":3,\"y\":2,\"x\":1},9],\"a\":10}\n```\n\n### cycles\n\nPass `true` in `opts.cycles` to stringify circular property as `__cycle__` - the result will not be a valid JSON string in this case.\n\nTypeError will be thrown in case of circular object without this option.\n\n# install\n\nWith [npm](https://npmjs.org) do:\n\n```\nnpm install fast-json-stable-stringify\n```\n\n# benchmark\n\nTo run benchmark (requires Node.js 6+):\n```\nnode benchmark\n```\n\nResults:\n```\nfast-json-stable-stringify x 17,189 ops/sec ±1.43% (83 runs sampled)\njson-stable-stringify x 13,634 ops/sec ±1.39% (85 runs sampled)\nfast-stable-stringify x 20,212 ops/sec ±1.20% (84 runs sampled)\nfaster-stable-stringify x 15,549 ops/sec ±1.12% (84 runs sampled)\nThe fastest is fast-stable-stringify\n```\n\n## Enterprise support\n\nfast-json-stable-stringify package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-fast-json-stable-stringify?utm_source=npm-fast-json-stable-stringify&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers.\n\n## Security contact\n\nTo report a security vulnerability, please use the\n[Tidelift security contact](https://tidelift.com/security).\nTidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues.\n\n# license\n\n[MIT](https://github.com/epoberezkin/fast-json-stable-stringify/blob/master/LICENSE)\n# extend-shallow [](http://badge.fury.io/js/extend-shallow) [](https://travis-ci.org/jonschlinkert/extend-shallow)\n\n> Extend an object with the properties of additional objects. node.js/javascript util.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i extend-shallow --save\n```\n\n## Usage\n\n```js\nvar extend = require('extend-shallow');\n\nextend({a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\nPass an empty object to shallow clone:\n\n```js\nvar obj = {};\nextend(obj, {a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\n## Related\n\n* [extend-shallow](https://github.com/jonschlinkert/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util.\n* [for-own](https://github.com/jonschlinkert/for-own): Iterate over the own enumerable properties of an object, and return an object with properties… [more](https://github.com/jonschlinkert/for-own)\n* [for-in](https://github.com/jonschlinkert/for-in): Iterate over the own and inherited enumerable properties of an objecte, and return an object… [more](https://github.com/jonschlinkert/for-in)\n* [is-plain-object](https://github.com/jonschlinkert/is-plain-object): Returns true if an object was created by the `Object` constructor.\n* [isobject](https://github.com/jonschlinkert/isobject): Returns true if the value is an object and not an array or null.\n* [kind-of](https://github.com/jonschlinkert/kind-of): Get the native type of a value.\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on June 29, 2015._\n# util.promisify\nPolyfill for util.promisify in node versions < v8\n\nnode v8.0.0 added support for a built-in `util.promisify`: https://github.com/nodejs/node/pull/12442/\n\nThis package provides the built-in `util.promisify` in node v8.0.0 and later, and a replacement in other environments.\n\n## Usage\n\n**Direct**\n```js\nconst promisify = require('util.promisify');\n// Use `promisify` just like the built-in method on `util`\n```\n\n**Shim**\n```js\nrequire('util.promisify/shim')();\n// `util.promisify` is now defined\nconst util = require('util');\n// Use `util.promisify`\n```\n\nNote: this package requires a native ES5 environment, and for `Promise` to be globally available. It will throw upon requiring it if these are not present.\n\n## Promisifying modules\n\nIf you want to promisify a whole module, like the `fs` module, you can use [`util.promisify-all`](https://www.npmjs.com/package/util.promisify-all).\n# [postcss][postcss]-normalize-whitespace\n\n> Normalize whitespace with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-normalize-whitespace) do:\n\n```\nnpm install postcss-normalize-whitespace --save\n```\n\n## Example\n\n### Input\n\n```css\nh1{\n width: calc(10px - ( 100px / var(--test) )) \n}\n```\n\n### Output\n\n```css\nh1{\n width: calc(10px - 100px / var(--test))\n}\n``` \n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# union-value [](https://www.npmjs.com/package/union-value) [](https://npmjs.org/package/union-value) [](https://npmjs.org/package/union-value) [](https://travis-ci.org/jonschlinkert/union-value)\n\n> Set an array of unique values as the property of an object. Supports setting deeply nested properties using using object-paths/dot notation.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save union-value\n```\n\n## Usage\n\n```js\nvar union = require('union-value');\n\nvar obj = {};\n\nunion(obj, 'a.b.c', ['one', 'two']);\nunion(obj, 'a.b.c', ['three']);\n\nconsole.log(obj);\n//=> {a: {b: {c: [ 'one', 'two', 'three' ] }}}\n```\n\n## About\n\n### Related projects\n\n* [assign-value](https://www.npmjs.com/package/assign-value): Assign a value or extend a deeply nested property of an object using object path… [more](https://github.com/jonschlinkert/assign-value) | [homepage](https://github.com/jonschlinkert/assign-value \"Assign a value or extend a deeply nested property of an object using object path notation.\")\n* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value \"Use property paths (`a.b.c`) to get a nested value from an object.\")\n* [has-value](https://www.npmjs.com/package/has-value): Returns true if a value exists, false if empty. Works with deeply nested values using… [more](https://github.com/jonschlinkert/has-value) | [homepage](https://github.com/jonschlinkert/has-value \"Returns true if a value exists, false if empty. Works with deeply nested values using object paths.\")\n* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value \"Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths.\")\n* [unset-value](https://www.npmjs.com/package/unset-value): Delete nested properties from an object using dot notation. | [homepage](https://github.com/jonschlinkert/unset-value \"Delete nested properties from an object using dot notation.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 25, 2017._\n# simple-swizzle [](https://travis-ci.org/Qix-/node-simple-swizzle) [](https://coveralls.io/r/Qix-/node-simple-swizzle)\n\n> [Swizzle](https://en.wikipedia.org/wiki/Swizzling_(computer_graphics)) your function arguments; pass in mixed arrays/values and get a clean array\n\n## Usage\n\n```js\nvar swizzle = require('simple-swizzle');\n\nfunction myFunc() {\n\tvar args = swizzle(arguments);\n\t// ...\n\treturn args;\n}\n\nmyFunc(1, [2, 3], 4); // [1, 2, 3, 4]\nmyFunc(1, 2, 3, 4); // [1, 2, 3, 4]\nmyFunc([1, 2, 3, 4]); // [1, 2, 3, 4]\n```\n\nFunctions can also be wrapped to automatically swizzle arguments and be passed\nthe resulting array.\n\n```js\nvar swizzle = require('simple-swizzle');\n\nvar swizzledFn = swizzle.wrap(function (args) {\n\t// ...\n\treturn args;\n});\n\nswizzledFn(1, [2, 3], 4); // [1, 2, 3, 4]\nswizzledFn(1, 2, 3, 4); // [1, 2, 3, 4]\nswizzledFn([1, 2, 3, 4]); // [1, 2, 3, 4]\n```\n\n## License\nLicensed under the [MIT License](http://opensource.org/licenses/MIT).\nYou can find a copy of it in [LICENSE](LICENSE).\nA JSON with color names and its values. Based on http://dev.w3.org/csswg/css-color/#named-colors.\n\n[](https://nodei.co/npm/color-name/)\n\n```js\nvar colors = require('color-name');\ncolors.red //[255,0,0]\n```\n\n<a href=\"LICENSE\"><img src=\"https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg\" width=\"120\"/></a>\nanymatch [](https://travis-ci.org/micromatch/anymatch) [](https://coveralls.io/r/micromatch/anymatch?branch=master)\n======\nJavascript module to match a string against a regular expression, glob, string,\nor function that takes the string as an argument and returns a truthy or falsy\nvalue. The matcher can also be an array of any or all of these. Useful for\nallowing a very flexible user-defined config to define things like file paths.\n\n__Note: This module has Bash-parity, please be aware that Windows-style backslashes are not supported as separators. See https://github.com/micromatch/micromatch#backslashes for more information.__\n\n[](https://nodei.co/npm/anymatch/)\n[](https://nodei.co/npm-dl/anymatch/)\n\nUsage\n-----\n```sh\nnpm install anymatch --save\n```\n\n#### anymatch (matchers, testString, [returnIndex], [startIndex], [endIndex])\n* __matchers__: (_Array|String|RegExp|Function_)\nString to be directly matched, string with glob patterns, regular expression\ntest, function that takes the testString as an argument and returns a truthy\nvalue if it should be matched, or an array of any number and mix of these types.\n* __testString__: (_String|Array_) The string to test against the matchers. If\npassed as an array, the first element of the array will be used as the\n`testString` for non-function matchers, while the entire array will be applied\nas the arguments for function matchers.\n* __returnIndex__: (_Boolean [optional]_) If true, return the array index of\nthe first matcher that that testString matched, or -1 if no match, instead of a\nboolean result.\n* __startIndex, endIndex__: (_Integer [optional]_) Can be used to define a\nsubset out of the array of provided matchers to test against. Can be useful\nwith bound matcher functions (see below). When used with `returnIndex = true`\npreserves original indexing. Behaves the same as `Array.prototype.slice` (i.e.\nincludes array members up to, but not including endIndex).\n\n```js\nvar anymatch = require('anymatch');\n\nvar matchers = [\n\t'path/to/file.js',\n\t'path/anyjs/**/*.js',\n\t/foo\\.js$/,\n\tfunction (string) {\n\t\treturn string.indexOf('bar') !== -1 && string.length > 10\n\t}\n];\n\nanymatch(matchers, 'path/to/file.js'); // true\nanymatch(matchers, 'path/anyjs/baz.js'); // true\nanymatch(matchers, 'path/to/foo.js'); // true\nanymatch(matchers, 'path/to/bar.js'); // true\nanymatch(matchers, 'bar.js'); // false\n\n// returnIndex = true\nanymatch(matchers, 'foo.js', true); // 2\nanymatch(matchers, 'path/anyjs/foo.js', true); // 1\n\n// skip matchers\nanymatch(matchers, 'path/to/file.js', false, 1); // false\nanymatch(matchers, 'path/anyjs/foo.js', true, 2, 3); // 2\nanymatch(matchers, 'path/to/bar.js', true, 0, 3); // -1\n\n// using globs to match directories and their children\nanymatch('node_modules', 'node_modules'); // true\nanymatch('node_modules', 'node_modules/somelib/index.js'); // false\nanymatch('node_modules/**', 'node_modules/somelib/index.js'); // true\nanymatch('node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // false\nanymatch('**/node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // true\n```\n\n#### anymatch (matchers)\nYou can also pass in only your matcher(s) to get a curried function that has\nalready been bound to the provided matching criteria. This can be used as an\n`Array.prototype.filter` callback.\n\n```js\nvar matcher = anymatch(matchers);\n\nmatcher('path/to/file.js'); // true\nmatcher('path/anyjs/baz.js', true); // 1\nmatcher('path/anyjs/baz.js', true, 2); // -1\n\n['foo.js', 'bar.js'].filter(matcher); // ['foo.js']\n```\n\nChange Log\n----------\n[See release notes page on GitHub](https://github.com/micromatch/anymatch/releases)\n\nNOTE: As of v2.0.0, [micromatch](https://github.com/jonschlinkert/micromatch) moves away from minimatch-parity and inline with Bash. This includes handling backslashes differently (see https://github.com/micromatch/micromatch#backslashes for more information).\n\nNOTE: As of v1.2.0, anymatch uses [micromatch](https://github.com/jonschlinkert/micromatch)\nfor glob pattern matching. Issues with glob pattern matching should be\nreported directly to the [micromatch issue tracker](https://github.com/jonschlinkert/micromatch/issues).\n\nLicense\n-------\n[ISC](https://raw.github.com/micromatch/anymatch/master/LICENSE)\n# [postcss][postcss]-normalize-unicode\n\n> Normalize unicode with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-normalize-unicode) do:\n\n```\nnpm install postcss-normalize-unicode --save\n```\n\n## Example\n\n### Input\n\n```css\n@font-face{\n font-family: test;\n unicode-range: u+2b00-2bff\n}\n```\n\n### Output\n\n```css\n@font-face{\n font-family: test;\n unicode-range: u+2b??\n}\n``` \n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# ASN1.js\n\nASN.1 DER Encoder/Decoder and DSL.\n\n## Example\n\nDefine model:\n\n```javascript\nvar asn = require('asn1.js');\n\nvar Human = asn.define('Human', function() {\n this.seq().obj(\n this.key('firstName').octstr(),\n this.key('lastName').octstr(),\n this.key('age').int(),\n this.key('gender').enum({ 0: 'male', 1: 'female' }),\n this.key('bio').seqof(Bio)\n );\n});\n\nvar Bio = asn.define('Bio', function() {\n this.seq().obj(\n this.key('time').gentime(),\n this.key('description').octstr()\n );\n});\n```\n\nEncode data:\n\n```javascript\nvar output = Human.encode({\n firstName: 'Thomas',\n lastName: 'Anderson',\n age: 28,\n gender: 'male',\n bio: [\n {\n time: +new Date('31 March 1999'),\n description: 'freedom of mind'\n }\n ]\n}, 'der');\n```\n\nDecode data:\n\n```javascript\nvar human = Human.decode(output, 'der');\nconsole.log(human);\n/*\n{ firstName: <Buffer 54 68 6f 6d 61 73>,\n lastName: <Buffer 41 6e 64 65 72 73 6f 6e>,\n age: 28,\n gender: 'male',\n bio:\n [ { time: 922820400000,\n description: <Buffer 66 72 65 65 64 6f 6d 20 6f 66 20 6d 69 6e 64> } ] }\n*/\n```\n\n### Partial decode\n\nIts possible to parse data without stopping on first error. In order to do it,\nyou should call:\n\n```javascript\nvar human = Human.decode(output, 'der', { partial: true });\nconsole.log(human);\n/*\n{ result: { ... },\n errors: [ ... ] }\n*/\n```\n\n#### LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2017.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n# saxes\n\nA sax-style non-validating parser for XML.\n\nSaxes is a fork of [sax](https://github.com/isaacs/sax-js) 1.2.4. All mentions\nof sax in this project's documentation are references to sax 1.2.4.\n\nDesigned with [node](http://nodejs.org/) in mind, but should work fine in the\nbrowser or other CommonJS implementations.\n\nSaxes does not support Node versions older than 10.\n\n## Notable Differences from Sax.\n\n* Saxes aims to be much stricter than sax with regards to XML\n well-formedness. Sax, even in its so-called \"strict mode\", is not strict. It\n silently accepts structures that are not well-formed XML. Projects that need\n better compliance with well-formedness constraints cannot use sax as-is.\n\n Consequently, saxes does not support HTML, or pseudo-XML, or bad XML. Saxes\n will report well-formedness errors in all these cases but it won't try to\n extract data from malformed documents like sax does.\n\n* Saxes is much much faster than sax, mostly because of a substantial redesign\n of the internal parsing logic. The speed improvement is not merely due to\n removing features that were supported by sax. That helped a bit, but saxes\n adds some expensive checks in its aim for conformance with the XML\n specification. Redesigning the parsing logic is what accounts for most of the\n performance improvement.\n\n* Saxes does not aim to support antiquated platforms. We will not pollute the\n source or the default build with support for antiquated platforms. If you want\n support for IE 11, you are welcome to produce a PR that adds a *new build*\n transpiled to ES5.\n\n* Saxes handles errors differently from sax: it provides a default onerror\n handler which throws. You can replace it with your own handler if you want. If\n your handler does nothing, there is no `resume` method to call.\n\n* There's no `Stream` API. A revamped API may be introduced later. (It is still\n a \"streaming parser\" in the general sense that you write a character stream to\n it.)\n\n* Saxes does not have facilities for limiting the size the data chunks passed to\n event handlers. See the FAQ entry for more details.\n\n## Conformance\n\nSaxes supports:\n\n* [XML 1.0 fifth edition](https://www.w3.org/TR/2008/REC-xml-20081126/)\n* [XML 1.1 second edition](https://www.w3.org/TR/2006/REC-xml11-20060816/)\n* [Namespaces in XML 1.0 (Third Edition)](https://www.w3.org/TR/2009/REC-xml-names-20091208/).\n* [Namespaces in XML 1.1 (Second Edition)](https://www.w3.org/TR/2006/REC-xml-names11-20060816/).\n\n## Limitations\n\nThis is a non-validating parser so it only verifies whether the document is\nwell-formed. We do aim to raise errors for all malformed constructs\nencountered. However, this parser does not thorougly parse the contents of\nDTDs. So most malformedness errors caused by errors **in DTDs** cannot be\nreported.\n\n## Regarding `<!DOCTYPE` and `<!ENTITY`\n\nThe parser will handle the basic XML entities in text nodes and attribute\nvalues: `& < > ' "`. It's possible to define additional\nentities in XML by putting them in the DTD. This parser doesn't do anything with\nthat. If you want to listen to the `doctype` event, and then fetch the\ndoctypes, and read the entities and add them to `parser.ENTITIES`, then be my\nguest.\n\n## Documentation\n\nThe source code contains JSDOC comments. Use them. What follows is a brief\nsummary of what is available. The final authority is the source code.\n\n**PAY CLOSE ATTENTION TO WHAT IS PUBLIC AND WHAT IS PRIVATE.**\n\nThe move to TypeScript makes it so that everything is now formally private,\nprotected, or public.\n\nIf you use anything not public, that's at your own peril.\n\nIf there's a mistake in the documentation, raise an issue. If you just assume,\nyou may assume incorrectly.\n\n## Summary Usage Information\n\n### Example\n\n```javascript\nvar saxes = require(\"./lib/saxes\"),\n parser = new saxes.SaxesParser();\n\nparser.on(\"error\", function (e) {\n // an error happened.\n});\nparser.on(\"text\", function (t) {\n // got some text. t is the string of text.\n});\nparser.on(\"opentag\", function (node) {\n // opened a tag. node has \"name\" and \"attributes\"\n});\nparser.on(\"end\", function () {\n // parser stream is done, and ready to have more stuff written to it.\n});\n\nparser.write('<xml>Hello, <who name=\"world\">world</who>!</xml>').close();\n```\n\n### Constructor Arguments\n\nSettings supported:\n\n* `xmlns` - Boolean. If `true`, then namespaces are supported. Default\n is `false`.\n\n* `position` - Boolean. If `false`, then don't track line/col/position. Unset is\n treated as `true`. Default is unset. Currently, setting this to `false` only\n results in a cosmetic change: the errors reported do not contain position\n information. sax-js would literally turn off the position-computing logic if\n this flag was set to false. The notion was that it would optimize\n execution. In saxes at least it turns out that continually testing this flag\n causes a cost that offsets the benefits of turning off this logic.\n\n* `fileName` - String. Set a file name for error reporting. This is useful only\n when tracking positions. You may leave it unset.\n\n* `fragment` - Boolean. If `true`, parse the XML as an XML fragment. Default is\n `false`.\n\n* `additionalNamespaces` - A plain object whose key, value pairs define\n namespaces known before parsing the XML file. It is not legal to pass\n bindings for the namespaces `\"xml\"` or `\"xmlns\"`.\n\n* `defaultXMLVersion` - The default version of the XML specification to use if\n the document contains no XML declaration. If the document does contain an XML\n declaration, then this setting is ignored. Must be `\"1.0\"` or `\"1.1\"`. The\n default is `\"1.0\"`.\n\n* `forceXMLVersion` - Boolean. A flag indicating whether to force the XML\n version used for parsing to the value of ``defaultXMLVersion``. When this flag\n is ``true``, ``defaultXMLVersion`` must be specified. If unspecified, the\n default value of this flag is ``false``.\n\n Example: suppose you are parsing a document that has an XML declaration\n specifying XML version 1.1.\n\n If you set ``defaultXMLVersion`` to ``\"1.0\"`` without setting\n ``forceXMLVersion`` then the XML declaration will override the value of\n ``defaultXMLVersion`` and the document will be parsed according to XML 1.1.\n\n If you set ``defaultXMLVersion`` to ``\"1.0\"`` and set ``forceXMLVersion`` to\n ``true``, then the XML declaration will be ignored and the document will be\n parsed according to XML 1.0.\n\n### Methods\n\n`write` - Write bytes onto the stream. You don't have to pass the whole document\nin one `write` call. You can read your source chunk by chunk and call `write`\nwith each chunk.\n\n`close` - Close the stream. Once closed, no more data may be written until it is\ndone processing the buffer, which is signaled by the `end` event.\n\n### Properties\n\nThe parser has the following properties:\n\n`line`, `column`, `columnIndex`, `position` - Indications of the position in the\nXML document where the parser currently is looking. The `columnIndex` property\ncounts columns as if indexing into a JavaScript string, whereas the `column`\nproperty counts Unicode characters.\n\n`closed` - Boolean indicating whether or not the parser can be written to. If\nit's `true`, then wait for the `ready` event to write again.\n\n`opt` - Any options passed into the constructor.\n\n`xmlDecl` - The XML declaration for this document. It contains the fields\n`version`, `encoding` and `standalone`. They are all `undefined` before\nencountering the XML declaration. If they are undefined after the XML\ndeclaration, the corresponding value was not set by the declaration. There is no\nevent associated with the XML declaration. In a well-formed document, the XML\ndeclaration may be preceded only by an optional BOM. So by the time any event\ngenerated by the parser happens, the declaration has been processed if present\nat all. Otherwise, you have a malformed document, and as stated above, you\ncannot rely on the parser data!\n\n### Error Handling\n\nThe parser continues to parse even upon encountering errors, and does its best\nto continue reporting errors. You should heed all errors reported. After an\nerror, however, saxes may interpret your document incorrectly. For instance\n``<foo a=bc=\"d\"/>`` is invalid XML. Did you mean to have ``<foo a=\"bc=d\"/>`` or\n``<foo a=\"b\" c=\"d\"/>`` or some other variation? For the sake of continuing to\nprovide errors, saxes will continue parsing the document, but the structure it\nreports may be incorrect. It is only after the errors are fixed in the document\nthat saxes can provide a reliable interpretation of the document.\n\nThat leaves you with two rules of thumb when using saxes:\n\n* Pay attention to the errors that saxes report. The default `onerror` handler\n throws, so by default, you cannot miss errors.\n\n* **ONCE AN ERROR HAS BEEN ENCOUNTERED, STOP RELYING ON THE EVENT HANDLERS OTHER\n THAN `onerror`.** As explained above, when saxes runs into a well-formedness\n problem, it makes a guess in order to continue reporting more errors. The guess\n may be wrong.\n\n### Events\n\nTo listen to an event, override `on<eventname>`. The list of supported events\nare also in the exported `EVENTS` array.\n\nSee the JSDOC comments in the source code for a description of each supported\nevent.\n\n### Parsing XML Fragments\n\nThe XML specification does not define any method by which to parse XML\nfragments. However, there are usage scenarios in which it is desirable to parse\nfragments. In order to allow this, saxes provides three initialization options.\n\nIf you pass the option `fragment: true` to the parser constructor, the parser\nwill expect an XML fragment. It essentially starts with a parsing state\nequivalent to the one it would be in if `parser.write(\"<foo\">)` had been called\nright after initialization. In other words, it expects content which is\nacceptable inside an element. This also turns off well-formedness checks that\nare inappropriate when parsing a fragment.\n\nThe option `additionalNamespaces` allows you to define additional prefix-to-URI\nbindings known before parsing starts. You would use this over `resolvePrefix` if\nyou have at the ready a series of namespaces bindings to use.\n\nThe option `resolvePrefix` allows you to pass a function which saxes will use if\nit is unable to resolve a namespace prefix by itself. You would use this over\n`additionalNamespaces` in a context where getting a complete list of defined\nnamespaces is onerous.\n\nNote that you can use `additionalNamespaces` and `resolvePrefix` together if you\nwant. `additionalNamespaces` applies before `resolvePrefix`.\n\nThe options `additionalNamespaces` and `resolvePrefix` are really meant to be\nused for parsing fragments. However, saxes won't prevent you from using them\nwith `fragment: false`. Note that if you do this, your document may parse\nwithout errors and yet be malformed because the document can refer to namespaces\nwhich are not defined *in* the document.\n\nOf course, `additionalNamespaces` and `resolvePrefix` are used only if `xmlns`\nis `true`. If you are parsing a fragment that does not use namespaces, there's\nno point in setting these options.\n\n### Performance Tips\n\n* saxes works faster on files that use newlines (``\\u000A``) as end of line\n markers than files that use other end of line markers (like ``\\r`` or\n ``\\r\\n``). The XML specification requires that conformant applications behave\n as if all characters that are to be treated as end of line characters are\n converted to ``\\u000A`` prior to parsing. The optimal code path for saxes is a\n file in which all end of line characters are already ``\\u000A``.\n\n* Don't split Unicode strings you feed to saxes across surrogates. When you\n naively split a string in JavaScript, you run the risk of splitting a Unicode\n character into two surrogates. e.g. In the following example ``a`` and ``b``\n each contain half of a single Unicode character: ``const a = \"\\u{1F4A9}\"[0];\n const b = \"\\u{1F4A9}\"[1]`` If you feed such split surrogates to versions of\n saxes prior to 4, you'd get errors. Saxes version 4 and over are able to\n detect when a chunk of data ends with a surrogate and carry over the surrogate\n to the next chunk. However this operation entails slicing and concatenating\n strings. If you can feed your data in a way that does not split surrogates,\n you should do it. (Obviously, feeding all the data at once with a single write\n is fastest.)\n\n* Don't set event handlers you don't need. Saxes has always aimed to avoid doing\n work that will just be tossed away but future improvements hope to do this\n more aggressively. One way saxes knows whether or not some data is needed is\n by checking whether a handler has been set for a specific event.\n\n## FAQ\n\nQ. Why has saxes dropped support for limiting the size of data chunks passed to\nevent handlers?\n\nA. With sax you could set ``MAX_BUFFER_LENGTH`` to cause the parser to limit the\nsize of data chunks passed to event handlers. So if you ran into a span of text\nabove the limit, multiple ``text`` events with smaller data chunks were fired\ninstead of a single event with a large chunk.\n\nHowever, that functionality had some problematic characteristics. It had an\narbitrary default value. It was library-wide so all parsers created from a\nsingle instance of the ``sax`` library shared it. This could potentially cause\nconflicts among libraries running in the same VM but using sax for different\npurposes.\n\nThese issues could have been easily fixed, but there were larger issues. The\nbuffer limit arbitrarily applied to some events but not others. It would split\n``text``, ``cdata`` and ``script`` events. However, if a ``comment``,\n``doctype``, ``attribute`` or ``processing instruction`` were more than the\nlimit, the parser would generate an error and you were left picking up the\npieces.\n\nIt was not intuitive to use. You'd think setting the limit to 1K would prevent\nchunks bigger than 1K to be passed to event handlers. But that was not the\ncase. A comment in the source code told you that you might go over the limit if\nyou passed large chunks to ``write``. So if you want a 1K limit, don't pass 64K\nchunks to ``write``. Fair enough. You know what limit you want so you can\ncontrol the size of the data you pass to ``write``. So you limit the chunks to\n``write`` to 1K at a time. Even if you do this, your event handlers may get data\nchunks that are 2K in size. Suppose on the previous ``write`` the parser has\njust finished processing an open tag, so it is ready for text. Your ``write``\npasses 1K of text. You are not above the limit yet, so no event is generated\nyet. The next ``write`` passes another 1K of text. It so happens that sax checks\nbuffer limits only once per ``write``, after the chunk of data has been\nprocessed. Now you've hit the limit and you get a ``text`` event with 2K of\ndata. So even if you limit your ``write`` calls to the buffer limit you've set,\nyou may still get events with chunks at twice the buffer size limit you've\nspecified.\n\nWe may consider reinstating an equivalent functionality, provided that it\naddresses the issues above and does not cause a huge performance drop for\nuse-case scenarios that don't need it.\n# <img src=\"./logo.png\" alt=\"bn.js\" width=\"160\" height=\"160\" />\n\n> BigNum in pure javascript\n\n[](http://travis-ci.org/indutny/bn.js)\n\n## Install\n`npm install --save bn.js`\n\n## Usage\n\n```js\nconst BN = require('bn.js');\n\nvar a = new BN('dead', 16);\nvar b = new BN('101010', 2);\n\nvar res = a.add(b);\nconsole.log(res.toString(10)); // 57047\n```\n\n**Note**: decimals are not supported in this library.\n\n## Notation\n\n### Prefixes\n\nThere are several prefixes to instructions that affect the way the work. Here\nis the list of them in the order of appearance in the function name:\n\n* `i` - perform operation in-place, storing the result in the host object (on\n which the method was invoked). Might be used to avoid number allocation costs\n* `u` - unsigned, ignore the sign of operands when performing operation, or\n always return positive value. Second case applies to reduction operations\n like `mod()`. In such cases if the result will be negative - modulo will be\n added to the result to make it positive\n\n### Postfixes\n\n* `n` - the argument of the function must be a plain JavaScript\n Number. Decimals are not supported.\n* `rn` - both argument and return value of the function are plain JavaScript\n Numbers. Decimals are not supported.\n\n### Examples\n\n* `a.iadd(b)` - perform addition on `a` and `b`, storing the result in `a`\n* `a.umod(b)` - reduce `a` modulo `b`, returning positive value\n* `a.iushln(13)` - shift bits of `a` left by 13\n\n## Instructions\n\nPrefixes/postfixes are put in parens at the of the line. `endian` - could be\neither `le` (little-endian) or `be` (big-endian).\n\n### Utilities\n\n* `a.clone()` - clone number\n* `a.toString(base, length)` - convert to base-string and pad with zeroes\n* `a.toNumber()` - convert to Javascript Number (limited to 53 bits)\n* `a.toJSON()` - convert to JSON compatible hex string (alias of `toString(16)`)\n* `a.toArray(endian, length)` - convert to byte `Array`, and optionally zero\n pad to length, throwing if already exceeding\n* `a.toArrayLike(type, endian, length)` - convert to an instance of `type`,\n which must behave like an `Array`\n* `a.toBuffer(endian, length)` - convert to Node.js Buffer (if available). For\n compatibility with browserify and similar tools, use this instead:\n `a.toArrayLike(Buffer, endian, length)`\n* `a.bitLength()` - get number of bits occupied\n* `a.zeroBits()` - return number of less-significant consequent zero bits\n (example: `1010000` has 4 zero bits)\n* `a.byteLength()` - return number of bytes occupied\n* `a.isNeg()` - true if the number is negative\n* `a.isEven()` - no comments\n* `a.isOdd()` - no comments\n* `a.isZero()` - no comments\n* `a.cmp(b)` - compare numbers and return `-1` (a `<` b), `0` (a `==` b), or `1` (a `>` b)\n depending on the comparison result (`ucmp`, `cmpn`)\n* `a.lt(b)` - `a` less than `b` (`n`)\n* `a.lte(b)` - `a` less than or equals `b` (`n`)\n* `a.gt(b)` - `a` greater than `b` (`n`)\n* `a.gte(b)` - `a` greater than or equals `b` (`n`)\n* `a.eq(b)` - `a` equals `b` (`n`)\n* `a.toTwos(width)` - convert to two's complement representation, where `width` is bit width\n* `a.fromTwos(width)` - convert from two's complement representation, where `width` is the bit width\n* `BN.isBN(object)` - returns true if the supplied `object` is a BN.js instance\n* `BN.max(a, b)` - return `a` if `a` bigger than `b`\n* `BN.min(a, b)` - return `a` if `a` less than `b`\n\n### Arithmetics\n\n* `a.neg()` - negate sign (`i`)\n* `a.abs()` - absolute value (`i`)\n* `a.add(b)` - addition (`i`, `n`, `in`)\n* `a.sub(b)` - subtraction (`i`, `n`, `in`)\n* `a.mul(b)` - multiply (`i`, `n`, `in`)\n* `a.sqr()` - square (`i`)\n* `a.pow(b)` - raise `a` to the power of `b`\n* `a.div(b)` - divide (`divn`, `idivn`)\n* `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`)\n* `a.divRound(b)` - rounded division\n\n### Bit operations\n\n* `a.or(b)` - or (`i`, `u`, `iu`)\n* `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced\n with `andn` in future)\n* `a.xor(b)` - xor (`i`, `u`, `iu`)\n* `a.setn(b)` - set specified bit to `1`\n* `a.shln(b)` - shift left (`i`, `u`, `iu`)\n* `a.shrn(b)` - shift right (`i`, `u`, `iu`)\n* `a.testn(b)` - test if specified bit is set\n* `a.maskn(b)` - clear bits with indexes higher or equal to `b` (`i`)\n* `a.bincn(b)` - add `1 << b` to the number\n* `a.notn(w)` - not (for the width specified by `w`) (`i`)\n\n### Reduction\n\n* `a.gcd(b)` - GCD\n* `a.egcd(b)` - Extended GCD results (`{ a: ..., b: ..., gcd: ... }`)\n* `a.invm(b)` - inverse `a` modulo `b`\n\n## Fast reduction\n\nWhen doing lots of reductions using the same modulo, it might be beneficial to\nuse some tricks: like [Montgomery multiplication][0], or using special algorithm\nfor [Mersenne Prime][1].\n\n### Reduction context\n\nTo enable this tricks one should create a reduction context:\n\n```js\nvar red = BN.red(num);\n```\nwhere `num` is just a BN instance.\n\nOr:\n\n```js\nvar red = BN.red(primeName);\n```\n\nWhere `primeName` is either of these [Mersenne Primes][1]:\n\n* `'k256'`\n* `'p224'`\n* `'p192'`\n* `'p25519'`\n\nOr:\n\n```js\nvar red = BN.mont(num);\n```\n\nTo reduce numbers with [Montgomery trick][0]. `.mont()` is generally faster than\n`.red(num)`, but slower than `BN.red(primeName)`.\n\n### Converting numbers\n\nBefore performing anything in reduction context - numbers should be converted\nto it. Usually, this means that one should:\n\n* Convert inputs to reducted ones\n* Operate on them in reduction context\n* Convert outputs back from the reduction context\n\nHere is how one may convert numbers to `red`:\n\n```js\nvar redA = a.toRed(red);\n```\nWhere `red` is a reduction context created using instructions above\n\nHere is how to convert them back:\n\n```js\nvar a = redA.fromRed();\n```\n\n### Red instructions\n\nMost of the instructions from the very start of this readme have their\ncounterparts in red context:\n\n* `a.redAdd(b)`, `a.redIAdd(b)`\n* `a.redSub(b)`, `a.redISub(b)`\n* `a.redShl(num)`\n* `a.redMul(b)`, `a.redIMul(b)`\n* `a.redSqr()`, `a.redISqr()`\n* `a.redSqrt()` - square root modulo reduction context's prime\n* `a.redInvm()` - modular inverse of the number\n* `a.redNeg()`\n* `a.redPow(b)` - modular exponentiation\n\n### Number Size\n\nOptimized for elliptic curves that work with 256-bit numbers.\nThere is no limitation on the size of the numbers.\n\n## LICENSE\n\nThis software is licensed under the MIT License.\n\nCopyright Fedor Indutny, 2015.\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the\nfollowing conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN\nNO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\nDAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE\nUSE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication\n[1]: https://en.wikipedia.org/wiki/Mersenne_prime\n# require-main-filename\n\n[](https://travis-ci.org/yargs/require-main-filename)\n[](https://coveralls.io/r/yargs/require-main-filename?branch=master)\n[](https://www.npmjs.com/package/require-main-filename)\n\n`require.main.filename` is great for figuring out the entry\npoint for the current application. This can be combined with a module like\n[pkg-conf](https://www.npmjs.com/package/pkg-conf) to, _as if by magic_, load\ntop-level configuration.\n\nUnfortunately, `require.main.filename` sometimes fails when an application is\nexecuted with an alternative process manager, e.g., [iisnode](https://github.com/tjanczuk/iisnode).\n\n`require-main-filename` is a shim that addresses this problem.\n\n## Usage\n\n```js\nvar main = require('require-main-filename')()\n// use main as an alternative to require.main.filename.\n```\n\n## License\n\nISC\n# hosted-git-info\n\nThis will let you identify and transform various git hosts URLs between\nprotocols. It also can tell you what the URL is for the raw path for\nparticular file for direct access without git.\n\n## Example\n\n```javascript\nvar hostedGitInfo = require(\"hosted-git-info\")\nvar info = hostedGitInfo.fromUrl(\"git@github.com:npm/hosted-git-info.git\", opts)\n/* info looks like:\n{\n type: \"github\",\n domain: \"github.com\",\n user: \"npm\",\n project: \"hosted-git-info\"\n}\n*/\n```\n\nIf the URL can't be matched with a git host, `null` will be returned. We\ncan match git, ssh and https urls. Additionally, we can match ssh connect\nstrings (`git@github.com:npm/hosted-git-info`) and shortcuts (eg,\n`github:npm/hosted-git-info`). Github specifically, is detected in the case\nof a third, unprefixed, form: `npm/hosted-git-info`.\n\nIf it does match, the returned object has properties of:\n\n* info.type -- The short name of the service\n* info.domain -- The domain for git protocol use\n* info.user -- The name of the user/org on the git host\n* info.project -- The name of the project on the git host\n\n## Version Contract\n\nThe major version will be bumped any time…\n\n* The constructor stops accepting URLs that it previously accepted.\n* A method is removed.\n* A method can no longer accept the number and type of arguments it previously accepted.\n* A method can return a different type than it currently returns.\n\nImplications:\n\n* I do not consider the specific format of the urls returned from, say\n `.https()` to be a part of the contract. The contract is that it will\n return a string that can be used to fetch the repo via HTTPS. But what\n that string looks like, specifically, can change.\n* Dropping support for a hosted git provider would constitute a breaking\n change.\n\n## Usage\n\n### var info = hostedGitInfo.fromUrl(gitSpecifier[, options])\n\n* *gitSpecifer* is a URL of a git repository or a SCP-style specifier of one.\n* *options* is an optional object. It can have the following properties:\n * *noCommittish* — If true then committishes won't be included in generated URLs.\n * *noGitPlus* — If true then `git+` won't be prefixed on URLs.\n\n## Methods\n\nAll of the methods take the same options as the `fromUrl` factory. Options\nprovided to a method override those provided to the constructor.\n\n* info.file(path, opts)\n\nGiven the path of a file relative to the repository, returns a URL for\ndirectly fetching it from the githost. If no committish was set then\n`master` will be used as the default.\n\nFor example `hostedGitInfo.fromUrl(\"git@github.com:npm/hosted-git-info.git#v1.0.0\").file(\"package.json\")`\nwould return `https://raw.githubusercontent.com/npm/hosted-git-info/v1.0.0/package.json`\n\n* info.shortcut(opts)\n\neg, `github:npm/hosted-git-info`\n\n* info.browse(path, fragment, opts)\n\neg, `https://github.com/npm/hosted-git-info/tree/v1.2.0`,\n`https://github.com/npm/hosted-git-info/tree/v1.2.0/package.json`,\n`https://github.com/npm/hosted-git-info/tree/v1.2.0/REAMDE.md#supported-hosts`\n\n* info.bugs(opts)\n\neg, `https://github.com/npm/hosted-git-info/issues`\n\n* info.docs(opts)\n\neg, `https://github.com/npm/hosted-git-info/tree/v1.2.0#readme`\n\n* info.https(opts)\n\neg, `git+https://github.com/npm/hosted-git-info.git`\n\n* info.sshurl(opts)\n\neg, `git+ssh://git@github.com/npm/hosted-git-info.git`\n\n* info.ssh(opts)\n\neg, `git@github.com:npm/hosted-git-info.git`\n\n* info.path(opts)\n\neg, `npm/hosted-git-info`\n\n* info.tarball(opts)\n\neg, `https://github.com/npm/hosted-git-info/archive/v1.2.0.tar.gz`\n\n* info.getDefaultRepresentation()\n\nReturns the default output type. The default output type is based on the\nstring you passed in to be parsed\n\n* info.toString(opts)\n\nUses the getDefaultRepresentation to call one of the other methods to get a URL for\nthis resource. As such `hostedGitInfo.fromUrl(url).toString()` will give\nyou a normalized version of the URL that still uses the same protocol.\n\nShortcuts will still be returned as shortcuts, but the special case github\nform of `org/project` will be normalized to `github:org/project`.\n\nSSH connect strings will be normalized into `git+ssh` URLs.\n\n## Supported hosts\n\nCurrently this supports Github, Bitbucket and Gitlab. Pull requests for\nadditional hosts welcome.\n# debug\n[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers)\n[](#sponsors)\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nA tiny JavaScript debugging utility modelled after Node.js core's debugging\ntechnique. Works in Node.js and web browsers.\n\n## Installation\n\n```bash\n$ npm install debug\n```\n\n## Usage\n\n`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.\n\nExample [_app.js_](./examples/node/app.js):\n\n```js\nvar debug = require('debug')('http')\n , http = require('http')\n , name = 'My App';\n\n// fake app\n\ndebug('booting %o', name);\n\nhttp.createServer(function(req, res){\n debug(req.method + ' ' + req.url);\n res.end('hello\\n');\n}).listen(3000, function(){\n debug('listening');\n});\n\n// fake worker of some kind\n\nrequire('./worker');\n```\n\nExample [_worker.js_](./examples/node/worker.js):\n\n```js\nvar a = require('debug')('worker:a')\n , b = require('debug')('worker:b');\n\nfunction work() {\n a('doing lots of uninteresting work');\n setTimeout(work, Math.random() * 1000);\n}\n\nwork();\n\nfunction workb() {\n b('doing some work');\n setTimeout(workb, Math.random() * 2000);\n}\n\nworkb();\n```\n\nThe `DEBUG` environment variable is then used to enable these based on space or\ncomma-delimited names.\n\nHere are some examples:\n\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 04 pm\" src=\"https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 38 pm\" src=\"https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png\">\n<img width=\"647\" alt=\"screen shot 2017-08-08 at 12 53 25 pm\" src=\"https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png\">\n\n#### Windows note\n\nOn Windows the environment variable is set using the `set` command.\n\n```cmd\nset DEBUG=*,-not_this\n```\n\nNote that PowerShell uses different syntax to set environment variables.\n\n```cmd\n$env:DEBUG = \"*,-not_this\"\n```\n\nThen, run the program to be debugged as usual.\n\n## Namespace Colors\n\nEvery debug instance has a color generated for it based on its namespace name.\nThis helps when visually parsing the debug output to identify which debug instance\na debug line belongs to.\n\n#### Node.js\n\nIn Node.js, colors are enabled when stderr is a TTY. You also _should_ install\nthe [`supports-color`](https://npmjs.org/supports-color) module alongside debug,\notherwise debug will only use a small handful of basic colors.\n\n<img width=\"521\" src=\"https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png\">\n\n#### Web Browser\n\nColors are also enabled on \"Web Inspectors\" that understand the `%c` formatting\noption. These are WebKit web inspectors, Firefox ([since version\n31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/))\nand the Firebug plugin for Firefox (any version).\n\n<img width=\"524\" src=\"https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png\">\n\n## Millisecond diff\n\nWhen actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the \"+NNNms\" will show you how much time was spent between calls.\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png\">\n\nWhen stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below:\n\n<img width=\"647\" src=\"https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png\">\n\n## Conventions\n\nIf you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use \":\" to separate features. For example \"bodyParser\" from Connect would then be \"connect:bodyParser\". If you append a \"*\" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output.\n\n## Wildcards\n\nThe `*` character may be used as a wildcard. Suppose for example your library has\ndebuggers named \"connect:bodyParser\", \"connect:compress\", \"connect:session\",\ninstead of listing all three with\n`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do\n`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`.\n\nYou can also exclude specific debuggers by prefixing them with a \"-\" character.\nFor example, `DEBUG=*,-connect:*` would include all debuggers except those\nstarting with \"connect:\".\n\n## Environment Variables\n\nWhen running through Node.js, you can set a few environment variables that will\nchange the behavior of the debug logging:\n\n| Name | Purpose |\n|-----------|-------------------------------------------------|\n| `DEBUG` | Enables/disables specific debugging namespaces. |\n| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). |\n| `DEBUG_COLORS`| Whether or not to use colors in the debug output. |\n| `DEBUG_DEPTH` | Object inspection depth. |\n| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |\n\n__Note:__ The environment variables beginning with `DEBUG_` end up being\nconverted into an Options object that gets used with `%o`/`%O` formatters.\nSee the Node.js documentation for\n[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options)\nfor the complete list.\n\n## Formatters\n\nDebug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting.\nBelow are the officially supported formatters:\n\n| Formatter | Representation |\n|-----------|----------------|\n| `%O` | Pretty-print an Object on multiple lines. |\n| `%o` | Pretty-print an Object all on a single line. |\n| `%s` | String. |\n| `%d` | Number (both integer and float). |\n| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. |\n| `%%` | Single percent sign ('%'). This does not consume an argument. |\n\n### Custom formatters\n\nYou can add custom formatters by extending the `debug.formatters` object.\nFor example, if you wanted to add support for rendering a Buffer as hex with\n`%h`, you could do something like:\n\n```js\nconst createDebug = require('debug')\ncreateDebug.formatters.h = (v) => {\n return v.toString('hex')\n}\n\n// …elsewhere\nconst debug = createDebug('foo')\ndebug('this is hex: %h', new Buffer('hello world'))\n// foo this is hex: 68656c6c6f20776f726c6421 +0ms\n```\n\n## Browser Support\n\nYou can build a browser-ready script using [browserify](https://github.com/substack/node-browserify),\nor just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest),\nif you don't want to build it yourself.\n\nDebug's enable state is currently persisted by `localStorage`.\nConsider the situation shown below where you have `worker:a` and `worker:b`,\nand wish to debug both. You can enable this using `localStorage.debug`:\n\n```js\nlocalStorage.debug = 'worker:*'\n```\n\nAnd then refresh the page.\n\n```js\na = debug('worker:a');\nb = debug('worker:b');\n\nsetInterval(function(){\n a('doing some work');\n}, 1000);\n\nsetInterval(function(){\n b('doing some work');\n}, 1200);\n```\n\n## Output streams\n\n By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method:\n\nExample [_stdout.js_](./examples/node/stdout.js):\n\n```js\nvar debug = require('debug');\nvar error = debug('app:error');\n\n// by default stderr is used\nerror('goes to stderr!');\n\nvar log = debug('app:log');\n// set this namespace to log via console.log\nlog.log = console.log.bind(console); // don't forget to bind to console!\nlog('goes to stdout');\nerror('still goes to stderr!');\n\n// set all output to go via console.info\n// overrides all per-namespace log settings\ndebug.log = console.info.bind(console);\nerror('now goes to stdout via console.info');\nlog('still goes to stdout, but via console.info now');\n```\n\n## Checking whether a debug target is enabled\n\nAfter you've created a debug instance, you can determine whether or not it is\nenabled by checking the `enabled` property:\n\n```javascript\nconst debug = require('debug')('http');\n\nif (debug.enabled) {\n // do stuff...\n}\n```\n\nYou can also manually toggle this property to force the debug instance to be\nenabled or disabled.\n\n## Authors\n\n - TJ Holowaychuk\n - Nathan Rajlich\n - Andrew Rhyne\n\n## Backers\n\nSupport us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)]\n\n<a href=\"https://opencollective.com/debug/backer/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/backer/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/backer/29/avatar.svg\"></a>\n\n## Sponsors\n\nBecome a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)]\n\n<a href=\"https://opencollective.com/debug/sponsor/0/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/0/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/1/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/1/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/2/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/2/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/3/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/3/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/4/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/4/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/5/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/5/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/6/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/6/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/7/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/7/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/8/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/8/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/9/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/9/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/10/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/10/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/11/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/11/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/12/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/12/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/13/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/13/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/14/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/14/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/15/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/15/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/16/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/16/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/17/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/17/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/18/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/18/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/19/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/19/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/20/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/20/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/21/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/21/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/22/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/22/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/23/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/23/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/24/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/24/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/25/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/25/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/26/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/26/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/27/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/27/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/28/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/28/avatar.svg\"></a>\n<a href=\"https://opencollective.com/debug/sponsor/29/website\" target=\"_blank\"><img src=\"https://opencollective.com/debug/sponsor/29/avatar.svg\"></a>\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n<h1 align=\"center\">\n <img width=\"100\" height=\"100\" src=\"logo.svg\" alt=\"\"><br>\n jsdom\n</h1>\n\njsdom is a pure-JavaScript implementation of many web standards, notably the WHATWG [DOM](https://dom.spec.whatwg.org/) and [HTML](https://html.spec.whatwg.org/multipage/) Standards, for use with Node.js. In general, the goal of the project is to emulate enough of a subset of a web browser to be useful for testing and scraping real-world web applications.\n\nThe latest versions of jsdom require Node.js v10 or newer. (Versions of jsdom below v16 still work with previous Node.js versions, but are unsupported.)\n\n## Basic usage\n\n```js\nconst jsdom = require(\"jsdom\");\nconst { JSDOM } = jsdom;\n```\n\nTo use jsdom, you will primarily use the `JSDOM` constructor, which is a named export of the jsdom main module. Pass the constructor a string. You will get back a `JSDOM` object, which has a number of useful properties, notably `window`:\n\n```js\nconst dom = new JSDOM(`<!DOCTYPE html><p>Hello world</p>`);\nconsole.log(dom.window.document.querySelector(\"p\").textContent); // \"Hello world\"\n```\n\n(Note that jsdom will parse the HTML you pass it just like a browser does, including implied `<html>`, `<head>`, and `<body>` tags.)\n\nThe resulting object is an instance of the `JSDOM` class, which contains a number of useful properties and methods besides `window`. In general, it can be used to act on the jsdom from the \"outside,\" doing things that are not possible with the normal DOM APIs. For simple cases, where you don't need any of this functionality, we recommend a coding pattern like\n\n```js\nconst { window } = new JSDOM(`...`);\n// or even\nconst { document } = (new JSDOM(`...`)).window;\n```\n\nFull documentation on everything you can do with the `JSDOM` class is below, in the section \"`JSDOM` Object API\".\n\n## Customizing jsdom\n\nThe `JSDOM` constructor accepts a second parameter which can be used to customize your jsdom in the following ways.\n\n### Simple options\n\n```js\nconst dom = new JSDOM(``, {\n url: \"https://example.org/\",\n referrer: \"https://example.com/\",\n contentType: \"text/html\",\n includeNodeLocations: true,\n storageQuota: 10000000\n});\n```\n\n- `url` sets the value returned by `window.location`, `document.URL`, and `document.documentURI`, and affects things like resolution of relative URLs within the document and the same-origin restrictions and referrer used while fetching subresources. It defaults to `\"about:blank\"`.\n- `referrer` just affects the value read from `document.referrer`. It defaults to no referrer (which reflects as the empty string).\n- `contentType` affects the value read from `document.contentType`, as well as how the document is parsed: as HTML or as XML. Values that are not a [HTML mime type](https://mimesniff.spec.whatwg.org/#html-mime-type) or an [XML mime type](https://mimesniff.spec.whatwg.org/#xml-mime-type) will throw. It defaults to `\"text/html\"`. If a `charset` parameter is present, it can affect [binary data processing](#encoding-sniffing).\n- `includeNodeLocations` preserves the location info produced by the HTML parser, allowing you to retrieve it with the `nodeLocation()` method (described below). It also ensures that line numbers reported in exception stack traces for code running inside `<script>` elements are correct. It defaults to `false` to give the best performance, and cannot be used with an XML content type since our XML parser does not support location info.\n- `storageQuota` is the maximum size in code units for the separate storage areas used by `localStorage` and `sessionStorage`. Attempts to store data larger than this limit will cause a `DOMException` to be thrown. By default, it is set to 5,000,000 code units per origin, as inspired by the HTML specification.\n\nNote that both `url` and `referrer` are canonicalized before they're used, so e.g. if you pass in `\"https:example.com\"`, jsdom will interpret that as if you had given `\"https://example.com/\"`. If you pass an unparseable URL, the call will throw. (URLs are parsed and serialized according to the [URL Standard](http://url.spec.whatwg.org/).)\n\n### Executing scripts\n\njsdom's most powerful ability is that it can execute scripts inside the jsdom. These scripts can modify the content of the page and access all the web platform APIs jsdom implements.\n\nHowever, this is also highly dangerous when dealing with untrusted content. The jsdom sandbox is not foolproof, and code running inside the DOM's `<script>`s can, if it tries hard enough, get access to the Node.js environment, and thus to your machine. As such, the ability to execute scripts embedded in the HTML is disabled by default:\n\n```js\nconst dom = new JSDOM(`<body>\n <script>document.body.appendChild(document.createElement(\"hr\"));</script>\n</body>`);\n\n// The script will not be executed, by default:\ndom.window.document.body.children.length === 1;\n```\n\nTo enable executing scripts inside the page, you can use the `runScripts: \"dangerously\"` option:\n\n```js\nconst dom = new JSDOM(`<body>\n <script>document.body.appendChild(document.createElement(\"hr\"));</script>\n</body>`, { runScripts: \"dangerously\" });\n\n// The script will be executed and modify the DOM:\ndom.window.document.body.children.length === 2;\n```\n\nAgain we emphasize to only use this when feeding jsdom code you know is safe. If you use it on arbitrary user-supplied code, or code from the Internet, you are effectively running untrusted Node.js code, and your machine could be compromised.\n\nIf you want to execute _external_ scripts, included via `<script src=\"\">`, you'll also need to ensure that they load them. To do this, add the option `resources: \"usable\"` [as described below](#loading-subresources). (You'll likely also want to set the `url` option, for the reasons discussed there.)\n\nEvent handler attributes, like `<div onclick=\"\">`, are also governed by this setting; they will not function unless `runScripts` is set to `\"dangerously\"`. (However, event handler _properties_, like `div.onclick = ...`, will function regardless of `runScripts`.)\n\nIf you are simply trying to execute script \"from the outside\", instead of letting `<script>` elements and event handlers attributes run \"from the inside\", you can use the `runScripts: \"outside-only\"` option, which enables fresh copies of all the JavaScript spec-provided globals to be installed on `window`. This includes things like `window.Array`, `window.Promise`, etc. It also, notably, includes `window.eval`, which allows running scripts, but with the jsdom `window` as the global:\n\n```js\nconst { window } = new JSDOM(``, { runScripts: \"outside-only\" });\n\nwindow.eval(`document.body.innerHTML = \"<p>Hello, world!</p>\";`);\nwindow.document.body.children.length === 1;\n```\n\nThis is turned off by default for performance reasons, but is safe to enable.\n\n(Note that in the default configuration, without setting `runScripts`, the values of `window.Array`, `window.eval`, etc. will be the same as those provided by the outer Node.js environment. That is, `window.eval === eval` will hold, so `window.eval` will not run scripts in a useful way.)\n\nWe strongly advise against trying to \"execute scripts\" by mashing together the jsdom and Node global environments (e.g. by doing `global.window = dom.window`), and then executing scripts or test code inside the Node global environment. Instead, you should treat jsdom like you would a browser, and run all scripts and tests that need access to a DOM inside the jsdom environment, using `window.eval` or `runScripts: \"dangerously\"`. This might require, for example, creating a browserify bundle to execute as a `<script>` element—just like you would in a browser.\n\nFinally, for advanced use cases you can use the `dom.getInternalVMContext()` method, documented below.\n\n### Pretending to be a visual browser\n\njsdom does not have the capability to render visual content, and will act like a headless browser by default. It provides hints to web pages through APIs such as `document.hidden` that their content is not visible.\n\nWhen the `pretendToBeVisual` option is set to `true`, jsdom will pretend that it is rendering and displaying content. It does this by:\n\n* Changing `document.hidden` to return `false` instead of `true`\n* Changing `document.visibilityState` to return `\"visible\"` instead of `\"prerender\"`\n* Enabling `window.requestAnimationFrame()` and `window.cancelAnimationFrame()` methods, which otherwise do not exist\n\n```js\nconst window = (new JSDOM(``, { pretendToBeVisual: true })).window;\n\nwindow.requestAnimationFrame(timestamp => {\n console.log(timestamp > 0);\n});\n```\n\nNote that jsdom still [does not do any layout or rendering](#unimplemented-parts-of-the-web-platform), so this is really just about _pretending_ to be visual, not about implementing the parts of the platform a real, visual web browser would implement.\n\n### Loading subresources\n\n#### Basic options\n\nBy default, jsdom will not load any subresources such as scripts, stylesheets, images, or iframes. If you'd like jsdom to load such resources, you can pass the `resources: \"usable\"` option, which will load all usable resources. Those are:\n\n* Frames and iframes, via `<frame>` and `<iframe>`\n* Stylesheets, via `<link rel=\"stylesheet\">`\n* Scripts, via `<script>`, but only if `runScripts: \"dangerously\"` is also set\n* Images, via `<img>`, but only if the `canvas` npm package is also installed (see \"[Canvas Support](#canvas-support)\" below)\n\nWhen attempting to load resources, recall that the default value for the `url` option is `\"about:blank\"`, which means that any resources included via relative URLs will fail to load. (The result of trying to parse the URL `/something` against the URL `about:blank` is an error.) So, you'll likely want to set a non-default value for the `url` option in those cases, or use one of the [convenience APIs](#convenience-apis) that do so automatically.\n\n#### Advanced configuration\n\n_This resource loader system is new as of jsdom v12.0.0, and we'd love your feedback on whether it meets your needs and how easy it is to use. Please file an issue to discuss!_\n\nTo more fully customize jsdom's resource-loading behavior, you can pass an instance of the `ResourceLoader` class as the `resources` option value:\n\n```js\nconst resourceLoader = new jsdom.ResourceLoader({\n proxy: \"http://127.0.0.1:9001\",\n strictSSL: false,\n userAgent: \"Mellblomenator/9000\",\n});\nconst dom = new JSDOM(``, { resources: resourceLoader });\n```\n\nThe three options to the `ResourceLoader` constructor are:\n\n- `proxy` is the address of an HTTP proxy to be used.\n- `strictSSL` can be set to false to disable the requirement that SSL certificates be valid.\n- `userAgent` affects the `User-Agent` header sent, and thus the resulting value for `navigator.userAgent`. It defaults to <code>\\`Mozilla/5.0 (${process.platform || \"unknown OS\"}) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/${jsdomVersion}\\`</code>.\n\nYou can further customize resource fetching by subclassing `ResourceLoader` and overriding the `fetch()` method. For example, here is a version that only returns results for requests to a trusted origin:\n\n```js\nclass CustomResourceLoader extends jsdom.ResourceLoader {\n fetch(url, options) {\n // Override the contents of this script to do something unusual.\n if (url === \"https://example.com/some-specific-script.js\") {\n return Promise.resolve(Buffer.from(\"window.someGlobal = 5;\"));\n }\n\n return super.fetch(url, options);\n }\n}\n```\n\njsdom will call your custom resource loader's `fetch()` method whenever it encounters a \"usable\" resource, per the above section. The method takes a URL string, as well as a few options which you should pass through unmodified if calling `super.fetch()`. It must return a promise for a Node.js `Buffer` object, or return `null` if the resource is intentionally not to be loaded. In general, most cases will want to delegate to `super.fetch()`, as shown.\n\nOne of the options you will receive in `fetch()` will be the element (if applicable) that is fetching a resource.\n\n```js\nclass CustomResourceLoader extends jsdom.ResourceLoader {\n fetch(url, options) {\n if (options.element) {\n console.log(`Element ${options.element.localName} is requesting the url ${url}`);\n }\n\n return super.fetch(url, options);\n }\n}\n```\n\n### Virtual consoles\n\nLike web browsers, jsdom has the concept of a \"console\". This records both information directly sent from the page, via scripts executing inside the document, as well as information from the jsdom implementation itself. We call the user-controllable console a \"virtual console\", to distinguish it from the Node.js `console` API and from the inside-the-page `window.console` API.\n\nBy default, the `JSDOM` constructor will return an instance with a virtual console that forwards all its output to the Node.js console. To create your own virtual console and pass it to jsdom, you can override this default by doing\n\n```js\nconst virtualConsole = new jsdom.VirtualConsole();\nconst dom = new JSDOM(``, { virtualConsole });\n```\n\nCode like this will create a virtual console with no behavior. You can give it behavior by adding event listeners for all the possible console methods:\n\n```js\nvirtualConsole.on(\"error\", () => { ... });\nvirtualConsole.on(\"warn\", () => { ... });\nvirtualConsole.on(\"info\", () => { ... });\nvirtualConsole.on(\"dir\", () => { ... });\n// ... etc. See https://console.spec.whatwg.org/#logging\n```\n\n(Note that it is probably best to set up these event listeners *before* calling `new JSDOM()`, since errors or console-invoking script might occur during parsing.)\n\nIf you simply want to redirect the virtual console output to another console, like the default Node.js one, you can do\n\n```js\nvirtualConsole.sendTo(console);\n```\n\nThere is also a special event, `\"jsdomError\"`, which will fire with error objects to report errors from jsdom itself. This is similar to how error messages often show up in web browser consoles, even if they are not initiated by `console.error`. So far, the following errors are output this way:\n\n- Errors loading or parsing subresources (scripts, stylesheets, frames, and iframes)\n- Script execution errors that are not handled by a window `onerror` event handler that returns `true` or calls `event.preventDefault()`\n- Not-implemented errors resulting from calls to methods, like `window.alert`, which jsdom does not implement, but installs anyway for web compatibility\n\nIf you're using `sendTo(c)` to send errors to `c`, by default it will call `c.error(errorStack[, errorDetail])` with information from `\"jsdomError\"` events. If you'd prefer to maintain a strict one-to-one mapping of events to method calls, and perhaps handle `\"jsdomError\"`s yourself, then you can do\n\n```js\nvirtualConsole.sendTo(c, { omitJSDOMErrors: true });\n```\n\n### Cookie jars\n\nLike web browsers, jsdom has the concept of a cookie jar, storing HTTP cookies. Cookies that have a URL on the same domain as the document, and are not marked HTTP-only, are accessible via the `document.cookie` API. Additionally, all cookies in the cookie jar will impact the fetching of subresources.\n\nBy default, the `JSDOM` constructor will return an instance with an empty cookie jar. To create your own cookie jar and pass it to jsdom, you can override this default by doing\n\n```js\nconst cookieJar = new jsdom.CookieJar(store, options);\nconst dom = new JSDOM(``, { cookieJar });\n```\n\nThis is mostly useful if you want to share the same cookie jar among multiple jsdoms, or prime the cookie jar with certain values ahead of time.\n\nCookie jars are provided by the [tough-cookie](https://www.npmjs.com/package/tough-cookie) package. The `jsdom.CookieJar` constructor is a subclass of the tough-cookie cookie jar which by default sets the `looseMode: true` option, since that [matches better how browsers behave](https://github.com/whatwg/html/issues/804). If you want to use tough-cookie's utilities and classes yourself, you can use the `jsdom.toughCookie` module export to get access to the tough-cookie module instance packaged with jsdom.\n\n### Intervening before parsing\n\njsdom allows you to intervene in the creation of a jsdom very early: after the `Window` and `Document` objects are created, but before any HTML is parsed to populate the document with nodes:\n\n```js\nconst dom = new JSDOM(`<p>Hello</p>`, {\n beforeParse(window) {\n window.document.childNodes.length === 0;\n window.someCoolAPI = () => { /* ... */ };\n }\n});\n```\n\nThis is especially useful if you are wanting to modify the environment in some way, for example adding shims for web platform APIs jsdom does not support.\n\n## `JSDOM` object API\n\nOnce you have constructed a `JSDOM` object, it will have the following useful capabilities:\n\n### Properties\n\nThe property `window` retrieves the `Window` object that was created for you.\n\nThe properties `virtualConsole` and `cookieJar` reflect the options you pass in, or the defaults created for you if nothing was passed in for those options.\n\n### Serializing the document with `serialize()`\n\nThe `serialize()` method will return the [HTML serialization](https://html.spec.whatwg.org/#html-fragment-serialisation-algorithm) of the document, including the doctype:\n\n```js\nconst dom = new JSDOM(`<!DOCTYPE html>hello`);\n\ndom.serialize() === \"<!DOCTYPE html><html><head></head><body>hello</body></html>\";\n\n// Contrast with:\ndom.window.document.documentElement.outerHTML === \"<html><head></head><body>hello</body></html>\";\n```\n\n### Getting the source location of a node with `nodeLocation(node)`\n\nThe `nodeLocation()` method will find where a DOM node is within the source document, returning the [parse5 location info](https://www.npmjs.com/package/parse5#options-locationinfo) for the node:\n\n```js\nconst dom = new JSDOM(\n `<p>Hello\n <img src=\"foo.jpg\">\n </p>`,\n { includeNodeLocations: true }\n);\n\nconst document = dom.window.document;\nconst bodyEl = document.body; // implicitly created\nconst pEl = document.querySelector(\"p\");\nconst textNode = pEl.firstChild;\nconst imgEl = document.querySelector(\"img\");\n\nconsole.log(dom.nodeLocation(bodyEl)); // null; it's not in the source\nconsole.log(dom.nodeLocation(pEl)); // { startOffset: 0, endOffset: 39, startTag: ..., endTag: ... }\nconsole.log(dom.nodeLocation(textNode)); // { startOffset: 3, endOffset: 13 }\nconsole.log(dom.nodeLocation(imgEl)); // { startOffset: 13, endOffset: 32 }\n```\n\nNote that this feature only works if you have set the `includeNodeLocations` option; node locations are off by default for performance reasons.\n\n### Interfacing with the Node.js `vm` module using `getInternalVMContext()`\n\nThe built-in [`vm`](https://nodejs.org/api/vm.html) module of Node.js is what underpins jsdom's script-running magic. Some advanced use cases, like pre-compiling a script and then running it multiple times, benefit from using the `vm` module directly with a jsdom-created `Window`.\n\nTo get access to the [contextified global object](https://nodejs.org/api/vm.html#vm_what_does_it_mean_to_contextify_an_object), suitable for use with the `vm` APIs, you can use the `getInternalVMContext()` method:\n\n```js\nconst { Script } = require(\"vm\");\n\nconst dom = new JSDOM(``, { runScripts: \"outside-only\" });\nconst script = new Script(`\n if (!this.ran) {\n this.ran = 0;\n }\n\n ++this.ran;\n`);\n\nconst vmContext = dom.getInternalVMContext();\n\nscript.runInContext(vmContext);\nscript.runInContext(vmContext);\nscript.runInContext(vmContext);\n\nconsole.assert(dom.window.ran === 3);\n```\n\nThis is somewhat-advanced functionality, and we advise sticking to normal DOM APIs (such as `window.eval()` or `document.createElement(\"script\")`) unless you have very specific needs.\n\nNote that this method will throw an exception if the `JSDOM` instance was created without `runScripts` set, or if you are [using jsdom in a web browser](#running-jsdom-inside-a-web-browser).\n\n### Reconfiguring the jsdom with `reconfigure(settings)`\n\nThe `top` property on `window` is marked `[Unforgeable]` in the spec, meaning it is a non-configurable own property and thus cannot be overridden or shadowed by normal code running inside the jsdom, even using `Object.defineProperty`.\n\nSimilarly, at present jsdom does not handle navigation (such as setting `window.location.href = \"https://example.com/\"`); doing so will cause the virtual console to emit a `\"jsdomError\"` explaining that this feature is not implemented, and nothing will change: there will be no new `Window` or `Document` object, and the existing `window`'s `location` object will still have all the same property values.\n\nHowever, if you're acting from outside the window, e.g. in some test framework that creates jsdoms, you can override one or both of these using the special `reconfigure()` method:\n\n```js\nconst dom = new JSDOM();\n\ndom.window.top === dom.window;\ndom.window.location.href === \"about:blank\";\n\ndom.reconfigure({ windowTop: myFakeTopForTesting, url: \"https://example.com/\" });\n\ndom.window.top === myFakeTopForTesting;\ndom.window.location.href === \"https://example.com/\";\n```\n\nNote that changing the jsdom's URL will impact all APIs that return the current document URL, such as `window.location`, `document.URL`, and `document.documentURI`, as well as the resolution of relative URLs within the document, and the same-origin checks and referrer used while fetching subresources. It will not, however, perform navigation to the contents of that URL; the contents of the DOM will remain unchanged, and no new instances of `Window`, `Document`, etc. will be created.\n\n## Convenience APIs\n\n### `fromURL()`\n\nIn addition to the `JSDOM` constructor itself, jsdom provides a promise-returning factory method for constructing a jsdom from a URL:\n\n```js\nJSDOM.fromURL(\"https://example.com/\", options).then(dom => {\n console.log(dom.serialize());\n});\n```\n\nThe returned promise will fulfill with a `JSDOM` instance if the URL is valid and the request is successful. Any redirects will be followed to their ultimate destination.\n\nThe options provided to `fromURL()` are similar to those provided to the `JSDOM` constructor, with the following additional restrictions and consequences:\n\n- The `url` and `contentType` options cannot be provided.\n- The `referrer` option is used as the HTTP `Referer` request header of the initial request.\n- The `resources` option also affects the initial request; this is useful if you want to, for example, configure a proxy (see above).\n- The resulting jsdom's URL, content type, and referrer are determined from the response.\n- Any cookies set via HTTP `Set-Cookie` response headers are stored in the jsdom's cookie jar. Similarly, any cookies already in a supplied cookie jar are sent as HTTP `Cookie` request headers.\n\n### `fromFile()`\n\nSimilar to `fromURL()`, jsdom also provides a `fromFile()` factory method for constructing a jsdom from a filename:\n\n```js\nJSDOM.fromFile(\"stuff.html\", options).then(dom => {\n console.log(dom.serialize());\n});\n```\n\nThe returned promise will fulfill with a `JSDOM` instance if the given file can be opened. As usual in Node.js APIs, the filename is given relative to the current working directory.\n\nThe options provided to `fromFile()` are similar to those provided to the `JSDOM` constructor, with the following additional defaults:\n\n- The `url` option will default to a file URL corresponding to the given filename, instead of to `\"about:blank\"`.\n- The `contentType` option will default to `\"application/xhtml+xml\"` if the given filename ends in `.xht`, `.xhtml`, or `.xml`; otherwise it will continue to default to `\"text/html\"`.\n\n### `fragment()`\n\nFor the very simplest of cases, you might not need a whole `JSDOM` instance with all its associated power. You might not even need a `Window` or `Document`! Instead, you just need to parse some HTML, and get a DOM object you can manipulate. For that, we have `fragment()`, which creates a `DocumentFragment` from a given string:\n\n```js\nconst frag = JSDOM.fragment(`<p>Hello</p><p><strong>Hi!</strong>`);\n\nfrag.childNodes.length === 2;\nfrag.querySelector(\"strong\").textContent === \"Hi!\";\n// etc.\n```\n\nHere `frag` is a [`DocumentFragment`](https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment) instance, whose contents are created by parsing the provided string. The parsing is done using a `<template>` element, so you can include any element there (including ones with weird parsing rules like `<td>`). It's also important to note that the resulting `DocumentFragment` will not have [an associated browsing context](https://html.spec.whatwg.org/multipage/#concept-document-bc): that is, elements' `ownerDocument` will have a null `defaultView` property, resources will not load, etc.\n\nAll invocations of the `fragment()` factory result in `DocumentFragment`s that share the same template owner `Document`. This allows many calls to `fragment()` with no extra overhead. But it also means that calls to `fragment()` cannot be customized with any options.\n\nNote that serialization is not as easy with `DocumentFragment`s as it is with full `JSDOM` objects. If you need to serialize your DOM, you should probably use the `JSDOM` constructor more directly. But for the special case of a fragment containing a single element, it's pretty easy to do through normal means:\n\n```js\nconst frag = JSDOM.fragment(`<p>Hello</p>`);\nconsole.log(frag.firstChild.outerHTML); // logs \"<p>Hello</p>\"\n```\n\n## Other noteworthy features\n\n### Canvas support\n\njsdom includes support for using the [`canvas`](https://www.npmjs.com/package/canvas) package to extend any `<canvas>` elements with the canvas API. To make this work, you need to include `canvas` as a dependency in your project, as a peer of `jsdom`. If jsdom can find the `canvas` package, it will use it, but if it's not present, then `<canvas>` elements will behave like `<div>`s. Since jsdom v13, version 2.x of `canvas` is required; version 1.x is no longer supported.\n\n### Encoding sniffing\n\nIn addition to supplying a string, the `JSDOM` constructor can also be supplied binary data, in the form of a Node.js [`Buffer`](https://nodejs.org/docs/latest/api/buffer.html) or a standard JavaScript binary data type like `ArrayBuffer`, `Uint8Array`, `DataView`, etc. When this is done, jsdom will [sniff the encoding](https://html.spec.whatwg.org/multipage/syntax.html#encoding-sniffing-algorithm) from the supplied bytes, scanning for `<meta charset>` tags just like a browser does.\n\nIf the supplied `contentType` option contains a `charset` parameter, that encoding will override the sniffed encoding—unless a UTF-8 or UTF-16 BOM is present, in which case those take precedence. (Again, this is just like a browser.)\n\nThis encoding sniffing also applies to `JSDOM.fromFile()` and `JSDOM.fromURL()`. In the latter case, any `Content-Type` headers sent with the response will take priority, in the same fashion as the constructor's `contentType` option.\n\nNote that in many cases supplying bytes in this fashion can be better than supplying a string. For example, if you attempt to use Node.js's `buffer.toString(\"utf-8\")` API, Node.js will not strip any leading BOMs. If you then give this string to jsdom, it will interpret it verbatim, leaving the BOM intact. But jsdom's binary data decoding code will strip leading BOMs, just like a browser; in such cases, supplying `buffer` directly will give the desired result.\n\n### Closing down a jsdom\n\nTimers in the jsdom (set by `window.setTimeout()` or `window.setInterval()`) will, by definition, execute code in the future in the context of the window. Since there is no way to execute code in the future without keeping the process alive, outstanding jsdom timers will keep your Node.js process alive. Similarly, since there is no way to execute code in the context of an object without keeping that object alive, outstanding jsdom timers will prevent garbage collection of the window on which they are scheduled.\n\nIf you want to be sure to shut down a jsdom window, use `window.close()`, which will terminate all running timers (and also remove any event listeners on the window and document).\n\n### Running jsdom inside a web browser\n\njsdom has some support for being run inside a web browser, using [browserify](https://browserify.org/). That is, inside a web browser, you can use a browserified jsdom to create an entirely self-contained set of plain JavaScript objects which look and act much like the browser's existing DOM objects, while being entirely independent of them. \"Virtual DOM\", indeed!\n\njsdom's primary target is still Node.js, and so we use language features that are only present in recent Node.js versions (namely, Node.js v8+). Thus, older browsers will likely not work. (Even transpilation will not help: we use `Proxy`s extensively throughout the jsdom codebase.)\n\nNotably, jsdom works well inside a web worker. The original contributor, [@lawnsea](https://github.com/lawnsea/), who made this possible, has [published a paper](https://pdfs.semanticscholar.org/47f0/6bb6607a975500a30e9e52d7c9fbc0034e27.pdf) about his project which uses this capability.\n\nNot everything works perfectly when running jsdom inside a web browser. Sometimes that is because of fundamental limitations (such as not having filesystem access), but sometimes it is simply because we haven't spent enough time making the appropriate small tweaks. Bug reports are certainly welcome.\n\n### Debugging the DOM using Chrome Devtools\n\nAs of Node.js v6 you can debug programs using Chrome Devtools. See the [official documentation](https://nodejs.org/en/docs/inspector/) for how to get started.\n\nBy default jsdom elements are formatted as plain old JS objects in the console. To make it easier to debug, you can use [jsdom-devtools-formatter](https://github.com/viddo/jsdom-devtools-formatter), which lets you inspect them like real DOM elements.\n\n## Caveats\n\n### Asynchronous script loading\n\nPeople often have trouble with asynchronous script loading when using jsdom. Many pages load scripts asynchronously, but there is no way to tell when they're done doing so, and thus when it's a good time to run your code and inspect the resulting DOM structure. This is a fundamental limitation; we cannot predict what scripts on the web page will do, and so cannot tell you when they are done loading more scripts.\n\nThis can be worked around in a few ways. The best way, if you control the page in question, is to use whatever mechanisms are given by the script loader to detect when loading is done. For example, if you're using a module loader like RequireJS, the code could look like:\n\n```js\n// On the Node.js side:\nconst window = (new JSDOM(...)).window;\nwindow.onModulesLoaded = () => {\n console.log(\"ready to roll!\");\n};\n```\n\n```html\n<!-- Inside the HTML you supply to jsdom -->\n<script>\nrequirejs([\"entry-module\"], () => {\n window.onModulesLoaded();\n});\n</script>\n```\n\nIf you do not control the page, you could try workarounds such as polling for the presence of a specific element.\n\nFor more details, see the discussion in [#640](https://github.com/jsdom/jsdom/issues/640), especially [@matthewkastor](https://github.com/matthewkastor)'s [insightful comment](https://github.com/jsdom/jsdom/issues/640#issuecomment-22216965).\n\n### Unimplemented parts of the web platform\n\nAlthough we enjoy adding new features to jsdom and keeping it up to date with the latest web specs, it has many missing APIs. Please feel free to file an issue for anything missing, but we're a small and busy team, so a pull request might work even better.\n\nBeyond just features that we haven't gotten to yet, there are two major features that are currently outside the scope of jsdom. These are:\n\n- **Navigation**: the ability to change the global object, and all other objects, when clicking a link or assigning `location.href` or similar.\n- **Layout**: the ability to calculate where elements will be visually laid out as a result of CSS, which impacts methods like `getBoundingClientRects()` or properties like `offsetTop`.\n\nCurrently jsdom has dummy behaviors for some aspects of these features, such as sending a \"not implemented\" `\"jsdomError\"` to the virtual console for navigation, or returning zeros for many layout-related properties. Often you can work around these limitations in your code, e.g. by creating new `JSDOM` instances for each page you \"navigate\" to during a crawl, or using `Object.defineProperty()` to change what various layout-related getters and methods return.\n\nNote that other tools in the same space, such as PhantomJS, do support these features. On the wiki, we have a more complete writeup about [jsdom vs. PhantomJS](https://github.com/jsdom/jsdom/wiki/jsdom-vs.-PhantomJS).\n\n## Supporting jsdom\n\njsdom is a community-driven project maintained by a team of [volunteers](https://github.com/orgs/jsdom/people). You could support jsdom by:\n\n- [Getting professional support for jsdom](https://tidelift.com/subscription/pkg/npm-jsdom?utm_source=npm-jsdom&utm_medium=referral&utm_campaign=readme) as part of a Tidelift subscription. Tidelift helps making open source sustainable for us while giving teams assurances for maintenance, licensing, and security.\n- [Contributing](https://github.com/jsdom/jsdom/blob/master/Contributing.md) directly to the project.\n\n## Getting help\n\nIf you need help with jsdom, please feel free to use any of the following venues:\n\n- The [mailing list](http://groups.google.com/group/jsdom) (best for \"how do I\" questions)\n- The [issue tracker](https://github.com/jsdom/jsdom/issues) (best for bug reports)\n- The IRC channel: [#jsdom on freenode](irc://irc.freenode.net/jsdom)\n# tslib\n\nThis is a runtime library for [TypeScript](http://www.typescriptlang.org/) that contains all of the TypeScript helper functions.\n\nThis library is primarily used by the `--importHelpers` flag in TypeScript.\nWhen using `--importHelpers`, a module that uses helper functions like `__extends` and `__assign` in the following emitted file:\n\n```ts\nvar __assign = (this && this.__assign) || Object.assign || function(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))\n t[p] = s[p];\n }\n return t;\n};\nexports.x = {};\nexports.y = __assign({}, exports.x);\n\n```\n\nwill instead be emitted as something like the following:\n\n```ts\nvar tslib_1 = require(\"tslib\");\nexports.x = {};\nexports.y = tslib_1.__assign({}, exports.x);\n```\n\nBecause this can avoid duplicate declarations of things like `__extends`, `__assign`, etc., this means delivering users smaller files on average, as well as less runtime overhead.\nFor optimized bundles with TypeScript, you should absolutely consider using `tslib` and `--importHelpers`.\n\n# Installing\n\nFor the latest stable version, run:\n\n## npm\n\n```sh\n# TypeScript 2.3.3 or later\nnpm install --save tslib\n\n# TypeScript 2.3.2 or earlier\nnpm install --save tslib@1.6.1\n```\n\n## yarn\n\n```sh\n# TypeScript 2.3.3 or later\nyarn add tslib\n\n# TypeScript 2.3.2 or earlier\nyarn add tslib@1.6.1\n```\n\n## bower\n\n```sh\n# TypeScript 2.3.3 or later\nbower install tslib\n\n# TypeScript 2.3.2 or earlier\nbower install tslib@1.6.1\n```\n\n## JSPM\n\n```sh\n# TypeScript 2.3.3 or later\njspm install tslib\n\n# TypeScript 2.3.2 or earlier\njspm install tslib@1.6.1\n```\n\n# Usage\n\nSet the `importHelpers` compiler option on the command line:\n\n```\ntsc --importHelpers file.ts\n```\n\nor in your tsconfig.json:\n\n```json\n{\n \"compilerOptions\": {\n \"importHelpers\": true\n }\n}\n```\n\n#### For bower and JSPM users\n\nYou will need to add a `paths` mapping for `tslib`, e.g. For Bower users:\n\n```json\n{\n \"compilerOptions\": {\n \"module\": \"amd\",\n \"importHelpers\": true,\n \"baseUrl\": \"./\",\n \"paths\": {\n \"tslib\" : [\"bower_components/tslib/tslib.d.ts\"]\n }\n }\n}\n```\n\nFor JSPM users:\n\n```json\n{\n \"compilerOptions\": {\n \"module\": \"system\",\n \"importHelpers\": true,\n \"baseUrl\": \"./\",\n \"paths\": {\n \"tslib\" : [\"jspm_packages/npm/tslib@1.13.0/tslib.d.ts\"]\n }\n }\n}\n```\n\n# Contribute\n\nThere are many ways to [contribute](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md) to TypeScript.\n\n* [Submit bugs](https://github.com/Microsoft/TypeScript/issues) and help us verify fixes as they are checked in.\n* Review the [source code changes](https://github.com/Microsoft/TypeScript/pulls).\n* Engage with other TypeScript users and developers on [StackOverflow](http://stackoverflow.com/questions/tagged/typescript).\n* Join the [#typescript](http://twitter.com/#!/search/realtime/%23typescript) discussion on Twitter.\n* [Contribute bug fixes](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md).\n\n# Documentation\n\n* [Quick tutorial](http://www.typescriptlang.org/Tutorial)\n* [Programming handbook](http://www.typescriptlang.org/Handbook)\n* [Homepage](http://www.typescriptlang.org/)\n# etag\n\n[![NPM Version][npm-image]][npm-url]\n[![NPM Downloads][downloads-image]][downloads-url]\n[![Node.js Version][node-version-image]][node-version-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n\nCreate simple HTTP ETags\n\nThis module generates HTTP ETags (as defined in RFC 7232) for use in\nHTTP responses.\n\n## Installation\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```sh\n$ npm install etag\n```\n\n## API\n\n<!-- eslint-disable no-unused-vars -->\n\n```js\nvar etag = require('etag')\n```\n\n### etag(entity, [options])\n\nGenerate a strong ETag for the given entity. This should be the complete\nbody of the entity. Strings, `Buffer`s, and `fs.Stats` are accepted. By\ndefault, a strong ETag is generated except for `fs.Stats`, which will\ngenerate a weak ETag (this can be overwritten by `options.weak`).\n\n<!-- eslint-disable no-undef -->\n\n```js\nres.setHeader('ETag', etag(body))\n```\n\n#### Options\n\n`etag` accepts these properties in the options object.\n\n##### weak\n\nSpecifies if the generated ETag will include the weak validator mark (that\nis, the leading `W/`). The actual entity tag is the same. The default value\nis `false`, unless the `entity` is `fs.Stats`, in which case it is `true`.\n\n## Testing\n\n```sh\n$ npm test\n```\n\n## Benchmark\n\n```bash\n$ npm run-script bench\n\n> etag@1.8.1 bench nodejs-etag\n> node benchmark/index.js\n\n http_parser@2.7.0\n node@6.11.1\n v8@5.1.281.103\n uv@1.11.0\n zlib@1.2.11\n ares@1.10.1-DEV\n icu@58.2\n modules@48\n openssl@1.0.2k\n\n> node benchmark/body0-100b.js\n\n 100B body\n\n 4 tests completed.\n\n buffer - strong x 258,647 ops/sec ±1.07% (180 runs sampled)\n buffer - weak x 263,812 ops/sec ±0.61% (184 runs sampled)\n string - strong x 259,955 ops/sec ±1.19% (185 runs sampled)\n string - weak x 264,356 ops/sec ±1.09% (184 runs sampled)\n\n> node benchmark/body1-1kb.js\n\n 1KB body\n\n 4 tests completed.\n\n buffer - strong x 189,018 ops/sec ±1.12% (182 runs sampled)\n buffer - weak x 190,586 ops/sec ±0.81% (186 runs sampled)\n string - strong x 144,272 ops/sec ±0.96% (188 runs sampled)\n string - weak x 145,380 ops/sec ±1.43% (187 runs sampled)\n\n> node benchmark/body2-5kb.js\n\n 5KB body\n\n 4 tests completed.\n\n buffer - strong x 92,435 ops/sec ±0.42% (188 runs sampled)\n buffer - weak x 92,373 ops/sec ±0.58% (189 runs sampled)\n string - strong x 48,850 ops/sec ±0.56% (186 runs sampled)\n string - weak x 49,380 ops/sec ±0.56% (190 runs sampled)\n\n> node benchmark/body3-10kb.js\n\n 10KB body\n\n 4 tests completed.\n\n buffer - strong x 55,989 ops/sec ±0.93% (188 runs sampled)\n buffer - weak x 56,148 ops/sec ±0.55% (190 runs sampled)\n string - strong x 27,345 ops/sec ±0.43% (188 runs sampled)\n string - weak x 27,496 ops/sec ±0.45% (190 runs sampled)\n\n> node benchmark/body4-100kb.js\n\n 100KB body\n\n 4 tests completed.\n\n buffer - strong x 7,083 ops/sec ±0.22% (190 runs sampled)\n buffer - weak x 7,115 ops/sec ±0.26% (191 runs sampled)\n string - strong x 3,068 ops/sec ±0.34% (190 runs sampled)\n string - weak x 3,096 ops/sec ±0.35% (190 runs sampled)\n\n> node benchmark/stats.js\n\n stat\n\n 4 tests completed.\n\n real - strong x 871,642 ops/sec ±0.34% (189 runs sampled)\n real - weak x 867,613 ops/sec ±0.39% (190 runs sampled)\n fake - strong x 401,051 ops/sec ±0.40% (189 runs sampled)\n fake - weak x 400,100 ops/sec ±0.47% (188 runs sampled)\n```\n\n## License\n\n[MIT](LICENSE)\n\n[npm-image]: https://img.shields.io/npm/v/etag.svg\n[npm-url]: https://npmjs.org/package/etag\n[node-version-image]: https://img.shields.io/node/v/etag.svg\n[node-version-url]: https://nodejs.org/en/download/\n[travis-image]: https://img.shields.io/travis/jshttp/etag/master.svg\n[travis-url]: https://travis-ci.org/jshttp/etag\n[coveralls-image]: https://img.shields.io/coveralls/jshttp/etag/master.svg\n[coveralls-url]: https://coveralls.io/r/jshttp/etag?branch=master\n[downloads-image]: https://img.shields.io/npm/dm/etag.svg\n[downloads-url]: https://npmjs.org/package/etag\n# fill-range [](https://www.npmjs.com/package/fill-range) [](https://npmjs.org/package/fill-range) [](https://npmjs.org/package/fill-range) [](https://travis-ci.org/jonschlinkert/fill-range)\n\n> Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Options](#options)\n * [options.step](#optionsstep)\n * [options.strictRanges](#optionsstrictranges)\n * [options.stringify](#optionsstringify)\n * [options.toRegex](#optionstoregex)\n * [options.transform](#optionstransform)\n- [About](#about)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save fill-range\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add fill-range\n```\n\n## Usage\n\nExpands numbers and letters, optionally using a `step` as the last argument. _(Numbers may be defined as JavaScript numbers or strings)_.\n\n```js\nvar fill = require('fill-range');\nfill(from, to[, step, options]);\n\n// examples\nconsole.log(fill('1', '10')); //=> '[ '1', '2', '3', '4', '5', '6', '7', '8', '9', '10' ]'\nconsole.log(fill('1', '10', {toRegex: true})); //=> [1-9]|10\n```\n\n**Params**\n\n* `from`: **{String|Number}** the number or letter to start with\n* `to`: **{String|Number}** the number or letter to end with\n* `step`: **{String|Number|Object|Function}** Optionally pass a [step](#optionsstep) to use.\n* `options`: **{Object|Function}**: See all available [options](#options)\n\n## Examples\n\nBy default, an array of values is returned.\n\n**Alphabetical ranges**\n\n```js\nconsole.log(fill('a', 'e')); //=> ['a', 'b', 'c', 'd', 'e']\nconsole.log(fill('A', 'E')); //=> [ 'A', 'B', 'C', 'D', 'E' ]\n```\n\n**Numerical ranges**\n\nNumbers can be defined as actual numbers or strings.\n\n```js\nconsole.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]\nconsole.log(fill('1', '5')); //=> [ 1, 2, 3, 4, 5 ]\n```\n\n**Negative ranges**\n\nNumbers can be defined as actual numbers or strings.\n\n```js\nconsole.log(fill('-5', '-1')); //=> [ '-5', '-4', '-3', '-2', '-1' ]\nconsole.log(fill('-5', '5')); //=> [ '-5', '-4', '-3', '-2', '-1', '0', '1', '2', '3', '4', '5' ]\n```\n\n**Steps (increments)**\n\n```js\n// numerical ranges with increments\nconsole.log(fill('0', '25', 4)); //=> [ '0', '4', '8', '12', '16', '20', '24' ]\nconsole.log(fill('0', '25', 5)); //=> [ '0', '5', '10', '15', '20', '25' ]\nconsole.log(fill('0', '25', 6)); //=> [ '0', '6', '12', '18', '24' ]\n\n// alphabetical ranges with increments\nconsole.log(fill('a', 'z', 4)); //=> [ 'a', 'e', 'i', 'm', 'q', 'u', 'y' ]\nconsole.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]\nconsole.log(fill('a', 'z', 6)); //=> [ 'a', 'g', 'm', 's', 'y' ]\n```\n\n## Options\n\n### options.step\n\n**Type**: `number` (formatted as a string or number)\n\n**Default**: `undefined`\n\n**Description**: The increment to use for the range. Can be used with letters or numbers.\n\n**Example(s)**\n\n```js\n// numbers\nconsole.log(fill('1', '10', 2)); //=> [ '1', '3', '5', '7', '9' ]\nconsole.log(fill('1', '10', 3)); //=> [ '1', '4', '7', '10' ]\nconsole.log(fill('1', '10', 4)); //=> [ '1', '5', '9' ]\n\n// letters\nconsole.log(fill('a', 'z', 5)); //=> [ 'a', 'f', 'k', 'p', 'u', 'z' ]\nconsole.log(fill('a', 'z', 7)); //=> [ 'a', 'h', 'o', 'v' ]\nconsole.log(fill('a', 'z', 9)); //=> [ 'a', 'j', 's' ]\n```\n\n### options.strictRanges\n\n**Type**: `boolean`\n\n**Default**: `false`\n\n**Description**: By default, `null` is returned when an invalid range is passed. Enable this option to throw a `RangeError` on invalid ranges.\n\n**Example(s)**\n\nThe following are all invalid:\n\n```js\nfill('1.1', '2'); // decimals not supported in ranges\nfill('a', '2'); // incompatible range values\nfill(1, 10, 'foo'); // invalid \"step\" argument\n```\n\n### options.stringify\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\n**Description**: Cast all returned values to strings. By default, integers are returned as numbers.\n\n**Example(s)**\n\n```js\nconsole.log(fill(1, 5)); //=> [ 1, 2, 3, 4, 5 ]\nconsole.log(fill(1, 5, {stringify: true})); //=> [ '1', '2', '3', '4', '5' ]\n```\n\n### options.toRegex\n\n**Type**: `boolean`\n\n**Default**: `undefined`\n\n**Description**: Create a regex-compatible source string, instead of expanding values to an array.\n\n**Example(s)**\n\n```js\n// alphabetical range\nconsole.log(fill('a', 'e', {toRegex: true})); //=> '[a-e]'\n// alphabetical with step\nconsole.log(fill('a', 'z', 3, {toRegex: true})); //=> 'a|d|g|j|m|p|s|v|y'\n// numerical range\nconsole.log(fill('1', '100', {toRegex: true})); //=> '[1-9]|[1-9][0-9]|100'\n// numerical range with zero padding\nconsole.log(fill('000001', '100000', {toRegex: true}));\n//=> '0{5}[1-9]|0{4}[1-9][0-9]|0{3}[1-9][0-9]{2}|0{2}[1-9][0-9]{3}|0[1-9][0-9]{4}|100000'\n```\n\n### options.transform\n\n**Type**: `function`\n\n**Default**: `undefined`\n\n**Description**: Customize each value in the returned array (or [string](#optionstoRegex)). _(you can also pass this function as the last argument to `fill()`)_.\n\n**Example(s)**\n\n```js\n// increase padding by two\nvar arr = fill('01', '05', function(val, a, b, step, idx, arr, options) {\n return repeat('0', (options.maxLength + 2) - val.length) + val;\n});\n\nconsole.log(arr);\n//=> ['0001', '0002', '0003', '0004', '0005']\n```\n\n## About\n\n### Related projects\n\n* [braces](https://www.npmjs.com/package/braces): Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces… [more](https://github.com/jonschlinkert/braces) | [homepage](https://github.com/jonschlinkert/braces \"Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces specification, without sacrificing speed.\")\n* [expand-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See… [more](https://github.com/jonschlinkert/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range \"Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See the benchmarks. Used by micromatch.\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n* [to-regex-range](https://www.npmjs.com/package/to-regex-range): Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… [more](https://github.com/jonschlinkert/to-regex-range) | [homepage](https://github.com/jonschlinkert/to-regex-range \"Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.87 million test assertions.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 103 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 2 | [paulmillr](https://github.com/paulmillr) | \n| 1 | [edorivai](https://github.com/edorivai) | \n| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | \n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 23, 2017._\nCompiler frontend for node.js\n=============================\n\nUsage\n-----\n\nFor an up to date list of available command line options, see:\n\n```\n$> asc --help\n```\n\nAPI\n---\n\nThe API accepts the same options as the CLI but also lets you override stdout and stderr and/or provide a callback. Example:\n\n```js\nconst asc = require(\"assemblyscript/cli/asc\");\nasc.ready.then(() => {\n asc.main([\n \"myModule.ts\",\n \"--binaryFile\", \"myModule.wasm\",\n \"--optimize\",\n \"--sourceMap\",\n \"--measure\"\n ], {\n stdout: process.stdout,\n stderr: process.stderr\n }, function(err) {\n if (err)\n throw err;\n ...\n });\n});\n```\n\nAvailable command line options can also be obtained programmatically:\n\n```js\nconst options = require(\"assemblyscript/cli/asc.json\");\n...\n```\n\nYou can also compile a source string directly, for example in a browser environment:\n\n```js\nconst asc = require(\"assemblyscript/cli/asc\");\nasc.ready.then(() => {\n const { binary, text, stdout, stderr } = asc.compileString(`...`, { optimize: 2 });\n});\n...\n```\n# typedarray-to-buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]\n\n[travis-image]: https://img.shields.io/travis/feross/typedarray-to-buffer/master.svg\n[travis-url]: https://travis-ci.org/feross/typedarray-to-buffer\n[npm-image]: https://img.shields.io/npm/v/typedarray-to-buffer.svg\n[npm-url]: https://npmjs.org/package/typedarray-to-buffer\n[downloads-image]: https://img.shields.io/npm/dm/typedarray-to-buffer.svg\n[downloads-url]: https://npmjs.org/package/typedarray-to-buffer\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n\n#### Convert a typed array to a [Buffer](https://github.com/feross/buffer) without a copy.\n\n[![saucelabs][saucelabs-image]][saucelabs-url]\n\n[saucelabs-image]: https://saucelabs.com/browser-matrix/typedarray-to-buffer.svg\n[saucelabs-url]: https://saucelabs.com/u/typedarray-to-buffer\n\nSay you're using the ['buffer'](https://github.com/feross/buffer) module on npm, or\n[browserify](http://browserify.org/) and you're working with lots of binary data.\n\nUnfortunately, sometimes the browser or someone else's API gives you a typed array like\n`Uint8Array` to work with and you need to convert it to a `Buffer`. What do you do?\n\nOf course: `Buffer.from(uint8array)`\n\nBut, alas, every time you do `Buffer.from(uint8array)` **the entire array gets copied**.\nThe `Buffer` constructor does a copy; this is\ndefined by the [node docs](http://nodejs.org/api/buffer.html) and the 'buffer' module\nmatches the node API exactly.\n\nSo, how can we avoid this expensive copy in\n[performance critical applications](https://github.com/feross/buffer/issues/22)?\n\n***Simply use this module, of course!***\n\nIf you have an `ArrayBuffer`, you don't need this module, because\n`Buffer.from(arrayBuffer)`\n[is already efficient](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_from_arraybuffer_byteoffset_length).\n\n## install\n\n```bash\nnpm install typedarray-to-buffer\n```\n\n## usage\n\nTo convert a typed array to a `Buffer` **without a copy**, do this:\n\n```js\nvar toBuffer = require('typedarray-to-buffer')\n\nvar arr = new Uint8Array([1, 2, 3])\narr = toBuffer(arr)\n\n// arr is a buffer now!\n\narr.toString() // '\\u0001\\u0002\\u0003'\narr.readUInt16BE(0) // 258\n```\n\n## how it works\n\nIf the browser supports typed arrays, then `toBuffer` will **augment the typed array** you\npass in with the `Buffer` methods and return it. See [how does Buffer\nwork?](https://github.com/feross/buffer#how-does-it-work) for more about how augmentation\nworks.\n\nThis module uses the typed array's underlying `ArrayBuffer` to back the new `Buffer`. This\nrespects the \"view\" on the `ArrayBuffer`, i.e. `byteOffset` and `byteLength`. In other\nwords, if you do `toBuffer(new Uint32Array([1, 2, 3]))`, then the new `Buffer` will\ncontain `[1, 0, 0, 0, 2, 0, 0, 0, 3, 0, 0, 0]`, **not** `[1, 2, 3]`. And it still doesn't\nrequire a copy.\n\nIf the browser doesn't support typed arrays, then `toBuffer` will create a new `Buffer`\nobject, copy the data into it, and return it. There's no simple performance optimization\nwe can do for old browsers. Oh well.\n\nIf this module is used in node, then it will just call `Buffer.from`. This is just for\nthe convenience of modules that work in both node and the browser.\n\n## license\n\nMIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org).\n<p align=\"center\">\n <a href=\"https://gulpjs.com\">\n <img height=\"257\" width=\"114\" src=\"https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png\">\n </a>\n</p>\n\n# glob-parent\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Azure Pipelines Build Status][azure-pipelines-image]][azure-pipelines-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]\n\nExtract the non-magic parent path from a glob string.\n\n## Usage\n\n```js\nvar globParent = require('glob-parent');\n\nglobParent('path/to/*.js'); // 'path/to'\nglobParent('/root/path/to/*.js'); // '/root/path/to'\nglobParent('/*.js'); // '/'\nglobParent('*.js'); // '.'\nglobParent('**/*.js'); // '.'\nglobParent('path/{to,from}'); // 'path'\nglobParent('path/!(to|from)'); // 'path'\nglobParent('path/?(to|from)'); // 'path'\nglobParent('path/+(to|from)'); // 'path'\nglobParent('path/*(to|from)'); // 'path'\nglobParent('path/@(to|from)'); // 'path'\nglobParent('path/**/*'); // 'path'\n\n// if provided a non-glob path, returns the nearest dir\nglobParent('path/foo/bar.js'); // 'path/foo'\nglobParent('path/foo/'); // 'path/foo'\nglobParent('path/foo'); // 'path' (see issue #3 for details)\n```\n\n## API\n\n### `globParent(maybeGlobString, [options])`\n\nTakes a string and returns the part of the path before the glob begins. Be aware of Escaping rules and Limitations below.\n\n#### options\n\n```js\n{\n // Disables the automatic conversion of slashes for Windows\n flipBackslashes: true\n}\n```\n\n## Escaping\n\nThe following characters have special significance in glob patterns and must be escaped if you want them to be treated as regular path characters:\n\n- `?` (question mark) unless used as a path segment alone\n- `*` (asterisk)\n- `|` (pipe)\n- `(` (opening parenthesis)\n- `)` (closing parenthesis)\n- `{` (opening curly brace)\n- `}` (closing curly brace)\n- `[` (opening bracket)\n- `]` (closing bracket)\n\n**Example**\n\n```js\nglobParent('foo/[bar]/') // 'foo'\nglobParent('foo/\\\\[bar]/') // 'foo/[bar]'\n```\n\n## Limitations\n\n### Braces & Brackets\nThis library attempts a quick and imperfect method of determining which path\nparts have glob magic without fully parsing/lexing the pattern. There are some\nadvanced use cases that can trip it up, such as nested braces where the outer\npair is escaped and the inner one contains a path separator. If you find\nyourself in the unlikely circumstance of being affected by this or need to\nensure higher-fidelity glob handling in your library, it is recommended that you\npre-process your input with [expand-braces] and/or [expand-brackets].\n\n### Windows\nBackslashes are not valid path separators for globs. If a path with backslashes\nis provided anyway, for simple cases, glob-parent will replace the path\nseparator for you and return the non-glob parent path (now with\nforward-slashes, which are still valid as Windows path separators).\n\nThis cannot be used in conjunction with escape characters.\n\n```js\n// BAD\nglobParent('C:\\\\Program Files \\\\(x86\\\\)\\\\*.ext') // 'C:/Program Files /(x86/)'\n\n// GOOD\nglobParent('C:/Program Files\\\\(x86\\\\)/*.ext') // 'C:/Program Files (x86)'\n```\n\nIf you are using escape characters for a pattern without path parts (i.e.\nrelative to `cwd`), prefix with `./` to avoid confusing glob-parent.\n\n```js\n// BAD\nglobParent('foo \\\\[bar]') // 'foo '\nglobParent('foo \\\\[bar]*') // 'foo '\n\n// GOOD\nglobParent('./foo \\\\[bar]') // 'foo [bar]'\nglobParent('./foo \\\\[bar]*') // '.'\n```\n\n## License\n\nISC\n\n[expand-braces]: https://github.com/jonschlinkert/expand-braces\n[expand-brackets]: https://github.com/jonschlinkert/expand-brackets\n\n[downloads-image]: https://img.shields.io/npm/dm/glob-parent.svg\n[npm-url]: https://www.npmjs.com/package/glob-parent\n[npm-image]: https://img.shields.io/npm/v/glob-parent.svg\n\n[azure-pipelines-url]: https://dev.azure.com/gulpjs/gulp/_build/latest?definitionId=2&branchName=master\n[azure-pipelines-image]: https://dev.azure.com/gulpjs/gulp/_apis/build/status/glob-parent?branchName=master\n\n[travis-url]: https://travis-ci.org/gulpjs/glob-parent\n[travis-image]: https://img.shields.io/travis/gulpjs/glob-parent.svg?label=travis-ci\n\n[appveyor-url]: https://ci.appveyor.com/project/gulpjs/glob-parent\n[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/glob-parent.svg?label=appveyor\n\n[coveralls-url]: https://coveralls.io/r/gulpjs/glob-parent\n[coveralls-image]: https://img.shields.io/coveralls/gulpjs/glob-parent/master.svg\n\n[gitter-url]: https://gitter.im/gulpjs/gulp\n[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg\n# is-number [](https://www.npmjs.com/package/is-number) [](https://npmjs.org/package/is-number) [](https://travis-ci.org/jonschlinkert/is-number)\n\n> Returns true if the value is a number. comprehensive tests.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-number\n```\n\n## Usage\n\nTo understand some of the rationale behind the decisions made in this library (and to learn about some oddities of number evaluation in JavaScript), [see this gist](https://gist.github.com/jonschlinkert/e30c70c713da325d0e81).\n\n```js\nvar isNumber = require('is-number');\n```\n\n### true\n\nSee the [tests](./test.js) for more examples.\n\n```js\nisNumber(5e3) //=> 'true'\nisNumber(0xff) //=> 'true'\nisNumber(-1.1) //=> 'true'\nisNumber(0) //=> 'true'\nisNumber(1) //=> 'true'\nisNumber(1.1) //=> 'true'\nisNumber(10) //=> 'true'\nisNumber(10.10) //=> 'true'\nisNumber(100) //=> 'true'\nisNumber('-1.1') //=> 'true'\nisNumber('0') //=> 'true'\nisNumber('012') //=> 'true'\nisNumber('0xff') //=> 'true'\nisNumber('1') //=> 'true'\nisNumber('1.1') //=> 'true'\nisNumber('10') //=> 'true'\nisNumber('10.10') //=> 'true'\nisNumber('100') //=> 'true'\nisNumber('5e3') //=> 'true'\nisNumber(parseInt('012')) //=> 'true'\nisNumber(parseFloat('012')) //=> 'true'\n```\n\n### False\n\nSee the [tests](./test.js) for more examples.\n\n```js\nisNumber('foo') //=> 'false'\nisNumber([1]) //=> 'false'\nisNumber([]) //=> 'false'\nisNumber(function () {}) //=> 'false'\nisNumber(Infinity) //=> 'false'\nisNumber(NaN) //=> 'false'\nisNumber(new Array('abc')) //=> 'false'\nisNumber(new Array(2)) //=> 'false'\nisNumber(new Buffer('abc')) //=> 'false'\nisNumber(null) //=> 'false'\nisNumber(undefined) //=> 'false'\nisNumber({abc: 'abc'}) //=> 'false'\n```\n\n## About\n\n### Related projects\n\n* [even](https://www.npmjs.com/package/even): Get the even numbered items from an array. | [homepage](https://github.com/jonschlinkert/even \"Get the even numbered items from an array.\")\n* [is-even](https://www.npmjs.com/package/is-even): Return true if the given number is even. | [homepage](https://github.com/jonschlinkert/is-even \"Return true if the given number is even.\")\n* [is-odd](https://www.npmjs.com/package/is-odd): Returns true if the given number is odd. | [homepage](https://github.com/jonschlinkert/is-odd \"Returns true if the given number is odd.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of \"Get the native type of a value.\")\n* [odd](https://www.npmjs.com/package/odd): Get the odd numbered items from an array. | [homepage](https://github.com/jonschlinkert/odd \"Get the odd numbered items from an array.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/is-number/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on September 10, 2016._\nwrite-file-atomic\n-----------------\n\nThis is an extension for node's `fs.writeFile` that makes its operation\natomic and allows you set ownership (uid/gid of the file).\n\n### var writeFileAtomic = require('write-file-atomic')<br>writeFileAtomic(filename, data, [options], [callback])\n\n* filename **String**\n* data **String** | **Buffer**\n* options **Object** | **String**\n * chown **Object** default, uid & gid of existing file, if any\n * uid **Number**\n * gid **Number**\n * encoding **String** | **Null** default = 'utf8'\n * fsync **Boolean** default = true\n * mode **Number** default, from existing file, if any\n * tmpfileCreated **Function** called when the tmpfile is created\n* callback **Function**\n\nAtomically and asynchronously writes data to a file, replacing the file if it already\nexists. data can be a string or a buffer.\n\nThe file is initially named `filename + \".\" + murmurhex(__filename, process.pid, ++invocations)`.\nNote that `require('worker_threads').threadId` is used in addition to `process.pid` if running inside of a worker thread.\nIf writeFile completes successfully then, if passed the **chown** option it will change\nthe ownership of the file. Finally it renames the file back to the filename you specified. If\nit encounters errors at any of these steps it will attempt to unlink the temporary file and then\npass the error back to the caller.\nIf multiple writes are concurrently issued to the same file, the write operations are put into a queue and serialized in the order they were called, using Promises. Writes to different files are still executed in parallel.\n\nIf provided, the **chown** option requires both **uid** and **gid** properties or else\nyou'll get an error. If **chown** is not specified it will default to using\nthe owner of the previous file. To prevent chown from being ran you can\nalso pass `false`, in which case the file will be created with the current user's credentials.\n\nIf **mode** is not specified, it will default to using the permissions from\nan existing file, if any. Expicitly setting this to `false` remove this default, resulting\nin a file created with the system default permissions.\n\nIf options is a String, it's assumed to be the **encoding** option. The **encoding** option is ignored if **data** is a buffer. It defaults to 'utf8'.\n\nIf the **fsync** option is **false**, writeFile will skip the final fsync call.\n\nIf the **tmpfileCreated** option is specified it will be called with the name of the tmpfile when created.\n\nExample:\n\n```javascript\nwriteFileAtomic('message.txt', 'Hello Node', {chown:{uid:100,gid:50}}, function (err) {\n if (err) throw err;\n console.log('It\\'s saved!');\n});\n```\n\nThis function also supports async/await:\n\n```javascript\n(async () => {\n try {\n await writeFileAtomic('message.txt', 'Hello Node', {chown:{uid:100,gid:50}});\n console.log('It\\'s saved!');\n } catch (err) {\n console.error(err);\n process.exit(1);\n }\n})();\n```\n\n### var writeFileAtomicSync = require('write-file-atomic').sync<br>writeFileAtomicSync(filename, data, [options])\n\nThe synchronous version of **writeFileAtomic**.\n# object.pick [](https://www.npmjs.com/package/object.pick) [](https://npmjs.org/package/object.pick) [](https://npmjs.org/package/object.pick) [](https://travis-ci.org/jonschlinkert/object.pick)\n\n> Returns a filtered copy of an object with only the specified keys, similar to `_.pick` from lodash / underscore.\n\nYou might also be interested in [object.omit](https://github.com/jonschlinkert/object.omit).\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save object.pick\n```\n\n## benchmarks\n\nThis is the [fastest implementation](http://jsperf.com/pick-props) I tested. Pull requests welcome!\n\n## Usage\n\n```js\nvar pick = require('object.pick');\n\npick({a: 'a', b: 'b'}, 'a')\n//=> {a: 'a'}\n\npick({a: 'a', b: 'b', c: 'c'}, ['a', 'b'])\n//=> {a: 'a', b: 'b'}\n```\n\n## About\n\n### Related projects\n\n* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow \"Extend an object with the properties of additional objects. node.js/javascript util.\")\n* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value \"Use property paths (`a.b.c`) to get a nested value from an object.\")\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep \"Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone.\")\n* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value \"Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/object.pick/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 27, 2016._\n<a href=\"http://promisesaplus.com/\">\n <img src=\"https://promises-aplus.github.io/promises-spec/assets/logo-small.png\" align=\"right\" alt=\"Promises/A+ logo\" />\n</a>\n\n# request-promise-core\n\n[](https://gitter.im/request/request-promise?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://travis-ci.org/request/promise-core)\n[](https://coveralls.io/r/request/promise-core)\n[](https://david-dm.org/request/promise-core)\n[](https://snyk.io/test/npm/promise-core)\n\nThis package is the core for the following packages:\n\n- [`request-promise`](https://github.com/request/request-promise)\n- [`request-promise-any`](https://github.com/request/request-promise-any)\n- [`request-promise-bluebird`](https://github.com/request/request-promise-bluebird)\n- [`request-promise-native`](https://github.com/request/request-promise-native)\n\n`request-promise-core` contains the core logic to add Promise support to [`request`](https://github.com/request/request).\n\nPlease use one of the libraries above. It is only recommended to use this library directly, if you have very specific requirements.\n\n## Installation for `request@^2.34`\n\nThis module is installed via npm:\n\n```\nnpm install --save request\nnpm install --save request-promise-core\n```\n\n`request` is defined as a peer-dependency and thus has to be installed separately.\n\n## Usage for `request@^2.34`\n\n``` js\n// 1. Load the request library\n\n// Only use a direct require if you are 100% sure that:\n// - Your project does not use request directly. That is without the Promise capabilities by calling require('request').\n// - Any of the installed libraries use request.\n// ...because Request's prototype will be patched in step 2.\n/* var request = require('request'); */\n\n// Instead use:\nvar stealthyRequire = require('stealthy-require');\nvar request = stealthyRequire(require.cache, function () {\n return require('request');\n});\n\n// 2. Add Promise support to request\n\nvar configure = require('request-promise-core/configure/request2');\n\nconfigure({\n request: request,\n\t// Pass your favorite ES6-compatible promise implementation\n PromiseImpl: Promise,\n\t// Expose all methods of the promise instance you want to call on the request(...) call\n expose: [\n 'then', // Allows to use request(...).then(...)\n 'catch', // Allows to use request(...).catch(...)\n 'promise' // Allows to use request(...).promise() which returns the promise instance\n ],\n // Optional: Pass a callback that is called within the Promise constructor\n constructorMixin: function (resolve, reject) {\n // `this` is the request object\n // Additional arguments may be passed depending on the PromiseImpl used\n }\n});\n\n// 3. Use request with its promise capabilities\n\n// E.g. crawl a web page:\nrequest('http://www.google.com')\n .then(function (htmlString) {\n // Process html...\n })\n .catch(function (err) {\n // Crawling failed...\n });\n```\n\n## Installation and Usage for `request@next`\n\n[Request Next](https://github.com/request/request/issues/1982) is still in alpha. However, `request-promise-core` is already designed to be compatible and ships with a configuration helper – `require('request-promise-core/configure/request-next')` – that is [used by `request-promise`](https://github.com/request/request-promise/blob/next/lib/rp.js) in its \"next\" branch.\n\n## Contributing\n\nTo set up your development environment:\n\n1. clone the repo to your desktop,\n2. in the shell `cd` to the main folder,\n3. hit `npm install`,\n4. hit `npm install gulp -g` if you haven't installed gulp globally yet, and\n5. run `gulp dev`. (Or run `node ./node_modules/.bin/gulp dev` if you don't want to install gulp globally.)\n\n`gulp dev` watches all source files and if you save some changes it will lint the code and execute all tests. The test coverage report can be viewed from `./coverage/lcov-report/index.html`.\n\nIf you want to debug a test you should use `gulp test-without-coverage` to run all tests without obscuring the code by the test coverage instrumentation.\n\n## Change History\n\n- 1.1.4 (2020-07-21)\n - Security fix: bumped `lodash` to `^4.17.19` following [this advisory](https://www.npmjs.com/advisories/1523).\n- 1.1.3 (2019-11-03)\n - Security fix: bumped `lodash` to `^4.17.15`. See [vulnerabilty reports](https://snyk.io/vuln/search?q=lodash&type=npm).\n *(Thanks to @daniel-nagy for pull request [#20](https://github.com/request/promise-core/pull/20) and thanks to @quetzaluz for reporting this in issue [#21](https://github.com/request/promise-core/issues/21).)*\n- 1.1.2 (2019-02-14)\n - Security fix: bumped `lodash` to `^4.17.11`. See [vulnerabilty reports](https://snyk.io/vuln/search?q=lodash&type=npm).\n *(Thanks to @lucaswillering and @sam-warren-finnair for reporting this in issues [#12](https://github.com/request/promise-core/issues/12) and [#13](https://github.com/request/promise-core/issues/13) and thanks to @Alec321 for pull request [#14](https://github.com/request/promise-core/pull/14).)*\n- 1.1.1 (2016-08-08)\n - Renamed package to `request-promise-core` because there were [too](https://github.com/request/request-promise/issues/137) [many](https://github.com/request/request-promise/issues/141) issues with the scoped package name `@request/promise-core`\n- 1.1.0 (2016-07-30)\n - Added `constructorMixin` option to enable [request/request-promise#123](https://github.com/request/request-promise/pull/123)\n- 1.0.0 (2016-07-15)\n - All tests green, ready for prime time\n- 1.0.0-rc.1 (2016-07-10)\n - Reimplementation of core logic based on `request-promise@3.0.0`\n - Plus `transform2xxOnly` option (fixes [request/request-promise#131](https://github.com/request/request-promise/issues/131))\n\n## License (ISC)\n\nIn case you never heard about the [ISC license](http://en.wikipedia.org/wiki/ISC_license) it is functionally equivalent to the MIT license.\n\nSee the [LICENSE file](LICENSE) for details.\n# has-symbols <sup>[![Version Badge][2]][1]</sup>\n\n[![Build Status][3]][4]\n[![dependency status][5]][6]\n[![dev dependency status][7]][8]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][11]][1]\n\nDetermine if the JS environment has Symbol support. Supports spec, or shams.\n\n## Example\n\n```js\nvar hasSymbols = require('has-symbols');\n\nhasSymbols() === true; // if the environment has native Symbol support. Not polyfillable, not forgeable.\n\nvar hasSymbolsKinda = require('has-symbols/shams');\nhasSymbolsKinda() === true; // if the environment has a Symbol sham that mostly follows the spec.\n```\n\n## Supported Symbol shams\n - get-own-property-symbols [npm](https://www.npmjs.com/package/get-own-property-symbols) | [github](https://github.com/WebReflection/get-own-property-symbols)\n - core-js [npm](https://www.npmjs.com/package/core-js) | [github](https://github.com/zloirock/core-js)\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[1]: https://npmjs.org/package/has-symbols\n[2]: http://versionbadg.es/ljharb/has-symbols.svg\n[3]: https://travis-ci.org/ljharb/has-symbols.svg\n[4]: https://travis-ci.org/ljharb/has-symbols\n[5]: https://david-dm.org/ljharb/has-symbols.svg\n[6]: https://david-dm.org/ljharb/has-symbols\n[7]: https://david-dm.org/ljharb/has-symbols/dev-status.svg\n[8]: https://david-dm.org/ljharb/has-symbols#info=devDependencies\n[9]: https://ci.testling.com/ljharb/has-symbols.png\n[10]: https://ci.testling.com/ljharb/has-symbols\n[11]: https://nodei.co/npm/has-symbols.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/has-symbols.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/has-symbols.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=has-symbols\n# browser-process-hrtime\n\nBrowser shim for Node.js `process.hrtime()`.\nSee [documentation at nodejs.org](http://nodejs.org/api/process.html#process_process_hrtime)\n\nThis module does not provide the same level of time precision as node.js, but provides a matching API and response format.\n\n### usage\nUse hrtime independent of environment (node or browser).\nIt will use `process.hrtime` first and fallback if not present.\n```js\nconst hrtime = require('browser-process-hrtime')\nconst start = hrtime()\n// ...\nconst delta = hrtime(start)\n```\n\n### monkey-patching\nYou can monkey-patch `process.hrtime` for your dependency graph like this:\n```js\nprocess.hrtime = require('browser-process-hrtime')\nconst coolTool = require('module-that-uses-hrtime-somewhere-in-its-depths')\n```\n\n### note\nThis was originally pull-requested against [node-process](https://github.com/defunctzombie/node-process),\nbut they are trying to stay lean.\n# Forge\n\n[](https://nodei.co/npm/node-forge/)\n\n[](https://travis-ci.org/digitalbazaar/forge)\n\nA native implementation of [TLS][] (and various other cryptographic tools) in\n[JavaScript][].\n\nIntroduction\n------------\n\nThe Forge software is a fully native implementation of the [TLS][] protocol\nin JavaScript, a set of cryptography utilities, and a set of tools for\ndeveloping Web Apps that utilize many network resources.\n\nPerformance\n------------\n\nForge is fast. Benchmarks against other popular JavaScript cryptography\nlibraries can be found here:\n\n* http://dominictarr.github.io/crypto-bench/\n* http://cryptojs.altervista.org/test/simulate-threading-speed_test.html\n\nDocumentation\n-------------\n\n* [Introduction](#introduction)\n* [Performance](#performance)\n* [Installation](#installation)\n* [Testing](#testing)\n* [Contributing](#contributing)\n\n### API\n\n* [Options](#options)\n\n### Transports\n\n* [TLS](#tls)\n* [HTTP](#http)\n* [SSH](#ssh)\n* [XHR](#xhr)\n* [Sockets](#socket)\n\n### Ciphers\n\n* [CIPHER](#cipher)\n* [AES](#aes)\n* [DES](#des)\n* [RC2](#rc2)\n\n### PKI\n\n* [ED25519](#ed25519)\n* [RSA](#rsa)\n* [RSA-KEM](#rsakem)\n* [X.509](#x509)\n* [PKCS#5](#pkcs5)\n* [PKCS#7](#pkcs7)\n* [PKCS#8](#pkcs8)\n* [PKCS#10](#pkcs10)\n* [PKCS#12](#pkcs12)\n* [ASN.1](#asn)\n\n### Message Digests\n\n* [SHA1](#sha1)\n* [SHA256](#sha256)\n* [SHA384](#sha384)\n* [SHA512](#sha512)\n* [MD5](#md5)\n* [HMAC](#hmac)\n\n### Utilities\n\n* [Prime](#prime)\n* [PRNG](#prng)\n* [Tasks](#task)\n* [Utilities](#util)\n* [Logging](#log)\n* [Debugging](#debug)\n* [Flash Networking Support](#flash)\n\n### Other\n\n* [Security Considerations](#security-considerations)\n* [Library Background](#library-background)\n* [Contact](#contact)\n* [Donations](#donations)\n\n---------------------------------------\n\nInstallation\n------------\n\n**Note**: Please see the [Security Considerations](#security-considerations)\nsection before using packaging systems and pre-built files.\n\nForge uses a [CommonJS][] module structure with a build process for browser\nbundles. The older [0.6.x][] branch with standalone files is available but will\nnot be regularly updated.\n\n### Node.js\n\nIf you want to use forge with [Node.js][], it is available through `npm`:\n\nhttps://npmjs.org/package/node-forge\n\nInstallation:\n\n npm install node-forge\n\nYou can then use forge as a regular module:\n\n```js\nvar forge = require('node-forge');\n```\n\nThe npm package includes pre-built `forge.min.js`, `forge.all.min.js`, and\n`prime.worker.min.js` using the [UMD][] format.\n\n### Bundle / Bower\n\nEach release is published in a separate repository as pre-built and minimized\nbasic forge bundles using the [UMD][] format.\n\nhttps://github.com/digitalbazaar/forge-dist\n\nThis bundle can be used in many environments. In particular it can be installed\nwith [Bower][]:\n\n bower install forge\n\n### jsDelivr CDN\n\nTo use it via [jsDelivr](https://www.jsdelivr.com/package/npm/node-forge) include this in your html:\n\n```html\n<script src=\"https://cdn.jsdelivr.net/npm/node-forge@0.7.0/dist/forge.min.js\"></script>\n```\n\n### unpkg CDN\n\nTo use it via [unpkg](https://unpkg.com/#/) include this in your html:\n\n```html\n<script src=\"https://unpkg.com/node-forge@0.7.0/dist/forge.min.js\"></script>\n```\n\n### Development Requirements\n\nThe core JavaScript has the following requirements to build and test:\n\n* Building a browser bundle:\n * Node.js\n * npm\n* Testing\n * Node.js\n * npm\n * Chrome, Firefox, Safari (optional)\n\nSome special networking features can optionally use a Flash component. See the\n[Flash README](./flash/README.md) for details.\n\n### Building for a web browser\n\nTo create single file bundles for use with browsers run the following:\n\n npm install\n npm run build\n\nThis will create single non-minimized and minimized files that can be\nincluded in the browser:\n\n dist/forge.js\n dist/forge.min.js\n\nA bundle that adds some utilities and networking support is also available:\n\n dist/forge.all.js\n dist/forge.all.min.js\n\nInclude the file via:\n\n```html\n<script src=\"YOUR_SCRIPT_PATH/forge.js\"></script>\n```\nor\n```html\n<script src=\"YOUR_SCRIPT_PATH/forge.min.js\"></script>\n```\n\nThe above bundles will synchronously create a global 'forge' object.\n\n**Note**: These bundles will not include any WebWorker scripts (eg:\n`dist/prime.worker.js`), so these will need to be accessible from the browser\nif any WebWorkers are used.\n\n### Building a custom browser bundle\n\nThe build process uses [webpack][] and the [config](./webpack.config.js) file\ncan be modified to generate a file or files that only contain the parts of\nforge you need.\n\n[Browserify][] override support is also present in `package.json`.\n\nTesting\n-------\n\nSee the [testing README](./tests/README.md) for full details.\n\n### Prepare to run tests\n\n npm install\n\n### Running automated tests with Node.js\n\nForge natively runs in a [Node.js][] environment:\n\n npm test\n\n### Running automated tests with PhantomJS\n\nAutomated testing is done via [Karma][]. By default it will run the tests in a\nheadless manner with PhantomJS.\n\n npm run test-karma\n\nIs 'mocha' reporter output too verbose? Other reporters are available. Try\n'dots', 'progress', or 'tap'.\n\n npm run test-karma -- --reporters progress\n\nBy default [webpack][] is used. [Browserify][] can also be used.\n\n BUNDLER=browserify npm run test-karma\n\n### Running automated tests with one or more browsers\n\nYou can also specify one or more browsers to use.\n\n npm run test-karma -- --browsers Chrome,Firefox,Safari,PhantomJS\n\nThe reporter option and `BUNDLER` environment variable can also be used.\n\n### Running manual tests in a browser\n\nTesting in a browser uses [webpack][] to combine forge and all tests and then\nloading the result in a browser. A simple web server is provided that will\noutput the HTTP or HTTPS URLs to load. It also will start a simple Flash Policy\nServer. Unit tests and older legacy tests are provided. Custom ports can be\nused by running `node tests/server.js` manually.\n\nTo run the unit tests in a browser a special forge build is required:\n\n npm run test-build\n\nTo run legacy browser based tests the main forge build is required:\n\n npm run build\n\nThe tests are run with a custom server that prints out the URLs to use:\n\n npm run test-server\n\n### Running other tests\n\nThere are some other random tests and benchmarks available in the tests\ndirectory.\n\n### Coverage testing\n\nTo perform coverage testing of the unit tests, run the following. The results\nwill be put in the `coverage/` directory. Note that coverage testing can slow\ndown some tests considerably.\n\n npm install\n npm run coverage\n\nContributing\n------------\n\nAny contributions (eg: PRs) that are accepted will be brought under the same\nlicense used by the rest of the Forge project. This license allows Forge to\nbe used under the terms of either the BSD License or the GNU General Public\nLicense (GPL) Version 2.\n\nSee: [LICENSE](https://github.com/digitalbazaar/forge/blob/cbebca3780658703d925b61b2caffb1d263a6c1d/LICENSE)\n\nIf a contribution contains 3rd party source code with its own license, it\nmay retain it, so long as that license is compatible with the Forge license.\n\nAPI\n---\n\n<a name=\"options\" />\n\n### Options\n\nIf at any time you wish to disable the use of native code, where available,\nfor particular forge features like its secure random number generator, you\nmay set the ```forge.options.usePureJavaScript``` flag to ```true```. It is\nnot recommended that you set this flag as native code is typically more\nperformant and may have stronger security properties. It may be useful to\nset this flag to test certain features that you plan to run in environments\nthat are different from your testing environment.\n\nTo disable native code when including forge in the browser:\n\n```js\n// run this *after* including the forge script\nforge.options.usePureJavaScript = true;\n```\n\nTo disable native code when using Node.js:\n\n```js\nvar forge = require('node-forge');\nforge.options.usePureJavaScript = true;\n```\n\nTransports\n----------\n\n<a name=\"tls\" />\n\n### TLS\n\nProvides a native javascript client and server-side [TLS][] implementation.\n\n__Examples__\n\n```js\n// create TLS client\nvar client = forge.tls.createConnection({\n server: false,\n caStore: /* Array of PEM-formatted certs or a CA store object */,\n sessionCache: {},\n // supported cipher suites in order of preference\n cipherSuites: [\n forge.tls.CipherSuites.TLS_RSA_WITH_AES_128_CBC_SHA,\n forge.tls.CipherSuites.TLS_RSA_WITH_AES_256_CBC_SHA],\n virtualHost: 'example.com',\n verify: function(connection, verified, depth, certs) {\n if(depth === 0) {\n var cn = certs[0].subject.getField('CN').value;\n if(cn !== 'example.com') {\n verified = {\n alert: forge.tls.Alert.Description.bad_certificate,\n message: 'Certificate common name does not match hostname.'\n };\n }\n }\n return verified;\n },\n connected: function(connection) {\n console.log('connected');\n // send message to server\n connection.prepare(forge.util.encodeUtf8('Hi server!'));\n /* NOTE: experimental, start heartbeat retransmission timer\n myHeartbeatTimer = setInterval(function() {\n connection.prepareHeartbeatRequest(forge.util.createBuffer('1234'));\n }, 5*60*1000);*/\n },\n /* provide a client-side cert if you want\n getCertificate: function(connection, hint) {\n return myClientCertificate;\n },\n /* the private key for the client-side cert if provided */\n getPrivateKey: function(connection, cert) {\n return myClientPrivateKey;\n },\n tlsDataReady: function(connection) {\n // TLS data (encrypted) is ready to be sent to the server\n sendToServerSomehow(connection.tlsData.getBytes());\n // if you were communicating with the server below, you'd do:\n // server.process(connection.tlsData.getBytes());\n },\n dataReady: function(connection) {\n // clear data from the server is ready\n console.log('the server sent: ' +\n forge.util.decodeUtf8(connection.data.getBytes()));\n // close connection\n connection.close();\n },\n /* NOTE: experimental\n heartbeatReceived: function(connection, payload) {\n // restart retransmission timer, look at payload\n clearInterval(myHeartbeatTimer);\n myHeartbeatTimer = setInterval(function() {\n connection.prepareHeartbeatRequest(forge.util.createBuffer('1234'));\n }, 5*60*1000);\n payload.getBytes();\n },*/\n closed: function(connection) {\n console.log('disconnected');\n },\n error: function(connection, error) {\n console.log('uh oh', error);\n }\n});\n\n// start the handshake process\nclient.handshake();\n\n// when encrypted TLS data is received from the server, process it\nclient.process(encryptedBytesFromServer);\n\n// create TLS server\nvar server = forge.tls.createConnection({\n server: true,\n caStore: /* Array of PEM-formatted certs or a CA store object */,\n sessionCache: {},\n // supported cipher suites in order of preference\n cipherSuites: [\n forge.tls.CipherSuites.TLS_RSA_WITH_AES_128_CBC_SHA,\n forge.tls.CipherSuites.TLS_RSA_WITH_AES_256_CBC_SHA],\n // require a client-side certificate if you want\n verifyClient: true,\n verify: function(connection, verified, depth, certs) {\n if(depth === 0) {\n var cn = certs[0].subject.getField('CN').value;\n if(cn !== 'the-client') {\n verified = {\n alert: forge.tls.Alert.Description.bad_certificate,\n message: 'Certificate common name does not match expected client.'\n };\n }\n }\n return verified;\n },\n connected: function(connection) {\n console.log('connected');\n // send message to client\n connection.prepare(forge.util.encodeUtf8('Hi client!'));\n /* NOTE: experimental, start heartbeat retransmission timer\n myHeartbeatTimer = setInterval(function() {\n connection.prepareHeartbeatRequest(forge.util.createBuffer('1234'));\n }, 5*60*1000);*/\n },\n getCertificate: function(connection, hint) {\n return myServerCertificate;\n },\n getPrivateKey: function(connection, cert) {\n return myServerPrivateKey;\n },\n tlsDataReady: function(connection) {\n // TLS data (encrypted) is ready to be sent to the client\n sendToClientSomehow(connection.tlsData.getBytes());\n // if you were communicating with the client above you'd do:\n // client.process(connection.tlsData.getBytes());\n },\n dataReady: function(connection) {\n // clear data from the client is ready\n console.log('the client sent: ' +\n forge.util.decodeUtf8(connection.data.getBytes()));\n // close connection\n connection.close();\n },\n /* NOTE: experimental\n heartbeatReceived: function(connection, payload) {\n // restart retransmission timer, look at payload\n clearInterval(myHeartbeatTimer);\n myHeartbeatTimer = setInterval(function() {\n connection.prepareHeartbeatRequest(forge.util.createBuffer('1234'));\n }, 5*60*1000);\n payload.getBytes();\n },*/\n closed: function(connection) {\n console.log('disconnected');\n },\n error: function(connection, error) {\n console.log('uh oh', error);\n }\n});\n\n// when encrypted TLS data is received from the client, process it\nserver.process(encryptedBytesFromClient);\n```\n\nConnect to a TLS server using node's net.Socket:\n\n```js\nvar socket = new net.Socket();\n\nvar client = forge.tls.createConnection({\n server: false,\n verify: function(connection, verified, depth, certs) {\n // skip verification for testing\n console.log('[tls] server certificate verified');\n return true;\n },\n connected: function(connection) {\n console.log('[tls] connected');\n // prepare some data to send (note that the string is interpreted as\n // 'binary' encoded, which works for HTTP which only uses ASCII, use\n // forge.util.encodeUtf8(str) otherwise\n client.prepare('GET / HTTP/1.0\\r\\n\\r\\n');\n },\n tlsDataReady: function(connection) {\n // encrypted data is ready to be sent to the server\n var data = connection.tlsData.getBytes();\n socket.write(data, 'binary'); // encoding should be 'binary'\n },\n dataReady: function(connection) {\n // clear data from the server is ready\n var data = connection.data.getBytes();\n console.log('[tls] data received from the server: ' + data);\n },\n closed: function() {\n console.log('[tls] disconnected');\n },\n error: function(connection, error) {\n console.log('[tls] error', error);\n }\n});\n\nsocket.on('connect', function() {\n console.log('[socket] connected');\n client.handshake();\n});\nsocket.on('data', function(data) {\n client.process(data.toString('binary')); // encoding should be 'binary'\n});\nsocket.on('end', function() {\n console.log('[socket] disconnected');\n});\n\n// connect to google.com\nsocket.connect(443, 'google.com');\n\n// or connect to gmail's imap server (but don't send the HTTP header above)\n//socket.connect(993, 'imap.gmail.com');\n```\n\n<a name=\"http\" />\n\n### HTTP\n\nProvides a native [JavaScript][] mini-implementation of an http client that\nuses pooled sockets.\n\n__Examples__\n\n```js\n// create an HTTP GET request\nvar request = forge.http.createRequest({method: 'GET', path: url.path});\n\n// send the request somewhere\nsendSomehow(request.toString());\n\n// receive response\nvar buffer = forge.util.createBuffer();\nvar response = forge.http.createResponse();\nvar someAsyncDataHandler = function(bytes) {\n if(!response.bodyReceived) {\n buffer.putBytes(bytes);\n if(!response.headerReceived) {\n if(response.readHeader(buffer)) {\n console.log('HTTP response header: ' + response.toString());\n }\n }\n if(response.headerReceived && !response.bodyReceived) {\n if(response.readBody(buffer)) {\n console.log('HTTP response body: ' + response.body);\n }\n }\n }\n};\n```\n\n<a name=\"ssh\" />\n\n### SSH\n\nProvides some SSH utility functions.\n\n__Examples__\n\n```js\n// encodes (and optionally encrypts) a private RSA key as a Putty PPK file\nforge.ssh.privateKeyToPutty(privateKey, passphrase, comment);\n\n// encodes a public RSA key as an OpenSSH file\nforge.ssh.publicKeyToOpenSSH(key, comment);\n\n// encodes a private RSA key as an OpenSSH file\nforge.ssh.privateKeyToOpenSSH(privateKey, passphrase);\n\n// gets the SSH public key fingerprint in a byte buffer\nforge.ssh.getPublicKeyFingerprint(key);\n\n// gets a hex-encoded, colon-delimited SSH public key fingerprint\nforge.ssh.getPublicKeyFingerprint(key, {encoding: 'hex', delimiter: ':'});\n```\n\n<a name=\"xhr\" />\n\n### XHR\n\nProvides an XmlHttpRequest implementation using forge.http as a backend.\n\n__Examples__\n\n```js\n// TODO\n```\n\n<a name=\"socket\" />\n\n### Sockets\n\nProvides an interface to create and use raw sockets provided via Flash.\n\n__Examples__\n\n```js\n// TODO\n```\n\nCiphers\n-------\n\n<a name=\"cipher\" />\n\n### CIPHER\n\nProvides a basic API for block encryption and decryption. There is built-in\nsupport for the ciphers: [AES][], [3DES][], and [DES][], and for the modes\nof operation: [ECB][], [CBC][], [CFB][], [OFB][], [CTR][], and [GCM][].\n\nThese algorithms are currently supported:\n\n* AES-ECB\n* AES-CBC\n* AES-CFB\n* AES-OFB\n* AES-CTR\n* AES-GCM\n* 3DES-ECB\n* 3DES-CBC\n* DES-ECB\n* DES-CBC\n\nWhen using an [AES][] algorithm, the key size will determine whether\nAES-128, AES-192, or AES-256 is used (all are supported). When a [DES][]\nalgorithm is used, the key size will determine whether [3DES][] or regular\n[DES][] is used. Use a [3DES][] algorithm to enforce Triple-DES.\n\n__Examples__\n\n```js\n// generate a random key and IV\n// Note: a key size of 16 bytes will use AES-128, 24 => AES-192, 32 => AES-256\nvar key = forge.random.getBytesSync(16);\nvar iv = forge.random.getBytesSync(16);\n\n/* alternatively, generate a password-based 16-byte key\nvar salt = forge.random.getBytesSync(128);\nvar key = forge.pkcs5.pbkdf2('password', salt, numIterations, 16);\n*/\n\n// encrypt some bytes using CBC mode\n// (other modes include: ECB, CFB, OFB, CTR, and GCM)\n// Note: CBC and ECB modes use PKCS#7 padding as default\nvar cipher = forge.cipher.createCipher('AES-CBC', key);\ncipher.start({iv: iv});\ncipher.update(forge.util.createBuffer(someBytes));\ncipher.finish();\nvar encrypted = cipher.output;\n// outputs encrypted hex\nconsole.log(encrypted.toHex());\n\n// decrypt some bytes using CBC mode\n// (other modes include: CFB, OFB, CTR, and GCM)\nvar decipher = forge.cipher.createDecipher('AES-CBC', key);\ndecipher.start({iv: iv});\ndecipher.update(encrypted);\nvar result = decipher.finish(); // check 'result' for true/false\n// outputs decrypted hex\nconsole.log(decipher.output.toHex());\n\n// decrypt bytes using CBC mode and streaming\n// Performance can suffer for large multi-MB inputs due to buffer\n// manipulations. Stream processing in chunks can offer significant\n// improvement. CPU intensive update() calls could also be performed with\n// setImmediate/setTimeout to avoid blocking the main browser UI thread (not\n// shown here). Optimal block size depends on the JavaScript VM and other\n// factors. Encryption can use a simple technique for increased performance.\nvar encryptedBytes = encrypted.bytes();\nvar decipher = forge.cipher.createDecipher('AES-CBC', key);\ndecipher.start({iv: iv});\nvar length = encryptedBytes.length;\nvar chunkSize = 1024 * 64;\nvar index = 0;\nvar decrypted = '';\ndo {\n decrypted += decipher.output.getBytes();\n var buf = forge.util.createBuffer(encryptedBytes.substr(index, chunkSize));\n decipher.update(buf);\n index += chunkSize;\n} while(index < length);\nvar result = decipher.finish();\nassert(result);\ndecrypted += decipher.output.getBytes();\nconsole.log(forge.util.bytesToHex(decrypted));\n\n// encrypt some bytes using GCM mode\nvar cipher = forge.cipher.createCipher('AES-GCM', key);\ncipher.start({\n iv: iv, // should be a 12-byte binary-encoded string or byte buffer\n additionalData: 'binary-encoded string', // optional\n tagLength: 128 // optional, defaults to 128 bits\n});\ncipher.update(forge.util.createBuffer(someBytes));\ncipher.finish();\nvar encrypted = cipher.output;\nvar tag = cipher.mode.tag;\n// outputs encrypted hex\nconsole.log(encrypted.toHex());\n// outputs authentication tag\nconsole.log(tag.toHex());\n\n// decrypt some bytes using GCM mode\nvar decipher = forge.cipher.createDecipher('AES-GCM', key);\ndecipher.start({\n iv: iv,\n additionalData: 'binary-encoded string', // optional\n tagLength: 128, // optional, defaults to 128 bits\n tag: tag // authentication tag from encryption\n});\ndecipher.update(encrypted);\nvar pass = decipher.finish();\n// pass is false if there was a failure (eg: authentication tag didn't match)\nif(pass) {\n // outputs decrypted hex\n console.log(decipher.output.toHex());\n}\n```\n\nUsing forge in Node.js to match openssl's \"enc\" command line tool (**Note**: OpenSSL \"enc\" uses a non-standard file format with a custom key derivation function and a fixed iteration count of 1, which some consider less secure than alternatives such as [OpenPGP](https://tools.ietf.org/html/rfc4880)/[GnuPG](https://www.gnupg.org/)):\n\n```js\nvar forge = require('node-forge');\nvar fs = require('fs');\n\n// openssl enc -des3 -in input.txt -out input.enc\nfunction encrypt(password) {\n var input = fs.readFileSync('input.txt', {encoding: 'binary'});\n\n // 3DES key and IV sizes\n var keySize = 24;\n var ivSize = 8;\n\n // get derived bytes\n // Notes:\n // 1. If using an alternative hash (eg: \"-md sha1\") pass\n // \"forge.md.sha1.create()\" as the final parameter.\n // 2. If using \"-nosalt\", set salt to null.\n var salt = forge.random.getBytesSync(8);\n // var md = forge.md.sha1.create(); // \"-md sha1\"\n var derivedBytes = forge.pbe.opensslDeriveBytes(\n password, salt, keySize + ivSize/*, md*/);\n var buffer = forge.util.createBuffer(derivedBytes);\n var key = buffer.getBytes(keySize);\n var iv = buffer.getBytes(ivSize);\n\n var cipher = forge.cipher.createCipher('3DES-CBC', key);\n cipher.start({iv: iv});\n cipher.update(forge.util.createBuffer(input, 'binary'));\n cipher.finish();\n\n var output = forge.util.createBuffer();\n\n // if using a salt, prepend this to the output:\n if(salt !== null) {\n output.putBytes('Salted__'); // (add to match openssl tool output)\n output.putBytes(salt);\n }\n output.putBuffer(cipher.output);\n\n fs.writeFileSync('input.enc', output.getBytes(), {encoding: 'binary'});\n}\n\n// openssl enc -d -des3 -in input.enc -out input.dec.txt\nfunction decrypt(password) {\n var input = fs.readFileSync('input.enc', {encoding: 'binary'});\n\n // parse salt from input\n input = forge.util.createBuffer(input, 'binary');\n // skip \"Salted__\" (if known to be present)\n input.getBytes('Salted__'.length);\n // read 8-byte salt\n var salt = input.getBytes(8);\n\n // Note: if using \"-nosalt\", skip above parsing and use\n // var salt = null;\n\n // 3DES key and IV sizes\n var keySize = 24;\n var ivSize = 8;\n\n var derivedBytes = forge.pbe.opensslDeriveBytes(\n password, salt, keySize + ivSize);\n var buffer = forge.util.createBuffer(derivedBytes);\n var key = buffer.getBytes(keySize);\n var iv = buffer.getBytes(ivSize);\n\n var decipher = forge.cipher.createDecipher('3DES-CBC', key);\n decipher.start({iv: iv});\n decipher.update(input);\n var result = decipher.finish(); // check 'result' for true/false\n\n fs.writeFileSync(\n 'input.dec.txt', decipher.output.getBytes(), {encoding: 'binary'});\n}\n```\n\n<a name=\"aes\" />\n\n### AES\n\nProvides [AES][] encryption and decryption in [CBC][], [CFB][], [OFB][],\n[CTR][], and [GCM][] modes. See [CIPHER](#cipher) for examples.\n\n<a name=\"des\" />\n\n### DES\n\nProvides [3DES][] and [DES][] encryption and decryption in [ECB][] and\n[CBC][] modes. See [CIPHER](#cipher) for examples.\n\n<a name=\"rc2\" />\n\n### RC2\n\n__Examples__\n\n```js\n// generate a random key and IV\nvar key = forge.random.getBytesSync(16);\nvar iv = forge.random.getBytesSync(8);\n\n// encrypt some bytes\nvar cipher = forge.rc2.createEncryptionCipher(key);\ncipher.start(iv);\ncipher.update(forge.util.createBuffer(someBytes));\ncipher.finish();\nvar encrypted = cipher.output;\n// outputs encrypted hex\nconsole.log(encrypted.toHex());\n\n// decrypt some bytes\nvar cipher = forge.rc2.createDecryptionCipher(key);\ncipher.start(iv);\ncipher.update(encrypted);\ncipher.finish();\n// outputs decrypted hex\nconsole.log(cipher.output.toHex());\n```\n\nPKI\n---\n\nProvides [X.509][] certificate support, ED25519 key generation and\nsigning/verifying, and RSA public and private key encoding, decoding,\nencryption/decryption, and signing/verifying.\n\n<a name=\"ed25519\" />\n\n### ED25519\n\nSpecial thanks to [TweetNaCl.js][] for providing the bulk of the implementation.\n\n__Examples__\n\n```js\nvar ed25519 = forge.pki.ed25519;\n\n// generate a random ED25519 keypair\nvar keypair = ed25519.generateKeyPair();\n// `keypair.publicKey` is a node.js Buffer or Uint8Array\n// `keypair.privateKey` is a node.js Buffer or Uint8Array\n\n// generate a random ED25519 keypair based on a random 32-byte seed\nvar seed = forge.random.getBytesSync(32);\nvar keypair = ed25519.generateKeyPair({seed: seed});\n\n// generate a random ED25519 keypair based on a \"password\" 32-byte seed\nvar password = 'Mai9ohgh6ahxee0jutheew0pungoozil';\nvar seed = new forge.util.ByteBuffer(password, 'utf8');\nvar keypair = ed25519.generateKeyPair({seed: seed});\n\n// sign a UTF-8 message\nvar signature = ED25519.sign({\n message: 'test',\n // also accepts `binary` if you want to pass a binary string\n encoding: 'utf8',\n // node.js Buffer, Uint8Array, forge ByteBuffer, binary string\n privateKey: privateKey\n});\n// `signature` is a node.js Buffer or Uint8Array\n\n// sign a message passed as a buffer\nvar signature = ED25519.sign({\n // also accepts a forge ByteBuffer or Uint8Array\n message: new Buffer('test', 'utf8'),\n privateKey: privateKey\n});\n\n// sign a message digest (shorter \"message\" == better performance)\nvar md = forge.md.sha256.create();\nmd.update('test', 'utf8');\nvar signature = ED25519.sign({\n md: md,\n privateKey: privateKey\n});\n\n// verify a signature on a UTF-8 message\nvar verified = ED25519.verify({\n message: 'test',\n encoding: 'utf8',\n // node.js Buffer, Uint8Array, forge ByteBuffer, or binary string\n signature: signature,\n // node.js Buffer, Uint8Array, forge ByteBuffer, or binary string\n publicKey: publicKey\n});\n// `verified` is true/false\n\n// sign a message passed as a buffer\nvar verified = ED25519.verify({\n // also accepts a forge ByteBuffer or Uint8Array\n message: new Buffer('test', 'utf8'),\n // node.js Buffer, Uint8Array, forge ByteBuffer, or binary string\n signature: signature,\n // node.js Buffer, Uint8Array, forge ByteBuffer, or binary string\n publicKey: publicKey\n});\n\n// verify a signature on a message digest\nvar md = forge.md.sha256.create();\nmd.update('test', 'utf8');\nvar verified = ED25519.verify({\n md: md,\n // node.js Buffer, Uint8Array, forge ByteBuffer, or binary string\n signature: signature,\n // node.js Buffer, Uint8Array, forge ByteBuffer, or binary string\n publicKey: publicKey\n});\n```\n\n<a name=\"rsa\" />\n\n### RSA\n\n__Examples__\n\n```js\nvar rsa = forge.pki.rsa;\n\n// generate an RSA key pair synchronously\n// *NOT RECOMMENDED* -- can be significantly slower than async and will not\n// use native APIs if available.\nvar keypair = rsa.generateKeyPair({bits: 2048, e: 0x10001});\n\n// generate an RSA key pair asynchronously (uses web workers if available)\n// use workers: -1 to run a fast core estimator to optimize # of workers\n// *RECOMMENDED* - can be significantly faster than sync -- and will use\n// native APIs if available.\nrsa.generateKeyPair({bits: 2048, workers: 2}, function(err, keypair) {\n // keypair.privateKey, keypair.publicKey\n});\n\n// generate an RSA key pair in steps that attempt to run for a specified period\n// of time on the main JS thread\nvar state = rsa.createKeyPairGenerationState(2048, 0x10001);\nvar step = function() {\n // run for 100 ms\n if(!rsa.stepKeyPairGenerationState(state, 100)) {\n setTimeout(step, 1);\n }\n else {\n // done, turn off progress indicator, use state.keys\n }\n};\n// turn on progress indicator, schedule generation to run\nsetTimeout(step);\n\n// sign data with a private key and output DigestInfo DER-encoded bytes\n// (defaults to RSASSA PKCS#1 v1.5)\nvar md = forge.md.sha1.create();\nmd.update('sign this', 'utf8');\nvar signature = privateKey.sign(md);\n\n// verify data with a public key\n// (defaults to RSASSA PKCS#1 v1.5)\nvar verified = publicKey.verify(md.digest().bytes(), signature);\n\n// sign data using RSASSA-PSS where PSS uses a SHA-1 hash, a SHA-1 based\n// masking function MGF1, and a 20 byte salt\nvar md = forge.md.sha1.create();\nmd.update('sign this', 'utf8');\nvar pss = forge.pss.create({\n md: forge.md.sha1.create(),\n mgf: forge.mgf.mgf1.create(forge.md.sha1.create()),\n saltLength: 20\n // optionally pass 'prng' with a custom PRNG implementation\n // optionalls pass 'salt' with a forge.util.ByteBuffer w/custom salt\n});\nvar signature = privateKey.sign(md, pss);\n\n// verify RSASSA-PSS signature\nvar pss = forge.pss.create({\n md: forge.md.sha1.create(),\n mgf: forge.mgf.mgf1.create(forge.md.sha1.create()),\n saltLength: 20\n // optionally pass 'prng' with a custom PRNG implementation\n});\nvar md = forge.md.sha1.create();\nmd.update('sign this', 'utf8');\npublicKey.verify(md.digest().getBytes(), signature, pss);\n\n// encrypt data with a public key (defaults to RSAES PKCS#1 v1.5)\nvar encrypted = publicKey.encrypt(bytes);\n\n// decrypt data with a private key (defaults to RSAES PKCS#1 v1.5)\nvar decrypted = privateKey.decrypt(encrypted);\n\n// encrypt data with a public key using RSAES PKCS#1 v1.5\nvar encrypted = publicKey.encrypt(bytes, 'RSAES-PKCS1-V1_5');\n\n// decrypt data with a private key using RSAES PKCS#1 v1.5\nvar decrypted = privateKey.decrypt(encrypted, 'RSAES-PKCS1-V1_5');\n\n// encrypt data with a public key using RSAES-OAEP\nvar encrypted = publicKey.encrypt(bytes, 'RSA-OAEP');\n\n// decrypt data with a private key using RSAES-OAEP\nvar decrypted = privateKey.decrypt(encrypted, 'RSA-OAEP');\n\n// encrypt data with a public key using RSAES-OAEP/SHA-256\nvar encrypted = publicKey.encrypt(bytes, 'RSA-OAEP', {\n md: forge.md.sha256.create()\n});\n\n// decrypt data with a private key using RSAES-OAEP/SHA-256\nvar decrypted = privateKey.decrypt(encrypted, 'RSA-OAEP', {\n md: forge.md.sha256.create()\n});\n\n// encrypt data with a public key using RSAES-OAEP/SHA-256/MGF1-SHA-1\n// compatible with Java's RSA/ECB/OAEPWithSHA-256AndMGF1Padding\nvar encrypted = publicKey.encrypt(bytes, 'RSA-OAEP', {\n md: forge.md.sha256.create(),\n mgf1: {\n md: forge.md.sha1.create()\n }\n});\n\n// decrypt data with a private key using RSAES-OAEP/SHA-256/MGF1-SHA-1\n// compatible with Java's RSA/ECB/OAEPWithSHA-256AndMGF1Padding\nvar decrypted = privateKey.decrypt(encrypted, 'RSA-OAEP', {\n md: forge.md.sha256.create(),\n mgf1: {\n md: forge.md.sha1.create()\n }\n});\n\n```\n\n<a name=\"rsakem\" />\n\n### RSA-KEM\n\n__Examples__\n\n```js\n// generate an RSA key pair asynchronously (uses web workers if available)\n// use workers: -1 to run a fast core estimator to optimize # of workers\nforge.rsa.generateKeyPair({bits: 2048, workers: -1}, function(err, keypair) {\n // keypair.privateKey, keypair.publicKey\n});\n\n// generate and encapsulate a 16-byte secret key\nvar kdf1 = new forge.kem.kdf1(forge.md.sha1.create());\nvar kem = forge.kem.rsa.create(kdf1);\nvar result = kem.encrypt(keypair.publicKey, 16);\n// result has 'encapsulation' and 'key'\n\n// encrypt some bytes\nvar iv = forge.random.getBytesSync(12);\nvar someBytes = 'hello world!';\nvar cipher = forge.cipher.createCipher('AES-GCM', result.key);\ncipher.start({iv: iv});\ncipher.update(forge.util.createBuffer(someBytes));\ncipher.finish();\nvar encrypted = cipher.output.getBytes();\nvar tag = cipher.mode.tag.getBytes();\n\n// send 'encrypted', 'iv', 'tag', and result.encapsulation to recipient\n\n// decrypt encapsulated 16-byte secret key\nvar kdf1 = new forge.kem.kdf1(forge.md.sha1.create());\nvar kem = forge.kem.rsa.create(kdf1);\nvar key = kem.decrypt(keypair.privateKey, result.encapsulation, 16);\n\n// decrypt some bytes\nvar decipher = forge.cipher.createDecipher('AES-GCM', key);\ndecipher.start({iv: iv, tag: tag});\ndecipher.update(forge.util.createBuffer(encrypted));\nvar pass = decipher.finish();\n// pass is false if there was a failure (eg: authentication tag didn't match)\nif(pass) {\n // outputs 'hello world!'\n console.log(decipher.output.getBytes());\n}\n\n```\n\n<a name=\"x509\" />\n\n### X.509\n\n__Examples__\n\n```js\nvar pki = forge.pki;\n\n// convert a PEM-formatted public key to a Forge public key\nvar publicKey = pki.publicKeyFromPem(pem);\n\n// convert a Forge public key to PEM-format\nvar pem = pki.publicKeyToPem(publicKey);\n\n// convert an ASN.1 SubjectPublicKeyInfo to a Forge public key\nvar publicKey = pki.publicKeyFromAsn1(subjectPublicKeyInfo);\n\n// convert a Forge public key to an ASN.1 SubjectPublicKeyInfo\nvar subjectPublicKeyInfo = pki.publicKeyToAsn1(publicKey);\n\n// gets a SHA-1 RSAPublicKey fingerprint a byte buffer\npki.getPublicKeyFingerprint(key);\n\n// gets a SHA-1 SubjectPublicKeyInfo fingerprint a byte buffer\npki.getPublicKeyFingerprint(key, {type: 'SubjectPublicKeyInfo'});\n\n// gets a hex-encoded, colon-delimited SHA-1 RSAPublicKey public key fingerprint\npki.getPublicKeyFingerprint(key, {encoding: 'hex', delimiter: ':'});\n\n// gets a hex-encoded, colon-delimited SHA-1 SubjectPublicKeyInfo public key fingerprint\npki.getPublicKeyFingerprint(key, {\n type: 'SubjectPublicKeyInfo',\n encoding: 'hex',\n delimiter: ':'\n});\n\n// gets a hex-encoded, colon-delimited MD5 RSAPublicKey public key fingerprint\npki.getPublicKeyFingerprint(key, {\n md: forge.md.md5.create(),\n encoding: 'hex',\n delimiter: ':'\n});\n\n// creates a CA store\nvar caStore = pki.createCaStore([/* PEM-encoded cert */, ...]);\n\n// add a certificate to the CA store\ncaStore.addCertificate(certObjectOrPemString);\n\n// gets the issuer (its certificate) for the given certificate\nvar issuerCert = caStore.getIssuer(subjectCert);\n\n// verifies a certificate chain against a CA store\npki.verifyCertificateChain(caStore, chain, customVerifyCallback);\n\n// signs a certificate using the given private key\ncert.sign(privateKey);\n\n// signs a certificate using SHA-256 instead of SHA-1\ncert.sign(privateKey, forge.md.sha256.create());\n\n// verifies an issued certificate using the certificates public key\nvar verified = issuer.verify(issued);\n\n// generate a keypair and create an X.509v3 certificate\nvar keys = pki.rsa.generateKeyPair(2048);\nvar cert = pki.createCertificate();\ncert.publicKey = keys.publicKey;\n// alternatively set public key from a csr\n//cert.publicKey = csr.publicKey;\n// NOTE: serialNumber is the hex encoded value of an ASN.1 INTEGER.\n// Conforming CAs should ensure serialNumber is:\n// - no more than 20 octets\n// - non-negative (prefix a '00' if your value starts with a '1' bit)\ncert.serialNumber = '01';\ncert.validity.notBefore = new Date();\ncert.validity.notAfter = new Date();\ncert.validity.notAfter.setFullYear(cert.validity.notBefore.getFullYear() + 1);\nvar attrs = [{\n name: 'commonName',\n value: 'example.org'\n}, {\n name: 'countryName',\n value: 'US'\n}, {\n shortName: 'ST',\n value: 'Virginia'\n}, {\n name: 'localityName',\n value: 'Blacksburg'\n}, {\n name: 'organizationName',\n value: 'Test'\n}, {\n shortName: 'OU',\n value: 'Test'\n}];\ncert.setSubject(attrs);\n// alternatively set subject from a csr\n//cert.setSubject(csr.subject.attributes);\ncert.setIssuer(attrs);\ncert.setExtensions([{\n name: 'basicConstraints',\n cA: true\n}, {\n name: 'keyUsage',\n keyCertSign: true,\n digitalSignature: true,\n nonRepudiation: true,\n keyEncipherment: true,\n dataEncipherment: true\n}, {\n name: 'extKeyUsage',\n serverAuth: true,\n clientAuth: true,\n codeSigning: true,\n emailProtection: true,\n timeStamping: true\n}, {\n name: 'nsCertType',\n client: true,\n server: true,\n email: true,\n objsign: true,\n sslCA: true,\n emailCA: true,\n objCA: true\n}, {\n name: 'subjectAltName',\n altNames: [{\n type: 6, // URI\n value: 'http://example.org/webid#me'\n }, {\n type: 7, // IP\n ip: '127.0.0.1'\n }]\n}, {\n name: 'subjectKeyIdentifier'\n}]);\n/* alternatively set extensions from a csr\nvar extensions = csr.getAttribute({name: 'extensionRequest'}).extensions;\n// optionally add more extensions\nextensions.push.apply(extensions, [{\n name: 'basicConstraints',\n cA: true\n}, {\n name: 'keyUsage',\n keyCertSign: true,\n digitalSignature: true,\n nonRepudiation: true,\n keyEncipherment: true,\n dataEncipherment: true\n}]);\ncert.setExtensions(extensions);\n*/\n// self-sign certificate\ncert.sign(keys.privateKey);\n\n// convert a Forge certificate to PEM\nvar pem = pki.certificateToPem(cert);\n\n// convert a Forge certificate from PEM\nvar cert = pki.certificateFromPem(pem);\n\n// convert an ASN.1 X.509x3 object to a Forge certificate\nvar cert = pki.certificateFromAsn1(obj);\n\n// convert a Forge certificate to an ASN.1 X.509v3 object\nvar asn1Cert = pki.certificateToAsn1(cert);\n```\n\n<a name=\"pkcs5\" />\n\n### PKCS#5\n\nProvides the password-based key-derivation function from [PKCS#5][].\n\n__Examples__\n\n```js\n// generate a password-based 16-byte key\n// note an optional message digest can be passed as the final parameter\nvar salt = forge.random.getBytesSync(128);\nvar derivedKey = forge.pkcs5.pbkdf2('password', salt, numIterations, 16);\n\n// generate key asynchronously\n// note an optional message digest can be passed before the callback\nforge.pkcs5.pbkdf2('password', salt, numIterations, 16, function(err, derivedKey) {\n // do something w/derivedKey\n});\n```\n\n<a name=\"pkcs7\" />\n\n### PKCS#7\n\nProvides cryptographically protected messages from [PKCS#7][].\n\n__Examples__\n\n```js\n// convert a message from PEM\nvar p7 = forge.pkcs7.messageFromPem(pem);\n// look at p7.recipients\n\n// find a recipient by the issuer of a certificate\nvar recipient = p7.findRecipient(cert);\n\n// decrypt\np7.decrypt(p7.recipients[0], privateKey);\n\n// create a p7 enveloped message\nvar p7 = forge.pkcs7.createEnvelopedData();\n\n// add a recipient\nvar cert = forge.pki.certificateFromPem(certPem);\np7.addRecipient(cert);\n\n// set content\np7.content = forge.util.createBuffer('Hello');\n\n// encrypt\np7.encrypt();\n\n// convert message to PEM\nvar pem = forge.pkcs7.messageToPem(p7);\n\n// create a degenerate PKCS#7 certificate container\n// (CRLs not currently supported, only certificates)\nvar p7 = forge.pkcs7.createSignedData();\np7.addCertificate(certOrCertPem1);\np7.addCertificate(certOrCertPem2);\nvar pem = forge.pkcs7.messageToPem(p7);\n\n// create PKCS#7 signed data with authenticatedAttributes\n// attributes include: PKCS#9 content-type, message-digest, and signing-time\nvar p7 = forge.pkcs7.createSignedData();\np7.content = forge.util.createBuffer('Some content to be signed.', 'utf8');\np7.addCertificate(certOrCertPem);\np7.addSigner({\n key: privateKeyAssociatedWithCert,\n certificate: certOrCertPem,\n digestAlgorithm: forge.pki.oids.sha256,\n authenticatedAttributes: [{\n type: forge.pki.oids.contentType,\n value: forge.pki.oids.data\n }, {\n type: forge.pki.oids.messageDigest\n // value will be auto-populated at signing time\n }, {\n type: forge.pki.oids.signingTime,\n // value can also be auto-populated at signing time\n value: new Date()\n }]\n});\np7.sign();\nvar pem = forge.pkcs7.messageToPem(p7);\n\n// PKCS#7 Sign in detached mode.\n// Includes the signature and certificate without the signed data.\np7.sign({detached: true});\n\n```\n\n<a name=\"pkcs8\" />\n\n### PKCS#8\n\n__Examples__\n\n```js\nvar pki = forge.pki;\n\n// convert a PEM-formatted private key to a Forge private key\nvar privateKey = pki.privateKeyFromPem(pem);\n\n// convert a Forge private key to PEM-format\nvar pem = pki.privateKeyToPem(privateKey);\n\n// convert an ASN.1 PrivateKeyInfo or RSAPrivateKey to a Forge private key\nvar privateKey = pki.privateKeyFromAsn1(rsaPrivateKey);\n\n// convert a Forge private key to an ASN.1 RSAPrivateKey\nvar rsaPrivateKey = pki.privateKeyToAsn1(privateKey);\n\n// wrap an RSAPrivateKey ASN.1 object in a PKCS#8 ASN.1 PrivateKeyInfo\nvar privateKeyInfo = pki.wrapRsaPrivateKey(rsaPrivateKey);\n\n// convert a PKCS#8 ASN.1 PrivateKeyInfo to PEM\nvar pem = pki.privateKeyInfoToPem(privateKeyInfo);\n\n// encrypts a PrivateKeyInfo and outputs an EncryptedPrivateKeyInfo\nvar encryptedPrivateKeyInfo = pki.encryptPrivateKeyInfo(\n privateKeyInfo, 'password', {\n algorithm: 'aes256', // 'aes128', 'aes192', 'aes256', '3des'\n });\n\n// decrypts an ASN.1 EncryptedPrivateKeyInfo\nvar privateKeyInfo = pki.decryptPrivateKeyInfo(\n encryptedPrivateKeyInfo, 'password');\n\n// converts an EncryptedPrivateKeyInfo to PEM\nvar pem = pki.encryptedPrivateKeyToPem(encryptedPrivateKeyInfo);\n\n// converts a PEM-encoded EncryptedPrivateKeyInfo to ASN.1 format\nvar encryptedPrivateKeyInfo = pki.encryptedPrivateKeyFromPem(pem);\n\n// wraps and encrypts a Forge private key and outputs it in PEM format\nvar pem = pki.encryptRsaPrivateKey(privateKey, 'password');\n\n// encrypts a Forge private key and outputs it in PEM format using OpenSSL's\n// proprietary legacy format + encapsulated PEM headers (DEK-Info)\nvar pem = pki.encryptRsaPrivateKey(privateKey, 'password', {legacy: true});\n\n// decrypts a PEM-formatted, encrypted private key\nvar privateKey = pki.decryptRsaPrivateKey(pem, 'password');\n\n// sets an RSA public key from a private key\nvar publicKey = pki.setRsaPublicKey(privateKey.n, privateKey.e);\n```\n\n<a name=\"pkcs10\" />\n\n### PKCS#10\n\nProvides certification requests or certificate signing requests (CSR) from\n[PKCS#10][].\n\n__Examples__\n\n```js\n// generate a key pair\nvar keys = forge.pki.rsa.generateKeyPair(1024);\n\n// create a certification request (CSR)\nvar csr = forge.pki.createCertificationRequest();\ncsr.publicKey = keys.publicKey;\ncsr.setSubject([{\n name: 'commonName',\n value: 'example.org'\n}, {\n name: 'countryName',\n value: 'US'\n}, {\n shortName: 'ST',\n value: 'Virginia'\n}, {\n name: 'localityName',\n value: 'Blacksburg'\n}, {\n name: 'organizationName',\n value: 'Test'\n}, {\n shortName: 'OU',\n value: 'Test'\n}]);\n// set (optional) attributes\ncsr.setAttributes([{\n name: 'challengePassword',\n value: 'password'\n}, {\n name: 'unstructuredName',\n value: 'My Company, Inc.'\n}, {\n name: 'extensionRequest',\n extensions: [{\n name: 'subjectAltName',\n altNames: [{\n // 2 is DNS type\n type: 2,\n value: 'test.domain.com'\n }, {\n type: 2,\n value: 'other.domain.com',\n }, {\n type: 2,\n value: 'www.domain.net'\n }]\n }]\n}]);\n\n// sign certification request\ncsr.sign(keys.privateKey);\n\n// verify certification request\nvar verified = csr.verify();\n\n// convert certification request to PEM-format\nvar pem = forge.pki.certificationRequestToPem(csr);\n\n// convert a Forge certification request from PEM-format\nvar csr = forge.pki.certificationRequestFromPem(pem);\n\n// get an attribute\ncsr.getAttribute({name: 'challengePassword'});\n\n// get extensions array\ncsr.getAttribute({name: 'extensionRequest'}).extensions;\n\n```\n\n<a name=\"pkcs12\" />\n\n### PKCS#12\n\nProvides the cryptographic archive file format from [PKCS#12][].\n\n**Note for Chrome/Firefox/iOS/similar users**: If you have trouble importing\na PKCS#12 container, try using the TripleDES algorithm. It can be passed\nto `forge.pkcs12.toPkcs12Asn1` using the `{algorithm: '3des'}` option.\n\n__Examples__\n\n```js\n// decode p12 from base64\nvar p12Der = forge.util.decode64(p12b64);\n// get p12 as ASN.1 object\nvar p12Asn1 = forge.asn1.fromDer(p12Der);\n// decrypt p12 using the password 'password'\nvar p12 = forge.pkcs12.pkcs12FromAsn1(p12Asn1, 'password');\n// decrypt p12 using non-strict parsing mode (resolves some ASN.1 parse errors)\nvar p12 = forge.pkcs12.pkcs12FromAsn1(p12Asn1, false, 'password');\n// decrypt p12 using literally no password (eg: Mac OS X/apple push)\nvar p12 = forge.pkcs12.pkcs12FromAsn1(p12Asn1);\n// decrypt p12 using an \"empty\" password (eg: OpenSSL with no password input)\nvar p12 = forge.pkcs12.pkcs12FromAsn1(p12Asn1, '');\n// p12.safeContents is an array of safe contents, each of\n// which contains an array of safeBags\n\n// get bags by friendlyName\nvar bags = p12.getBags({friendlyName: 'test'});\n// bags are key'd by attribute type (here \"friendlyName\")\n// and the key values are an array of matching objects\nvar cert = bags.friendlyName[0];\n\n// get bags by localKeyId\nvar bags = p12.getBags({localKeyId: buffer});\n// bags are key'd by attribute type (here \"localKeyId\")\n// and the key values are an array of matching objects\nvar cert = bags.localKeyId[0];\n\n// get bags by localKeyId (input in hex)\nvar bags = p12.getBags({localKeyIdHex: '7b59377ff142d0be4565e9ac3d396c01401cd879'});\n// bags are key'd by attribute type (here \"localKeyId\", *not* \"localKeyIdHex\")\n// and the key values are an array of matching objects\nvar cert = bags.localKeyId[0];\n\n// get bags by type\nvar bags = p12.getBags({bagType: forge.pki.oids.certBag});\n// bags are key'd by bagType and each bagType key's value\n// is an array of matches (in this case, certificate objects)\nvar cert = bags[forge.pki.oids.certBag][0];\n\n// get bags by friendlyName and filter on bag type\nvar bags = p12.getBags({\n friendlyName: 'test',\n bagType: forge.pki.oids.certBag\n});\n\n// get key bags\nvar bags = p12.getBags({bagType: forge.pki.oids.keyBag});\n// get key\nvar bag = bags[forge.pki.oids.keyBag][0];\nvar key = bag.key;\n// if the key is in a format unrecognized by forge then\n// bag.key will be `null`, use bag.asn1 to get the ASN.1\n// representation of the key\nif(bag.key === null) {\n var keyAsn1 = bag.asn1;\n // can now convert back to DER/PEM/etc for export\n}\n\n// generate a p12 using AES (default)\nvar p12Asn1 = forge.pkcs12.toPkcs12Asn1(\n privateKey, certificateChain, 'password');\n\n// generate a p12 that can be imported by Chrome/Firefox/iOS\n// (requires the use of Triple DES instead of AES)\nvar p12Asn1 = forge.pkcs12.toPkcs12Asn1(\n privateKey, certificateChain, 'password',\n {algorithm: '3des'});\n\n// base64-encode p12\nvar p12Der = forge.asn1.toDer(p12Asn1).getBytes();\nvar p12b64 = forge.util.encode64(p12Der);\n\n// create download link for p12\nvar a = document.createElement('a');\na.download = 'example.p12';\na.setAttribute('href', 'data:application/x-pkcs12;base64,' + p12b64);\na.appendChild(document.createTextNode('Download'));\n```\n\n<a name=\"asn\" />\n\n### ASN.1\n\nProvides [ASN.1][] DER encoding and decoding.\n\n__Examples__\n\n```js\nvar asn1 = forge.asn1;\n\n// create a SubjectPublicKeyInfo\nvar subjectPublicKeyInfo =\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [\n // AlgorithmIdentifier\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [\n // algorithm\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.OID, false,\n asn1.oidToDer(pki.oids['rsaEncryption']).getBytes()),\n // parameters (null)\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.NULL, false, '')\n ]),\n // subjectPublicKey\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.BITSTRING, false, [\n // RSAPublicKey\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.SEQUENCE, true, [\n // modulus (n)\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.INTEGER, false,\n _bnToBytes(key.n)),\n // publicExponent (e)\n asn1.create(asn1.Class.UNIVERSAL, asn1.Type.INTEGER, false,\n _bnToBytes(key.e))\n ])\n ])\n ]);\n\n// serialize an ASN.1 object to DER format\nvar derBuffer = asn1.toDer(subjectPublicKeyInfo);\n\n// deserialize to an ASN.1 object from a byte buffer filled with DER data\nvar object = asn1.fromDer(derBuffer);\n\n// convert an OID dot-separated string to a byte buffer\nvar derOidBuffer = asn1.oidToDer('1.2.840.113549.1.1.5');\n\n// convert a byte buffer with a DER-encoded OID to a dot-separated string\nconsole.log(asn1.derToOid(derOidBuffer));\n// output: 1.2.840.113549.1.1.5\n\n// validates that an ASN.1 object matches a particular ASN.1 structure and\n// captures data of interest from that structure for easy access\nvar publicKeyValidator = {\n name: 'SubjectPublicKeyInfo',\n tagClass: asn1.Class.UNIVERSAL,\n type: asn1.Type.SEQUENCE,\n constructed: true,\n captureAsn1: 'subjectPublicKeyInfo',\n value: [{\n name: 'SubjectPublicKeyInfo.AlgorithmIdentifier',\n tagClass: asn1.Class.UNIVERSAL,\n type: asn1.Type.SEQUENCE,\n constructed: true,\n value: [{\n name: 'AlgorithmIdentifier.algorithm',\n tagClass: asn1.Class.UNIVERSAL,\n type: asn1.Type.OID,\n constructed: false,\n capture: 'publicKeyOid'\n }]\n }, {\n // subjectPublicKey\n name: 'SubjectPublicKeyInfo.subjectPublicKey',\n tagClass: asn1.Class.UNIVERSAL,\n type: asn1.Type.BITSTRING,\n constructed: false,\n value: [{\n // RSAPublicKey\n name: 'SubjectPublicKeyInfo.subjectPublicKey.RSAPublicKey',\n tagClass: asn1.Class.UNIVERSAL,\n type: asn1.Type.SEQUENCE,\n constructed: true,\n optional: true,\n captureAsn1: 'rsaPublicKey'\n }]\n }]\n};\n\nvar capture = {};\nvar errors = [];\nif(!asn1.validate(\n publicKeyValidator, subjectPublicKeyInfo, validator, capture, errors)) {\n throw 'ASN.1 object is not a SubjectPublicKeyInfo.';\n}\n// capture.subjectPublicKeyInfo contains the full ASN.1 object\n// capture.rsaPublicKey contains the full ASN.1 object for the RSA public key\n// capture.publicKeyOid only contains the value for the OID\nvar oid = asn1.derToOid(capture.publicKeyOid);\nif(oid !== pki.oids['rsaEncryption']) {\n throw 'Unsupported OID.';\n}\n\n// pretty print an ASN.1 object to a string for debugging purposes\nasn1.prettyPrint(object);\n```\n\nMessage Digests\n----------------\n\n<a name=\"sha1\" />\n\n### SHA1\n\nProvides [SHA-1][] message digests.\n\n__Examples__\n\n```js\nvar md = forge.md.sha1.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: 2fd4e1c67a2d28fced849ee1bb76e7391b93eb12\n```\n\n<a name=\"sha256\" />\n\n### SHA256\n\nProvides [SHA-256][] message digests.\n\n__Examples__\n\n```js\nvar md = forge.md.sha256.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592\n```\n\n<a name=\"sha384\" />\n\n### SHA384\n\nProvides [SHA-384][] message digests.\n\n__Examples__\n\n```js\nvar md = forge.md.sha384.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: ca737f1014a48f4c0b6dd43cb177b0afd9e5169367544c494011e3317dbf9a509cb1e5dc1e85a941bbee3d7f2afbc9b1\n```\n\n<a name=\"sha512\" />\n\n### SHA512\n\nProvides [SHA-512][] message digests.\n\n__Examples__\n\n```js\n// SHA-512\nvar md = forge.md.sha512.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: 07e547d9586f6a73f73fbac0435ed76951218fb7d0c8d788a309d785436bbb642e93a252a954f23912547d1e8a3b5ed6e1bfd7097821233fa0538f3db854fee6\n\n// SHA-512/224\nvar md = forge.md.sha512.sha224.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: 944cd2847fb54558d4775db0485a50003111c8e5daa63fe722c6aa37\n\n// SHA-512/256\nvar md = forge.md.sha512.sha256.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: dd9d67b371519c339ed8dbd25af90e976a1eeefd4ad3d889005e532fc5bef04d\n```\n\n<a name=\"md5\" />\n\n### MD5\n\nProvides [MD5][] message digests.\n\n__Examples__\n\n```js\nvar md = forge.md.md5.create();\nmd.update('The quick brown fox jumps over the lazy dog');\nconsole.log(md.digest().toHex());\n// output: 9e107d9d372bb6826bd81d3542a419d6\n```\n\n<a name=\"hmac\" />\n\n### HMAC\n\nProvides [HMAC][] w/any supported message digest algorithm.\n\n__Examples__\n\n```js\nvar hmac = forge.hmac.create();\nhmac.start('sha1', 'Jefe');\nhmac.update('what do ya want for nothing?');\nconsole.log(hmac.digest().toHex());\n// output: effcdf6ae5eb2fa2d27416d5f184df9c259a7c79\n```\n\nUtilities\n---------\n\n<a name=\"prime\" />\n\n### Prime\n\nProvides an API for generating large, random, probable primes.\n\n__Examples__\n\n```js\n// generate a random prime on the main JS thread\nvar bits = 1024;\nforge.prime.generateProbablePrime(bits, function(err, num) {\n console.log('random prime', num.toString(16));\n});\n\n// generate a random prime using Web Workers (if available, otherwise\n// falls back to the main thread)\nvar bits = 1024;\nvar options = {\n algorithm: {\n name: 'PRIMEINC',\n workers: -1 // auto-optimize # of workers\n }\n};\nforge.prime.generateProbablePrime(bits, options, function(err, num) {\n console.log('random prime', num.toString(16));\n});\n```\n\n<a name=\"prng\" />\n\n### PRNG\n\nProvides a [Fortuna][]-based cryptographically-secure pseudo-random number\ngenerator, to be used with a cryptographic function backend, e.g. [AES][]. An\nimplementation using [AES][] as a backend is provided. An API for collecting\nentropy is given, though if window.crypto.getRandomValues is available, it will\nbe used automatically.\n\n__Examples__\n\n```js\n// get some random bytes synchronously\nvar bytes = forge.random.getBytesSync(32);\nconsole.log(forge.util.bytesToHex(bytes));\n\n// get some random bytes asynchronously\nforge.random.getBytes(32, function(err, bytes) {\n console.log(forge.util.bytesToHex(bytes));\n});\n\n// collect some entropy if you'd like\nforge.random.collect(someRandomBytes);\njQuery().mousemove(function(e) {\n forge.random.collectInt(e.clientX, 16);\n forge.random.collectInt(e.clientY, 16);\n});\n\n// specify a seed file for use with the synchronous API if you'd like\nforge.random.seedFileSync = function(needed) {\n // get 'needed' number of random bytes from somewhere\n return fetchedRandomBytes;\n};\n\n// specify a seed file for use with the asynchronous API if you'd like\nforge.random.seedFile = function(needed, callback) {\n // get the 'needed' number of random bytes from somewhere\n callback(null, fetchedRandomBytes);\n});\n\n// register the main thread to send entropy or a Web Worker to receive\n// entropy on demand from the main thread\nforge.random.registerWorker(self);\n\n// generate a new instance of a PRNG with no collected entropy\nvar myPrng = forge.random.createInstance();\n```\n\n<a name=\"task\" />\n\n### Tasks\n\nProvides queuing and synchronizing tasks in a web application.\n\n__Examples__\n\n```js\n// TODO\n```\n\n<a name=\"util\" />\n\n### Utilities\n\nProvides utility functions, including byte buffer support, base64,\nbytes to/from hex, zlib inflate/deflate, etc.\n\n__Examples__\n\n```js\n// encode/decode base64\nvar encoded = forge.util.encode64(str);\nvar str = forge.util.decode64(encoded);\n\n// encode/decode UTF-8\nvar encoded = forge.util.encodeUtf8(str);\nvar str = forge.util.decodeUtf8(encoded);\n\n// bytes to/from hex\nvar bytes = forge.util.hexToBytes(hex);\nvar hex = forge.util.bytesToHex(bytes);\n\n// create an empty byte buffer\nvar buffer = forge.util.createBuffer();\n// create a byte buffer from raw binary bytes\nvar buffer = forge.util.createBuffer(input, 'raw');\n// create a byte buffer from utf8 bytes\nvar buffer = forge.util.createBuffer(input, 'utf8');\n\n// get the length of the buffer in bytes\nbuffer.length();\n// put bytes into the buffer\nbuffer.putBytes(bytes);\n// put a 32-bit integer into the buffer\nbuffer.putInt32(10);\n// buffer to hex\nbuffer.toHex();\n// get a copy of the bytes in the buffer\nbytes.bytes(/* count */);\n// empty this buffer and get its contents\nbytes.getBytes(/* count */);\n\n// convert a forge buffer into a Node.js Buffer\n// make sure you specify the encoding as 'binary'\nvar forgeBuffer = forge.util.createBuffer();\nvar nodeBuffer = new Buffer(forgeBuffer.getBytes(), 'binary');\n\n// convert a Node.js Buffer into a forge buffer\n// make sure you specify the encoding as 'binary'\nvar nodeBuffer = new Buffer();\nvar forgeBuffer = forge.util.createBuffer(nodeBuffer.toString('binary'));\n\n// parse a URL\nvar parsed = forge.util.parseUrl('http://example.com/foo?bar=baz');\n// parsed.scheme, parsed.host, parsed.port, parsed.path, parsed.fullHost\n```\n\n<a name=\"log\" />\n\n### Logging\n\nProvides logging to a javascript console using various categories and\nlevels of verbosity.\n\n__Examples__\n\n```js\n// TODO\n```\n\n<a name=\"debug\" />\n\n### Debugging\n\nProvides storage of debugging information normally inaccessible in\nclosures for viewing/investigation.\n\n__Examples__\n\n```js\n// TODO\n```\n\n<a name=\"flash\" />\n\n### Flash Networking Support\n\nThe [flash README](./flash/README.md) provides details on rebuilding the\noptional Flash component used for networking. It also provides details on\nPolicy Server support.\n\nSecurity Considerations\n-----------------------\n\nWhen using this code please keep the following in mind:\n\n- Cryptography is hard. Please review and test this code before depending on it\n for critical functionality.\n- The nature of JavaScript is that execution of this code depends on trusting a\n very large set of JavaScript tools and systems. Consider runtime variations,\n runtime characteristics, runtime optimization, code optimization, code\n minimization, code obfuscation, bundling tools, possible bugs, the Forge code\n itself, and so on.\n- If using pre-built bundles from [Bower][] or similar be aware someone else\n ran the tools to create those files.\n- Use a secure transport channel such as [TLS][] to load scripts and consider\n using additional security mechanisms such as [Subresource Integrity][] script\n attributes.\n- Use \"native\" functionality where possible. This can be critical when dealing\n with performance and random number generation. Note that the JavaScript\n random number algorithms should perform well if given suitable entropy.\n- Understand possible attacks against cryptographic systems. For instance side\n channel and timing attacks may be possible due to the difficulty in\n implementing constant time algorithms in pure JavaScript.\n- Certain features in this library are less susceptible to attacks depending on\n usage. This primarily includes features that deal with data format\n manipulation or those that are not involved in communication.\n\nLibrary Background\n------------------\n\n* http://digitalbazaar.com/2010/07/20/javascript-tls-1/\n* http://digitalbazaar.com/2010/07/20/javascript-tls-2/\n\nContact\n-------\n\n* Code: https://github.com/digitalbazaar/forge\n* Bugs: https://github.com/digitalbazaar/forge/issues\n* Email: support@digitalbazaar.com\n* IRC: [#forgejs][] on [freenode][]\n\nDonations\n---------\n\nFinancial support is welcome and helps contribute to futher development:\n\n* For [PayPal][] please send to paypal@digitalbazaar.com.\n* Something else? Please contact support@digitalbazaar.com.\n\n[#forgejs]: https://webchat.freenode.net/?channels=#forgejs\n[0.6.x]: https://github.com/digitalbazaar/forge/tree/0.6.x\n[3DES]: http://en.wikipedia.org/wiki/Triple_DES\n[AES]: http://en.wikipedia.org/wiki/Advanced_Encryption_Standard\n[ASN.1]: http://en.wikipedia.org/wiki/ASN.1\n[Bower]: https://bower.io/\n[Browserify]: http://browserify.org/\n[CBC]: http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation\n[CFB]: http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation\n[CTR]: http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation\n[CommonJS]: https://en.wikipedia.org/wiki/CommonJS\n[DES]: http://en.wikipedia.org/wiki/Data_Encryption_Standard\n[ECB]: http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation\n[Fortuna]: http://en.wikipedia.org/wiki/Fortuna_(PRNG)\n[GCM]: http://en.wikipedia.org/wiki/GCM_mode\n[HMAC]: http://en.wikipedia.org/wiki/HMAC\n[JavaScript]: http://en.wikipedia.org/wiki/JavaScript\n[Karma]: https://karma-runner.github.io/\n[MD5]: http://en.wikipedia.org/wiki/MD5\n[Node.js]: http://nodejs.org/\n[OFB]: http://en.wikipedia.org/wiki/Block_cipher_mode_of_operation\n[PKCS#10]: http://en.wikipedia.org/wiki/Certificate_signing_request\n[PKCS#12]: http://en.wikipedia.org/wiki/PKCS_%E2%99%AF12\n[PKCS#5]: http://en.wikipedia.org/wiki/PKCS\n[PKCS#7]: http://en.wikipedia.org/wiki/Cryptographic_Message_Syntax\n[PayPal]: https://www.paypal.com/\n[RC2]: http://en.wikipedia.org/wiki/RC2\n[SHA-1]: http://en.wikipedia.org/wiki/SHA-1\n[SHA-256]: http://en.wikipedia.org/wiki/SHA-256\n[SHA-384]: http://en.wikipedia.org/wiki/SHA-384\n[SHA-512]: http://en.wikipedia.org/wiki/SHA-512\n[Subresource Integrity]: https://www.w3.org/TR/SRI/\n[TLS]: http://en.wikipedia.org/wiki/Transport_Layer_Security\n[UMD]: https://github.com/umdjs/umd\n[X.509]: http://en.wikipedia.org/wiki/X.509\n[freenode]: https://freenode.net/\n[unpkg]: https://unpkg.com/\n[webpack]: https://webpack.github.io/\n[TweetNaCl]: https://github.com/dchest/tweetnacl-js\n# send\n\n[![NPM Version][npm-version-image]][npm-url]\n[![NPM Downloads][npm-downloads-image]][npm-url]\n[![Linux Build][travis-image]][travis-url]\n[![Windows Build][appveyor-image]][appveyor-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n\nSend is a library for streaming files from the file system as a http response\nsupporting partial responses (Ranges), conditional-GET negotiation (If-Match,\nIf-Unmodified-Since, If-None-Match, If-Modified-Since), high test coverage,\nand granular events which may be leveraged to take appropriate actions in your\napplication or framework.\n\nLooking to serve up entire folders mapped to URLs? Try [serve-static](https://www.npmjs.org/package/serve-static).\n\n## Installation\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```bash\n$ npm install send\n```\n\n## API\n\n<!-- eslint-disable no-unused-vars -->\n\n```js\nvar send = require('send')\n```\n\n### send(req, path, [options])\n\nCreate a new `SendStream` for the given path to send to a `res`. The `req` is\nthe Node.js HTTP request and the `path` is a urlencoded path to send (urlencoded,\nnot the actual file-system path).\n\n#### Options\n\n##### acceptRanges\n\nEnable or disable accepting ranged requests, defaults to true.\nDisabling this will not send `Accept-Ranges` and ignore the contents\nof the `Range` request header.\n\n##### cacheControl\n\nEnable or disable setting `Cache-Control` response header, defaults to\ntrue. Disabling this will ignore the `immutable` and `maxAge` options.\n\n##### dotfiles\n\nSet how \"dotfiles\" are treated when encountered. A dotfile is a file\nor directory that begins with a dot (\".\"). Note this check is done on\nthe path itself without checking if the path actually exists on the\ndisk. If `root` is specified, only the dotfiles above the root are\nchecked (i.e. the root itself can be within a dotfile when when set\nto \"deny\").\n\n - `'allow'` No special treatment for dotfiles.\n - `'deny'` Send a 403 for any request for a dotfile.\n - `'ignore'` Pretend like the dotfile does not exist and 404.\n\nThe default value is _similar_ to `'ignore'`, with the exception that\nthis default will not ignore the files within a directory that begins\nwith a dot, for backward-compatibility.\n\n##### end\n\nByte offset at which the stream ends, defaults to the length of the file\nminus 1. The end is inclusive in the stream, meaning `end: 3` will include\nthe 4th byte in the stream.\n\n##### etag\n\nEnable or disable etag generation, defaults to true.\n\n##### extensions\n\nIf a given file doesn't exist, try appending one of the given extensions,\nin the given order. By default, this is disabled (set to `false`). An\nexample value that will serve extension-less HTML files: `['html', 'htm']`.\nThis is skipped if the requested file already has an extension.\n\n##### immutable\n\nEnable or diable the `immutable` directive in the `Cache-Control` response\nheader, defaults to `false`. If set to `true`, the `maxAge` option should\nalso be specified to enable caching. The `immutable` directive will prevent\nsupported clients from making conditional requests during the life of the\n`maxAge` option to check if the file has changed.\n\n##### index\n\nBy default send supports \"index.html\" files, to disable this\nset `false` or to supply a new index pass a string or an array\nin preferred order.\n\n##### lastModified\n\nEnable or disable `Last-Modified` header, defaults to true. Uses the file\nsystem's last modified value.\n\n##### maxAge\n\nProvide a max-age in milliseconds for http caching, defaults to 0.\nThis can also be a string accepted by the\n[ms](https://www.npmjs.org/package/ms#readme) module.\n\n##### root\n\nServe files relative to `path`.\n\n##### start\n\nByte offset at which the stream starts, defaults to 0. The start is inclusive,\nmeaning `start: 2` will include the 3rd byte in the stream.\n\n#### Events\n\nThe `SendStream` is an event emitter and will emit the following events:\n\n - `error` an error occurred `(err)`\n - `directory` a directory was requested `(res, path)`\n - `file` a file was requested `(path, stat)`\n - `headers` the headers are about to be set on a file `(res, path, stat)`\n - `stream` file streaming has started `(stream)`\n - `end` streaming has completed\n\n#### .pipe\n\nThe `pipe` method is used to pipe the response into the Node.js HTTP response\nobject, typically `send(req, path, options).pipe(res)`.\n\n### .mime\n\nThe `mime` export is the global instance of of the\n[`mime` npm module](https://www.npmjs.com/package/mime).\n\nThis is used to configure the MIME types that are associated with file extensions\nas well as other options for how to resolve the MIME type of a file (like the\ndefault type to use for an unknown file extension).\n\n## Error-handling\n\nBy default when no `error` listeners are present an automatic response will be\nmade, otherwise you have full control over the response, aka you may show a 5xx\npage etc.\n\n## Caching\n\nIt does _not_ perform internal caching, you should use a reverse proxy cache\nsuch as Varnish for this, or those fancy things called CDNs. If your\napplication is small enough that it would benefit from single-node memory\ncaching, it's small enough that it does not need caching at all ;).\n\n## Debugging\n\nTo enable `debug()` instrumentation output export __DEBUG__:\n\n```\n$ DEBUG=send node app\n```\n\n## Running tests\n\n```\n$ npm install\n$ npm test\n```\n\n## Examples\n\n### Serve a specific file\n\nThis simple example will send a specific file to all requests.\n\n```js\nvar http = require('http')\nvar send = require('send')\n\nvar server = http.createServer(function onRequest (req, res) {\n send(req, '/path/to/index.html')\n .pipe(res)\n})\n\nserver.listen(3000)\n```\n\n### Serve all files from a directory\n\nThis simple example will just serve up all the files in a\ngiven directory as the top-level. For example, a request\n`GET /foo.txt` will send back `/www/public/foo.txt`.\n\n```js\nvar http = require('http')\nvar parseUrl = require('parseurl')\nvar send = require('send')\n\nvar server = http.createServer(function onRequest (req, res) {\n send(req, parseUrl(req).pathname, { root: '/www/public' })\n .pipe(res)\n})\n\nserver.listen(3000)\n```\n\n### Custom file types\n\n```js\nvar http = require('http')\nvar parseUrl = require('parseurl')\nvar send = require('send')\n\n// Default unknown types to text/plain\nsend.mime.default_type = 'text/plain'\n\n// Add a custom type\nsend.mime.define({\n 'application/x-my-type': ['x-mt', 'x-mtt']\n})\n\nvar server = http.createServer(function onRequest (req, res) {\n send(req, parseUrl(req).pathname, { root: '/www/public' })\n .pipe(res)\n})\n\nserver.listen(3000)\n```\n\n### Custom directory index view\n\nThis is a example of serving up a structure of directories with a\ncustom function to render a listing of a directory.\n\n```js\nvar http = require('http')\nvar fs = require('fs')\nvar parseUrl = require('parseurl')\nvar send = require('send')\n\n// Transfer arbitrary files from within /www/example.com/public/*\n// with a custom handler for directory listing\nvar server = http.createServer(function onRequest (req, res) {\n send(req, parseUrl(req).pathname, { index: false, root: '/www/public' })\n .once('directory', directory)\n .pipe(res)\n})\n\nserver.listen(3000)\n\n// Custom directory handler\nfunction directory (res, path) {\n var stream = this\n\n // redirect to trailing slash for consistent url\n if (!stream.hasTrailingSlash()) {\n return stream.redirect(path)\n }\n\n // get directory list\n fs.readdir(path, function onReaddir (err, list) {\n if (err) return stream.error(err)\n\n // render an index for the directory\n res.setHeader('Content-Type', 'text/plain; charset=UTF-8')\n res.end(list.join('\\n') + '\\n')\n })\n}\n```\n\n### Serving from a root directory with custom error-handling\n\n```js\nvar http = require('http')\nvar parseUrl = require('parseurl')\nvar send = require('send')\n\nvar server = http.createServer(function onRequest (req, res) {\n // your custom error-handling logic:\n function error (err) {\n res.statusCode = err.status || 500\n res.end(err.message)\n }\n\n // your custom headers\n function headers (res, path, stat) {\n // serve all files for download\n res.setHeader('Content-Disposition', 'attachment')\n }\n\n // your custom directory handling logic:\n function redirect () {\n res.statusCode = 301\n res.setHeader('Location', req.url + '/')\n res.end('Redirecting to ' + req.url + '/')\n }\n\n // transfer arbitrary files from within\n // /www/example.com/public/*\n send(req, parseUrl(req).pathname, { root: '/www/public' })\n .on('error', error)\n .on('directory', redirect)\n .on('headers', headers)\n .pipe(res)\n})\n\nserver.listen(3000)\n```\n\n## License\n\n[MIT](LICENSE)\n\n[appveyor-image]: https://badgen.net/appveyor/ci/dougwilson/send/master?label=windows\n[appveyor-url]: https://ci.appveyor.com/project/dougwilson/send\n[coveralls-image]: https://badgen.net/coveralls/c/github/pillarjs/send/master\n[coveralls-url]: https://coveralls.io/r/pillarjs/send?branch=master\n[node-image]: https://badgen.net/npm/node/send\n[node-url]: https://nodejs.org/en/download/\n[npm-downloads-image]: https://badgen.net/npm/dm/send\n[npm-url]: https://npmjs.org/package/send\n[npm-version-image]: https://badgen.net/npm/v/send\n[travis-image]: https://badgen.net/travis/pillarjs/send/master?label=linux\n[travis-url]: https://travis-ci.org/pillarjs/send\n# color-convert\n\n[](https://travis-ci.org/Qix-/color-convert)\n\nColor-convert is a color conversion library for JavaScript and node.\nIt converts all ways between `rgb`, `hsl`, `hsv`, `hwb`, `cmyk`, `ansi`, `ansi16`, `hex` strings, and CSS `keyword`s (will round to closest):\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hsl(140, 200, 100); // [96, 48, 59]\nconvert.keyword.rgb('blue'); // [0, 0, 255]\n\nvar rgbChannels = convert.rgb.channels; // 3\nvar cmykChannels = convert.cmyk.channels; // 4\nvar ansiChannels = convert.ansi16.channels; // 1\n```\n\n# Install\n\n```console\n$ npm install color-convert\n```\n\n# API\n\nSimply get the property of the _from_ and _to_ conversion that you're looking for.\n\nAll functions have a rounded and unrounded variant. By default, return values are rounded. To get the unrounded (raw) results, simply tack on `.raw` to the function.\n\nAll 'from' functions have a hidden property called `.channels` that indicates the number of channels the function expects (not including alpha).\n\n```js\nvar convert = require('color-convert');\n\n// Hex to LAB\nconvert.hex.lab('DEADBF'); // [ 76, 21, -2 ]\nconvert.hex.lab.raw('DEADBF'); // [ 75.56213190997677, 20.653827952644754, -2.290532499330533 ]\n\n// RGB to CMYK\nconvert.rgb.cmyk(167, 255, 4); // [ 35, 0, 98, 0 ]\nconvert.rgb.cmyk.raw(167, 255, 4); // [ 34.509803921568626, 0, 98.43137254901961, 0 ]\n```\n\n### Arrays\nAll functions that accept multiple arguments also support passing an array.\n\nNote that this does **not** apply to functions that convert from a color that only requires one value (e.g. `keyword`, `ansi256`, `hex`, etc.)\n\n```js\nvar convert = require('color-convert');\n\nconvert.rgb.hex(123, 45, 67); // '7B2D43'\nconvert.rgb.hex([123, 45, 67]); // '7B2D43'\n```\n\n## Routing\n\nConversions that don't have an _explicitly_ defined conversion (in [conversions.js](conversions.js)), but can be converted by means of sub-conversions (e.g. XYZ -> **RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex).\n\nKeep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of \"direct\" (single-step) conversions, see [conversions.js](conversions.js).\n\n# Contribute\n\nIf there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request.\n\n# License\nCopyright © 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE).\n# isarray\n\n`Array#isArray` for older browsers.\n\n[](http://travis-ci.org/juliangruber/isarray)\n[](https://www.npmjs.org/package/isarray)\n\n[\n](https://ci.testling.com/juliangruber/isarray)\n\n## Usage\n\n```js\nvar isArray = require('isarray');\n\nconsole.log(isArray([])); // => true\nconsole.log(isArray({})); // => false\n```\n\n## Installation\n\nWith [npm](http://npmjs.org) do\n\n```bash\n$ npm install isarray\n```\n\nThen bundle for the browser with\n[browserify](https://github.com/substack/browserify).\n\nWith [component](http://component.io) do\n\n```bash\n$ component install juliangruber/isarray\n```\n\n## License\n\n(MIT)\n\nCopyright (c) 2013 Julian Gruber <julian@juliangruber.com>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\noauth-sign\n==========\n\nOAuth 1 signing. Formerly a vendor lib in mikeal/request, now a standalone module. \n\n## Supported Method Signatures\n\n- HMAC-SHA1\n- HMAC-SHA256\n- RSA-SHA1\n- PLAINTEXT\n# brace-expansion\n\n[Brace expansion](https://www.gnu.org/software/bash/manual/html_node/Brace-Expansion.html), \nas known from sh/bash, in JavaScript.\n\n[](http://travis-ci.org/juliangruber/brace-expansion)\n[](https://www.npmjs.org/package/brace-expansion)\n[](https://greenkeeper.io/)\n\n[](https://ci.testling.com/juliangruber/brace-expansion)\n\n## Example\n\n```js\nvar expand = require('brace-expansion');\n\nexpand('file-{a,b,c}.jpg')\n// => ['file-a.jpg', 'file-b.jpg', 'file-c.jpg']\n\nexpand('-v{,,}')\n// => ['-v', '-v', '-v']\n\nexpand('file{0..2}.jpg')\n// => ['file0.jpg', 'file1.jpg', 'file2.jpg']\n\nexpand('file-{a..c}.jpg')\n// => ['file-a.jpg', 'file-b.jpg', 'file-c.jpg']\n\nexpand('file{2..0}.jpg')\n// => ['file2.jpg', 'file1.jpg', 'file0.jpg']\n\nexpand('file{0..4..2}.jpg')\n// => ['file0.jpg', 'file2.jpg', 'file4.jpg']\n\nexpand('file-{a..e..2}.jpg')\n// => ['file-a.jpg', 'file-c.jpg', 'file-e.jpg']\n\nexpand('file{00..10..5}.jpg')\n// => ['file00.jpg', 'file05.jpg', 'file10.jpg']\n\nexpand('{{A..C},{a..c}}')\n// => ['A', 'B', 'C', 'a', 'b', 'c']\n\nexpand('ppp{,config,oe{,conf}}')\n// => ['ppp', 'pppconfig', 'pppoe', 'pppoeconf']\n```\n\n## API\n\n```js\nvar expand = require('brace-expansion');\n```\n\n### var expanded = expand(str)\n\nReturn an array of all possible and valid expansions of `str`. If none are\nfound, `[str]` is returned.\n\nValid expansions are:\n\n```js\n/^(.*,)+(.+)?$/\n// {a,b,...}\n```\n\nA comma separated list of options, like `{a,b}` or `{a,{b,c}}` or `{,a,}`.\n\n```js\n/^-?\\d+\\.\\.-?\\d+(\\.\\.-?\\d+)?$/\n// {x..y[..incr]}\n```\n\nA numeric sequence from `x` to `y` inclusive, with optional increment.\nIf `x` or `y` start with a leading `0`, all the numbers will be padded\nto have equal length. Negative numbers and backwards iteration work too.\n\n```js\n/^-?\\d+\\.\\.-?\\d+(\\.\\.-?\\d+)?$/\n// {x..y[..incr]}\n```\n\nAn alphabetic sequence from `x` to `y` inclusive, with optional increment.\n`x` and `y` must be exactly one character, and if given, `incr` must be a\nnumber.\n\nFor compatibility reasons, the string `${` is not eligible for brace expansion.\n\n## Installation\n\nWith [npm](https://npmjs.org) do:\n\n```bash\nnpm install brace-expansion\n```\n\n## Contributors\n\n- [Julian Gruber](https://github.com/juliangruber)\n- [Isaac Z. Schlueter](https://github.com/isaacs)\n\n## Sponsors\n\nThis module is proudly supported by my [Sponsors](https://github.com/juliangruber/sponsors)!\n\nDo you want to support modules like this to improve their quality, stability and weigh in on new features? Then please consider donating to my [Patreon](https://www.patreon.com/juliangruber). Not sure how much of my modules you're using? Try [feross/thanks](https://github.com/feross/thanks)!\n\n## License\n\n(MIT)\n\nCopyright (c) 2013 Julian Gruber <julian@juliangruber.com>\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n<!--\n -- This file is auto-generated from README_js.md. Changes should be made there.\n -->\n\n# uuid [](http://travis-ci.org/kelektiv/node-uuid) #\n\nSimple, fast generation of [RFC4122](http://www.ietf.org/rfc/rfc4122.txt) UUIDS.\n\nFeatures:\n\n* Support for version 1, 3, 4 and 5 UUIDs\n* Cross-platform\n* Uses cryptographically-strong random number APIs (when available)\n* Zero-dependency, small footprint (... but not [this small](https://gist.github.com/982883))\n\n[**Deprecation warning**: The use of `require('uuid')` is deprecated and will not be\nsupported after version 3.x of this module. Instead, use `require('uuid/[v1|v3|v4|v5]')` as shown in the examples below.]\n\n## Quickstart - CommonJS (Recommended)\n\n```shell\nnpm install uuid\n```\n\nThen generate your uuid version of choice ...\n\nVersion 1 (timestamp):\n\n```javascript\nconst uuidv1 = require('uuid/v1');\nuuidv1(); // ⇨ '2c5ea4c0-4067-11e9-8bad-9b1deb4d3b7d'\n\n```\n\nVersion 3 (namespace):\n\n```javascript\nconst uuidv3 = require('uuid/v3');\n\n// ... using predefined DNS namespace (for domain names)\nuuidv3('hello.example.com', uuidv3.DNS); // ⇨ '9125a8dc-52ee-365b-a5aa-81b0b3681cf6'\n\n// ... using predefined URL namespace (for, well, URLs)\nuuidv3('http://example.com/hello', uuidv3.URL); // ⇨ 'c6235813-3ba4-3801-ae84-e0a6ebb7d138'\n\n// ... using a custom namespace\n//\n// Note: Custom namespaces should be a UUID string specific to your application!\n// E.g. the one here was generated using this modules `uuid` CLI.\nconst MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';\nuuidv3('Hello, World!', MY_NAMESPACE); // ⇨ 'e8b5a51d-11c8-3310-a6ab-367563f20686'\n\n```\n\nVersion 4 (random):\n\n```javascript\nconst uuidv4 = require('uuid/v4');\nuuidv4(); // ⇨ '1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed'\n\n```\n\nVersion 5 (namespace):\n\n```javascript\nconst uuidv5 = require('uuid/v5');\n\n// ... using predefined DNS namespace (for domain names)\nuuidv5('hello.example.com', uuidv5.DNS); // ⇨ 'fdda765f-fc57-5604-a269-52a7df8164ec'\n\n// ... using predefined URL namespace (for, well, URLs)\nuuidv5('http://example.com/hello', uuidv5.URL); // ⇨ '3bbcee75-cecc-5b56-8031-b6641c1ed1f1'\n\n// ... using a custom namespace\n//\n// Note: Custom namespaces should be a UUID string specific to your application!\n// E.g. the one here was generated using this modules `uuid` CLI.\nconst MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341';\nuuidv5('Hello, World!', MY_NAMESPACE); // ⇨ '630eb68f-e0fa-5ecc-887a-7c7a62614681'\n\n```\n\n## API\n\n### Version 1\n\n```javascript\nconst uuidv1 = require('uuid/v1');\n\n// Incantations\nuuidv1();\nuuidv1(options);\nuuidv1(options, buffer, offset);\n```\n\nGenerate and return a RFC4122 v1 (timestamp-based) UUID.\n\n* `options` - (Object) Optional uuid state to apply. Properties may include:\n\n * `node` - (Array) Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1.\n * `clockseq` - (Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used.\n * `msecs` - (Number) Time in milliseconds since unix Epoch. Default: The current time is used.\n * `nsecs` - (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if `msecs` is unspecified. Default: internal uuid counter is used, as per 4.2.1.2.\n\n* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written.\n* `offset` - (Number) Starting index in `buffer` at which to begin writing.\n\nReturns `buffer`, if specified, otherwise the string form of the UUID\n\nNote: The default [node id](https://tools.ietf.org/html/rfc4122#section-4.1.6) (the last 12 digits in the UUID) is generated once, randomly, on process startup, and then remains unchanged for the duration of the process.\n\nExample: Generate string UUID with fully-specified options\n\n```javascript\nconst v1options = {\n node: [0x01, 0x23, 0x45, 0x67, 0x89, 0xab],\n clockseq: 0x1234,\n msecs: new Date('2011-11-01').getTime(),\n nsecs: 5678\n};\nuuidv1(v1options); // ⇨ '710b962e-041c-11e1-9234-0123456789ab'\n\n```\n\nExample: In-place generation of two binary IDs\n\n```javascript\n// Generate two ids in an array\nconst arr = new Array();\nuuidv1(null, arr, 0); // ⇨ \n // [\n // 44, 94, 164, 192, 64, 103,\n // 17, 233, 146, 52, 155, 29,\n // 235, 77, 59, 125\n // ]\nuuidv1(null, arr, 16); // ⇨ \n // [\n // 44, 94, 164, 192, 64, 103, 17, 233,\n // 146, 52, 155, 29, 235, 77, 59, 125,\n // 44, 94, 164, 193, 64, 103, 17, 233,\n // 146, 52, 155, 29, 235, 77, 59, 125\n // ]\n\n```\n\n### Version 3\n\n```javascript\nconst uuidv3 = require('uuid/v3');\n\n// Incantations\nuuidv3(name, namespace);\nuuidv3(name, namespace, buffer);\nuuidv3(name, namespace, buffer, offset);\n```\n\nGenerate and return a RFC4122 v3 UUID.\n\n* `name` - (String | Array[]) \"name\" to create UUID with\n* `namespace` - (String | Array[]) \"namespace\" UUID either as a String or Array[16] of byte values\n* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written.\n* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0\n\nReturns `buffer`, if specified, otherwise the string form of the UUID\n\nExample:\n\n```javascript\nuuidv3('hello world', MY_NAMESPACE); // ⇨ '042ffd34-d989-321c-ad06-f60826172424'\n\n```\n\n### Version 4\n\n```javascript\nconst uuidv4 = require('uuid/v4')\n\n// Incantations\nuuidv4();\nuuidv4(options);\nuuidv4(options, buffer, offset);\n```\n\nGenerate and return a RFC4122 v4 UUID.\n\n* `options` - (Object) Optional uuid state to apply. Properties may include:\n * `random` - (Number[16]) Array of 16 numbers (0-255) to use in place of randomly generated values\n * `rng` - (Function) Random # generator function that returns an Array[16] of byte values (0-255)\n* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written.\n* `offset` - (Number) Starting index in `buffer` at which to begin writing.\n\nReturns `buffer`, if specified, otherwise the string form of the UUID\n\nExample: Generate string UUID with predefined `random` values\n\n```javascript\nconst v4options = {\n random: [\n 0x10, 0x91, 0x56, 0xbe, 0xc4, 0xfb, 0xc1, 0xea,\n 0x71, 0xb4, 0xef, 0xe1, 0x67, 0x1c, 0x58, 0x36\n ]\n};\nuuidv4(v4options); // ⇨ '109156be-c4fb-41ea-b1b4-efe1671c5836'\n\n```\n\nExample: Generate two IDs in a single buffer\n\n```javascript\nconst buffer = new Array();\nuuidv4(null, buffer, 0); // ⇨ \n // [\n // 155, 29, 235, 77, 59,\n // 125, 75, 173, 155, 221,\n // 43, 13, 123, 61, 203,\n // 109\n // ]\nuuidv4(null, buffer, 16); // ⇨ \n // [\n // 155, 29, 235, 77, 59, 125, 75, 173,\n // 155, 221, 43, 13, 123, 61, 203, 109,\n // 27, 157, 107, 205, 187, 253, 75, 45,\n // 155, 93, 171, 141, 251, 189, 75, 237\n // ]\n\n```\n\n### Version 5\n\n```javascript\nconst uuidv5 = require('uuid/v5');\n\n// Incantations\nuuidv5(name, namespace);\nuuidv5(name, namespace, buffer);\nuuidv5(name, namespace, buffer, offset);\n```\n\nGenerate and return a RFC4122 v5 UUID.\n\n* `name` - (String | Array[]) \"name\" to create UUID with\n* `namespace` - (String | Array[]) \"namespace\" UUID either as a String or Array[16] of byte values\n* `buffer` - (Array | Buffer) Array or buffer where UUID bytes are to be written.\n* `offset` - (Number) Starting index in `buffer` at which to begin writing. Default = 0\n\nReturns `buffer`, if specified, otherwise the string form of the UUID\n\nExample:\n\n```javascript\nuuidv5('hello world', MY_NAMESPACE); // ⇨ '9f282611-e0fd-5650-8953-89c8e342da0b'\n\n```\n\n## Command Line\n\nUUIDs can be generated from the command line with the `uuid` command.\n\n```shell\n$ uuid\nddeb27fb-d9a0-4624-be4d-4615062daed4\n\n$ uuid v1\n02d37060-d446-11e7-a9fa-7bdae751ebe1\n```\n\nType `uuid --help` for usage details\n\n## Testing\n\n```shell\nnpm test\n```\n\n----\nMarkdown generated from [README_js.md](README_js.md) by [](https://github.com/broofa/runmd)\n# mime\n\nComprehensive MIME type mapping API based on mime-db module.\n\n## Install\n\nInstall with [npm](http://github.com/isaacs/npm):\n\n npm install mime\n\n## Contributing / Testing\n\n npm run test\n\n## Command Line\n\n mime [path_string]\n\nE.g.\n\n > mime scripts/jquery.js\n application/javascript\n\n## API - Queries\n\n### mime.lookup(path)\nGet the mime type associated with a file, if no mime type is found `application/octet-stream` is returned. Performs a case-insensitive lookup using the extension in `path` (the substring after the last '/' or '.'). E.g.\n\n```js\nvar mime = require('mime');\n\nmime.lookup('/path/to/file.txt'); // => 'text/plain'\nmime.lookup('file.txt'); // => 'text/plain'\nmime.lookup('.TXT'); // => 'text/plain'\nmime.lookup('htm'); // => 'text/html'\n```\n\n### mime.default_type\nSets the mime type returned when `mime.lookup` fails to find the extension searched for. (Default is `application/octet-stream`.)\n\n### mime.extension(type)\nGet the default extension for `type`\n\n```js\nmime.extension('text/html'); // => 'html'\nmime.extension('application/octet-stream'); // => 'bin'\n```\n\n### mime.charsets.lookup()\n\nMap mime-type to charset\n\n```js\nmime.charsets.lookup('text/plain'); // => 'UTF-8'\n```\n\n(The logic for charset lookups is pretty rudimentary. Feel free to suggest improvements.)\n\n## API - Defining Custom Types\n\nCustom type mappings can be added on a per-project basis via the following APIs.\n\n### mime.define()\n\nAdd custom mime/extension mappings\n\n```js\nmime.define({\n 'text/x-some-format': ['x-sf', 'x-sft', 'x-sfml'],\n 'application/x-my-type': ['x-mt', 'x-mtt'],\n // etc ...\n});\n\nmime.lookup('x-sft'); // => 'text/x-some-format'\n```\n\nThe first entry in the extensions array is returned by `mime.extension()`. E.g.\n\n```js\nmime.extension('text/x-some-format'); // => 'x-sf'\n```\n\n### mime.load(filepath)\n\nLoad mappings from an Apache \".types\" format file\n\n```js\nmime.load('./my_project.types');\n```\nThe .types file format is simple - See the `types` dir for examples.\nRailroad-diagram Generator\n==========================\n\nThis is a small js library for generating railroad diagrams\n(like what [JSON.org](http://json.org) uses)\nusing SVG.\n\nRailroad diagrams are a way of visually representing a grammar\nin a form that is more readable than using regular expressions or BNF.\nI think (though I haven't given it a lot of thought yet) that if it's easy to write a context-free grammar for the language,\nthe corresponding railroad diagram will be easy as well.\n\nThere are several railroad-diagram generators out there, but none of them had the visual appeal I wanted.\n[Here's an example of how they look!](http://www.xanthir.com/etc/railroad-diagrams/example.html)\nAnd [here's an online generator for you to play with and get SVG code from!](http://www.xanthir.com/etc/railroad-diagrams/generator.html)\n\nThe library now exists in a Python port as well! See the information further down.\n\nDetails\n-------\n\nTo use the library, just include the js and css files, and then call the Diagram() function.\nIts arguments are the components of the diagram (Diagram is a special form of Sequence).\nAn alternative to Diagram() is ComplexDiagram() which is used to describe a complex type diagram.\nComponents are either leaves or containers.\n\nThe leaves:\n* Terminal(text) or a bare string - represents literal text\n* NonTerminal(text) - represents an instruction or another production\n* Comment(text) - a comment\n* Skip() - an empty line\n\nThe containers:\n* Sequence(children) - like simple concatenation in a regex\n* Choice(index, children) - like | in a regex. The index argument specifies which child is the \"normal\" choice and should go in the middle\n* Optional(child, skip) - like ? in a regex. A shorthand for `Choice(1, [Skip(), child])`. If the optional `skip` parameter has the value `\"skip\"`, it instead puts the Skip() in the straight-line path, for when the \"normal\" behavior is to omit the item.\n* OneOrMore(child, repeat) - like + in a regex. The 'repeat' argument is optional, and specifies something that must go between the repetitions.\n* ZeroOrMore(child, repeat, skip) - like * in a regex. A shorthand for `Optional(OneOrMore(child, repeat))`. The optional `skip` parameter is identical to Optional().\n\nFor convenience, each component can be called with or without `new`.\nIf called without `new`,\nthe container components become n-ary;\nthat is, you can say either `new Sequence([A, B])` or just `Sequence(A,B)`.\n\nAfter constructing a Diagram, call `.format(...padding)` on it, specifying 0-4 padding values (just like CSS) for some additional \"breathing space\" around the diagram (the paddings default to 20px).\n\nThe result can either be `.toString()`'d for the markup, or `.toSVG()`'d for an `<svg>` element, which can then be immediately inserted to the document. As a convenience, Diagram also has an `.addTo(element)` method, which immediately converts it to SVG and appends it to the referenced element with default paddings. `element` defaults to `document.body`.\n\nOptions\n-------\n\nThere are a few options you can tweak, at the bottom of the file. Just tweak either until the diagram looks like what you want.\nYou can also change the CSS file - feel free to tweak to your heart's content.\nNote, though, that if you change the text sizes in the CSS,\nyou'll have to go adjust the metrics for the leaf nodes as well.\n\n* VERTICAL_SEPARATION - sets the minimum amount of vertical separation between two items. Note that the stroke width isn't counted when computing the separation; this shouldn't be relevant unless you have a very small separation or very large stroke width.\n* ARC_RADIUS - the radius of the arcs used in the branching containers like Choice. This has a relatively large effect on the size of non-trivial diagrams. Both tight and loose values look good, depending on what you're going for.\n* DIAGRAM_CLASS - the class set on the root `<svg>` element of each diagram, for use in the CSS stylesheet.\n* STROKE_ODD_PIXEL_LENGTH - the default stylesheet uses odd pixel lengths for 'stroke'. Due to rasterization artifacts, they look best when the item has been translated half a pixel in both directions. If you change the styling to use a stroke with even pixel lengths, you'll want to set this variable to `false`.\n* INTERNAL_ALIGNMENT - when some branches of a container are narrower than others, this determines how they're aligned in the extra space. Defaults to \"center\", but can be set to \"left\" or \"right\".\n\nCaveats\n-------\n\nAt this early stage, the generator is feature-complete and works as intended, but still has several TODOs:\n\n* The font-sizes are hard-coded right now, and the font handling in general is very dumb - I'm just guessing at some metrics that are probably \"good enough\" rather than measuring things properly.\n\nPython Port\n-----------\n\nIn addition to the canonical JS version, the library now exists as a Python library as well.\n\nUsing it is basically identical. The config variables are globals in the file, and so may be adjusted either manually or via tweaking from inside your program.\n\nThe main difference from the JS port is how you extract the string from the Diagram. You'll find a `writeSvg(writerFunc)` method on `Diagram`, which takes a callback of one argument and passes it the string form of the diagram. For example, it can be used like `Diagram(...).writeSvg(sys.stdout.write)` to write to stdout. **Note**: the callback will be called multiple times as it builds up the string, not just once with the whole thing. If you need it all at once, consider something like a `StringIO` as an easy way to collect it into a single string.\n\nLicense\n-------\n\nThis document and all associated files in the github project are licensed under [CC0](http://creativecommons.org/publicdomain/zero/1.0/) .\nThis means you can reuse, remix, or otherwise appropriate this project for your own use **without restriction**.\n(The actual legal meaning can be found at the above link.)\nDon't ask me for permission to use any part of this project, **just use it**.\nI would appreciate attribution, but that is not required by the license.\n# Overview\n\nAdds support for the `timers` module to browserify.\n\n## Wait, isn't it already supported in the browser?\n\nThe public methods of the `timers` module are:\n\n* `setTimeout(callback, delay, [arg], [...])`\n* `clearTimeout(timeoutId)`\n* `setInterval(callback, delay, [arg], [...])`\n* `clearInterval(intervalId)`\n\nand indeed, browsers support these already.\n\n## So, why does this exist?\n\nThe `timers` module also includes some private methods used in other built-in\nNode.js modules:\n\n* `enroll(item, delay)`\n* `unenroll(item)`\n* `active(item)`\n\nThese are used to efficiently support a large quantity of timers with the same\ntimeouts by creating only a few timers under the covers.\n\nNode.js also offers the `immediate` APIs, which aren't yet available cross-browser, so we polyfill those:\n\n* `setImmediate(callback, [arg], [...])`\n* `clearImmediate(immediateId)`\n\n## I need lots of timers and want to use linked list timers as Node.js does.\n\nLinked lists are efficient when you have thousands (millions?) of timers with the same delay.\nTake a look at [timers-browserify-full](https://www.npmjs.com/package/timers-browserify-full) in this case.\n\n# License\n\n[MIT](http://jryans.mit-license.org/)\n# Parse `data:` URLs\n\nThis package helps you parse `data:` URLs [according to the WHATWG Fetch Standard](https://fetch.spec.whatwg.org/#data-urls):\n\n```js\nconst parseDataURL = require(\"data-url\");\n\nconst textExample = parseDataURL(\"data:,Hello%2C%20World!\");\nconsole.log(textExample.mimeType.toString()); // \"text/plain;charset=US-ASCII\"\nconsole.log(textExample.body.toString()); // \"Hello, World!\"\n\nconst htmlExample = dataURL(\"data:text/html,%3Ch1%3EHello%2C%20World!%3C%2Fh1%3E\");\nconsole.log(htmlExample.mimeType.toString()); // \"text/html\"\nconsole.log(htmlExample.body.toString()); // <h1>Hello, World!</h1>\n\nconst pngExample = parseDataURL(\"data:image/png;base64,iVBORw0KGgoAAA\" +\n \"ANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4\" +\n \"//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU\" +\n \"5ErkJggg==\");\nconsole.log(pngExample.mimeType.toString()); // \"image/png\"\nconsole.log(pngExample.body); // <Buffer 89 50 4e 47 0d ... >\n```\n\n## API\n\nThis package's main module's default export is a function that accepts a string and returns a `{ mimeType, body }` object, or `null` if the result cannot be parsed as a `data:` URL.\n\n- The `mimeType` property is an instance of [whatwg-mimetype](https://www.npmjs.com/package/whatwg-mimetype)'s `MIMEType` class.\n- The `body` property is a Node.js [`Buffer`](https://nodejs.org/docs/latest/api/buffer.html) instance.\n\nAs shown in the examples above, both of these have useful `toString()` methods for manipulating them as string values. However…\n\n### A word of caution on string decoding\n\nBecause Node.js's `Buffer.prototype.toString()` assumes a UTF-8 encoding, simply doing `dataURL.body.toString()` may not work correctly if the `data:` URL's contents were not originally written in UTF-8. This includes if the encoding is \"US-ASCII\", [aka windows-1252](https://encoding.spec.whatwg.org/#names-and-labels), which is notable for being the default in many cases.\n\nA more complete decoding example would use the [whatwg-encoding](https://www.npmjs.com/package/whatwg-encoding) package as follows:\n\n```js\nconst parseDataURL = require(\"data-url\");\nconst { labelToName, decode } = require(\"whatwg-encoding\");\n\nconst dataURL = parseDataURL(arbitraryString);\nconst encodingName = labelToName(dataURL.mimeType.parameters.get(\"charset\"));\nconst bodyDecoded = decode(dataURL.body, encodingName);\n```\n\nFor example, given an `arbitraryString` of `data:,Hello!`, this will produce a `bodyDecoded` of `\"Hello!\"`, as expected. But given an `arbitraryString` of `\"data:,Héllo!\"`, this will correctly produce a `bodyDecoded` of `\"Héllo!\"`, whereas just doing `dataURL.body.toString()` will give back `\"Héllo!\"`.\n\nIn summary, only use `dataURL.body.toString()` when you are very certain your data is inside the ASCII range (i.e. code points within the range U+0000 to U+007F).\n\n### Advanced functionality: parsing from a URL record\n\nIf you are using the [whatwg-url](https://github.com/jsdom/whatwg-url) package, you may already have a \"URL record\" object on hand, as produced by that package's `parseURL` export. In that case, you can use this package's `fromURLRecord` export to save a bit of work:\n\n```js\nconst { parseURL } = require(\"whatwg-url\");\nconst dataURLFromURLRecord = require(\"data-url\").fromURLRecord;\n\nconst urlRecord = parseURL(\"data:,Hello%2C%20World!\");\nconst dataURL = dataURLFromURLRecord(urlRecord);\n```\n\nIn practice, we expect this functionality only to be used by consumers like [jsdom](https://www.npmjs.com/package/jsdom), which are using these packages at a very low level.\n# snapdragon-node [](https://www.npmjs.com/package/snapdragon-node) [](https://npmjs.org/package/snapdragon-node) [](https://npmjs.org/package/snapdragon-node) [](https://travis-ci.org/jonschlinkert/snapdragon-node)\n\n> Snapdragon utility for creating a new AST node in custom code, such as plugins.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save snapdragon-node\n```\n\n## Usage\n\nWith [snapdragon](https://github.com/jonschlinkert/snapdragon) v0.9.0 and higher you can use `this.node()` to create a new `Node`, whenever it makes sense.\n\n```js\nvar Node = require('snapdragon-node');\nvar Snapdragon = require('snapdragon');\nvar snapdragon = new Snapdragon();\n\n// example usage inside a parser visitor function\nsnapdragon.parser.set('foo', function() {\n // get the current \"start\" position\n var pos = this.position();\n\n // returns the match if regex matches the substring \n // at the current position on `parser.input`\n var match = this.match(/foo/);\n if (match) {\n // call \"pos\" on the node, to set the start and end \n // positions, and return the node to push it onto the AST\n // (snapdragon will push the node onto the correct\n // nodes array, based on the stack)\n return pos(new Node({type: 'bar', val: match[0]}));\n }\n});\n```\n\n## API\n\n### [Node](index.js#L22)\n\nCreate a new AST `Node` with the given `val` and `type`.\n\n**Params**\n\n* `val` **{String|Object}**: Pass a matched substring, or an object to merge onto the node.\n* `type` **{String}**: The node type to use when `val` is a string.\n* `returns` **{Object}**: node instance\n\n**Example**\n\n```js\nvar node = new Node('*', 'Star');\nvar node = new Node({type: 'star', val: '*'});\n```\n\n### [.isNode](index.js#L61)\n\nReturns true if the given value is a node.\n\n**Params**\n\n* `node` **{Object}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nvar Node = require('snapdragon-node');\nvar node = new Node({type: 'foo'});\nconsole.log(Node.isNode(node)); //=> true\nconsole.log(Node.isNode({})); //=> false\n```\n\n### [.define](index.js#L80)\n\nDefine a non-enumberable property on the node instance. Useful for adding properties that shouldn't be extended or visible during debugging.\n\n**Params**\n\n* `name` **{String}**\n* `val` **{any}**\n* `returns` **{Object}**: returns the node instance\n\n**Example**\n\n```js\nvar node = new Node();\nnode.define('foo', 'something non-enumerable');\n```\n\n### [.isEmpty](index.js#L100)\n\nReturns true if `node.val` is an empty string, or `node.nodes` does not contain any non-empty text nodes.\n\n**Params**\n\n* `fn` **{Function}**: (optional) Filter function that is called on `node` and/or child nodes. `isEmpty` will return false immediately when the filter function returns false on any nodes.\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nvar node = new Node({type: 'text'});\nnode.isEmpty(); //=> true\nnode.val = 'foo';\nnode.isEmpty(); //=> false\n```\n\n### [.push](index.js#L118)\n\nGiven node `foo` and node `bar`, push node `bar` onto `foo.nodes`, and set `foo` as `bar.parent`.\n\n**Params**\n\n* `node` **{Object}**\n* `returns` **{Number}**: Returns the length of `node.nodes`\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nfoo.push(bar);\n```\n\n### [.unshift](index.js#L140)\n\nGiven node `foo` and node `bar`, unshift node `bar` onto `foo.nodes`, and set `foo` as `bar.parent`.\n\n**Params**\n\n* `node` **{Object}**\n* `returns` **{Number}**: Returns the length of `node.nodes`\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nfoo.unshift(bar);\n```\n\n### [.pop](index.js#L167)\n\nPop a node from `node.nodes`.\n\n* `returns` **{Number}**: Returns the popped `node`\n\n**Example**\n\n```js\nvar node = new Node({type: 'foo'});\nnode.push(new Node({type: 'a'}));\nnode.push(new Node({type: 'b'}));\nnode.push(new Node({type: 'c'}));\nnode.push(new Node({type: 'd'}));\nconsole.log(node.nodes.length);\n//=> 4\nnode.pop();\nconsole.log(node.nodes.length);\n//=> 3\n```\n\n### [.shift](index.js#L190)\n\nShift a node from `node.nodes`.\n\n* `returns` **{Object}**: Returns the shifted `node`\n\n**Example**\n\n```js\nvar node = new Node({type: 'foo'});\nnode.push(new Node({type: 'a'}));\nnode.push(new Node({type: 'b'}));\nnode.push(new Node({type: 'c'}));\nnode.push(new Node({type: 'd'}));\nconsole.log(node.nodes.length);\n//=> 4\nnode.shift();\nconsole.log(node.nodes.length);\n//=> 3\n```\n\n### [.remove](index.js#L205)\n\nRemove `node` from `node.nodes`.\n\n**Params**\n\n* `node` **{Object}**\n* `returns` **{Object}**: Returns the removed node.\n\n**Example**\n\n```js\nnode.remove(childNode);\n```\n\n### [.find](index.js#L231)\n\nGet the first child node from `node.nodes` that matches the given `type`. If `type` is a number, the child node at that index is returned.\n\n**Params**\n\n* `type` **{String}**\n* `returns` **{Object}**: Returns a child node or undefined.\n\n**Example**\n\n```js\nvar child = node.find(1); //<= index of the node to get\nvar child = node.find('foo'); //<= node.type of a child node\nvar child = node.find(/^(foo|bar)$/); //<= regex to match node.type\nvar child = node.find(['foo', 'bar']); //<= array of node.type(s)\n```\n\n### [.isType](index.js#L249)\n\nReturn true if the node is the given `type`.\n\n**Params**\n\n* `type` **{String}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nvar node = new Node({type: 'bar'});\ncosole.log(node.isType('foo')); // false\ncosole.log(node.isType(/^(foo|bar)$/)); // true\ncosole.log(node.isType(['foo', 'bar'])); // true\n```\n\n### [.hasType](index.js#L270)\n\nReturn true if the `node.nodes` has the given `type`.\n\n**Params**\n\n* `type` **{String}**\n* `returns` **{Boolean}**\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nfoo.push(bar);\n\ncosole.log(foo.hasType('qux')); // false\ncosole.log(foo.hasType(/^(qux|bar)$/)); // true\ncosole.log(foo.hasType(['qux', 'bar'])); // true\n```\n\n* `returns` **{Array}**\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nfoo.push(bar);\nfoo.push(baz);\n\nconsole.log(bar.siblings.length) // 2\nconsole.log(baz.siblings.length) // 2\n```\n\n* `returns` **{Number}**\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nvar qux = new Node({type: 'qux'});\nfoo.push(bar);\nfoo.push(baz);\nfoo.unshift(qux);\n\nconsole.log(bar.index) // 1\nconsole.log(baz.index) // 2\nconsole.log(qux.index) // 0\n```\n\n* `returns` **{Object}**\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nfoo.push(bar);\nfoo.push(baz);\n\nconsole.log(baz.prev.type) // 'bar'\n```\n\n* `returns` **{Object}**\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nfoo.push(bar);\nfoo.push(baz);\n\nconsole.log(bar.siblings.length) // 2\nconsole.log(baz.siblings.length) // 2\n```\n\n* `returns` **{Object}**: The first node, or undefiend\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nvar qux = new Node({type: 'qux'});\nfoo.push(bar);\nfoo.push(baz);\nfoo.push(qux);\n\nconsole.log(foo.first.type) // 'bar'\n```\n\n* `returns` **{Object}**: The last node, or undefiend\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nvar qux = new Node({type: 'qux'});\nfoo.push(bar);\nfoo.push(baz);\nfoo.push(qux);\n\nconsole.log(foo.last.type) // 'qux'\n```\n\n* `returns` **{Object}**: The last node, or undefiend\n\n**Example**\n\n```js\nvar foo = new Node({type: 'foo'});\nvar bar = new Node({type: 'bar'});\nvar baz = new Node({type: 'baz'});\nvar qux = new Node({type: 'qux'});\nfoo.push(bar);\nfoo.push(baz);\nfoo.push(qux);\n\nconsole.log(foo.last.type) // 'qux'\n```\n\n## Release history\n\nChangelog entries are classified using the following labels from [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog):\n\n* `added`: for new features\n* `changed`: for changes in existing functionality\n* `deprecated`: for once-stable features removed in upcoming releases\n* `removed`: for deprecated features removed in this release\n* `fixed`: for any bug fixes\n\nCustom labels used in this changelog:\n\n* `dependencies`: bumps dependencies\n* `housekeeping`: code re-organization, minor edits, or other changes that don't fit in one of the other categories.\n\n### [2.0.0] - 2017-05-01\n\n**Changed**\n\n* `.unshiftNode` was renamed to [.unshift](#unshift)\n* `.pushNode` was renamed to [.push](#push)\n* `.getNode` was renamed to [.find](#find)\n\n**Added**\n\n* [.isNode](#isNode)\n* [.isEmpty](#isEmpty)\n* [.pop](#pop)\n* [.shift](#shift)\n* [.remove](#remove)\n\n### [0.1.0]\n\nFirst release.\n\n## About\n\n### Related projects\n\n* [breakdance](https://www.npmjs.com/package/breakdance): Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy… [more](http://breakdance.io) | [homepage](http://breakdance.io \"Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy to use. It's time for your markup to get down.\")\n* [snapdragon-capture](https://www.npmjs.com/package/snapdragon-capture): Snapdragon plugin that adds a capture method to the parser instance. | [homepage](https://github.com/jonschlinkert/snapdragon-capture \"Snapdragon plugin that adds a capture method to the parser instance.\")\n* [snapdragon-cheerio](https://www.npmjs.com/package/snapdragon-cheerio): Snapdragon plugin for converting a cheerio AST to a snapdragon AST. | [homepage](https://github.com/jonschlinkert/snapdragon-cheerio \"Snapdragon plugin for converting a cheerio AST to a snapdragon AST.\")\n* [snapdragon-util](https://www.npmjs.com/package/snapdragon-util): Utilities for the snapdragon parser/compiler. | [homepage](https://github.com/jonschlinkert/snapdragon-util \"Utilities for the snapdragon parser/compiler.\")\n* [snapdragon](https://www.npmjs.com/package/snapdragon): Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map… [more](https://github.com/jonschlinkert/snapdragon) | [homepage](https://github.com/jonschlinkert/snapdragon \"Easy-to-use plugin system for creating powerful, fast and versatile parsers and compilers, with built-in source-map support.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 25, 2017._\n# Node.js releases data\n\nAll data is located in `data` directory.\n\n`data/raw` contains raw data `nodejs.json` and `iojs.json`.\n\n`data/processed` contains `envs.js` with both node.js and io.js data preprocessed to be used by [browserlist](https://github.com/ai/browserslist) and other projects. Each version in this file contains only necessary info: version, release date and optionally LTS flag.\n\n## Installation\n```bash\nnpm install --save node-releases\n```\n\n## Updating data\n```bash\nnpm run build\n```\nThis is a build script which fetches data from web, processes it and saves processed data to `data/processed/envs.json`. If you want to run this steps separately you can use commands described below.\n\n### Fetching data\n```bash\nnpm run fetch\n```\nThis npm script will download new data to `data/raw` directory. Also it'll download Node.js release schedule into `release-schedule` folder.\n\n### Processing data\n```bash\nnpm run process\n```\nThis script generates `envs.json` file from raw data files and saves it to `data/processed` directory.\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/tabrindle/envinfo/master/logo.png\" align=\"center\" width=\"700px\"/>\n <h3 align=\"center\">envinfo generates a report of the common details needed when troubleshooting software issues, such as your operating system, binary versions, browsers, installed languages, and more</h3> \n <hr/>\n</p>\n\n[](https://circleci.com/gh/tabrindle/envinfo/tree/master) [](https://travis-ci.org/tabrindle/envinfo) [](https://badge.fury.io/js/envinfo) [](https://www.npmjs.com/package/envinfo) [](https://opensource.org/licenses/MIT)\n[](#contributors)\n\n## The problem\n\n- It works on my computer\n- \"command not found\"\n- what version of \"command\" are you running?\n- what version of \"different command\" are you running?\n- do you have \"insert obscure android sdk version\"?\n- every github issue reporting template ever:\n\n**Please mention other relevant information such as the browser version, Node.js version, Operating System and programming language.**\n\n## This solution\n\n- Gather all of this information in one spot, quickly, and painlessly.\n\n## Installation\n\nTo use as a CLI tool, install this package globally:\n\n```sh\nnpm install -g envinfo || yarn global add envinfo\n```\n\nOr, use without installing with npx:\n\n`npx envinfo`\n\nTo use as a library in another project:\n\n```sh\nnpm install envinfo || yarn add envinfo\n```\n\n## CLI Usage\n\n`envinfo` || `npx envinfo`\n\n```bash\n System:\n OS: macOS Mojave 10.14.5\n CPU: (8) x64 Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz\n Memory: 2.97 GB / 16.00 GB\n Shell: 5.3 - /bin/zsh\n Binaries:\n Node: 8.16.0 - ~/.nvm/versions/node/v8.16.0/bin/node\n Yarn: 1.15.2 - ~/.yarn/bin/yarn\n npm: 6.9.0 - ~/.nvm/versions/node/v8.16.0/bin/npm\n Watchman: 4.9.0 - /usr/local/bin/watchman\n Managers:\n Cargo: 1.31.0 - ~/.cargo/bin/cargo\n CocoaPods: 1.7.3 - /usr/local/bin/pod\n Composer: 1.8.6 - /usr/local/bin/composer\n Gradle: 5.5 - /usr/local/bin/gradle\n Homebrew: 2.1.7 - /usr/local/bin/brew\n Maven: 3.6.1 - /usr/local/bin/mvn\n pip2: 19.0.3 - /usr/local/bin/pip2\n pip3: 19.0.2 - /usr/local/bin/pip3\n RubyGems: 2.5.2.3 - /usr/bin/gem\n Utilities:\n CMake: 3.13.3 - /usr/local/bin/cmake\n Make: 3.81 - /usr/bin/make\n GCC: 10.14. - /usr/bin/gcc\n Git: 2.20.0 - /usr/local/bin/git\n Mercurial: 4.5.3 - /usr/bin/hg\n Clang: 1001.0.46.4 - /usr/bin/clang\n Subversion: 1.10.3 - /usr/bin/svn\n Servers:\n Apache: 2.4.34 - /usr/sbin/apachectl\n Nginx: 1.13.12 - /usr/local/bin/nginx\n Virtualization:\n Docker: 18.09.1 - /usr/local/bin/docker\n Parallels: 13.3.0 - /usr/local/bin/prlctl\n VirtualBox: 5.2.20 - /usr/local/bin/vboxmanage\n SDKs:\n iOS SDK:\n Platforms: iOS 12.2, macOS 10.14, tvOS 12.2, watchOS 5.2\n Android SDK:\n API Levels: 28\n Build Tools: 28.0.3\n System Images: android-28 | Google Play Intel x86 Atom\n IDEs:\n Android Studio: 3.2 AI-181.5540.7.32.5056338\n Atom: 1.23.3\n Emacs: 22.1.1 - /usr/bin/emacs\n Nano: 2.0.6 - /usr/bin/nano\n VSCode: 1.36.0 - /usr/local/bin/code\n Vim: 8.0 - /usr/bin/vim\n Xcode: 10.2.1/10E1001 - /usr/bin/xcodebuild\n Languages:\n Bash: 4.4.23 - /usr/local/bin/bash\n Elixir: 1.6.2 - /usr/local/bin/elixir\n Go: 1.11.1 - /usr/local/bin/go\n Java: 1.8.0_192 - /usr/bin/javac\n Perl: 5.18.4 - /usr/bin/perl\n PHP: 7.1.23 - /usr/bin/php\n Python: 2.7.16 - /usr/local/bin/python\n Python3: 3.7.2 - /usr/local/bin/python3\n R: 3.6.0 - /usr/local/bin/R\n Ruby: 2.3.7 - /usr/bin/ruby\n Rust: 1.16.0 - /Users/tabrindle/.cargo/bin/rustup\n Databases:\n MongoDB: 3.6.4 - /usr/local/bin/mongo\n MySQL: 10.3.10 (MariaDB) - /usr/local/bin/mysql\n PostgreSQL: 10.3 - /usr/local/bin/postgres\n SQLite: 3.24.0 - /usr/bin/sqlite3\n Browsers:\n Chrome: 75.0.3770.100\n Chrome Canary: 77.0.3847.0\n Firefox: 68.0\n Firefox Developer Edition: 69.0\n Firefox Nightly: 69.0a1\n Safari: 12.1.1\n Safari Technology Preview: 13.0\n npmPackages:\n apollo-client: ^2.3.1 => 2.3.1\n jest: ^22.2.1 => 22.2.1\n ...\n react: ^16.3.2 => 16.3.2\n react-apollo: ^2.1.4 => 2.1.4\n run4staged: ^1.1.1 => 1.1.1\n solidarity: 2.0.5 => 2.0.5\n styled-components: ^3.1.6 => 3.1.6\n npmGlobalPackages:\n create-react-app: 1.5.2\n create-react-native-app: 1.0.0\n envinfo: 5.10.0\n exp: 49.2.2\n gatsby-cli: 1.1.52\n npm: 5.6.0\n react-native-cli: 2.0.1\n solidarity: 2.1.0\n typescript: 2.8.1\n```\n\n## Programmatic Usage\n\nEnvinfo takes a configuration object and returns a Promise that resolves a string (optionally yaml, json or markdown)\n\n```javascript\nimport envinfo from 'envinfo';\n\nenvinfo.run(\n {\n System: ['OS', 'CPU'],\n Binaries: ['Node', 'Yarn', 'npm'],\n Browsers: ['Chrome', 'Firefox', 'Safari'],\n npmPackages: ['styled-components', 'babel-plugin-styled-components'],\n },\n { json: true, showNotFound: true }\n).then(env => console.log(env));\n```\n\nlogs:\n\n```json\n{\n \"System\": {\n \"OS\": \"macOS High Sierra 10.13\",\n \"CPU\": \"x64 Intel(R) Core(TM) i7-4870HQ CPU @ 2.50GHz\"\n },\n \"Binaries\": {\n \"Node\": {\n \"version\": \"8.11.0\",\n \"path\": \"~/.nvm/versions/node/v8.11.0/bin/node\"\n },\n \"Yarn\": {\n \"version\": \"1.5.1\",\n \"path\": \"~/.yarn/bin/yarn\"\n },\n \"npm\": {\n \"version\": \"5.6.0\",\n \"path\": \"~/.nvm/versions/node/v8.11.0/bin/npm\"\n }\n },\n \"Browsers\": {\n \"Chrome\": {\n \"version\": \"67.0.3396.62\"\n },\n \"Firefox\": {\n \"version\": \"59.0.2\"\n },\n \"Safari\": {\n \"version\": \"11.0\"\n }\n },\n \"npmPackages\": {\n \"styled-components\": {\n \"wanted\": \"^3.2.1\",\n \"installed\": \"3.2.1\"\n },\n \"babel-plugin-styled-components\": \"Not Found\"\n }\n}\n```\n\nAll of envinfo's helpers are also exported for use. You can use envinfo as a whole, or just the parts that you need, like this:\n\n```javascript\nconst envinfo = require('envinfo');\n\n// each helper returns a promise\nconst node = await envinfo.helpers.getNodeInfo();\n\n// The promises resolve to an array of values: [\"Name\", \"Version\", \"Path\"]\n// e.g. [\"Node\", \"10.9.0\", \"/usr/local/bin/node\"]\n\nconsole.log(`Node: ${node[1]} - ${node[2]}`); // \"Node: 10.9.0 - ~/.nvm/versions/node/v8.14.0/bin/node\"\n```\n\n## CLI Options\n\n```\n --system Print general system info such as OS, CPU, Memory and Shell\n --browsers Get version numbers of installed web browsers\n --SDKs Get platforms, build tools and SDKs of iOS and Android\n --IDEs Get version numbers of installed IDEs\n --languages Get version numbers of installed languages such as Java, Python, PHP, etc\n --binaries Get version numbers of node, npm, watchman, etc\n --npmPackages Get version numbers of locally installed npm packages - glob, string, or comma delimited list\n --npmGlobalPackages Get version numbers of globally installed npm packages\n\n --duplicates Mark duplicate npm packages inside parentheses eg. (2.1.4)\n --fullTree Traverse entire node_modules dependency tree, not just top level\n\n --markdown Print output in markdown format\n --json Print output in JSON format\n --console Print to console (defaults to on for CLI usage, off for programmatic usage)\n```\n\n## Integration\n\nenvinfo is live in:\n\n- [React Native](https://github.com/facebook/react-native) (`react-native info`)\n- [Create React App](https://github.com/facebook/create-react-app) (`create-react-app --info`)\n- [Expo CLI](https://github.com/expo/expo-cli) (`expo diagnostics`)\n- [Webpack](https://github.com/webpack/webpack-cli) (`webpack-cli info`)\n- [Solidarity](https://github.com/infinitered/solidarity) (`solidarity report`)\n- [Gatsby](https://github.com/gatsbyjs/gatsby) (`gatsby info`)\n\nenvinfo is used in the ISSUE_TEMPLATE of:\n\n- [styled-components](https://github.com/styled-components/styled-components)\n- [Jest](https://github.com/facebook/jest)\n- [Apollo Client](https://github.com/apollographql/apollo-client)\n\n## Alternatives\n\n- type `command -v` until you smash your computer\n- [specs](https://github.com/mcandre/specs) - an excellent ruby gem that runs `command -v` for you on :all-the-things: Great for raw info.\n- [screenfetch](https://github.com/KittyKatt/screenFetch) - fetch system and terminal information, and display a pretty ascii logo\n- [Solidarity](https://github.com/infinitered/solidarity) - a project based environment checker\n- write your own\n\n## License\n\nMIT\n\n## Contributing\n\nPRs for additional features are welcome! Run `npm run lint && npm run format` before committing.\n\nThis project came out of a [PR](https://github.com/facebook/react-native/pull/14428) to the React Native CLI tool - issues are reported frequently without important environment information, like Node/npm versions.\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore -->\n| [<img src=\"https://avatars1.githubusercontent.com/u/2925048?v=4\" width=\"100px;\"/><br /><sub><b>Trevor Brindle</b></sub>](http://trevorbrindle.com)<br />[💬](#question-tabrindle \"Answering Questions\") [📝](#blog-tabrindle \"Blogposts\") [🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Atabrindle \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=tabrindle \"Code\") [📖](https://github.com/tabrindle/envinfo/commits?author=tabrindle \"Documentation\") [💡](#example-tabrindle \"Examples\") [🤔](#ideas-tabrindle \"Ideas, Planning, & Feedback\") [👀](#review-tabrindle \"Reviewed Pull Requests\") [📢](#talk-tabrindle \"Talks\") [⚠️](https://github.com/tabrindle/envinfo/commits?author=tabrindle \"Tests\") | [<img src=\"https://avatars0.githubusercontent.com/u/997157?v=4\" width=\"100px;\"/><br /><sub><b>Gant Laborde</b></sub>](http://gantlaborde.com/)<br />[📝](#blog-GantMan \"Blogposts\") [🐛](https://github.com/tabrindle/envinfo/issues?q=author%3AGantMan \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=GantMan \"Code\") [🤔](#ideas-GantMan \"Ideas, Planning, & Feedback\") | [<img src=\"https://avatars1.githubusercontent.com/u/599352?v=4\" width=\"100px;\"/><br /><sub><b>Anton Fisher</b></sub>](http://antonfisher.com)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Aantonfisher \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=antonfisher \"Code\") | [<img src=\"https://avatars1.githubusercontent.com/u/960133?v=4\" width=\"100px;\"/><br /><sub><b>Ahmad Awais ⚡️</b></sub>](https://AhmadAwais.com/)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Aahmadawais \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=ahmadawais \"Code\") | [<img src=\"https://avatars2.githubusercontent.com/u/9251453?v=4\" width=\"100px;\"/><br /><sub><b>Hasan</b></sub>](https://github.com/LEQADA)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3ALEQADA \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=LEQADA \"Code\") | [<img src=\"https://avatars3.githubusercontent.com/u/1232725?v=4\" width=\"100px;\"/><br /><sub><b>Ernesto Ramírez</b></sub>](http://twitter.com/_ErnestoR)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3AErnestoR \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=ErnestoR \"Code\") | [<img src=\"https://avatars1.githubusercontent.com/u/3759816?v=4\" width=\"100px;\"/><br /><sub><b>Jiawen Geng</b></sub>](https://www.gengjiawen.com)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Agengjiawen \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=gengjiawen \"Code\") [🤔](#ideas-gengjiawen \"Ideas, Planning, & Feedback\") [⚠️](https://github.com/tabrindle/envinfo/commits?author=gengjiawen \"Tests\") |\n| :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n| [<img src=\"https://avatars3.githubusercontent.com/u/12520493?v=4\" width=\"100px;\"/><br /><sub><b>Zac Anger</b></sub>](https://zacanger.com)<br />[💻](https://github.com/tabrindle/envinfo/commits?author=zacanger \"Code\") [🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Azacanger \"Bug reports\") | [<img src=\"https://avatars3.githubusercontent.com/u/497214?v=4\" width=\"100px;\"/><br /><sub><b>Ville Immonen</b></sub>](https://twitter.com/VilleImmonen)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Afson \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=fson \"Code\") | [<img src=\"https://avatars2.githubusercontent.com/u/27246?v=4\" width=\"100px;\"/><br /><sub><b>Olmo Maldonado</b></sub>](http://ibolmo.com)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Aibolmo \"Bug reports\") [💻](https://github.com/tabrindle/envinfo/commits?author=ibolmo \"Code\") |\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!\n<p align=\"center\">\n <a href=\"https://github.com/inikulin/parse5\">\n <img src=\"https://raw.github.com/inikulin/parse5/master/media/logo.png\" alt=\"parse5\" />\n </a>\n</p>\n\n<div align=\"center\">\n<h1>parse5</h1>\n<i><b>HTML parser and serializer.</b></i>\n</div>\n<br>\n\n<div align=\"center\">\n<code>npm install --save parse5</code>\n</div>\n<br>\n\n<p align=\"center\">\n 📖 <a href=\"https://github.com/inikulin/parse5/tree/master/packages/parse5/docs/index.md\"><b>Documentation</b></a> 📖\n</p>\n\n---\n\n<p align=\"center\">\n <a href=\"https://github.com/inikulin/parse5/tree/master/docs/list-of-packages.md\">List of parse5 toolset packages</a>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/inikulin/parse5\">GitHub</a>\n</p>\n\n<p align=\"center\">\n <a href=\"http://astexplorer.net/#/1CHlCXc4n4\">Online playground</a>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/inikulin/parse5/tree/master/docs/version-history.md\">Version history</a>\n</p>\n# Acorn AST walker\n\nAn abstract syntax tree walker for the\n[ESTree](https://github.com/estree/estree) format.\n\n## Community\n\nAcorn is open source software released under an\n[MIT license](https://github.com/acornjs/acorn/blob/master/acorn-walk/LICENSE).\n\nYou are welcome to\n[report bugs](https://github.com/acornjs/acorn/issues) or create pull\nrequests on [github](https://github.com/acornjs/acorn). For questions\nand discussion, please use the\n[Tern discussion forum](https://discuss.ternjs.net).\n\n## Installation\n\nThe easiest way to install acorn is from [`npm`](https://www.npmjs.com/):\n\n```sh\nnpm install acorn-walk\n```\n\nAlternately, you can download the source and build acorn yourself:\n\n```sh\ngit clone https://github.com/acornjs/acorn.git\ncd acorn\nnpm install\n```\n\n## Interface\n\nAn algorithm for recursing through a syntax tree is stored as an\nobject, with a property for each tree node type holding a function\nthat will recurse through such a node. There are several ways to run\nsuch a walker.\n\n**simple**`(node, visitors, base, state)` does a 'simple' walk over a\ntree. `node` should be the AST node to walk, and `visitors` an object\nwith properties whose names correspond to node types in the [ESTree\nspec](https://github.com/estree/estree). The properties should contain\nfunctions that will be called with the node object and, if applicable\nthe state at that point. The last two arguments are optional. `base`\nis a walker algorithm, and `state` is a start state. The default\nwalker will simply visit all statements and expressions and not\nproduce a meaningful state. (An example of a use of state is to track\nscope at each point in the tree.)\n\n```js\nconst acorn = require(\"acorn\")\nconst walk = require(\"acorn-walk\")\n\nwalk.simple(acorn.parse(\"let x = 10\"), {\n Literal(node) {\n console.log(`Found a literal: ${node.value}`)\n }\n})\n```\n\n**ancestor**`(node, visitors, base, state)` does a 'simple' walk over\na tree, building up an array of ancestor nodes (including the current node)\nand passing the array to the callbacks as a third parameter.\n\n```js\nconst acorn = require(\"acorn\")\nconst walk = require(\"acorn-walk\")\n\nwalk.ancestor(acorn.parse(\"foo('hi')\"), {\n Literal(_, ancestors) {\n console.log(\"This literal's ancestors are:\", ancestors.map(n => n.type))\n }\n})\n```\n\n**recursive**`(node, state, functions, base)` does a 'recursive'\nwalk, where the walker functions are responsible for continuing the\nwalk on the child nodes of their target node. `state` is the start\nstate, and `functions` should contain an object that maps node types\nto walker functions. Such functions are called with `(node, state, c)`\narguments, and can cause the walk to continue on a sub-node by calling\nthe `c` argument on it with `(node, state)` arguments. The optional\n`base` argument provides the fallback walker functions for node types\nthat aren't handled in the `functions` object. If not given, the\ndefault walkers will be used.\n\n**make**`(functions, base)` builds a new walker object by using the\nwalker functions in `functions` and filling in the missing ones by\ntaking defaults from `base`.\n\n**full**`(node, callback, base, state)` does a 'full' walk over a\ntree, calling the callback with the arguments (node, state, type) for\neach node\n\n**fullAncestor**`(node, callback, base, state)` does a 'full' walk\nover a tree, building up an array of ancestor nodes (including the\ncurrent node) and passing the array to the callbacks as a third\nparameter.\n\n```js\nconst acorn = require(\"acorn\")\nconst walk = require(\"acorn-walk\")\n\nwalk.full(acorn.parse(\"1 + 1\"), node => {\n console.log(`There's a ${node.type} node at ${node.ch}`)\n})\n```\n\n**findNodeAt**`(node, start, end, test, base, state)` tries to locate\na node in a tree at the given start and/or end offsets, which\nsatisfies the predicate `test`. `start` and `end` can be either `null`\n(as wildcard) or a number. `test` may be a string (indicating a node\ntype) or a function that takes `(nodeType, node)` arguments and\nreturns a boolean indicating whether this node is interesting. `base`\nand `state` are optional, and can be used to specify a custom walker.\nNodes are tested from inner to outer, so if two nodes match the\nboundaries, the inner one will be preferred.\n\n**findNodeAround**`(node, pos, test, base, state)` is a lot like\n`findNodeAt`, but will match any node that exists 'around' (spanning)\nthe given position.\n\n**findNodeAfter**`(node, pos, test, base, state)` is similar to\n`findNodeAround`, but will match all nodes *after* the given position\n(testing outer nodes before inner nodes).\n# PostCSS Discard Overridden\n\n[PostCSS] plugin to discard overridden `@keyframes` or `@counter-style`.\n\n`@keyframes` or `@counter-style` will be overridden by those who share the same identifiers and appear later in stylesheets. So we can discard all of them except the last one. When defined inside a `@media` or `@supports` rule, `@keyframes` and `@counter-style` rules only override global rules in some of the client browsers so they need handled separately. This plugin has taken care of this and transforms the PostCss AST **safely**.\n\n[PostCSS]: https://github.com/postcss/postcss\n\n```css\n@-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 0.8;\n }\n}\n@keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 0.8;\n }\n}\n@media (max-width: 500px) {\n @-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n }\n @keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n }\n @-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 0.8;\n }\n }\n @keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 0.8;\n }\n }\n @supports (display: flex) {\n @-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n }\n @keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n }\n }\n}\n@-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n}\n@keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n}\n```\n\n```css\n@media (max-width: 500px) {\n @-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 0.8;\n }\n }\n @keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 0.8;\n }\n }\n @supports (display: flex) {\n @-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n }\n @keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n }\n }\n}\n@-webkit-keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n}\n@keyframes fade-in {\n 0% {\n opacity: 0;\n }\n 100% {\n opacity: 1;\n }\n}\n```\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\npako - zlib port to javascript, very fast!\n==========================================\n\n[](https://travis-ci.org/nodeca/pako)\n[](https://www.npmjs.org/package/pako)\n\n__Why pako is cool:__\n\n- Almost as fast in modern JS engines as C implementation (see benchmarks).\n- Works in browsers, you can browserify any separate component.\n- Chunking support for big blobs.\n- Results are binary equal to well known [zlib](http://www.zlib.net/) (now v1.2.8 ported).\n\nThis project was done to understand how fast JS can be and is it necessary to\ndevelop native C modules for CPU-intensive tasks. Enjoy the result!\n\n__Famous projects, using pako:__\n\n- [browserify](http://browserify.org/) (via [browserify-zlib](https://github.com/devongovett/browserify-zlib))\n- [JSZip](http://stuk.github.io/jszip/)\n- [mincer](https://github.com/nodeca/mincer)\n- [JS-Git](https://github.com/creationix/js-git) and\n [Tedit](https://chrome.google.com/webstore/detail/tedit-development-environ/ooekdijbnbbjdfjocaiflnjgoohnblgf)\n by [@creatronix](https://github.com/creationix)\n\n__Benchmarks:__\n\n```\nnode v0.10.26, 1mb sample:\n\n deflate-dankogai x 4.73 ops/sec ±0.82% (15 runs sampled)\n deflate-gildas x 4.58 ops/sec ±2.33% (15 runs sampled)\n deflate-imaya x 3.22 ops/sec ±3.95% (12 runs sampled)\n ! deflate-pako x 6.99 ops/sec ±0.51% (21 runs sampled)\n deflate-pako-string x 5.89 ops/sec ±0.77% (18 runs sampled)\n deflate-pako-untyped x 4.39 ops/sec ±1.58% (14 runs sampled)\n * deflate-zlib x 14.71 ops/sec ±4.23% (59 runs sampled)\n inflate-dankogai x 32.16 ops/sec ±0.13% (56 runs sampled)\n inflate-imaya x 30.35 ops/sec ±0.92% (53 runs sampled)\n ! inflate-pako x 69.89 ops/sec ±1.46% (71 runs sampled)\n inflate-pako-string x 19.22 ops/sec ±1.86% (49 runs sampled)\n inflate-pako-untyped x 17.19 ops/sec ±0.85% (32 runs sampled)\n * inflate-zlib x 70.03 ops/sec ±1.64% (81 runs sampled)\n\nnode v0.11.12, 1mb sample:\n\n deflate-dankogai x 5.60 ops/sec ±0.49% (17 runs sampled)\n deflate-gildas x 5.06 ops/sec ±6.00% (16 runs sampled)\n deflate-imaya x 3.52 ops/sec ±3.71% (13 runs sampled)\n ! deflate-pako x 11.52 ops/sec ±0.22% (32 runs sampled)\n deflate-pako-string x 9.53 ops/sec ±1.12% (27 runs sampled)\n deflate-pako-untyped x 5.44 ops/sec ±0.72% (17 runs sampled)\n * deflate-zlib x 14.05 ops/sec ±3.34% (63 runs sampled)\n inflate-dankogai x 42.19 ops/sec ±0.09% (56 runs sampled)\n inflate-imaya x 79.68 ops/sec ±1.07% (68 runs sampled)\n ! inflate-pako x 97.52 ops/sec ±0.83% (80 runs sampled)\n inflate-pako-string x 45.19 ops/sec ±1.69% (57 runs sampled)\n inflate-pako-untyped x 24.35 ops/sec ±2.59% (40 runs sampled)\n * inflate-zlib x 60.32 ops/sec ±1.36% (69 runs sampled)\n```\n\nzlib's test is partialy afferted by marshling (that make sense for inflate only).\nYou can change deflate level to 0 in benchmark source, to investigate details.\nFor deflate level 6 results can be considered as correct.\n\n__Install:__\n\nnode.js:\n\n```\nnpm install pako\n```\n\nbrowser:\n\n```\nbower install pako\n```\n\nExample & API\n-------------\n\nFull docs - http://nodeca.github.io/pako/\n\n```javascript\nvar pako = require('pako');\n\n// Deflate\n//\nvar input = new Uint8Array();\n//... fill input data here\nvar output = pako.deflate(input);\n\n// Inflate (simple wrapper can throw exception on broken stream)\n//\nvar compressed = new Uint8Array();\n//... fill data to uncompress here\ntry {\n var result = pako.inflate(compressed);\n} catch (err) {\n console.log(err);\n}\n\n//\n// Alternate interface for chunking & without exceptions\n//\n\nvar inflator = new pako.Inflate();\n\ninflator.push(chunk1, false);\ninflator.push(chunk2, false);\n...\ninflator.push(chunkN, true); // true -> last chunk\n\nif (inflator.err) {\n console.log(inflator.msg);\n}\n\nvar output = inflator.result;\n\n```\n\nSometime you can wish to work with strings. For example, to send\nbig objects as json to server. Pako detects input data type. You can\nforce output to be string with option `{ to: 'string' }`.\n\n```javascript\nvar pako = require('pako');\n\nvar test = { my: 'super', puper: [456, 567], awesome: 'pako' };\n\nvar binaryString = pako.deflate(JSON.stringify(test), { to: 'string' });\n\n//\n// Here you can do base64 encode, make xhr requests and so on.\n//\n\nvar restored = JSON.parse(pako.inflate(binaryString, { to: 'string' }));\n```\n\nNotes\n-----\n\nPako does not contain some specific zlib functions:\n\n- __deflate__ - methods `deflateCopy`, `deflateBound`, `deflateParams`,\n `deflatePending`, `deflatePrime`, `deflateTune`.\n- __inflate__ - methods `inflateCopy`, `inflateMark`,\n `inflatePrime`, `inflateGetDictionary`, `inflateSync`, `inflateSyncPoint`, `inflateUndermine`.\n- High level inflate/deflate wrappers (classes) may not support some flush\n modes. Those should work: Z_NO_FLUSH, Z_FINISH, Z_SYNC_FLUSH.\n\nAuthors\n-------\n\n- Andrey Tupitsin [@anrd83](https://github.com/andr83)\n- Vitaly Puzrin [@puzrin](https://github.com/puzrin)\n\nPersonal thanks to:\n\n- Vyacheslav Egorov ([@mraleph](https://github.com/mraleph)) for his awesome\n tutorials about optimising JS code for v8, [IRHydra](http://mrale.ph/irhydra/)\n tool and his advices.\n- David Duponchel ([@dduponchel](https://github.com/dduponchel)) for help with\n testing.\n\nLicense\n-------\n\nMIT\n# babel-runtime\n# extend-shallow [](http://badge.fury.io/js/extend-shallow) [](https://travis-ci.org/jonschlinkert/extend-shallow)\n\n> Extend an object with the properties of additional objects. node.js/javascript util.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i extend-shallow --save\n```\n\n## Usage\n\n```js\nvar extend = require('extend-shallow');\n\nextend({a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\nPass an empty object to shallow clone:\n\n```js\nvar obj = {};\nextend(obj, {a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\n## Related\n\n* [extend-shallow](https://github.com/jonschlinkert/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util.\n* [for-own](https://github.com/jonschlinkert/for-own): Iterate over the own enumerable properties of an object, and return an object with properties… [more](https://github.com/jonschlinkert/for-own)\n* [for-in](https://github.com/jonschlinkert/for-in): Iterate over the own and inherited enumerable properties of an objecte, and return an object… [more](https://github.com/jonschlinkert/for-in)\n* [is-plain-object](https://github.com/jonschlinkert/is-plain-object): Returns true if an object was created by the `Object` constructor.\n* [isobject](https://github.com/jonschlinkert/isobject): Returns true if the value is an object and not an array or null.\n* [kind-of](https://github.com/jonschlinkert/kind-of): Get the native type of a value.\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on June 29, 2015._\n# JSON5 – JSON for Humans\n\n[][Build Status]\n[][Coverage\nStatus]\n\nThe JSON5 Data Interchange Format (JSON5) is a superset of [JSON] that aims to\nalleviate some of the limitations of JSON by expanding its syntax to include\nsome productions from [ECMAScript 5.1].\n\nThis JavaScript library is the official reference implementation for JSON5\nparsing and serialization libraries.\n\n[Build Status]: https://travis-ci.org/json5/json5\n\n[Coverage Status]: https://coveralls.io/github/json5/json5\n\n[JSON]: https://tools.ietf.org/html/rfc7159\n\n[ECMAScript 5.1]: https://www.ecma-international.org/ecma-262/5.1/\n\n## Summary of Features\nThe following ECMAScript 5.1 features, which are not supported in JSON, have\nbeen extended to JSON5.\n\n### Objects\n- Object keys may be an ECMAScript 5.1 _[IdentifierName]_.\n- Objects may have a single trailing comma.\n\n### Arrays\n- Arrays may have a single trailing comma.\n\n### Strings\n- Strings may be single quoted.\n- Strings may span multiple lines by escaping new line characters.\n- Strings may include character escapes.\n\n### Numbers\n- Numbers may be hexadecimal.\n- Numbers may have a leading or trailing decimal point.\n- Numbers may be [IEEE 754] positive infinity, negative infinity, and NaN.\n- Numbers may begin with an explicit plus sign.\n\n### Comments\n- Single and multi-line comments are allowed.\n\n### White Space\n- Additional white space characters are allowed.\n\n[IdentifierName]: https://www.ecma-international.org/ecma-262/5.1/#sec-7.6\n\n[IEEE 754]: http://ieeexplore.ieee.org/servlet/opac?punumber=4610933\n\n## Short Example\n```js\n{\n // comments\n unquoted: 'and you can quote me on that',\n singleQuotes: 'I can use \"double quotes\" here',\n lineBreaks: \"Look, Mom! \\\nNo \\\\n's!\",\n hexadecimal: 0xdecaf,\n leadingDecimalPoint: .8675309, andTrailing: 8675309.,\n positiveSign: +1,\n trailingComma: 'in objects', andIn: ['arrays',],\n \"backwardsCompatible\": \"with JSON\",\n}\n```\n\n## Specification\nFor a detailed explanation of the JSON5 format, please read the [official\nspecification](https://json5.github.io/json5-spec/).\n\n## Installation\n### Node.js\n```sh\nnpm install json5\n```\n\n```js\nconst JSON5 = require('json5')\n```\n\n### Browsers\n```html\n<script src=\"https://unpkg.com/json5@^2.0.0/dist/index.min.js\"></script>\n```\n\nThis will create a global `JSON5` variable.\n\n## API\nThe JSON5 API is compatible with the [JSON API].\n\n[JSON API]:\nhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON\n\n### JSON5.parse()\nParses a JSON5 string, constructing the JavaScript value or object described by\nthe string. An optional reviver function can be provided to perform a\ntransformation on the resulting object before it is returned.\n\n#### Syntax\n JSON5.parse(text[, reviver])\n\n#### Parameters\n- `text`: The string to parse as JSON5.\n- `reviver`: If a function, this prescribes how the value originally produced by\n parsing is transformed, before being returned.\n\n#### Return value\nThe object corresponding to the given JSON5 text.\n\n### JSON5.stringify()\nConverts a JavaScript value to a JSON5 string, optionally replacing values if a\nreplacer function is specified, or optionally including only the specified\nproperties if a replacer array is specified.\n\n#### Syntax\n JSON5.stringify(value[, replacer[, space]])\n JSON5.stringify(value[, options])\n\n#### Parameters\n- `value`: The value to convert to a JSON5 string.\n- `replacer`: A function that alters the behavior of the stringification\n process, or an array of String and Number objects that serve as a whitelist\n for selecting/filtering the properties of the value object to be included in\n the JSON5 string. If this value is null or not provided, all properties of the\n object are included in the resulting JSON5 string.\n- `space`: A String or Number object that's used to insert white space into the\n output JSON5 string for readability purposes. If this is a Number, it\n indicates the number of space characters to use as white space; this number is\n capped at 10 (if it is greater, the value is just 10). Values less than 1\n indicate that no space should be used. If this is a String, the string (or the\n first 10 characters of the string, if it's longer than that) is used as white\n space. If this parameter is not provided (or is null), no white space is used.\n If white space is used, trailing commas will be used in objects and arrays.\n- `options`: An object with the following properties:\n - `replacer`: Same as the `replacer` parameter.\n - `space`: Same as the `space` parameter.\n - `quote`: A String representing the quote character to use when serializing\n strings.\n\n#### Return value\nA JSON5 string representing the value.\n\n### Node.js `require()` JSON5 files\nWhen using Node.js, you can `require()` JSON5 files by adding the following\nstatement.\n\n```js\nrequire('json5/lib/register')\n```\n\nThen you can load a JSON5 file with a Node.js `require()` statement. For\nexample:\n\n```js\nconst config = require('./config.json5')\n```\n\n## CLI\nSince JSON is more widely used than JSON5, this package includes a CLI for\nconverting JSON5 to JSON and for validating the syntax of JSON5 documents.\n\n### Installation\n```sh\nnpm install --global json5\n```\n\n### Usage\n```sh\njson5 [options] <file>\n```\n\nIf `<file>` is not provided, then STDIN is used.\n\n#### Options:\n- `-s`, `--space`: The number of spaces to indent or `t` for tabs\n- `-o`, `--out-file [file]`: Output to the specified file, otherwise STDOUT\n- `-v`, `--validate`: Validate JSON5 but do not output JSON\n- `-V`, `--version`: Output the version number\n- `-h`, `--help`: Output usage information\n\n## Contributing\n### Development\n```sh\ngit clone https://github.com/json5/json5\ncd json5\nnpm install\n```\n\nWhen contributing code, please write relevant tests and run `npm test` and `npm\nrun lint` before submitting pull requests. Please use an editor that supports\n[EditorConfig](http://editorconfig.org/).\n\n### Issues\nTo report bugs or request features regarding the JSON5 data format, please\nsubmit an issue to the [official specification\nrepository](https://github.com/json5/json5-spec).\n\nTo report bugs or request features regarding the JavaScript implementation of\nJSON5, please submit an issue to this repository.\n\n## License\nMIT. See [LICENSE.md](./LICENSE.md) for details.\n\n## Credits\n[Assem Kishore](https://github.com/aseemk) founded this project.\n\n[Michael Bolin](http://bolinfest.com/) independently arrived at and published\nsome of these same ideas with awesome explanations and detail. Recommended\nreading: [Suggested Improvements to JSON](http://bolinfest.com/essays/json.html)\n\n[Douglas Crockford](http://www.crockford.com/) of course designed and built\nJSON, but his state machine diagrams on the [JSON website](http://json.org/), as\ncheesy as it may sound, gave us motivation and confidence that building a new\nparser to implement these ideas was within reach! The original\nimplementation of JSON5 was also modeled directly off of Doug’s open-source\n[json_parse.js] parser. We’re grateful for that clean and well-documented\ncode.\n\n[json_parse.js]:\nhttps://github.com/douglascrockford/JSON-js/blob/03157639c7a7cddd2e9f032537f346f1a87c0f6d/json_parse.js\n\n[Max Nanasy](https://github.com/MaxNanasy) has been an early and prolific\nsupporter, contributing multiple patches and ideas.\n\n[Andrew Eisenberg](https://github.com/aeisenberg) contributed the original\n`stringify` method.\n\n[Jordan Tucker](https://github.com/jordanbtucker) has aligned JSON5 more closely\nwith ES5, wrote the official JSON5 specification, completely rewrote the\ncodebase from the ground up, and is actively maintaining this project.\n# postcss-value-parser\n\n[](https://travis-ci.org/TrySound/postcss-value-parser)\n\nTransforms CSS declaration values and at-rule parameters into a tree of nodes, and provides a simple traversal API.\n\n## Usage\n\n```js\nvar valueParser = require('postcss-value-parser');\nvar cssBackgroundValue = 'url(foo.png) no-repeat 40px 73%';\nvar parsedValue = valueParser(cssBackgroundValue);\n// parsedValue exposes an API described below,\n// e.g. parsedValue.walk(..), parsedValue.toString(), etc.\n```\n\nFor example, parsing the value `rgba(233, 45, 66, .5)` will return the following:\n\n```js\n{\n nodes: [\n {\n type: 'function',\n value: 'rgba',\n before: '',\n after: '',\n nodes: [\n { type: 'word', value: '233' },\n { type: 'div', value: ',', before: '', after: ' ' },\n { type: 'word', value: '45' },\n { type: 'div', value: ',', before: '', after: ' ' },\n { type: 'word', value: '66' },\n { type: 'div', value: ',', before: ' ', after: '' },\n { type: 'word', value: '.5' }\n ]\n }\n ]\n}\n```\n\nIf you wanted to convert each `rgba()` value in `sourceCSS` to a hex value, you could do so like this:\n\n```js\nvar valueParser = require('postcss-value-parser');\n\nvar parsed = valueParser(sourceCSS);\n\n// walk() will visit all the of the nodes in the tree,\n// invoking the callback for each.\nparsed.walk(function (node) {\n\n // Since we only want to transform rgba() values,\n // we can ignore anything else.\n if (node.type !== 'function' && node.value !== 'rgba') return;\n\n // We can make an array of the rgba() arguments to feed to a\n // convertToHex() function\n var color = node.nodes.filter(function (node) {\n return node.type === 'word';\n }).map(function (node) {\n return Number(node.value);\n }); // [233, 45, 66, .5]\n\n // Now we will transform the existing rgba() function node\n // into a word node with the hex value\n node.type = 'word';\n node.value = convertToHex(color);\n})\n\nparsed.toString(); // #E92D42\n```\n\n## Nodes\n\nEach node is an object with these common properties:\n\n- **type**: The type of node (`word`, `string`, `div`, `space`, `comment`, or `function`).\n Each type is documented below.\n- **value**: Each node has a `value` property; but what exactly `value` means\n is specific to the node type. Details are documented for each type below.\n- **sourceIndex**: The starting index of the node within the original source\n string. For example, given the source string `10px 20px`, the `word` node\n whose value is `20px` will have a `sourceIndex` of `5`.\n\n### word\n\nThe catch-all node type that includes keywords (e.g. `no-repeat`),\nquantities (e.g. `20px`, `75%`, `1.5`), and hex colors (e.g. `#e6e6e6`).\n\nNode-specific properties:\n\n- **value**: The \"word\" itself.\n\n### string\n\nA quoted string value, e.g. `\"something\"` in `content: \"something\";`.\n\nNode-specific properties:\n\n- **value**: The text content of the string.\n- **quote**: The quotation mark surrounding the string, either `\"` or `'`.\n- **unclosed**: `true` if the string was not closed properly. e.g. `\"unclosed string `.\n\n### div\n\nA divider, for example\n\n- `,` in `animation-duration: 1s, 2s, 3s`\n- `/` in `border-radius: 10px / 23px`\n- `:` in `(min-width: 700px)`\n\nNode-specific properties:\n\n- **value**: The divider character. Either `,`, `/`, or `:` (see examples above).\n- **before**: Whitespace before the divider.\n- **after**: Whitespace after the divider.\n\n### space\n\nWhitespace used as a separator, e.g. ` ` occurring twice in `border: 1px solid black;`.\n\nNode-specific properties:\n\n- **value**: The whitespace itself.\n\n### comment\n\nA CSS comment starts with `/*` and ends with `*/`\n\nNode-specific properties:\n\n- **value**: The comment value without `/*` and `*/`\n- **unclosed**: `true` if the comment was not closed properly. e.g. `/* comment without an end `.\n\n### function\n\nA CSS function, e.g. `rgb(0,0,0)` or `url(foo.bar)`.\n\nFunction nodes have nodes nested within them: the function arguments.\n\nAdditional properties:\n\n- **value**: The name of the function, e.g. `rgb` in `rgb(0,0,0)`.\n- **before**: Whitespace after the opening parenthesis and before the first argument,\n e.g. ` ` in `rgb( 0,0,0)`.\n- **after**: Whitespace before the closing parenthesis and after the last argument,\n e.g. ` ` in `rgb(0,0,0 )`.\n- **nodes**: More nodes representing the arguments to the function.\n- **unclosed**: `true` if the parentheses was not closed properly. e.g. `( unclosed-function `.\n\nMedia features surrounded by parentheses are considered functions with an\nempty value. For example, `(min-width: 700px)` parses to these nodes:\n\n```js\n[\n {\n type: 'function', value: '', before: '', after: '',\n nodes: [\n { type: 'word', value: 'min-width' },\n { type: 'div', value: ':', before: '', after: ' ' },\n { type: 'word', value: '700px' }\n ]\n }\n]\n```\n\n`url()` functions can be parsed a little bit differently depending on\nwhether the first character in the argument is a quotation mark.\n\n`url( /gfx/img/bg.jpg )` parses to:\n\n```js\n{ type: 'function', sourceIndex: 0, value: 'url', before: ' ', after: ' ', nodes: [\n { type: 'word', sourceIndex: 5, value: '/gfx/img/bg.jpg' }\n] }\n```\n\n`url( \"/gfx/img/bg.jpg\" )`, on the other hand, parses to:\n\n```js\n{ type: 'function', sourceIndex: 0, value: 'url', before: ' ', after: ' ', nodes: [\n type: 'string', sourceIndex: 5, quote: '\"', value: '/gfx/img/bg.jpg' },\n] }\n```\n\n### unicode-range\n\nThe unicode-range CSS descriptor sets the specific range of characters to be \nused from a font defined by @font-face and made available \nfor use on the current page (`unicode-range: U+0025-00FF`).\n\nNode-specific properties:\n\n- **value**: The \"unicode-range\" itself.\n\n## API\n\n```\nvar valueParser = require('postcss-value-parser');\n```\n\n### valueParser.unit(quantity)\n\nParses `quantity`, distinguishing the number from the unit. Returns an object like the following:\n\n```js\n// Given 2rem\n{\n number: '2',\n unit: 'rem'\n}\n```\n\nIf the `quantity` argument cannot be parsed as a number, returns `false`.\n\n*This function does not parse complete values*: you cannot pass it `1px solid black` and expect `px` as\nthe unit. Instead, you should pass it single quantities only. Parse `1px solid black`, then pass it\nthe stringified `1px` node (a `word` node) to parse the number and unit.\n\n### valueParser.stringify(nodes[, custom])\n\nStringifies a node or array of nodes.\n\nThe `custom` function is called for each `node`; return a string to override the default behaviour.\n\n### valueParser.walk(nodes, callback[, bubble])\n\nWalks each provided node, recursively walking all descendent nodes within functions.\n\nReturning `false` in the `callback` will prevent traversal of descendent nodes (within functions).\nYou can use this feature to for shallow iteration, walking over only the *immediate* children.\n*Note: This only applies if `bubble` is `false` (which is the default).*\n\nBy default, the tree is walked from the outermost node inwards.\nTo reverse the direction, pass `true` for the `bubble` argument.\n\nThe `callback` is invoked with three arguments: `callback(node, index, nodes)`.\n\n- `node`: The current node.\n- `index`: The index of the current node.\n- `nodes`: The complete nodes array passed to `walk()`.\n\nReturns the `valueParser` instance.\n\n### var parsed = valueParser(value)\n\nReturns the parsed node tree.\n\n### parsed.nodes\n\nThe array of nodes.\n\n### parsed.toString()\n\nStringifies the node tree.\n\n### parsed.walk(callback[, bubble])\n\nWalks each node inside `parsed.nodes`. See the documentation for `valueParser.walk()` above.\n\n# License\n\nMIT © [Bogdan Chadkin](mailto:trysound@yandex.ru)\n# magic-string\n\n<p align=\"center\">\n <a href=\"https://travis-ci.org/Rich-Harris/magic-string\">\n <img src=\"http://img.shields.io/travis/Rich-Harris/magic-string.svg\"\n alt=\"build status\">\n </a>\n <a href=\"https://npmjs.org/package/magic-string\">\n <img src=\"https://img.shields.io/npm/v/magic-string.svg\"\n alt=\"npm version\">\n </a>\n <a href=\"https://github.com/Rich-Harris/magic-string/blob/master/LICENSE.md\">\n <img src=\"https://img.shields.io/npm/l/magic-string.svg\"\n alt=\"license\">\n </a>\n <a href=\"https://david-dm.org/Rich-Harris/magic-string\">\n <img src=\"https://david-dm.org/Rich-Harris/magic-string.svg\"\n alt=\"dependency status\">\n </a>\n <a href=\"http://codecov.io/github/Rich-Harris/magic-string?branch=master\">\n <img src=\"http://codecov.io/github/Rich-Harris/magic-string/coverage.svg?branch=master\" alt=\"Coverage via Codecov\" />\n </a>\n</p>\n\nSuppose you have some source code. You want to make some light modifications to it - replacing a few characters here and there, wrapping it with a header and footer, etc - and ideally you'd like to generate a source map at the end of it. You've thought about using something like [recast](https://github.com/benjamn/recast) (which allows you to generate an AST from some JavaScript, manipulate it, and reprint it with a sourcemap without losing your comments and formatting), but it seems like overkill for your needs (or maybe the source code isn't JavaScript).\n\nYour requirements are, frankly, rather niche. But they're requirements that I also have, and for which I made magic-string. It's a small, fast utility for manipulating strings and generating sourcemaps.\n\n## Installation\n\nmagic-string works in both node.js and browser environments. For node, install with npm:\n\n```bash\nnpm i magic-string\n```\n\nTo use in browser, grab the [magic-string.umd.js](https://unpkg.com/magic-string/dist/magic-string.umd.js) file and add it to your page:\n\n```html\n<script src='magic-string.umd.js'></script>\n```\n\n(It also works with various module systems, if you prefer that sort of thing - it has a dependency on [vlq](https://github.com/Rich-Harris/vlq).)\n\n## Usage\n\nThese examples assume you're in node.js, or something similar:\n\n```js\nvar MagicString = require( 'magic-string' );\nvar s = new MagicString( 'problems = 99' );\n\ns.overwrite( 0, 8, 'answer' );\ns.toString(); // 'answer = 99'\n\ns.overwrite( 11, 13, '42' ); // character indices always refer to the original string\ns.toString(); // 'answer = 42'\n\ns.prepend( 'var ' ).append( ';' ); // most methods are chainable\ns.toString(); // 'var answer = 42;'\n\nvar map = s.generateMap({\n source: 'source.js',\n file: 'converted.js.map',\n includeContent: true\n}); // generates a v3 sourcemap\n\nrequire( 'fs' ).writeFile( 'converted.js', s.toString() );\nrequire( 'fs' ).writeFile( 'converted.js.map', map.toString() );\n```\n\nYou can pass an options argument:\n\n```js\nvar s = new MagicString( someCode, {\n // both these options will be used if you later\n // call `bundle.addSource( s )` - see below\n filename: 'foo.js',\n indentExclusionRanges: [/*...*/]\n});\n```\n\n## Methods\n\n### s.addSourcemapLocation( index )\n\nAdds the specified character index (with respect to the original string) to sourcemap mappings, if `hires` is `false` (see below).\n\n### s.append( content )\n\nAppends the specified content to the end of the string. Returns `this`.\n\n### s.appendLeft( index, content )\n\nAppends the specified `content` at the `index` in the original string. If a range *ending* with `index` is subsequently moved, the insert will be moved with it. Returns `this`. See also `s.prependLeft(...)`.\n\n### s.appendRight( index, content )\n\nAppends the specified `content` at the `index` in the original string. If a range *starting* with `index` is subsequently moved, the insert will be moved with it. Returns `this`. See also `s.prependRight(...)`.\n\n### s.clone()\n\nDoes what you'd expect.\n\n### s.generateMap( options )\n\nGenerates a [version 3 sourcemap](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit). All options are, well, optional:\n\n* `file` - the filename where you plan to write the sourcemap\n* `source` - the filename of the file containing the original source\n* `includeContent` - whether to include the original content in the map's `sourcesContent` array\n* `hires` - whether the mapping should be high-resolution. Hi-res mappings map every single character, meaning (for example) your devtools will always be able to pinpoint the exact location of function calls and so on. With lo-res mappings, devtools may only be able to identify the correct line - but they're quicker to generate and less bulky. If sourcemap locations have been specified with `s.addSourceMapLocation()`, they will be used here.\n\nThe returned sourcemap has two (non-enumerable) methods attached for convenience:\n\n* `toString` - returns the equivalent of `JSON.stringify(map)`\n* `toUrl` - returns a DataURI containing the sourcemap. Useful for doing this sort of thing:\n\n```js\ncode += '\\n//# sourceMappingURL=' + map.toUrl();\n```\n\n### s.indent( prefix[, options] )\n\nPrefixes each line of the string with `prefix`. If `prefix` is not supplied, the indentation will be guessed from the original content, falling back to a single tab character. Returns `this`.\n\nThe `options` argument can have an `exclude` property, which is an array of `[start, end]` character ranges. These ranges will be excluded from the indentation - useful for (e.g.) multiline strings.\n\n### s.insertLeft( index, content )\n\n**DEPRECATED** since 0.17 – use `s.appendLeft(...)` instead\n\n### s.insertRight( index, content )\n\n**DEPRECATED** since 0.17 – use `s.prependRight(...)` instead\n\n### s.locate( index )\n\n**DEPRECATED** since 0.10 – see [#30](https://github.com/Rich-Harris/magic-string/pull/30)\n\n### s.locateOrigin( index )\n\n**DEPRECATED** since 0.10 – see [#30](https://github.com/Rich-Harris/magic-string/pull/30)\n\n### s.move( start, end, newIndex )\n\nMoves the characters from `start` and `end` to `index`. Returns `this`.\n\n### s.overwrite( start, end, content[, options] )\n\nReplaces the characters from `start` to `end` with `content`. The same restrictions as `s.remove()` apply. Returns `this`.\n\nThe fourth argument is optional. It can have a `storeName` property — if `true`, the original name will be stored for later inclusion in a sourcemap's `names` array — and a `contentOnly` property which determines whether only the content is overwritten, or anything that was appended/prepended to the range as well.\n\n### s.prepend( content )\n\nPrepends the string with the specified content. Returns `this`.\n\n### s.prependLeft ( index, content )\n\nSame as `s.appendLeft(...)`, except that the inserted content will go *before* any previous appends or prepends at `index`\n\n### s.prependRight ( index, content )\n\nSame as `s.appendRight(...)`, except that the inserted content will go *before* any previous appends or prepends at `index`\n\n### s.remove( start, end )\n\nRemoves the characters from `start` to `end` (of the original string, **not** the generated string). Removing the same content twice, or making removals that partially overlap, will cause an error. Returns `this`.\n\n### s.slice( start, end )\n\nReturns the content of the generated string that corresponds to the slice between `start` and `end` of the original string. Throws error if the indices are for characters that were already removed.\n\n### s.snip( start, end )\n\nReturns a clone of `s`, with all content before the `start` and `end` characters of the original string removed.\n\n### s.toString()\n\nReturns the generated string.\n\n### s.trim([ charType ])\n\nTrims content matching `charType` (defaults to `\\s`, i.e. whitespace) from the start and end. Returns `this`.\n\n### s.trimStart([ charType ])\n\nTrims content matching `charType` (defaults to `\\s`, i.e. whitespace) from the start. Returns `this`.\n\n### s.trimEnd([ charType ])\n\nTrims content matching `charType` (defaults to `\\s`, i.e. whitespace) from the end. Returns `this`.\n\n### s.trimLines()\n\nRemoves empty lines from the start and end. Returns `this`.\n\n## Bundling\n\nTo concatenate several sources, use `MagicString.Bundle`:\n\n```js\nvar bundle = new MagicString.Bundle();\n\nbundle.addSource({\n filename: 'foo.js',\n content: new MagicString( 'var answer = 42;' )\n});\n\nbundle.addSource({\n filename: 'bar.js',\n content: new MagicString( 'console.log( answer )' )\n});\n\n// Advanced: a source can include an `indentExclusionRanges` property\n// alongside `filename` and `content`. This will be passed to `s.indent()`\n// - see documentation above\n\nbundle.indent() // optionally, pass an indent string, otherwise it will be guessed\n .prepend( '(function () {\\n' )\n .append( '}());' );\n\nbundle.toString();\n// (function () {\n// var answer = 42;\n// console.log( answer );\n// }());\n\n// options are as per `s.generateMap()` above\nvar map = bundle.generateMap({\n file: 'bundle.js',\n includeContent: true,\n hires: true\n});\n```\n\nAs an alternative syntax, if you a) don't have `filename` or `indentExclusionRanges` options, or b) passed those in when you used `new MagicString(...)`, you can simply pass the `MagicString` instance itself:\n\n```js\nvar bundle = new MagicString.Bundle();\nvar source = new MagicString( someCode, {\n filename: 'foo.js'\n});\n\nbundle.addSource( source );\n```\n\n## License\n\nMIT\n# [NWSAPI](http://dperini.github.io/nwsapi/)\n\nFast CSS Selectors API Engine\n\n   \n\nNWSAPI is the development progress of [NWMATCHER](https://github.com/dperini/nwmatcher) aiming at [Selectors Level 4](https://www.w3.org/TR/selectors-4/) conformance. It has been completely reworked to be easily extended and maintained. It is a right-to-left selector parser and compiler written in pure Javascript with no external dependencies. It was initially thought as a cross browser library to improve event delegation and web page scraping in various frameworks but it has become a popular replacement of the native CSS selection and matching functionality in newer browsers and headless environments.\n\nIt uses [regular expressions](https://en.wikipedia.org/wiki/Regular_expression) to parse CSS selector strings and [metaprogramming](https://en.wikipedia.org/wiki/Metaprogramming) to transforms these selector strings into Javascript function resolvers. This process is executed only once for each selector string allowing memoization of the function resolvers and achieving unmatched performances.\n\n## Installation\n\nTo include NWSAPI in a standard web page:\n\n```html\n<script type=\"text/javascript\" src=\"nwsapi.js\"></script>\n```\n\nTo include NWSAPI in a standard web page and automatically replace the native QSA:\n\n```html\n<script type=\"text/javascript\" src=\"nwsapi.js\" onload=\"NW.Dom.install()\"></script>\n```\n\nTo use NWSAPI with Node.js:\n\n```\n$ npm install nwsapi\n```\n\nNWSAPI currently supports browsers (as a global, `NW.Dom`) and headless environments (as a CommonJS module).\n\n## Supported Selectors\n\nHere is a list of all the CSS2/CSS3/CSS4 [Supported selectors](https://github.com/dperini/nwsapi/wiki/CSS-supported-selectors).\n\n## Features and Compliance\n\nYou can read more about NWSAPI [features and compliance](https://github.com/dperini/nwsapi/wiki/Features-and-compliance) on the wiki.\n\n## API\n\n### DOM Selection\n\n#### `ancestor( selector, context, callback )`\n\nReturns a reference to the nearest ancestor element matching `selector`, starting at `context`. Returns `null` if no element is found. If `callback` is provided, it is invoked for the matched element.\n\n#### `first( selector, context, callback )`\n\nReturns a reference to the first element matching `selector`, starting at `context`. Returns `null` if no element matches. If `callback` is provided, it is invoked for the matched element.\n\n#### `match( selector, element, callback )`\n\nReturns `true` if `element` matches `selector`, starting at `context`; returns `false` otherwise. If `callback` is provided, it is invoked for the matched element.\n\n#### `select( selector, context, callback )`\n\nReturns an array of all the elements matching `selector`, starting at `context`; returns empty `Array` otherwise. If `callback` is provided, it is invoked for each matching element.\n\n### DOM Helpers\n\n#### `byId( id, from )`\n\nReturns a reference to the first element with ID `id`, optionally filtered to descendants of the element `from`.\n\n#### `byTag( tag, from )`\n\nReturns an array of elements having the specified tag name `tag`, optionally filtered to descendants of the element `from`.\n\n#### `byClass( class, from )`\n\nReturns an array of elements having the specified class name `class`, optionally filtered to descendants of the element `from`.\n\n### Engine Configuration\n\n#### `configure( options )`\n\nThe following is the list of currently available configuration options, their default values and descriptions, they are boolean flags that can be set to `true` or `false`:\n\n* `IDS_DUPES`: true - true to allow using multiple elements having the same id, false to disallow\n* `LIVECACHE`: true - true for caching both results and resolvers, false for caching only resolvers\n* `MIXEDCASE`: true - true to match tag names case insensitive, false to match using case sensitive\n* `LOGERRORS`: true - true to print errors and warnings to the console, false to mute both of them\n\n### Examples on extending the basic functionalities\n\n#### `configure( { <configuration-flag>: [ true | false ] } )`\n\nDisable logging errors/warnings to console, disallow duplicate ids. Example:\n\n```js\nNW.Dom.configure( { LOGERRORS: false, IDS_DUPES: false } );\n```\nNOTE: NW.Dom.configure() without parameters return the current configuration.\n\n#### `registerCombinator( symbol, resolver )`\n\nRegisters a new symbol and its matching resolver in the combinators table. Example:\n\n```js\nNW.Dom.registerCombinator( '^', 'e.parentElement' );\n```\n\n#### `registerOperator( symbol, resolver )`\n\nRegisters a new symbol and its matching resolver in the attribute operators table. Example:\n\n```js\nNW.Dom.registerOperator( '!=', { p1: '^', p2: '$', p3: 'false' } );\n```\n\n#### `registerSelector( name, rexp, func )`\n\nRegisters a new selector, the matching RE and the resolver function, in the selectors table. Example:\n\n```js\nNW.Dom.registerSelector('Controls', /^\\:(control)(.*)/i,\n (function(global) {\n return function(match, source, mode, callback) {\n var status = true;\n source = 'if(/^(button|input|select|textarea)/i.test(e.nodeName)){' + source + '}';\n return { 'source': source, 'status': status };\n };\n })(this));\n```\n# defaults\n\nA simple one level options merge utility\n\n## install\n\n`npm install defaults`\n\n## use\n\n```javascript\n\nvar defaults = require('defaults');\n\nvar handle = function(options, fn) {\n options = defaults(options, {\n timeout: 100\n });\n\n setTimeout(function() {\n fn(options);\n }, options.timeout);\n}\n\nhandle({ timeout: 1000 }, function() {\n // we're here 1000 ms later\n});\n\nhandle({ timeout: 10000 }, function() {\n // we're here 10s later\n});\n\n```\n\n## summary\n\nthis module exports a function that takes 2 arguments: `options` and `defaults`. When called, it overrides all of `undefined` properties in `options` with the clones of properties defined in `defaults`\n\nSidecases: if called with a falsy `options` value, options will be initialized to a new object before being merged onto.\n\n## license\n\n[MIT](LICENSE)\n# fragment-cache [](https://www.npmjs.com/package/fragment-cache) [](https://npmjs.org/package/fragment-cache) [](https://travis-ci.org/jonschlinkert/fragment-cache)\n\n> A cache for managing namespaced sub-caches\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save fragment-cache\n```\n\n## Usage\n\n```js\nvar Fragment = require('fragment-cache');\nvar fragment = new Fragment();\n```\n\n## API\n\n### [FragmentCache](index.js#L24)\n\nCreate a new `FragmentCache` with an optional object to use for `caches`.\n\n**Example**\n\n```js\nvar fragment = new FragmentCache();\n```\n\n**Params**\n\n* `cacheName` **{String}**\n* `returns` **{Object}**: Returns the [map-cache](https://github.com/jonschlinkert/map-cache) instance.\n\n### [.cache](index.js#L49)\n\nGet cache `name` from the `fragment.caches` object. Creates a new `MapCache` if it doesn't already exist.\n\n**Example**\n\n```js\nvar cache = fragment.cache('files');\nconsole.log(fragment.caches.hasOwnProperty('files'));\n//=> true\n```\n\n**Params**\n\n* `cacheName` **{String}**\n* `returns` **{Object}**: Returns the [map-cache](https://github.com/jonschlinkert/map-cache) instance.\n\n### [.set](index.js#L67)\n\nSet a value for property `key` on cache `name`\n\n**Example**\n\n```js\nfragment.set('files', 'somefile.js', new File({path: 'somefile.js'}));\n```\n\n**Params**\n\n* `name` **{String}**\n* `key` **{String}**: Property name to set\n* `val` **{any}**: The value of `key`\n* `returns` **{Object}**: The cache instance for chaining\n\n### [.has](index.js#L93)\n\nReturns true if a non-undefined value is set for `key` on fragment cache `name`.\n\n**Example**\n\n```js\nvar cache = fragment.cache('files');\ncache.set('somefile.js');\n\nconsole.log(cache.has('somefile.js'));\n//=> true\n\nconsole.log(cache.has('some-other-file.js'));\n//=> false\n```\n\n**Params**\n\n* `name` **{String}**: Cache name\n* `key` **{String}**: Optionally specify a property to check for on cache `name`\n* `returns` **{Boolean}**\n\n### [.get](index.js#L115)\n\nGet `name`, or if specified, the value of `key`. Invokes the [cache](#cache) method, so that cache `name` will be created it doesn't already exist. If `key` is not passed, the entire cache (`name`) is returned.\n\n**Example**\n\n```js\nvar Vinyl = require('vinyl');\nvar cache = fragment.cache('files');\ncache.set('somefile.js', new Vinyl({path: 'somefile.js'}));\nconsole.log(cache.get('somefile.js'));\n//=> <File \"somefile.js\">\n```\n\n**Params**\n\n* `name` **{String}**\n* `returns` **{Object}**: Returns cache `name`, or the value of `key` if specified\n\n## About\n\n### Related projects\n\n* [base](https://www.npmjs.com/package/base): base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/node-base/base) | [homepage](https://github.com/node-base/base \"base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.\")\n* [map-cache](https://www.npmjs.com/package/map-cache): Basic cache object for storing key-value pairs. | [homepage](https://github.com/jonschlinkert/map-cache \"Basic cache object for storing key-value pairs.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_\n\nTo generate the readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install -g verb verb-generate-readme && verb\n```\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/fragment-cache/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 17, 2016._\n# object.values <sup>[![Version Badge][npm-version-svg]][package-url]</sup>\n\n[![Build Status][travis-svg]][travis-url]\n[![dependency status][deps-svg]][deps-url]\n[![dev dependency status][dev-deps-svg]][dev-deps-url]\n[![License][license-image]][license-url]\n[![Downloads][downloads-image]][downloads-url]\n\n[![npm badge][npm-badge-png]][package-url]\n\n[![browser support][testling-svg]][testling-url]\n\nAn ES2017 spec-compliant `Object.values` shim. Invoke its \"shim\" method to shim `Object.values` if it is unavailable or noncompliant.\n\nThis package implements the [es-shim API](https://github.com/es-shims/api) interface. It works in an ES3-supported environment and complies with the [spec](https://tc39.github.io/ecma262/#sec-object.values).\n\nMost common usage:\n```js\nvar assert = require('assert');\nvar values = require('object.values');\n\nvar obj = { a: 1, b: 2, c: 3 };\nvar expected = [1, 2, 3];\n\nif (typeof Symbol === 'function' && typeof Symbol() === 'symbol') {\n\t// for environments with Symbol support\n\tvar sym = Symbol();\n\tobj[sym] = 4;\n\tobj.d = sym;\n\texpected.push(sym);\n}\n\nassert.deepEqual(values(obj), expected);\n\nif (!Object.values) {\n\tvalues.shim();\n}\n\nassert.deepEqual(Object.values(obj), expected);\n```\n\n## Tests\nSimply clone the repo, `npm install`, and run `npm test`\n\n[package-url]: https://npmjs.com/package/object.values\n[npm-version-svg]: http://versionbadg.es/es-shims/Object.values.svg\n[travis-svg]: https://travis-ci.org/es-shims/Object.values.svg\n[travis-url]: https://travis-ci.org/es-shims/Object.values\n[deps-svg]: https://david-dm.org/es-shims/Object.values.svg\n[deps-url]: https://david-dm.org/es-shims/Object.values\n[dev-deps-svg]: https://david-dm.org/es-shims/Object.values/dev-status.svg\n[dev-deps-url]: https://david-dm.org/es-shims/Object.values#info=devDependencies\n[testling-svg]: https://ci.testling.com/es-shims/Object.values.png\n[testling-url]: https://ci.testling.com/es-shims/Object.values\n[npm-badge-png]: https://nodei.co/npm/object.values.png?downloads=true&stars=true\n[license-image]: http://img.shields.io/npm/l/object.values.svg\n[license-url]: LICENSE\n[downloads-image]: http://img.shields.io/npm/dm/object.values.svg\n[downloads-url]: http://npm-stat.com/charts.html?package=object.values\n# posthtml-parser\n[](http://badge.fury.io/js/posthtml-parser)\n[](https://travis-ci.org/posthtml/posthtml-parser?branch=master)\n[](https://coveralls.io/r/posthtml/posthtml-parser?branch=master)\n\nParse HTML/XML to [PostHTML AST](https://github.com/posthtml/posthtml-parser#posthtml-ast-format).\nMore about [PostHTML](https://github.com/posthtml/posthtml#readme)\n\n## Install\n\n[NPM](http://npmjs.com) install\n```\n$ npm install posthtml-parser\n```\n\n## Usage\n\n#### Input HTML\n```html\n<a class=\"animals\" href=\"#\">\n <span class=\"animals__cat\" style=\"background: url(cat.png)\">Cat</span>\n</a>\n```\n```js\nconst parser = require('posthtml-parser')\nconst fs = require('fs')\nconst html = fs.readFileSync('path/to/input.html').toString()\n\nconsole.log(parser(html)) // Logs a PostHTML AST\n```\n\n#### input HTML\n```html\n<a class=\"animals\" href=\"#\">\n <span class=\"animals__cat\" style=\"background: url(cat.png)\">Cat</span>\n</a>\n```\n\n#### Result PostHTMLTree\n```js\n[{\n tag: 'a',\n attrs: {\n class: 'animals',\n href: '#'\n },\n content: [\n '\\n ',\n {\n tag: 'span',\n attrs: {\n class: 'animals__cat',\n style: 'background: url(cat.png)'\n },\n content: ['Cat']\n },\n '\\n'\n ]\n}]\n```\n\n## PostHTML AST Format\n\nAny parser being used with PostHTML should return a standard PostHTML [Abstract Syntax Tree](https://www.wikiwand.com/en/Abstract_syntax_tree) (AST). Fortunately, this is a very easy format to produce and understand. The AST is an array that can contain strings and objects. Any strings represent plain text content to be written to the output. Any objects represent HTML tags.\n\nTag objects generally look something like this:\n\n```js\n{\n tag: 'div',\n attrs: {\n class: 'foo'\n },\n content: ['hello world!']\n}\n```\n\nTag objects can contain three keys. The `tag` key takes the name of the tag as the value. This can include custom tags. The optional `attrs` key takes an object with key/value pairs representing the attributes of the html tag. A boolean attribute has an empty string as its value. Finally, the optional `content` key takes an array as its value, which is a PostHTML AST. In this manner, the AST is a tree that should be walked recursively.\n\n## Options\n\n### `directives`\nType: `Array` \nDefault: `[{name: '!doctype', start: '<', end: '>'}]` \nDescription: *Adds processing of custom directives. Note: The property ```name``` in custom directives can be ```String``` or ```RegExp``` type* \n\n### `xmlMode`\nType: `Boolean` \nDefault: `false` \nDescription: *Indicates whether special tags (`<script>` and `<style>`) should get special treatment and if \"empty\" tags (eg. `<br>`) can have children. If false, the content of special tags will be text only. For feeds and other XML content (documents that don't consist of HTML), set this to true.*\n\n### `decodeEntities`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, entities within the document will be decoded.*\n\n### `lowerCaseTags`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, all tags will be lowercased. If `xmlMode` is disabled.*\n\n### `lowerCaseAttributeNames`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, all attribute names will be lowercased. This has noticeable impact on speed.*\n\n### `recognizeCDATA`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, CDATA sections will be recognized as text even if the `xmlMode` option is not enabled. NOTE: If `xmlMode` is set to `true` then CDATA sections will always be recognized as text.*\n\n### `recognizeSelfClosing`\nType: `Boolean` \nDefault: `false` \nDescription: *If set to true, self-closing tags will trigger the `onclosetag` event even if `xmlMode` is not set to `true`. NOTE: If `xmlMode` is set to `true` then self-closing tags will always be recognized.*\n\n## License\n\n[MIT](LICENSE)\nagent-base\n==========\n### Turn a function into an [`http.Agent`][http.Agent] instance\n[](https://travis-ci.org/TooTallNate/node-agent-base)\n\nThis module provides an `http.Agent` generator. That is, you pass it an async\ncallback function, and it returns a new `http.Agent` instance that will invoke the\ngiven callback function when sending outbound HTTP requests.\n\n#### Some subclasses:\n\nHere's some more interesting uses of `agent-base`.\nSend a pull request to list yours!\n\n * [`http-proxy-agent`][http-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTP endpoints\n * [`https-proxy-agent`][https-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTPS endpoints\n * [`pac-proxy-agent`][pac-proxy-agent]: A PAC file proxy `http.Agent` implementation for HTTP and HTTPS\n * [`socks-proxy-agent`][socks-proxy-agent]: A SOCKS (v4a) proxy `http.Agent` implementation for HTTP and HTTPS\n\nInstallation\n------------\n\nInstall with `npm`:\n\n``` bash\n$ npm install agent-base\n```\n\nExample\n-------\n\nHere's a minimal example that creates a new `net.Socket` connection to the server\nfor every HTTP request (i.e. the equivalent of `agent: false` option):\n\n```js\nvar net = require('net');\nvar tls = require('tls');\nvar url = require('url');\nvar http = require('http');\nvar agent = require('agent-base');\n\nvar endpoint = 'http://nodejs.org/api/';\nvar parsed = url.parse(endpoint);\n\n// This is the important part!\nparsed.agent = agent(function (req, opts) {\n var socket;\n // `secureEndpoint` is true when using the https module\n if (opts.secureEndpoint) {\n socket = tls.connect(opts);\n } else {\n socket = net.connect(opts);\n }\n return socket;\n});\n\n// Everything else works just like normal...\nhttp.get(parsed, function (res) {\n console.log('\"response\" event!', res.headers);\n res.pipe(process.stdout);\n});\n```\n\nReturning a Promise or using an `async` function is also supported:\n\n```js\nagent(async function (req, opts) {\n await sleep(1000);\n // etc…\n});\n```\n\nReturn another `http.Agent` instance to \"pass through\" the responsibility\nfor that HTTP request to that agent:\n\n```js\nagent(function (req, opts) {\n return opts.secureEndpoint ? https.globalAgent : http.globalAgent;\n});\n```\n\nAPI\n---\n\n## Agent(Function callback[, Object options]) → [http.Agent][]\n\nCreates a base `http.Agent` that will execute the callback function `callback`\nfor every HTTP request that it is used as the `agent` for. The callback function\nis responsible for creating a `stream.Duplex` instance of some kind that will be\nused as the underlying socket in the HTTP request.\n\nThe `options` object accepts the following properties:\n\n * `timeout` - Number - Timeout for the `callback()` function in milliseconds. Defaults to Infinity (optional).\n\nThe callback function should have the following signature:\n\n### callback(http.ClientRequest req, Object options, Function cb) → undefined\n\nThe ClientRequest `req` can be accessed to read request headers and\nand the path, etc. The `options` object contains the options passed\nto the `http.request()`/`https.request()` function call, and is formatted\nto be directly passed to `net.connect()`/`tls.connect()`, or however\nelse you want a Socket to be created. Pass the created socket to\nthe callback function `cb` once created, and the HTTP request will\ncontinue to proceed.\n\nIf the `https` module is used to invoke the HTTP request, then the\n`secureEndpoint` property on `options` _will be set to `true`_.\n\nLicense\n-------\n\n(The MIT License)\n\nCopyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent\n[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent\n[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent\n[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent\n[http.Agent]: https://nodejs.org/api/http.html#http_class_http_agent\n# vlq.js\n\nConvert integers to a Base64-encoded VLQ string, and vice versa. No dependencies, works in node.js or browsers, supports AMD.\n\n## Why would you want to do that?\n\nSourcemaps are the most likely use case. Mappings from original source to generated content are encoded as a sequence of VLQ strings.\n\n## What is a VLQ string?\n\nA [variable-length quantity](http://en.wikipedia.org/wiki/Variable-length_quantity) is a compact way of encoding large integers in text (i.e. in situations where you can't transmit raw binary data). An integer represented as digits will always take up more space than the equivalent VLQ representation:\n\n| Integer | VLQ |\n| :------------------ | :--------- |\n| 0 | A |\n| 1 | C |\n| -1 | D |\n| 123 | 2H |\n| 123456789 | qxmvrH |\n| 123456789123456789 | gxvh6sB |\n\n## Installation\n\n```bash\nnpm install vlq\n```\n\n...or...\n\n```bash\nbower install vlq\n```\n\n...or grab the vlq.js file and include it with a `<script src='vlq.js'>` tag.\n\n## Usage\n\n### Encoding\n\n`vlq.encode` accepts an integer, or an array of integers, and returns a string:\n\n```js\nvlq.encode( 123 ); // '2H';\nvlq.encode([ 123, 456, 789 ]); // '2HwcqxB'\n```\n\n### Decoding\n\n`vlq.decode` accepts a string and always returns an array:\n\n```js\nvlq.decode( '2H' ); // [ 123 ]\nvlq.decode( '2HwcqxB' ); // [ 123, 456, 789 ]\n```\n\n## Using vlq.js with sourcemaps\n\n[See here for an example of using vlq.js with sourcemaps.](https://github.com/Rich-Harris/vlq/tree/master/sourcemaps)\n\n## Credits\n\nAdapted from [murzwin.com/base64vlq.html](http://murzwin.com/base64vlq.html) by Alexander Pavlov.\n\n## License\n\n[MIT](LICENSE).\n# postcss-selector-parser [](https://travis-ci.org/postcss/postcss-selector-parser)\n\n> Selector parser with built in methods for working with selector strings.\n\n## Install\n\nWith [npm](https://npmjs.com/package/postcss-selector-parser) do:\n\n```\nnpm install postcss-selector-parser\n```\n\n## Quick Start\n\n```js\nconst parser = require('postcss-selector-parser');\nconst transform = selectors => {\n selectors.walk(selector => {\n // do something with the selector\n console.log(String(selector))\n });\n};\n\nconst transformed = parser(transform).processSync('h1, h2, h3');\n```\n\nTo normalize selector whitespace:\n\n```js\nconst parser = require('postcss-selector-parser');\nconst normalized = parser().processSync('h1, h2, h3', {lossless: false});\n// -> h1,h2,h3\n```\n\nAsync support is provided through `parser.process` and will resolve a Promise\nwith the resulting selector string.\n\n## API\n\nPlease see [API.md](API.md).\n\n## Credits\n\n* Huge thanks to Andrey Sitnik (@ai) for work on PostCSS which helped\n accelerate this module's development.\n\n## License\n\nMIT\n# arr-flatten [](https://www.npmjs.com/package/arr-flatten) [](https://npmjs.org/package/arr-flatten) [](https://npmjs.org/package/arr-flatten) [](https://travis-ci.org/jonschlinkert/arr-flatten) [](https://ci.appveyor.com/project/jonschlinkert/arr-flatten)\n\n> Recursively flatten an array or arrays.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save arr-flatten\n```\n\n## Install\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install arr-flatten --save\n```\n\n## Usage\n\n```js\nvar flatten = require('arr-flatten');\n\nflatten(['a', ['b', ['c']], 'd', ['e']]);\n//=> ['a', 'b', 'c', 'd', 'e']\n```\n\n## Why another flatten utility?\n\nI wanted the fastest implementation I could find, with implementation choices that should work for 95% of use cases, but no cruft to cover the other 5%.\n\n## About\n\n### Related projects\n\n* [arr-filter](https://www.npmjs.com/package/arr-filter): Faster alternative to javascript's native filter method. | [homepage](https://github.com/jonschlinkert/arr-filter \"Faster alternative to javascript's native filter method.\")\n* [arr-union](https://www.npmjs.com/package/arr-union): Combines a list of arrays, returning a single array with unique values, using strict equality… [more](https://github.com/jonschlinkert/arr-union) | [homepage](https://github.com/jonschlinkert/arr-union \"Combines a list of arrays, returning a single array with unique values, using strict equality for comparisons.\")\n* [array-each](https://www.npmjs.com/package/array-each): Loop over each item in an array and call the given function on every element. | [homepage](https://github.com/jonschlinkert/array-each \"Loop over each item in an array and call the given function on every element.\")\n* [array-unique](https://www.npmjs.com/package/array-unique): Remove duplicate values from an array. Fastest ES5 implementation. | [homepage](https://github.com/jonschlinkert/array-unique \"Remove duplicate values from an array. Fastest ES5 implementation.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 20 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 1 | [lukeed](https://github.com/lukeed) |\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 05, 2017._\n# <img src=\"docs_app/assets/Rx_Logo_S.png\" alt=\"RxJS Logo\" width=\"86\" height=\"86\"> RxJS: Reactive Extensions For JavaScript\n\n[](https://circleci.com/gh/ReactiveX/rxjs/tree/6.x)\n[](http://badge.fury.io/js/%40reactivex%2Frxjs)\n[](https://gitter.im/Reactive-Extensions/RxJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\n# RxJS 6 Stable\n\n### MIGRATION AND RELEASE INFORMATION:\n\nFind out how to update to v6, **automatically update your TypeScript code**, and more!\n\n- [Current home is MIGRATION.md](./docs_app/content/guide/v6/migration.md)\n\n### FOR V 5.X PLEASE GO TO [THE 5.0 BRANCH](https://github.com/ReactiveX/rxjs/tree/5.x)\n\nReactive Extensions Library for JavaScript. This is a rewrite of [Reactive-Extensions/RxJS](https://github.com/Reactive-Extensions/RxJS) and is the latest production-ready version of RxJS. This rewrite is meant to have better performance, better modularity, better debuggable call stacks, while staying mostly backwards compatible, with some breaking changes that reduce the API surface.\n\n[Apache 2.0 License](LICENSE.txt)\n\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Contribution Guidelines](CONTRIBUTING.md)\n- [Maintainer Guidelines](doc_app/content/maintainer-guidelines.md)\n- [API Documentation](https://rxjs.dev/)\n\n## Versions In This Repository\n\n- [master](https://github.com/ReactiveX/rxjs/commits/master) - This is all of the current, unreleased work, which is against v6 of RxJS right now\n- [stable](https://github.com/ReactiveX/rxjs/commits/stable) - This is the branch for the latest version you'd get if you do `npm install rxjs`\n\n## Important\n\nBy contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.\n\n## Installation and Usage\n\n### ES6 via npm\n\n```sh\nnpm install rxjs\n```\n\nIt's recommended to pull in the Observable creation methods you need directly from `'rxjs'` as shown below with `range`. And you can pull in any operator you need from one spot, under `'rxjs/operators'`.\n\n```ts\nimport { range } from \"rxjs\";\nimport { map, filter } from \"rxjs/operators\";\n\nrange(1, 200)\n .pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n )\n .subscribe(x => console.log(x));\n```\n\nHere, we're using the built-in `pipe` method on Observables to combine operators. See [pipeable operators](https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md) for more information.\n\n### CommonJS via npm\n\nTo install this library for CommonJS (CJS) usage, use the following command:\n\n```sh\nnpm install rxjs\n```\n\n(Note: destructuring available in Node 8+)\n\n```js\nconst { range } = require('rxjs');\nconst { map, filter } = require('rxjs/operators');\n\nrange(1, 200).pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n).subscribe(x => console.log(x));\n```\n\n### CDN\n\nFor CDN, you can use [unpkg](https://unpkg.com/):\n\nhttps://unpkg.com/rxjs/bundles/rxjs.umd.min.js\n\nThe global namespace for rxjs is `rxjs`:\n\n```js\nconst { range } = rxjs;\nconst { map, filter } = rxjs.operators;\n\nrange(1, 200)\n .pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n )\n .subscribe(x => console.log(x));\n```\n\n## Goals\n\n- Smaller overall bundles sizes\n- Provide better performance than preceding versions of RxJS\n- To model/follow the [Observable Spec Proposal](https://github.com/zenparsing/es-observable) to the observable\n- Provide more modular file structure in a variety of formats\n- Provide more debuggable call stacks than preceding versions of RxJS\n\n## Building/Testing\n\n- `npm run build_all` - builds everything\n- `npm test` - runs tests\n- `npm run test_no_cache` - run test with `ts-node` set to false\n\n## Performance Tests\n\nRun `npm run build_perf` or `npm run perf` to run the performance tests with `protractor`.\n\nRun `npm run perf_micro [operator]` to run micro performance test benchmarking operator.\n\n## Adding documentation\n\nWe appreciate all contributions to the documentation of any type. All of the information needed to get the docs app up and running locally as well as how to contribute can be found in the [documentation directory](./docs_app).\n\n## Generating PNG marble diagrams\n\nThe script `npm run tests2png` requires some native packages installed locally: `imagemagick`, `graphicsmagick`, and `ghostscript`.\n\nFor Mac OS X with [Homebrew](http://brew.sh/):\n\n- `brew install imagemagick`\n- `brew install graphicsmagick`\n- `brew install ghostscript`\n- You may need to install the Ghostscript fonts manually:\n - Download the tarball from the [gs-fonts project](https://sourceforge.net/projects/gs-fonts)\n - `mkdir -p /usr/local/share/ghostscript && tar zxvf /path/to/ghostscript-fonts.tar.gz -C /usr/local/share/ghostscript`\n\nFor Debian Linux:\n\n- `sudo add-apt-repository ppa:dhor/myway`\n- `apt-get install imagemagick`\n- `apt-get install graphicsmagick`\n- `apt-get install ghostscript`\n\nFor Windows and other Operating Systems, check the download instructions here:\n\n- http://imagemagick.org\n- http://www.graphicsmagick.org\n- http://www.ghostscript.com/\n# define-property [](http://badge.fury.io/js/define-property)\n\n> Define a non-enumerable property on an object.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i define-property --save\n```\n\n## Usage\n\n**Params**\n\n* `obj`: The object on which to define the property.\n* `prop`: The name of the property to be defined or modified.\n* `descriptor`: The descriptor for the property being defined or modified.\n\n```js\nvar define = require('define-property');\nvar obj = {};\ndefine(obj, 'foo', function(val) {\n return val.toUpperCase();\n});\n\nconsole.log(obj);\n//=> {}\n\nconsole.log(obj.foo('bar'));\n//=> 'BAR'\n```\n\n**get/set**\n\n```js\ndefine(obj, 'foo', {\n get: function() {},\n set: function() {}\n});\n```\n\n## Related projects\n\n* [delegate-object](https://www.npmjs.com/package/delegate-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/delegate-object) | [homepage](https://github.com/doowb/delegate-object)\n* [forward-object](https://www.npmjs.com/package/forward-object): Copy properties from an object to another object, where properties with function values will be… [more](https://www.npmjs.com/package/forward-object) | [homepage](https://github.com/doowb/forward-object)\n* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)\n* [mixin-object](https://www.npmjs.com/package/mixin-object): Mixin the own and inherited properties of other objects onto the first object. Pass an… [more](https://www.npmjs.com/package/mixin-object) | [homepage](https://github.com/jonschlinkert/mixin-object)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/define-property/issues/new).\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 31, 2015._\n# fast-levenshtein - Levenshtein algorithm in Javascript\n\n[](http://travis-ci.org/hiddentao/fast-levenshtein)\n[](https://badge.fury.io/js/fast-levenshtein)\n[](https://www.npmjs.com/package/fast-levenshtein)\n[](https://twitter.com/hiddentao)\n\nAn efficient Javascript implementation of the [Levenshtein algorithm](http://en.wikipedia.org/wiki/Levenshtein_distance) with locale-specific collator support.\n\n## Features\n\n* Works in node.js and in the browser.\n* Better performance than other implementations by not needing to store the whole matrix ([more info](http://www.codeproject.com/Articles/13525/Fast-memory-efficient-Levenshtein-algorithm)).\n* Locale-sensitive string comparisions if needed.\n* Comprehensive test suite and performance benchmark.\n* Small: <1 KB minified and gzipped\n\n## Installation\n\n### node.js\n\nInstall using [npm](http://npmjs.org/):\n\n```bash\n$ npm install fast-levenshtein\n```\n\n### Browser\n\nUsing bower:\n\n```bash\n$ bower install fast-levenshtein\n```\n\nIf you are not using any module loader system then the API will then be accessible via the `window.Levenshtein` object.\n\n## Examples\n\n**Default usage**\n\n```javascript\nvar levenshtein = require('fast-levenshtein');\n\nvar distance = levenshtein.get('back', 'book'); // 2\nvar distance = levenshtein.get('我愛你', '我叫你'); // 1\n```\n\n**Locale-sensitive string comparisons**\n\nIt supports using [Intl.Collator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator) for locale-sensitive string comparisons:\n\n```javascript\nvar levenshtein = require('fast-levenshtein');\n\nlevenshtein.get('mikailovitch', 'Mikhaïlovitch', { useCollator: true});\n// 1\n```\n\n## Building and Testing\n\nTo build the code and run the tests:\n\n```bash\n$ npm install -g grunt-cli\n$ npm install\n$ npm run build\n```\n\n## Performance\n\n_Thanks to [Titus Wormer](https://github.com/wooorm) for [encouraging me](https://github.com/hiddentao/fast-levenshtein/issues/1) to do this._\n\nBenchmarked against other node.js levenshtein distance modules (on Macbook Air 2012, Core i7, 8GB RAM):\n\n```bash\nRunning suite Implementation comparison [benchmark/speed.js]...\n>> levenshtein-edit-distance x 234 ops/sec ±3.02% (73 runs sampled)\n>> levenshtein-component x 422 ops/sec ±4.38% (83 runs sampled)\n>> levenshtein-deltas x 283 ops/sec ±3.83% (78 runs sampled)\n>> natural x 255 ops/sec ±0.76% (88 runs sampled)\n>> levenshtein x 180 ops/sec ±3.55% (86 runs sampled)\n>> fast-levenshtein x 1,792 ops/sec ±2.72% (95 runs sampled)\nBenchmark done.\nFastest test is fast-levenshtein at 4.2x faster than levenshtein-component\n```\n\nYou can run this benchmark yourself by doing:\n\n```bash\n$ npm install\n$ npm run build\n$ npm run benchmark\n```\n\n## Contributing\n\nIf you wish to submit a pull request please update and/or create new tests for any changes you make and ensure the grunt build passes.\n\nSee [CONTRIBUTING.md](https://github.com/hiddentao/fast-levenshtein/blob/master/CONTRIBUTING.md) for details.\n\n## License\n\nMIT - see [LICENSE.md](https://github.com/hiddentao/fast-levenshtein/blob/master/LICENSE.md)\nAll the types of nodes in htmlparser2's DOM.\n# isobject [](https://www.npmjs.com/package/isobject) [](https://npmjs.org/package/isobject) [](https://travis-ci.org/jonschlinkert/isobject)\n\nReturns true if the value is an object and not an array or null.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install isobject --save\n```\n\nUse [is-plain-object](https://github.com/jonschlinkert/is-plain-object) if you want only objects that are created by the `Object` constructor.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install isobject\n```\n\nInstall with [bower](http://bower.io/)\n\n```sh\n$ bower install isobject\n```\n\n## Usage\n\n```js\nvar isObject = require('isobject');\n```\n\n**True**\n\nAll of the following return `true`:\n\n```js\nisObject({});\nisObject(Object.create({}));\nisObject(Object.create(Object.prototype));\nisObject(Object.create(null));\nisObject({});\nisObject(new Foo);\nisObject(/foo/);\n```\n\n**False**\n\nAll of the following return `false`:\n\n```js\nisObject();\nisObject(function () {});\nisObject(1);\nisObject([]);\nisObject(undefined);\nisObject(null);\n```\n\n## Related projects\n\nYou might also be interested in these projects:\n\n[merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep)\n\n* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow)\n* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object)\n* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of)\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/isobject/issues/new).\n\n## Building docs\n\nGenerate readme and API documentation with [verb](https://github.com/verbose/verb):\n\n```sh\n$ npm install verb && npm run docs\n```\n\nOr, if [verb](https://github.com/verbose/verb) is installed globally:\n\n```sh\n$ verb\n```\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/jonschlinkert/isobject/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 25, 2016._\n# fb-watchman\n\n`fb-watchman` is a filesystem watcher that uses the\n[Watchman](https://facebook.github.io/watchman/) file watching service from\nFacebook.\n\nWatchman provides file change notification services using very\nefficient recursive watches and also allows more advanced change matching and\nfilesystem tree querying operations using\n[a powerful expression syntax](https://facebook.github.io/watchman/docs/file-query.html#expressions).\n\n## Install\n\nYou should [install Watchman](\nhttps://facebook.github.io/watchman/docs/install.html) to make the most of this\nmodule.\n\nThen simply:\n\n```\n$ npm install fb-watchman\n```\n\n## Key Concepts\n\n- Watchman recursively watches directories.\n- Each watched directory is called a `root`.\n- You must initiate a `watch` on a `root` using the `watch-project` command prior to subscribing to changes\n- Rather than separately watching many sibling directories, `watch-project` consolidates and re-uses existing watches relative to a project root (the location of your `.watchmanconfig` or source control repository root)\n- change notifications are relative to the project root\n\n## How do I use it?\n\n[Read the NodeJS watchman documentation](https://facebook.github.io/watchman/docs/nodejs.html)\nAn ini format parser and serializer for node.\n\nSections are treated as nested objects. Items before the first\nheading are saved on the object directly.\n\n## Usage\n\nConsider an ini-file `config.ini` that looks like this:\n\n ; this comment is being ignored\n scope = global\n\n [database]\n user = dbuser\n password = dbpassword\n database = use_this_database\n\n [paths.default]\n datadir = /var/lib/data\n array[] = first value\n array[] = second value\n array[] = third value\n\nYou can read, manipulate and write the ini-file like so:\n\n var fs = require('fs')\n , ini = require('ini')\n\n var config = ini.parse(fs.readFileSync('./config.ini', 'utf-8'))\n\n config.scope = 'local'\n config.database.database = 'use_another_database'\n config.paths.default.tmpdir = '/tmp'\n delete config.paths.default.datadir\n config.paths.default.array.push('fourth value')\n\n fs.writeFileSync('./config_modified.ini', ini.stringify(config, { section: 'section' }))\n\nThis will result in a file called `config_modified.ini` being written\nto the filesystem with the following content:\n\n [section]\n scope=local\n [section.database]\n user=dbuser\n password=dbpassword\n database=use_another_database\n [section.paths.default]\n tmpdir=/tmp\n array[]=first value\n array[]=second value\n array[]=third value\n array[]=fourth value\n\n## API\n\n### decode(inistring)\n\nDecode the ini-style formatted `inistring` into a nested object.\n\n### parse(inistring)\n\nAlias for `decode(inistring)`\n\n### encode(object, [options])\n\nEncode the object `object` into an ini-style formatted string. If the\noptional parameter `section` is given, then all top-level properties\nof the object are put into this section and the `section`-string is\nprepended to all sub-sections, see the usage example above.\n\nThe `options` object may contain the following:\n\n* `section` A string which will be the first `section` in the encoded\n ini data. Defaults to none.\n* `whitespace` Boolean to specify whether to put whitespace around the\n `=` character. By default, whitespace is omitted, to be friendly to\n some persnickety old parsers that don't tolerate it well. But some\n find that it's more human-readable and pretty with the whitespace.\n\nFor backwards compatibility reasons, if a `string` options is passed\nin, then it is assumed to be the `section` value.\n\n### stringify(object, [options])\n\nAlias for `encode(object, [options])`\n\n### safe(val)\n\nEscapes the string `val` such that it is safe to be used as a key or\nvalue in an ini-file. Basically escapes quotes. For example\n\n ini.safe('\"unsafe string\"')\n\nwould result in\n\n \"\\\"unsafe string\\\"\"\n\n### unsafe(val)\n\nUnescapes the string `val`\n# DOMException\n\nThis package implements the [`DOMException`](https://heycam.github.io/webidl/#idl-DOMException) class, from web browsers. It exists in service of [jsdom](https://github.com/tmpvar/jsdom) and related packages.\n\nExample usage:\n\n```js\nconst DOMException = require(\"domexception\");\n\nconst e1 = new DOMException(\"Something went wrong\", \"BadThingsError\");\nconsole.assert(e1.name === \"BadThingsError\");\nconsole.assert(e1.code === 0);\n\nconst e2 = new DOMException(\"Another exciting error message\", \"NoModificationAllowedError\");\nconsole.assert(e2.name === \"NoModificationAllowedError\");\nconsole.assert(e2.code === 7);\n\nconsole.assert(DOMException.INUSE_ATTRIBUTE_ERR === 10);\n```\n# extend-shallow [](http://badge.fury.io/js/extend-shallow) [](https://travis-ci.org/jonschlinkert/extend-shallow)\n\n> Extend an object with the properties of additional objects. node.js/javascript util.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i extend-shallow --save\n```\n\n## Usage\n\n```js\nvar extend = require('extend-shallow');\n\nextend({a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\nPass an empty object to shallow clone:\n\n```js\nvar obj = {};\nextend(obj, {a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\n## Related\n\n* [extend-shallow](https://github.com/jonschlinkert/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util.\n* [for-own](https://github.com/jonschlinkert/for-own): Iterate over the own enumerable properties of an object, and return an object with properties… [more](https://github.com/jonschlinkert/for-own)\n* [for-in](https://github.com/jonschlinkert/for-in): Iterate over the own and inherited enumerable properties of an objecte, and return an object… [more](https://github.com/jonschlinkert/for-in)\n* [is-plain-object](https://github.com/jonschlinkert/is-plain-object): Returns true if an object was created by the `Object` constructor.\n* [isobject](https://github.com/jonschlinkert/isobject): Returns true if the value is an object and not an array or null.\n* [kind-of](https://github.com/jonschlinkert/kind-of): Get the native type of a value.\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on June 29, 2015._\n# is-data-descriptor [](https://www.npmjs.com/package/is-data-descriptor) [](https://travis-ci.org/jonschlinkert/is-data-descriptor)\n\n> Returns true if a value has the characteristics of a valid JavaScript data descriptor.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm i is-data-descriptor --save\n```\n\n## Usage\n\n```js\nvar isDataDesc = require('is-data-descriptor');\n```\n\n## Examples\n\n`true` when the descriptor has valid properties with valid values.\n\n```js\n// `value` can be anything\nisDataDesc({value: 'foo'})\nisDataDesc({value: function() {}})\nisDataDesc({value: true})\n//=> true\n```\n\n`false` when not an object\n\n```js\nisDataDesc('a')\n//=> false\nisDataDesc(null)\n//=> false\nisDataDesc([])\n//=> false\n```\n\n`false` when the object has invalid properties\n\n```js\nisDataDesc({value: 'foo', bar: 'baz'})\n//=> false\nisDataDesc({value: 'foo', bar: 'baz'})\n//=> false\nisDataDesc({value: 'foo', get: function(){}})\n//=> false\nisDataDesc({get: function(){}, value: 'foo'})\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisDataDesc({value: 'foo', enumerable: 'foo'})\n//=> false\nisDataDesc({value: 'foo', configurable: 'foo'})\n//=> false\nisDataDesc({value: 'foo', writable: 'foo'})\n//=> false\n```\n\n## Valid properties\n\nThe only valid data descriptor properties are the following:\n\n* `configurable` (required)\n* `enumerable` (required)\n* `value` (optional)\n* `writable` (optional)\n\nTo be a valid data descriptor, either `value` or `writable` must be defined.\n\n**Invalid properties**\n\nA descriptor may have additional _invalid_ properties (an error will **not** be thrown).\n\n```js\nvar foo = {};\n\nObject.defineProperty(foo, 'bar', {\n enumerable: true,\n whatever: 'blah', // invalid, but doesn't cause an error\n get: function() {\n return 'baz';\n }\n});\n\nconsole.log(foo.bar);\n//=> 'baz'\n```\n\n## Related projects\n\n* [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor)\n* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://www.npmjs.com/package/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor)\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-data-descriptor/issues/new).\n\n## Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 [Jon Schlinkert](https://github.com/jonschlinkert)\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb](https://github.com/verbose/verb) on December 28, 2015._\n# is-data-descriptor [](https://www.npmjs.com/package/is-data-descriptor) [](https://npmjs.org/package/is-data-descriptor) [](https://npmjs.org/package/is-data-descriptor) [](https://travis-ci.org/jonschlinkert/is-data-descriptor)\n\n> Returns true if a value has the characteristics of a valid JavaScript data descriptor.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save is-data-descriptor\n```\n\n## Usage\n\n```js\nvar isDataDesc = require('is-data-descriptor');\n```\n\n## Examples\n\n`true` when the descriptor has valid properties with valid values.\n\n```js\n// `value` can be anything\nisDataDesc({value: 'foo'})\nisDataDesc({value: function() {}})\nisDataDesc({value: true})\n//=> true\n```\n\n`false` when not an object\n\n```js\nisDataDesc('a')\n//=> false\nisDataDesc(null)\n//=> false\nisDataDesc([])\n//=> false\n```\n\n`false` when the object has invalid properties\n\n```js\nisDataDesc({value: 'foo', bar: 'baz'})\n//=> false\nisDataDesc({value: 'foo', bar: 'baz'})\n//=> false\nisDataDesc({value: 'foo', get: function(){}})\n//=> false\nisDataDesc({get: function(){}, value: 'foo'})\n//=> false\n```\n\n`false` when a value is not the correct type\n\n```js\nisDataDesc({value: 'foo', enumerable: 'foo'})\n//=> false\nisDataDesc({value: 'foo', configurable: 'foo'})\n//=> false\nisDataDesc({value: 'foo', writable: 'foo'})\n//=> false\n```\n\n## Valid properties\n\nThe only valid data descriptor properties are the following:\n\n* `configurable` (required)\n* `enumerable` (required)\n* `value` (optional)\n* `writable` (optional)\n\nTo be a valid data descriptor, either `value` or `writable` must be defined.\n\n**Invalid properties**\n\nA descriptor may have additional _invalid_ properties (an error will **not** be thrown).\n\n```js\nvar foo = {};\n\nObject.defineProperty(foo, 'bar', {\n enumerable: true,\n whatever: 'blah', // invalid, but doesn't cause an error\n get: function() {\n return 'baz';\n }\n});\n\nconsole.log(foo.bar);\n//=> 'baz'\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor \"Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.\")\n* [is-data-descriptor](https://www.npmjs.com/package/is-data-descriptor): Returns true if a value has the characteristics of a valid JavaScript data descriptor. | [homepage](https://github.com/jonschlinkert/is-data-descriptor \"Returns true if a value has the characteristics of a valid JavaScript data descriptor.\")\n* [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor \"Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.\")\n* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject \"Returns true if the value is an object and not an array or null.\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 21 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 2 | [realityking](https://github.com/realityking) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on November 01, 2017._\n[RFC6265](https://tools.ietf.org/html/rfc6265) Cookies and CookieJar for Node.js\n\n[](https://nodei.co/npm/tough-cookie/)\n\n[](https://travis-ci.org/salesforce/tough-cookie)\n\n# Synopsis\n\n``` javascript\nvar tough = require('tough-cookie');\nvar Cookie = tough.Cookie;\nvar cookie = Cookie.parse(header);\ncookie.value = 'somethingdifferent';\nheader = cookie.toString();\n\nvar cookiejar = new tough.CookieJar();\ncookiejar.setCookie(cookie, 'http://currentdomain.example.com/path', cb);\n// ...\ncookiejar.getCookies('http://example.com/otherpath',function(err,cookies) {\n res.headers['cookie'] = cookies.join('; ');\n});\n```\n\n# Installation\n\nIt's _so_ easy!\n\n`npm install tough-cookie`\n\nWhy the name? NPM modules `cookie`, `cookies` and `cookiejar` were already taken.\n\n## Version Support\n\nSupport for versions of node.js will follow that of the [request](https://www.npmjs.com/package/request) module.\n\n# API\n\n## tough\n\nFunctions on the module you get from `require('tough-cookie')`. All can be used as pure functions and don't need to be \"bound\".\n\n**Note**: prior to 1.0.x, several of these functions took a `strict` parameter. This has since been removed from the API as it was no longer necessary.\n\n### `parseDate(string)`\n\nParse a cookie date string into a `Date`. Parses according to RFC6265 Section 5.1.1, not `Date.parse()`.\n\n### `formatDate(date)`\n\nFormat a Date into a RFC1123 string (the RFC6265-recommended format).\n\n### `canonicalDomain(str)`\n\nTransforms a domain-name into a canonical domain-name. The canonical domain-name is a trimmed, lowercased, stripped-of-leading-dot and optionally punycode-encoded domain-name (Section 5.1.2 of RFC6265). For the most part, this function is idempotent (can be run again on its output without ill effects).\n\n### `domainMatch(str,domStr[,canonicalize=true])`\n\nAnswers \"does this real domain match the domain in a cookie?\". The `str` is the \"current\" domain-name and the `domStr` is the \"cookie\" domain-name. Matches according to RFC6265 Section 5.1.3, but it helps to think of it as a \"suffix match\".\n\nThe `canonicalize` parameter will run the other two parameters through `canonicalDomain` or not.\n\n### `defaultPath(path)`\n\nGiven a current request/response path, gives the Path apropriate for storing in a cookie. This is basically the \"directory\" of a \"file\" in the path, but is specified by Section 5.1.4 of the RFC.\n\nThe `path` parameter MUST be _only_ the pathname part of a URI (i.e. excludes the hostname, query, fragment, etc.). This is the `.pathname` property of node's `uri.parse()` output.\n\n### `pathMatch(reqPath,cookiePath)`\n\nAnswers \"does the request-path path-match a given cookie-path?\" as per RFC6265 Section 5.1.4. Returns a boolean.\n\nThis is essentially a prefix-match where `cookiePath` is a prefix of `reqPath`.\n\n### `parse(cookieString[, options])`\n\nalias for `Cookie.parse(cookieString[, options])`\n\n### `fromJSON(string)`\n\nalias for `Cookie.fromJSON(string)`\n\n### `getPublicSuffix(hostname)`\n\nReturns the public suffix of this hostname. The public suffix is the shortest domain-name upon which a cookie can be set. Returns `null` if the hostname cannot have cookies set for it.\n\nFor example: `www.example.com` and `www.subdomain.example.com` both have public suffix `example.com`.\n\nFor further information, see http://publicsuffix.org/. This module derives its list from that site. This call is currently a wrapper around [`psl`](https://www.npmjs.com/package/psl)'s [get() method](https://www.npmjs.com/package/psl#pslgetdomain).\n\n### `cookieCompare(a,b)`\n\nFor use with `.sort()`, sorts a list of cookies into the recommended order given in the RFC (Section 5.4 step 2). The sort algorithm is, in order of precedence:\n\n* Longest `.path`\n* oldest `.creation` (which has a 1ms precision, same as `Date`)\n* lowest `.creationIndex` (to get beyond the 1ms precision)\n\n``` javascript\nvar cookies = [ /* unsorted array of Cookie objects */ ];\ncookies = cookies.sort(cookieCompare);\n```\n\n**Note**: Since JavaScript's `Date` is limited to a 1ms precision, cookies within the same milisecond are entirely possible. This is especially true when using the `now` option to `.setCookie()`. The `.creationIndex` property is a per-process global counter, assigned during construction with `new Cookie()`. This preserves the spirit of the RFC sorting: older cookies go first. This works great for `MemoryCookieStore`, since `Set-Cookie` headers are parsed in order, but may not be so great for distributed systems. Sophisticated `Store`s may wish to set this to some other _logical clock_ such that if cookies A and B are created in the same millisecond, but cookie A is created before cookie B, then `A.creationIndex < B.creationIndex`. If you want to alter the global counter, which you probably _shouldn't_ do, it's stored in `Cookie.cookiesCreated`.\n\n### `permuteDomain(domain)`\n\nGenerates a list of all possible domains that `domainMatch()` the parameter. May be handy for implementing cookie stores.\n\n### `permutePath(path)`\n\nGenerates a list of all possible paths that `pathMatch()` the parameter. May be handy for implementing cookie stores.\n\n## Cookie\n\nExported via `tough.Cookie`.\n\n### `Cookie.parse(cookieString[, options])`\n\nParses a single Cookie or Set-Cookie HTTP header into a `Cookie` object. Returns `undefined` if the string can't be parsed.\n\nThe options parameter is not required and currently has only one property:\n\n * _loose_ - boolean - if `true` enable parsing of key-less cookies like `=abc` and `=`, which are not RFC-compliant.\n\nIf options is not an object, it is ignored, which means you can use `Array#map` with it.\n\nHere's how to process the Set-Cookie header(s) on a node HTTP/HTTPS response:\n\n``` javascript\nif (res.headers['set-cookie'] instanceof Array)\n cookies = res.headers['set-cookie'].map(Cookie.parse);\nelse\n cookies = [Cookie.parse(res.headers['set-cookie'])];\n```\n\n_Note:_ in version 2.3.3, tough-cookie limited the number of spaces before the `=` to 256 characters. This limitation has since been removed.\nSee [Issue 92](https://github.com/salesforce/tough-cookie/issues/92)\n\n### Properties\n\nCookie object properties:\n\n * _key_ - string - the name or key of the cookie (default \"\")\n * _value_ - string - the value of the cookie (default \"\")\n * _expires_ - `Date` - if set, the `Expires=` attribute of the cookie (defaults to the string `\"Infinity\"`). See `setExpires()`\n * _maxAge_ - seconds - if set, the `Max-Age=` attribute _in seconds_ of the cookie. May also be set to strings `\"Infinity\"` and `\"-Infinity\"` for non-expiry and immediate-expiry, respectively. See `setMaxAge()`\n * _domain_ - string - the `Domain=` attribute of the cookie\n * _path_ - string - the `Path=` of the cookie\n * _secure_ - boolean - the `Secure` cookie flag\n * _httpOnly_ - boolean - the `HttpOnly` cookie flag\n * _extensions_ - `Array` - any unrecognized cookie attributes as strings (even if equal-signs inside)\n * _creation_ - `Date` - when this cookie was constructed\n * _creationIndex_ - number - set at construction, used to provide greater sort precision (please see `cookieCompare(a,b)` for a full explanation)\n\nAfter a cookie has been passed through `CookieJar.setCookie()` it will have the following additional attributes:\n\n * _hostOnly_ - boolean - is this a host-only cookie (i.e. no Domain field was set, but was instead implied)\n * _pathIsDefault_ - boolean - if true, there was no Path field on the cookie and `defaultPath()` was used to derive one.\n * _creation_ - `Date` - **modified** from construction to when the cookie was added to the jar\n * _lastAccessed_ - `Date` - last time the cookie got accessed. Will affect cookie cleaning once implemented. Using `cookiejar.getCookies(...)` will update this attribute.\n\n### `Cookie([{properties}])`\n\nReceives an options object that can contain any of the above Cookie properties, uses the default for unspecified properties.\n\n### `.toString()`\n\nencode to a Set-Cookie header value. The Expires cookie field is set using `formatDate()`, but is omitted entirely if `.expires` is `Infinity`.\n\n### `.cookieString()`\n\nencode to a Cookie header value (i.e. the `.key` and `.value` properties joined with '=').\n\n### `.setExpires(String)`\n\nsets the expiry based on a date-string passed through `parseDate()`. If parseDate returns `null` (i.e. can't parse this date string), `.expires` is set to `\"Infinity\"` (a string) is set.\n\n### `.setMaxAge(number)`\n\nsets the maxAge in seconds. Coerces `-Infinity` to `\"-Infinity\"` and `Infinity` to `\"Infinity\"` so it JSON serializes correctly.\n\n### `.expiryTime([now=Date.now()])`\n\n### `.expiryDate([now=Date.now()])`\n\nexpiryTime() Computes the absolute unix-epoch milliseconds that this cookie expires. expiryDate() works similarly, except it returns a `Date` object. Note that in both cases the `now` parameter should be milliseconds.\n\nMax-Age takes precedence over Expires (as per the RFC). The `.creation` attribute -- or, by default, the `now` parameter -- is used to offset the `.maxAge` attribute.\n\nIf Expires (`.expires`) is set, that's returned.\n\nOtherwise, `expiryTime()` returns `Infinity` and `expiryDate()` returns a `Date` object for \"Tue, 19 Jan 2038 03:14:07 GMT\" (latest date that can be expressed by a 32-bit `time_t`; the common limit for most user-agents).\n\n### `.TTL([now=Date.now()])`\n\ncompute the TTL relative to `now` (milliseconds). The same precedence rules as for `expiryTime`/`expiryDate` apply.\n\nThe \"number\" `Infinity` is returned for cookies without an explicit expiry and `0` is returned if the cookie is expired. Otherwise a time-to-live in milliseconds is returned.\n\n### `.canonicalizedDomain()`\n\n### `.cdomain()`\n\nreturn the canonicalized `.domain` field. This is lower-cased and punycode (RFC3490) encoded if the domain has any non-ASCII characters.\n\n### `.toJSON()`\n\nFor convenience in using `JSON.serialize(cookie)`. Returns a plain-old `Object` that can be JSON-serialized.\n\nAny `Date` properties (i.e., `.expires`, `.creation`, and `.lastAccessed`) are exported in ISO format (`.toISOString()`).\n\n**NOTE**: Custom `Cookie` properties will be discarded. In tough-cookie 1.x, since there was no `.toJSON` method explicitly defined, all enumerable properties were captured. If you want a property to be serialized, add the property name to the `Cookie.serializableProperties` Array.\n\n### `Cookie.fromJSON(strOrObj)`\n\nDoes the reverse of `cookie.toJSON()`. If passed a string, will `JSON.parse()` that first.\n\nAny `Date` properties (i.e., `.expires`, `.creation`, and `.lastAccessed`) are parsed via `Date.parse()`, not the tough-cookie `parseDate`, since it's JavaScript/JSON-y timestamps being handled at this layer.\n\nReturns `null` upon JSON parsing error.\n\n### `.clone()`\n\nDoes a deep clone of this cookie, exactly implemented as `Cookie.fromJSON(cookie.toJSON())`.\n\n### `.validate()`\n\nStatus: *IN PROGRESS*. Works for a few things, but is by no means comprehensive.\n\nvalidates cookie attributes for semantic correctness. Useful for \"lint\" checking any Set-Cookie headers you generate. For now, it returns a boolean, but eventually could return a reason string -- you can future-proof with this construct:\n\n``` javascript\nif (cookie.validate() === true) {\n // it's tasty\n} else {\n // yuck!\n}\n```\n\n## CookieJar\n\nExported via `tough.CookieJar`.\n\n### `CookieJar([store],[options])`\n\nSimply use `new CookieJar()`. If you'd like to use a custom store, pass that to the constructor otherwise a `MemoryCookieStore` will be created and used.\n\nThe `options` object can be omitted and can have the following properties:\n\n * _rejectPublicSuffixes_ - boolean - default `true` - reject cookies with domains like \"com\" and \"co.uk\"\n * _looseMode_ - boolean - default `false` - accept malformed cookies like `bar` and `=bar`, which have an implied empty name.\n This is not in the standard, but is used sometimes on the web and is accepted by (most) browsers.\n\nSince eventually this module would like to support database/remote/etc. CookieJars, continuation passing style is used for CookieJar methods.\n\n### `.setCookie(cookieOrString, currentUrl, [{options},] cb(err,cookie))`\n\nAttempt to set the cookie in the cookie jar. If the operation fails, an error will be given to the callback `cb`, otherwise the cookie is passed through. The cookie will have updated `.creation`, `.lastAccessed` and `.hostOnly` properties.\n\nThe `options` object can be omitted and can have the following properties:\n\n * _http_ - boolean - default `true` - indicates if this is an HTTP or non-HTTP API. Affects HttpOnly cookies.\n * _secure_ - boolean - autodetect from url - indicates if this is a \"Secure\" API. If the currentUrl starts with `https:` or `wss:` then this is defaulted to `true`, otherwise `false`.\n * _now_ - Date - default `new Date()` - what to use for the creation/access time of cookies\n * _ignoreError_ - boolean - default `false` - silently ignore things like parse errors and invalid domains. `Store` errors aren't ignored by this option.\n\nAs per the RFC, the `.hostOnly` property is set if there was no \"Domain=\" parameter in the cookie string (or `.domain` was null on the Cookie object). The `.domain` property is set to the fully-qualified hostname of `currentUrl` in this case. Matching this cookie requires an exact hostname match (not a `domainMatch` as per usual).\n\n### `.setCookieSync(cookieOrString, currentUrl, [{options}])`\n\nSynchronous version of `setCookie`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.getCookies(currentUrl, [{options},] cb(err,cookies))`\n\nRetrieve the list of cookies that can be sent in a Cookie header for the current url.\n\nIf an error is encountered, that's passed as `err` to the callback, otherwise an `Array` of `Cookie` objects is passed. The array is sorted with `cookieCompare()` unless the `{sort:false}` option is given.\n\nThe `options` object can be omitted and can have the following properties:\n\n * _http_ - boolean - default `true` - indicates if this is an HTTP or non-HTTP API. Affects HttpOnly cookies.\n * _secure_ - boolean - autodetect from url - indicates if this is a \"Secure\" API. If the currentUrl starts with `https:` or `wss:` then this is defaulted to `true`, otherwise `false`.\n * _now_ - Date - default `new Date()` - what to use for the creation/access time of cookies\n * _expire_ - boolean - default `true` - perform expiry-time checking of cookies and asynchronously remove expired cookies from the store. Using `false` will return expired cookies and **not** remove them from the store (which is useful for replaying Set-Cookie headers, potentially).\n * _allPaths_ - boolean - default `false` - if `true`, do not scope cookies by path. The default uses RFC-compliant path scoping. **Note**: may not be supported by the underlying store (the default `MemoryCookieStore` supports it).\n\nThe `.lastAccessed` property of the returned cookies will have been updated.\n\n### `.getCookiesSync(currentUrl, [{options}])`\n\nSynchronous version of `getCookies`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.getCookieString(...)`\n\nAccepts the same options as `.getCookies()` but passes a string suitable for a Cookie header rather than an array to the callback. Simply maps the `Cookie` array via `.cookieString()`.\n\n### `.getCookieStringSync(...)`\n\nSynchronous version of `getCookieString`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.getSetCookieStrings(...)`\n\nReturns an array of strings suitable for **Set-Cookie** headers. Accepts the same options as `.getCookies()`. Simply maps the cookie array via `.toString()`.\n\n### `.getSetCookieStringsSync(...)`\n\nSynchronous version of `getSetCookieStrings`; only works with synchronous stores (e.g. the default `MemoryCookieStore`).\n\n### `.serialize(cb(err,serializedObject))`\n\nSerialize the Jar if the underlying store supports `.getAllCookies`.\n\n**NOTE**: Custom `Cookie` properties will be discarded. If you want a property to be serialized, add the property name to the `Cookie.serializableProperties` Array.\n\nSee [Serialization Format].\n\n### `.serializeSync()`\n\nSync version of .serialize\n\n### `.toJSON()`\n\nAlias of .serializeSync() for the convenience of `JSON.stringify(cookiejar)`.\n\n### `CookieJar.deserialize(serialized, [store], cb(err,object))`\n\nA new Jar is created and the serialized Cookies are added to the underlying store. Each `Cookie` is added via `store.putCookie` in the order in which they appear in the serialization.\n\nThe `store` argument is optional, but should be an instance of `Store`. By default, a new instance of `MemoryCookieStore` is created.\n\nAs a convenience, if `serialized` is a string, it is passed through `JSON.parse` first. If that throws an error, this is passed to the callback.\n\n### `CookieJar.deserializeSync(serialized, [store])`\n\nSync version of `.deserialize`. _Note_ that the `store` must be synchronous for this to work.\n\n### `CookieJar.fromJSON(string)`\n\nAlias of `.deserializeSync` to provide consistency with `Cookie.fromJSON()`.\n\n### `.clone([store,]cb(err,newJar))`\n\nProduces a deep clone of this jar. Modifications to the original won't affect the clone, and vice versa.\n\nThe `store` argument is optional, but should be an instance of `Store`. By default, a new instance of `MemoryCookieStore` is created. Transferring between store types is supported so long as the source implements `.getAllCookies()` and the destination implements `.putCookie()`.\n\n### `.cloneSync([store])`\n\nSynchronous version of `.clone`, returning a new `CookieJar` instance.\n\nThe `store` argument is optional, but must be a _synchronous_ `Store` instance if specified. If not passed, a new instance of `MemoryCookieStore` is used.\n\nThe _source_ and _destination_ must both be synchronous `Store`s. If one or both stores are asynchronous, use `.clone` instead. Recall that `MemoryCookieStore` supports both synchronous and asynchronous API calls.\n\n### `.removeAllCookies(cb(err))`\n\nRemoves all cookies from the jar.\n\nThis is a new backwards-compatible feature of `tough-cookie` version 2.5, so not all Stores will implement it efficiently. For Stores that do not implement `removeAllCookies`, the fallback is to call `removeCookie` after `getAllCookies`. If `getAllCookies` fails or isn't implemented in the Store, that error is returned. If one or more of the `removeCookie` calls fail, only the first error is returned.\n\n### `.removeAllCookiesSync()`\n\nSync version of `.removeAllCookies()`\n\n## Store\n\nBase class for CookieJar stores. Available as `tough.Store`.\n\n## Store API\n\nThe storage model for each `CookieJar` instance can be replaced with a custom implementation. The default is `MemoryCookieStore` which can be found in the `lib/memstore.js` file. The API uses continuation-passing-style to allow for asynchronous stores.\n\nStores should inherit from the base `Store` class, which is available as `require('tough-cookie').Store`.\n\nStores are asynchronous by default, but if `store.synchronous` is set to `true`, then the `*Sync` methods on the of the containing `CookieJar` can be used (however, the continuation-passing style\n\nAll `domain` parameters will have been normalized before calling.\n\nThe Cookie store must have all of the following methods.\n\n### `store.findCookie(domain, path, key, cb(err,cookie))`\n\nRetrieve a cookie with the given domain, path and key (a.k.a. name). The RFC maintains that exactly one of these cookies should exist in a store. If the store is using versioning, this means that the latest/newest such cookie should be returned.\n\nCallback takes an error and the resulting `Cookie` object. If no cookie is found then `null` MUST be passed instead (i.e. not an error).\n\n### `store.findCookies(domain, path, cb(err,cookies))`\n\nLocates cookies matching the given domain and path. This is most often called in the context of `cookiejar.getCookies()` above.\n\nIf no cookies are found, the callback MUST be passed an empty array.\n\nThe resulting list will be checked for applicability to the current request according to the RFC (domain-match, path-match, http-only-flag, secure-flag, expiry, etc.), so it's OK to use an optimistic search algorithm when implementing this method. However, the search algorithm used SHOULD try to find cookies that `domainMatch()` the domain and `pathMatch()` the path in order to limit the amount of checking that needs to be done.\n\nAs of version 0.9.12, the `allPaths` option to `cookiejar.getCookies()` above will cause the path here to be `null`. If the path is `null`, path-matching MUST NOT be performed (i.e. domain-matching only).\n\n### `store.putCookie(cookie, cb(err))`\n\nAdds a new cookie to the store. The implementation SHOULD replace any existing cookie with the same `.domain`, `.path`, and `.key` properties -- depending on the nature of the implementation, it's possible that between the call to `fetchCookie` and `putCookie` that a duplicate `putCookie` can occur.\n\nThe `cookie` object MUST NOT be modified; the caller will have already updated the `.creation` and `.lastAccessed` properties.\n\nPass an error if the cookie cannot be stored.\n\n### `store.updateCookie(oldCookie, newCookie, cb(err))`\n\nUpdate an existing cookie. The implementation MUST update the `.value` for a cookie with the same `domain`, `.path` and `.key`. The implementation SHOULD check that the old value in the store is equivalent to `oldCookie` - how the conflict is resolved is up to the store.\n\nThe `.lastAccessed` property will always be different between the two objects (to the precision possible via JavaScript's clock). Both `.creation` and `.creationIndex` are guaranteed to be the same. Stores MAY ignore or defer the `.lastAccessed` change at the cost of affecting how cookies are selected for automatic deletion (e.g., least-recently-used, which is up to the store to implement).\n\nStores may wish to optimize changing the `.value` of the cookie in the store versus storing a new cookie. If the implementation doesn't define this method a stub that calls `putCookie(newCookie,cb)` will be added to the store object.\n\nThe `newCookie` and `oldCookie` objects MUST NOT be modified.\n\nPass an error if the newCookie cannot be stored.\n\n### `store.removeCookie(domain, path, key, cb(err))`\n\nRemove a cookie from the store (see notes on `findCookie` about the uniqueness constraint).\n\nThe implementation MUST NOT pass an error if the cookie doesn't exist; only pass an error due to the failure to remove an existing cookie.\n\n### `store.removeCookies(domain, path, cb(err))`\n\nRemoves matching cookies from the store. The `path` parameter is optional, and if missing means all paths in a domain should be removed.\n\nPass an error ONLY if removing any existing cookies failed.\n\n### `store.removeAllCookies(cb(err))`\n\n_Optional_. Removes all cookies from the store.\n\nPass an error if one or more cookies can't be removed.\n\n**Note**: New method as of `tough-cookie` version 2.5, so not all Stores will implement this, plus some stores may choose not to implement this.\n\n### `store.getAllCookies(cb(err, cookies))`\n\n_Optional_. Produces an `Array` of all cookies during `jar.serialize()`. The items in the array can be true `Cookie` objects or generic `Object`s with the [Serialization Format] data structure.\n\nCookies SHOULD be returned in creation order to preserve sorting via `compareCookies()`. For reference, `MemoryCookieStore` will sort by `.creationIndex` since it uses true `Cookie` objects internally. If you don't return the cookies in creation order, they'll still be sorted by creation time, but this only has a precision of 1ms. See `compareCookies` for more detail.\n\nPass an error if retrieval fails.\n\n**Note**: not all Stores can implement this due to technical limitations, so it is optional.\n\n## MemoryCookieStore\n\nInherits from `Store`.\n\nA just-in-memory CookieJar synchronous store implementation, used by default. Despite being a synchronous implementation, it's usable with both the synchronous and asynchronous forms of the `CookieJar` API. Supports serialization, `getAllCookies`, and `removeAllCookies`.\n\n## Community Cookie Stores\n\nThese are some Store implementations authored and maintained by the community. They aren't official and we don't vouch for them but you may be interested to have a look:\n\n- [`db-cookie-store`](https://github.com/JSBizon/db-cookie-store): SQL including SQLite-based databases\n- [`file-cookie-store`](https://github.com/JSBizon/file-cookie-store): Netscape cookie file format on disk\n- [`redis-cookie-store`](https://github.com/benkroeger/redis-cookie-store): Redis\n- [`tough-cookie-filestore`](https://github.com/mitsuru/tough-cookie-filestore): JSON on disk\n- [`tough-cookie-web-storage-store`](https://github.com/exponentjs/tough-cookie-web-storage-store): DOM localStorage and sessionStorage\n\n# Serialization Format\n\n**NOTE**: if you want to have custom `Cookie` properties serialized, add the property name to `Cookie.serializableProperties`.\n\n```js\n {\n // The version of tough-cookie that serialized this jar.\n version: 'tough-cookie@1.x.y',\n\n // add the store type, to make humans happy:\n storeType: 'MemoryCookieStore',\n\n // CookieJar configuration:\n rejectPublicSuffixes: true,\n // ... future items go here\n\n // Gets filled from jar.store.getAllCookies():\n cookies: [\n {\n key: 'string',\n value: 'string',\n // ...\n /* other Cookie.serializableProperties go here */\n }\n ]\n }\n```\n\n# Copyright and License\n\nBSD-3-Clause:\n\n```text\n Copyright (c) 2015, Salesforce.com, Inc.\n All rights reserved.\n\n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n\n 1. Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n 3. Neither the name of Salesforce.com nor the names of its contributors may\n be used to endorse or promote products derived from this software without\n specific prior written permission.\n\n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\n ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE\n LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\n CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\n SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\n INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\n CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\n POSSIBILITY OF SUCH DAMAGE.\n```\n# unicode-trie\nA data structure for fast Unicode character metadata lookup, ported from ICU\n\n## Background\n\nWhen implementing many Unicode algorithms such as text segmentation,\nnormalization, bidi processing, etc., fast access to character metadata\nis crucial to good performance. There over a million code points in the\nUnicode standard, many of which produce the same result when looked up,\nso an array or hash table is not appropriate - those data structures are\nfast but would require a lot of memory. The data is generally\ngrouped in ranges, so you could do a binary search, but that is not\nfast enough for some applications.\n\nThe [International Components for Unicode](http://site.icu-project.org) (ICU) project\ncame up with a data structure based on a [Trie](http://en.wikipedia.org/wiki/Trie) that provides fast access\nto Unicode metadata. The range data is precompiled to a serialized\nand flattened trie, which is then used at runtime to lookup the necessary\ndata. According to my own tests, this is generally at least 50% faster\nthan binary search, with not too much additional memory required.\n\n## Installation\n\n npm install unicode-trie\n\n## Building a Trie\n\nUnicode Tries are generally precompiled from data in the Unicode database\nfor faster runtime performance. To build a Unicode Trie, use the\n`UnicodeTrieBuilder` class.\n\n```coffeescript\nUnicodeTrieBuilder = require 'unicode-trie/builder'\n\n# create a trie\nt = new UnicodeTrieBuilder\n\n# optional parameters for default value, and error value\n# if not provided, both are set to 0\nt = new UnicodeTrieBuilder 10, 999\n\n# set individual values and ranges\nt.set 0x4567, 99\nt.setRange 0x40, 0xe7, 0x1234\n\n# you can lookup a value if you like\nt.get 0x4567 # => 99\n\n# get a compiled trie (returns a UnicodeTrie object)\ntrie = t.freeze()\n\n# write compressed trie to a binary file\nfs.writeFile 'data.trie', t.toBuffer()\n```\n\n## Using a precompiled Trie\n\nOnce you've built a precompiled trie, you can load it into the\n`UnicodeTrie` class, which is a readonly representation of the\ntrie. From there, you can lookup values.\n\n```coffeescript\nUnicodeTrie = require 'unicode-trie'\nfs = require 'fs'\n\n# load serialized trie from binary file\ndata = fs.readFileSync 'data.trie'\ntrie = new UnicodeTrie data\n\n# lookup a value\ntrie.get 0x4567 # => 99\n```\n\n## License\n\nMIT\n# cosmiconfig\n\n[](https://travis-ci.org/davidtheclark/cosmiconfig) [](https://ci.appveyor.com/project/davidtheclark/cosmiconfig/branch/master)\n[](https://codecov.io/gh/davidtheclark/cosmiconfig)\n\nCosmiconfig searches for and loads configuration for your program.\n\nIt features smart defaults based on conventional expectations in the JavaScript ecosystem.\nBut it's also flexible enough to search wherever you'd like to search, and load whatever you'd like to load.\n\nBy default, Cosmiconfig will start where you tell it to start and search up the directory tree for the following:\n\n- a `package.json` property\n- a JSON or YAML, extensionless \"rc file\"\n- an \"rc file\" with the extensions `.json`, `.yaml`, `.yml`, or `.js`.\n- a `.config.js` CommonJS module\n\nFor example, if your module's name is \"soursocks\", cosmiconfig will search up the directory tree for configuration in the following places:\n\n- a `soursocks` property in `package.json`\n- a `.soursocksrc` file in JSON or YAML format\n- a `.soursocksrc.json` file\n- a `.soursocksrc.yaml`, `.soursocksrc.yml`, or `.soursocksrc.js` file\n- a `soursocks.config.js` file exporting a JS object\n\nCosmiconfig continues to search up the directory tree, checking each of these places in each directory, until it finds some acceptable configuration (or hits the home directory).\n\n👀 **Looking for the v4 docs?**\nv5 involves significant revisions to Cosmiconfig's API, allowing for much greater flexibility and clarifying some things.\nIf you have trouble switching from v4 to v5, please file an issue.\nIf you are still using v4, those v4 docs are available [in the `4.0.0` tag](https://github.com/davidtheclark/cosmiconfig/tree/4.0.0).\n\n## Table of contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Result](#result)\n- [cosmiconfig()](#cosmiconfig-1)\n - [moduleName](#modulename)\n- [explorer.search()](#explorersearch)\n - [searchFrom](#searchfrom)\n- [explorer.searchSync()](#explorersearchsync)\n- [explorer.load()](#explorerload)\n- [explorer.loadSync()](#explorerloadsync)\n- [explorer.clearLoadCache()](#explorerclearloadcache)\n- [explorer.clearSearchCache()](#explorerclearsearchcache)\n- [explorer.clearCaches()](#explorerclearcaches)\n- [cosmiconfigOptions](#cosmiconfigoptions)\n - [searchPlaces](#searchplaces)\n - [loaders](#loaders)\n - [packageProp](#packageprop)\n - [stopDir](#stopdir)\n - [cache](#cache)\n - [transform](#transform)\n - [ignoreEmptySearchPlaces](#ignoreemptysearchplaces)\n- [Caching](#caching)\n- [Differences from rc](#differences-from-rc)\n- [Contributing & Development](#contributing--development)\n\n## Installation\n\n```\nnpm install cosmiconfig\n```\n\nTested in Node 4+.\n\n## Usage\n\nCreate a Cosmiconfig explorer, then either `search` for or directly `load` a configuration file.\n\n```js\nconst cosmiconfig = require('cosmiconfig');\n// ...\nconst explorer = cosmiconfig(moduleName);\n\n// Search for a configuration by walking up directories.\n// See documentation for search, below.\nexplorer.search()\n .then((result) => {\n // result.config is the parsed configuration object.\n // result.filepath is the path to the config file that was found.\n // result.isEmpty is true if there was nothing to parse in the config file.\n })\n .catch((error) => {\n // Do something constructive.\n });\n\n// Load a configuration directly when you know where it should be.\n// The result object is the same as for search.\n// See documentation for load, below.\nexplorer.load(pathToConfig).then(..);\n\n// You can also search and load synchronously.\nconst searchedFor = explorer.searchSync();\nconst loaded = explorer.loadSync(pathToConfig);\n```\n\n## Result\n\nThe result object you get from `search` or `load` has the following properties:\n\n- **config:** The parsed configuration object. `undefined` if the file is empty.\n- **filepath:** The path to the configuration file that was found.\n- **isEmpty:** `true` if the configuration file is empty. This property will not be present if the configuration file is not empty.\n\n## cosmiconfig()\n\n```js\nconst explorer = cosmiconfig(moduleName[, cosmiconfigOptions])\n```\n\nCreates a cosmiconfig instance (\"explorer\") configured according to the arguments, and initializes its caches.\n\n### moduleName\n\nType: `string`. **Required.**\n\nYour module name. This is used to create the default [`searchPlaces`] and [`packageProp`].\n\n**[`cosmiconfigOptions`] are documented below.**\nYou may not need them, and should first read about the functions you'll use.\n\n## explorer.search()\n\n```js\nexplorer.search([searchFrom]).then(result => {..})\n```\n\nSearches for a configuration file. Returns a Promise that resolves with a [result] or with `null`, if no configuration file is found.\n\nYou can do the same thing synchronously with [`searchSync()`].\n\nLet's say your module name is `goldengrahams` so you initialized with `const explorer = cosmiconfig('goldengrahams');`.\nHere's how your default [`search()`] will work:\n\n- Starting from `process.cwd()` (or some other directory defined by the `searchFrom` argument to [`search()`]), look for configuration objects in the following places:\n 1. A `goldengrahams` property in a `package.json` file.\n 2. A `.goldengrahamsrc` file with JSON or YAML syntax.\n 3. A `.goldengrahamsrc.json` file.\n 4. A `.goldengrahamsrc.yaml`, `.goldengrahamsrc.yml`, or `.goldengrahamsrc.js` file.\n 5. A `goldengrahams.config.js` JS file exporting the object.\n- If none of those searches reveal a configuration object, move up one directory level and try again.\n So the search continues in `./`, `../`, `../../`, `../../../`, etc., checking the same places in each directory.\n- Continue searching until arriving at your home directory (or some other directory defined by the cosmiconfig option [`stopDir`]).\n- If at any point a parseable configuration is found, the [`search()`] Promise resolves with its [result] \\(or, with [`searchSync()`], the [result] is returned).\n- If no configuration object is found, the [`search()`] Promise resolves with `null` (or, with [`searchSync()`], `null` is returned).\n- If a configuration object is found *but is malformed* (causing a parsing error), the [`search()`] Promise rejects with that error (so you should `.catch()` it). (Or, with [`searchSync()`], the error is thrown.)\n\n**If you know exactly where your configuration file should be, you can use [`load()`], instead.**\n\n**The search process is highly customizable.**\nUse the cosmiconfig options [`searchPlaces`] and [`loaders`] to precisely define where you want to look for configurations and how you want to load them.\n\n### searchFrom\n\nType: `string`.\nDefault: `process.cwd()`.\n\nA filename.\n[`search()`] will start its search here.\n\nIf the value is a directory, that's where the search starts.\nIf it's a file, the search starts in that file's directory.\n\n## explorer.searchSync()\n\n```js\nconst result = explorer.searchSync([searchFrom]);\n```\n\nSynchronous version of [`search()`].\n\nReturns a [result] or `null`.\n\n## explorer.load()\n\n```js\nexplorer.load(loadPath).then(result => {..})\n```\n\nLoads a configuration file. Returns a Promise that resolves with a [result] or rejects with an error (if the file does not exist or cannot be loaded).\n\nUse `load` if you already know where the configuration file is and you just need to load it.\n\n```js\nexplorer.load('load/this/file.json'); // Tries to load load/this/file.json.\n```\n\nIf you load a `package.json` file, the result will be derived from whatever property is specified as your [`packageProp`].\n\n## explorer.loadSync()\n\n```js\nconst result = explorer.loadSync(loadPath);\n```\n\nSynchronous version of [`load()`].\n\nReturns a [result].\n\n## explorer.clearLoadCache()\n\nClears the cache used in [`load()`].\n\n## explorer.clearSearchCache()\n\nClears the cache used in [`search()`].\n\n## explorer.clearCaches()\n\nPerforms both [`clearLoadCache()`] and [`clearSearchCache()`].\n\n## cosmiconfigOptions\n\nType: `Object`.\n\nPossible options are documented below.\n\n### searchPlaces\n\nType: `Array<string>`.\nDefault: See below.\n\nAn array of places that [`search()`] will check in each directory as it moves up the directory tree.\nEach place is relative to the directory being searched, and the places are checked in the specified order.\n\n**Default `searchPlaces`:**\n\n```js\n[\n 'package.json',\n `.${moduleName}rc`,\n `.${moduleName}rc.json`,\n `.${moduleName}rc.yaml`,\n `.${moduleName}rc.yml`,\n `.${moduleName}rc.js`,\n `${moduleName}.config.js`,\n]\n```\n\nCreate your own array to search more, fewer, or altogether different places.\n\nEvery item in `searchPlaces` needs to have a loader in [`loaders`] that corresponds to its extension.\n(Common extensions are covered by default loaders.)\nRead more about [`loaders`] below.\n\n`package.json` is a special value: When it is included in `searchPlaces`, Cosmiconfig will always parse it as JSON and load a property within it, not the whole file.\nThat property is defined with the [`packageProp`] option, and defaults to your module name.\n\nExamples, with a module named `porgy`:\n\n```js\n// Disallow extensions on rc files:\n[\n 'package.json',\n '.porgyrc',\n 'porgy.config.js'\n]\n\n// ESLint searches for configuration in these places:\n[\n '.eslintrc.js',\n '.eslintrc.yaml',\n '.eslintrc.yml',\n '.eslintrc.json',\n '.eslintrc',\n 'package.json'\n]\n\n// Babel looks in fewer places:\n[\n 'package.json',\n '.babelrc'\n]\n\n// Maybe you want to look for a wide variety of JS flavors:\n[\n 'porgy.config.js',\n 'porgy.config.mjs',\n 'porgy.config.ts',\n 'porgy.config.coffee'\n]\n// ^^ You will need to designate custom loaders to tell\n// Cosmiconfig how to handle these special JS flavors.\n\n// Look within a .config/ subdirectory of every searched directory:\n[\n 'package.json',\n '.porgyrc',\n '.config/.porgyrc',\n '.porgyrc.json',\n '.config/.porgyrc.json'\n]\n```\n\n### loaders\n\nType: `Object`.\nDefault: See below.\n\nAn object that maps extensions to the loader functions responsible for loading and parsing files with those extensions.\n\nCosmiconfig exposes its default loaders for `.js`, `.json`, and `.yaml` as `cosmiconfig.loadJs`, `cosmiconfig.loadJson`, and `cosmiconfig.loadYaml`, respectively.\n\n**Default `loaders`:**\n\n```js\n{\n '.json': cosmiconfig.loadJson,\n '.yaml': cosmiconfig.loadYaml,\n '.yml': cosmiconfig.loadYaml,\n '.js': cosmiconfig.loadJs,\n noExt: cosmiconfig.loadYaml\n}\n```\n\n(YAML is a superset of JSON; which means YAML parsers can parse JSON; which is how extensionless files can be either YAML *or* JSON with only one parser.)\n\n**If you provide a `loaders` object, your object will be *merged* with the defaults.**\nSo you can override one or two without having to override them all.\n\n**Keys in `loaders`** are extensions (starting with a period), or `noExt` to specify the loader for files *without* extensions, like `.soursocksrc`.\n\n**Values in `loaders`** are either a loader function (described below) or an object with `sync` and/or `async` properties, whose values are loader functions.\n\n**The most common use case for custom loaders value is to load extensionless `rc` files as strict JSON**, instead of JSON *or* YAML (the default).\nTo accomplish that, provide the following `loaders` value:\n\n```js\n{\n noExt: cosmiconfig.loadJson\n}\n```\n\nIf you want to load files that are not handled by the loader functions Cosmiconfig exposes, you can write a custom loader function or use one from NPM if it exists.\n\n**Third-party loaders:**\n\n- [@endemolshinegroup/cosmiconfig-typescript-loader](https://github.com/EndemolShineGroup/cosmiconfig-typescript-loader)\n\n**Use cases for custom loader function:**\n\n- Allow configuration syntaxes that aren't handled by Cosmiconfig's defaults, like JSON5, INI, or XML.\n- Allow ES2015 modules from `.mjs` configuration files.\n- Parse JS files with Babel before deriving the configuration.\n\n**Custom loader functions** have the following signature:\n\n```js\n// Sync\n(filepath: string, content: string) => Object | null\n\n// Async\n(filepath: string, content: string) => Object | null | Promise<Object | null>\n```\n\nCosmiconfig reads the file when it checks whether the file exists, so it will provide you with both the file's path and its content.\nDo whatever you need to, and return either a configuration object or `null` (or, for async-only loaders, a Promise that resolves with one of those).\n`null` indicates that no real configuration was found and the search should continue.\n\nIt's easiest if you make your custom loader function synchronous.\nThen it can be used regardless of whether you end up calling [`search()`] or [`searchSync()`], [`load()`] or [`loadSync()`].\nIf you want or need to provide an async-only loader, you can do so by making the value of `loaders` an object with an `async` property whose value is the async loader.\nYou can also add a `sync` property to designate a sync loader, if you want to use both async and sync search and load functions.\n\nA few things to note:\n\n- If you use a custom loader, be aware of whether it's sync or async and how that aligned with your usage of sync or async search and load functions.\n- **Special JS syntax can also be handled by using a `require` hook**, because `cosmiconfig.loadJs` just uses `require`.\n Whether you use custom loaders or a `require` hook is up to you.\n\nExamples:\n\n```js\n// Allow JSON5 syntax:\n{\n '.json': json5Loader\n}\n\n// Allow XML, and treat sync and async separately:\n{\n '.xml': { async: asyncXmlLoader, sync: syncXmlLoader }\n}\n\n// Allow a special configuration syntax of your own creation:\n{\n '.special': specialLoader\n}\n\n// Allow many flavors of JS, using custom loaders:\n{\n '.mjs': esmLoader,\n '.ts': typeScriptLoader,\n '.coffee': coffeeScriptLoader\n}\n\n// Allow many flavors of JS but rely on require hooks:\n{\n '.mjs': cosmiconfig.loadJs,\n '.ts': cosmiconfig.loadJs,\n '.coffee': cosmiconfig.loadJs\n}\n```\n\n### packageProp\n\nType: `string | Array<string>`.\nDefault: `` `${moduleName}` ``.\n\nName of the property in `package.json` to look for.\n\nUse a period-delimited string or an array of strings to describe a path to nested properties.\n\nFor example, the value `'configs.myPackage'` or `['configs', 'myPackage']` will get you the `\"myPackage\"` value in a `package.json` like this:\n\n```json\n{\n \"configs\": {\n \"myPackage\": {..}\n }\n}\n```\n\nIf nested property names within the path include periods, you need to use an array of strings. For example, the value `['configs', 'foo.bar', 'baz']` will get you the `\"baz\"` value in a `package.json` like this:\n\n```json\n{\n \"configs\": {\n \"foo.bar\": {\n \"baz\": {..}\n }\n }\n}\n```\n\nIf a string includes period but corresponds to a top-level property name, it will not be interpreted as a period-delimited path. For example, the value `'one.two'` will get you the `\"three\"` value in a `package.json` like this:\n\n```json\n{\n \"one.two\": \"three\",\n \"one\": {\n \"two\": \"four\"\n }\n}\n```\n\n### stopDir\n\nType: `string`.\nDefault: Absolute path to your home directory.\n\nDirectory where the search will stop.\n\n### cache\n\nType: `boolean`.\nDefault: `true`.\n\nIf `false`, no caches will be used.\nRead more about [\"Caching\"](#caching) below.\n\n### transform\n\nType: `(Result) => Promise<Result> | Result`.\n\nA function that transforms the parsed configuration. Receives the [result].\n\nIf using [`search()`] or [`load()`] \\(which are async), the transform function can return the transformed result or return a Promise that resolves with the transformed result.\nIf using [`searchSync()`] or [`loadSync()`], the function must be synchronous and return the transformed result.\n\nThe reason you might use this option — instead of simply applying your transform function some other way — is that *the transformed result will be cached*. If your transformation involves additional filesystem I/O or other potentially slow processing, you can use this option to avoid repeating those steps every time a given configuration is searched or loaded.\n\n### ignoreEmptySearchPlaces\n\nType: `boolean`.\nDefault: `true`.\n\nBy default, if [`search()`] encounters an empty file (containing nothing but whitespace) in one of the [`searchPlaces`], it will ignore the empty file and move on.\nIf you'd like to load empty configuration files, instead, set this option to `false`.\n\nWhy might you want to load empty configuration files?\nIf you want to throw an error, or if an empty configuration file means something to your program.\n\n## Caching\n\nAs of v2, cosmiconfig uses caching to reduce the need for repetitious reading of the filesystem or expensive transforms. Every new cosmiconfig instance (created with `cosmiconfig()`) has its own caches.\n\nTo avoid or work around caching, you can do the following:\n\n- Set the `cosmiconfig` option [`cache`] to `false`.\n- Use the cache-clearing methods [`clearLoadCache()`], [`clearSearchCache()`], and [`clearCaches()`].\n- Create separate instances of cosmiconfig (separate \"explorers\").\n\n## Differences from [rc](https://github.com/dominictarr/rc)\n\n[rc](https://github.com/dominictarr/rc) serves its focused purpose well. cosmiconfig differs in a few key ways — making it more useful for some projects, less useful for others:\n\n- Looks for configuration in some different places: in a `package.json` property, an rc file, a `.config.js` file, and rc files with extensions.\n- Built-in support for JSON, YAML, and CommonJS formats.\n- Stops at the first configuration found, instead of finding all that can be found up the directory tree and merging them automatically.\n- Options.\n- Asynchronous by default (though can be run synchronously).\n\n## Contributing & Development\n\nPlease note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.\n\nAnd please do participate!\n\n[result]: #result\n\n[`load()`]: #explorerload\n\n[`loadsync()`]: #explorerloadsync\n\n[`search()`]: #explorersearch\n\n[`searchsync()`]: #explorersearchsync\n\n[`clearloadcache()`]: #explorerclearloadcache\n\n[`clearsearchcache()`]: #explorerclearsearchcache\n\n[`clearcaches()`]: #explorerclearcaches\n\n[`packageprop`]: #packageprop\n\n[`cache`]: #cache\n\n[`stopdir`]: #stopdir\n\n[`searchplaces`]: #searchplaces\n\n[`loaders`]: #loaders\n\n[`cosmiconfigoptions`]: #cosmiconfigoptions\n# rgb-regex\n\n[](https://travis-ci.org/regexps/rgb-regex)\n\nRegex for RGB color strings.\n\n## Installation\n\n```bash\nnpm install --save rgb-regex\n```\n\n## Usage\n\n```javascript\nvar rgbRegex = require('rgb-regex');\n\nrgbRegex({ exact: true }).test('rgb(12, 34, 56)'); // => true\nrgbRegex({ exact: true }).test('unicorns'); // -> false\nrgbRegex({ exact: true }).test('rgb(,,)'); // => false\n\nrgbRegex().exec('rgb(12, 34, 56)');\n// => [\n// '12',\n// '34',\n// '56',\n// index: 0,\n// input: 'rgb(12,34,56)'\n// ]\n\n'rgb(12, 34, 56) cats and dogs'.match(rgbRegex());\n// = ['rgb(12, 34, 56)']\n```\n\n## License\n\nMIT\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\nCrafted with <3 by John Otander ([@4lpine](https://twitter.com/4lpine)).\n\n***\n\n> This package was initially generated with [yeoman](http://yeoman.io) and the [p generator](https://github.com/johnotander/generator-p.git).\n# kind-of [](https://www.npmjs.com/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://npmjs.org/package/kind-of) [](https://travis-ci.org/jonschlinkert/kind-of)\n\n> Get the native type of a value.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save kind-of\n```\n\nInstall with [bower](https://bower.io/)\n\n```sh\n$ bower install kind-of --save\n```\n\n## Why use this?\n\n1. [it's fast](#benchmarks) | [optimizations](#optimizations)\n2. [better type checking](#better-type-checking)\n\n## Usage\n\n> es5, es6, and browser ready\n\n```js\nvar kindOf = require('kind-of');\n\nkindOf(undefined);\n//=> 'undefined'\n\nkindOf(null);\n//=> 'null'\n\nkindOf(true);\n//=> 'boolean'\n\nkindOf(false);\n//=> 'boolean'\n\nkindOf(new Buffer(''));\n//=> 'buffer'\n\nkindOf(42);\n//=> 'number'\n\nkindOf('str');\n//=> 'string'\n\nkindOf(arguments);\n//=> 'arguments'\n\nkindOf({});\n//=> 'object'\n\nkindOf(Object.create(null));\n//=> 'object'\n\nkindOf(new Test());\n//=> 'object'\n\nkindOf(new Date());\n//=> 'date'\n\nkindOf([1, 2, 3]);\n//=> 'array'\n\nkindOf(/foo/);\n//=> 'regexp'\n\nkindOf(new RegExp('foo'));\n//=> 'regexp'\n\nkindOf(new Error('error'));\n//=> 'error'\n\nkindOf(function () {});\n//=> 'function'\n\nkindOf(function * () {});\n//=> 'generatorfunction'\n\nkindOf(Symbol('str'));\n//=> 'symbol'\n\nkindOf(new Map());\n//=> 'map'\n\nkindOf(new WeakMap());\n//=> 'weakmap'\n\nkindOf(new Set());\n//=> 'set'\n\nkindOf(new WeakSet());\n//=> 'weakset'\n\nkindOf(new Int8Array());\n//=> 'int8array'\n\nkindOf(new Uint8Array());\n//=> 'uint8array'\n\nkindOf(new Uint8ClampedArray());\n//=> 'uint8clampedarray'\n\nkindOf(new Int16Array());\n//=> 'int16array'\n\nkindOf(new Uint16Array());\n//=> 'uint16array'\n\nkindOf(new Int32Array());\n//=> 'int32array'\n\nkindOf(new Uint32Array());\n//=> 'uint32array'\n\nkindOf(new Float32Array());\n//=> 'float32array'\n\nkindOf(new Float64Array());\n//=> 'float64array'\n```\n\n## Benchmarks\n\nBenchmarked against [typeof](http://github.com/CodingFu/typeof) and [type-of](https://github.com/ForbesLindesay/type-of).\n\n```bash\n# arguments (32 bytes)\n kind-of x 17,024,098 ops/sec ±1.90% (86 runs sampled)\n lib-type-of x 11,926,235 ops/sec ±1.34% (83 runs sampled)\n lib-typeof x 9,245,257 ops/sec ±1.22% (87 runs sampled)\n\n fastest is kind-of (by 161% avg)\n\n# array (22 bytes)\n kind-of x 17,196,492 ops/sec ±1.07% (88 runs sampled)\n lib-type-of x 8,838,283 ops/sec ±1.02% (87 runs sampled)\n lib-typeof x 8,677,848 ops/sec ±0.87% (87 runs sampled)\n\n fastest is kind-of (by 196% avg)\n\n# boolean (24 bytes)\n kind-of x 16,841,600 ops/sec ±1.10% (86 runs sampled)\n lib-type-of x 8,096,787 ops/sec ±0.95% (87 runs sampled)\n lib-typeof x 8,423,345 ops/sec ±1.15% (86 runs sampled)\n\n fastest is kind-of (by 204% avg)\n\n# buffer (38 bytes)\n kind-of x 14,848,060 ops/sec ±1.05% (86 runs sampled)\n lib-type-of x 3,671,577 ops/sec ±1.49% (87 runs sampled)\n lib-typeof x 8,360,236 ops/sec ±1.24% (86 runs sampled)\n\n fastest is kind-of (by 247% avg)\n\n# date (30 bytes)\n kind-of x 16,067,761 ops/sec ±1.58% (86 runs sampled)\n lib-type-of x 8,954,436 ops/sec ±1.40% (87 runs sampled)\n lib-typeof x 8,488,307 ops/sec ±1.51% (84 runs sampled)\n\n fastest is kind-of (by 184% avg)\n\n# error (36 bytes)\n kind-of x 9,634,090 ops/sec ±1.12% (89 runs sampled)\n lib-type-of x 7,735,624 ops/sec ±1.32% (86 runs sampled)\n lib-typeof x 7,442,160 ops/sec ±1.11% (90 runs sampled)\n\n fastest is kind-of (by 127% avg)\n\n# function (34 bytes)\n kind-of x 10,031,494 ops/sec ±1.27% (86 runs sampled)\n lib-type-of x 9,502,757 ops/sec ±1.17% (89 runs sampled)\n lib-typeof x 8,278,985 ops/sec ±1.08% (88 runs sampled)\n\n fastest is kind-of (by 113% avg)\n\n# null (24 bytes)\n kind-of x 18,159,808 ops/sec ±1.92% (86 runs sampled)\n lib-type-of x 12,927,635 ops/sec ±1.01% (88 runs sampled)\n lib-typeof x 7,958,234 ops/sec ±1.21% (89 runs sampled)\n\n fastest is kind-of (by 174% avg)\n\n# number (22 bytes)\n kind-of x 17,846,779 ops/sec ±0.91% (85 runs sampled)\n lib-type-of x 3,316,636 ops/sec ±1.19% (86 runs sampled)\n lib-typeof x 2,329,477 ops/sec ±2.21% (85 runs sampled)\n\n fastest is kind-of (by 632% avg)\n\n# object-plain (47 bytes)\n kind-of x 7,085,155 ops/sec ±1.05% (88 runs sampled)\n lib-type-of x 8,870,930 ops/sec ±1.06% (83 runs sampled)\n lib-typeof x 8,716,024 ops/sec ±1.05% (87 runs sampled)\n\n fastest is lib-type-of (by 112% avg)\n\n# regex (25 bytes)\n kind-of x 14,196,052 ops/sec ±1.65% (84 runs sampled)\n lib-type-of x 9,554,164 ops/sec ±1.25% (88 runs sampled)\n lib-typeof x 8,359,691 ops/sec ±1.07% (87 runs sampled)\n\n fastest is kind-of (by 158% avg)\n\n# string (33 bytes)\n kind-of x 16,131,428 ops/sec ±1.41% (85 runs sampled)\n lib-type-of x 7,273,172 ops/sec ±1.05% (87 runs sampled)\n lib-typeof x 7,382,635 ops/sec ±1.17% (85 runs sampled)\n\n fastest is kind-of (by 220% avg)\n\n# symbol (34 bytes)\n kind-of x 17,011,537 ops/sec ±1.24% (86 runs sampled)\n lib-type-of x 3,492,454 ops/sec ±1.23% (89 runs sampled)\n lib-typeof x 7,471,235 ops/sec ±2.48% (87 runs sampled)\n\n fastest is kind-of (by 310% avg)\n\n# template-strings (36 bytes)\n kind-of x 15,434,250 ops/sec ±1.46% (83 runs sampled)\n lib-type-of x 7,157,907 ops/sec ±0.97% (87 runs sampled)\n lib-typeof x 7,517,986 ops/sec ±0.92% (86 runs sampled)\n\n fastest is kind-of (by 210% avg)\n\n# undefined (29 bytes)\n kind-of x 19,167,115 ops/sec ±1.71% (87 runs sampled)\n lib-type-of x 15,477,740 ops/sec ±1.63% (85 runs sampled)\n lib-typeof x 19,075,495 ops/sec ±1.17% (83 runs sampled)\n\n fastest is lib-typeof,kind-of\n\n```\n\n## Optimizations\n\nIn 7 out of 8 cases, this library is 2x-10x faster than other top libraries included in the benchmarks. There are a few things that lead to this performance advantage, none of them hard and fast rules, but all of them simple and repeatable in almost any code library:\n\n1. Optimize around the fastest and most common use cases first. Of course, this will change from project-to-project, but I took some time to understand how and why `typeof` checks were being used in my own libraries and other libraries I use a lot.\n2. Optimize around bottlenecks - In other words, the order in which conditionals are implemented is significant, because each check is only as fast as the failing checks that came before it. Here, the biggest bottleneck by far is checking for plain objects (an object that was created by the `Object` constructor). I opted to make this check happen by process of elimination rather than brute force up front (e.g. by using something like `val.constructor.name`), so that every other type check would not be penalized it.\n3. Don't do uneccessary processing - why do `.slice(8, -1).toLowerCase();` just to get the word `regex`? It's much faster to do `if (type === '[object RegExp]') return 'regex'`\n4. There is no reason to make the code in a microlib as terse as possible, just to win points for making it shorter. It's always better to favor performant code over terse code. You will always only be using a single `require()` statement to use the library anyway, regardless of how the code is written.\n\n## Better type checking\n\nkind-of seems to be more consistently \"correct\" than other type checking libs I've looked at. For example, here are some differing results from other popular libs:\n\n### [typeof](https://github.com/CodingFu/typeof) lib\n\nIncorrectly identifies instances of custom constructors (pretty common):\n\n```js\nvar typeOf = require('typeof');\nfunction Test() {}\nconsole.log(typeOf(new Test()));\n//=> 'test'\n```\n\nReturns `object` instead of `arguments`:\n\n```js\nfunction foo() {\n console.log(typeOf(arguments)) //=> 'object'\n}\nfoo();\n```\n\n### [type-of](https://github.com/ForbesLindesay/type-of) lib\n\nIncorrectly returns `object` for generator functions, buffers, `Map`, `Set`, `WeakMap` and `WeakSet`:\n\n```js\nfunction * foo() {}\nconsole.log(typeOf(foo));\n//=> 'object'\nconsole.log(typeOf(new Buffer('')));\n//=> 'object'\nconsole.log(typeOf(new Map()));\n//=> 'object'\nconsole.log(typeOf(new Set()));\n//=> 'object'\nconsole.log(typeOf(new WeakMap()));\n//=> 'object'\nconsole.log(typeOf(new WeakSet()));\n//=> 'object'\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/micromatch/is-glob) | [homepage](https://github.com/micromatch/is-glob \"Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet\")\n* [is-number](https://www.npmjs.com/package/is-number): Returns true if a number or string value is a finite number. Useful for regex… [more](https://github.com/jonschlinkert/is-number) | [homepage](https://github.com/jonschlinkert/is-number \"Returns true if a number or string value is a finite number. Useful for regex matches, parsing, user input, etc.\")\n* [is-primitive](https://www.npmjs.com/package/is-primitive): Returns `true` if the value is a primitive. | [homepage](https://github.com/jonschlinkert/is-primitive \"Returns `true` if the value is a primitive. \")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- | \n| 102 | [jonschlinkert](https://github.com/jonschlinkert) | \n| 3 | [aretecode](https://github.com/aretecode) | \n| 2 | [miguelmota](https://github.com/miguelmota) | \n| 1 | [doowb](https://github.com/doowb) | \n| 1 | [dtothefp](https://github.com/dtothefp) | \n| 1 | [ianstormtaylor](https://github.com/ianstormtaylor) | \n| 1 | [ksheedlo](https://github.com/ksheedlo) | \n| 1 | [pdehaan](https://github.com/pdehaan) | \n| 1 | [laggingreflex](https://github.com/laggingreflex) | \n| 1 | [tunnckoCore](https://github.com/tunnckoCore) | \n| 1 | [xiaofen9](https://github.com/xiaofen9) | \n\n### Author\n\n**Jon Schlinkert**\n\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n\n### License\n\nCopyright © 2020, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on January 16, 2020._\nLike `chown -R`.\n\nTakes the same arguments as `fs.chown()`\n# spdx-license-ids\n\n[](https://www.npmjs.com/package/spdx-license-ids)\n[](https://wdp9fww0r9.execute-api.us-west-2.amazonaws.com/production/results/shinnn/spdx-license-ids)\n\nA list of [SPDX license](https://spdx.org/licenses/) identifiers\n\n## Installation\n\n[Download JSON directly](https://raw.githubusercontent.com/shinnn/spdx-license-ids/master/index.json), or [use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/):\n\n```\nnpm install spdx-license-ids\n```\n\n## [Node.js](https://nodejs.org/) API\n\n### require('spdx-license-ids')\n\nType: `string[]`\n\nAll license IDs except for the currently deprecated ones.\n\n```javascript\nconst ids = require('spdx-license-ids');\n//=> ['0BSD', 'AAL', 'ADSL', 'AFL-1.1', 'AFL-1.2', 'AFL-2.0', 'AFL-2.1', 'AFL-3.0', 'AGPL-1.0-only', ...]\n\nids.includes('BSD-3-Clause'); //=> true\nids.includes('CC-BY-1.0'); //=> true\n\nids.includes('GPL-3.0'); //=> false\n```\n\n### require('spdx-license-ids/deprecated')\n\nType: `string[]`\n\nDeprecated license IDs.\n\n```javascript\nconst deprecatedIds = require('spdx-license-ids/deprecated');\n//=> ['AGPL-1.0', 'AGPL-3.0', 'GFDL-1.1', 'GFDL-1.2', 'GFDL-1.3', 'GPL-1.0', 'GPL-2.0', ...]\n\ndeprecatedIds.includes('BSD-3-Clause'); //=> false\ndeprecatedIds.includes('CC-BY-1.0'); //=> false\n\ndeprecatedIds.includes('GPL-3.0'); //=> true\n```\n\n## License\n\n[Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/deed)\n# EVP\\_BytesToKey\n[](https://www.npmjs.org/package/evp_bytestokey)\n[](https://travis-ci.org/crypto-browserify/EVP_BytesToKey)\n[](https://david-dm.org/crypto-browserify/EVP_BytesToKey#info=dependencies)\n\n[](https://github.com/feross/standard)\n\nThe insecure [key derivation algorithm from OpenSSL.][1]\n\n**WARNING: DO NOT USE, except for compatibility reasons.**\n\nMD5 is insecure.\n\nUse at least `scrypt` or `pbkdf2-hmac-sha256` instead.\n\n## API\n`EVP_BytesToKey(password, salt, keyLen, ivLen)`\n\n* `password` - `Buffer`, password used to derive the key data.\n* `salt` - 8 byte `Buffer` or `null`, salt is used as a salt in the derivation.\n* `keyBits` - `number`, key length in **bits**.\n* `ivLen` - `number`, iv length in bytes.\n\n*Returns*: `{ key: Buffer, iv: Buffer }`\n\n## Examples\nMD5 with `aes-256-cbc`:\n\n```js\nconst crypto = require('crypto')\nconst EVP_BytesToKey = require('evp_bytestokey')\n\nconst result = EVP_BytesToKey(\n 'my-secret-password',\n null,\n 32,\n 16\n)\n// =>\n// { key: <Buffer e3 4f 96 f3 86 24 82 7c c2 5d ff 23 18 6f 77 72 54 45 7f 49 d4 be 4b dd 4f 6e 1b cc 92 a4 27 33>,\n// iv: <Buffer 85 71 9a bf ae f4 1e 74 dd 46 b6 13 79 56 f5 5b> }\n\nconst cipher = crypto.createCipheriv('aes-256-cbc', result.key, result.iv)\n```\n\n## LICENSE [MIT](LICENSE)\n\n[1]: https://wiki.openssl.org/index.php/Manual:EVP_BytesToKey(3)\n[2]: https://nodejs.org/api/crypto.html#crypto_class_hash\n# Form-Data [](https://www.npmjs.com/package/form-data) [](https://gitter.im/form-data/form-data)\n\nA library to create readable ```\"multipart/form-data\"``` streams. Can be used to submit forms and file uploads to other web applications.\n\nThe API of this library is inspired by the [XMLHttpRequest-2 FormData Interface][xhr2-fd].\n\n[xhr2-fd]: http://dev.w3.org/2006/webapi/XMLHttpRequest-2/Overview.html#the-formdata-interface\n\n[](https://travis-ci.org/form-data/form-data)\n[](https://travis-ci.org/form-data/form-data)\n[](https://ci.appveyor.com/project/alexindigo/form-data)\n\n[](https://coveralls.io/github/form-data/form-data?branch=master)\n[](https://david-dm.org/form-data/form-data)\n[](https://www.bithound.io/github/form-data/form-data)\n\n## Install\n\n```\nnpm install --save form-data\n```\n\n## Usage\n\nIn this example we are constructing a form with 3 fields that contain a string,\na buffer and a file stream.\n\n``` javascript\nvar FormData = require('form-data');\nvar fs = require('fs');\n\nvar form = new FormData();\nform.append('my_field', 'my value');\nform.append('my_buffer', new Buffer(10));\nform.append('my_file', fs.createReadStream('/foo/bar.jpg'));\n```\n\nAlso you can use http-response stream:\n\n``` javascript\nvar FormData = require('form-data');\nvar http = require('http');\n\nvar form = new FormData();\n\nhttp.request('http://nodejs.org/images/logo.png', function(response) {\n form.append('my_field', 'my value');\n form.append('my_buffer', new Buffer(10));\n form.append('my_logo', response);\n});\n```\n\nOr @mikeal's [request](https://github.com/request/request) stream:\n\n``` javascript\nvar FormData = require('form-data');\nvar request = require('request');\n\nvar form = new FormData();\n\nform.append('my_field', 'my value');\nform.append('my_buffer', new Buffer(10));\nform.append('my_logo', request('http://nodejs.org/images/logo.png'));\n```\n\nIn order to submit this form to a web application, call ```submit(url, [callback])``` method:\n\n``` javascript\nform.submit('http://example.org/', function(err, res) {\n // res – response object (http.IncomingMessage) //\n res.resume();\n});\n\n```\n\nFor more advanced request manipulations ```submit()``` method returns ```http.ClientRequest``` object, or you can choose from one of the alternative submission methods.\n\n### Custom options\n\nYou can provide custom options, such as `maxDataSize`:\n\n``` javascript\nvar FormData = require('form-data');\n\nvar form = new FormData({ maxDataSize: 20971520 });\nform.append('my_field', 'my value');\nform.append('my_buffer', /* something big */);\n```\n\nList of available options could be found in [combined-stream](https://github.com/felixge/node-combined-stream/blob/master/lib/combined_stream.js#L7-L15)\n\n### Alternative submission methods\n\nYou can use node's http client interface:\n\n``` javascript\nvar http = require('http');\n\nvar request = http.request({\n method: 'post',\n host: 'example.org',\n path: '/upload',\n headers: form.getHeaders()\n});\n\nform.pipe(request);\n\nrequest.on('response', function(res) {\n console.log(res.statusCode);\n});\n```\n\nOr if you would prefer the `'Content-Length'` header to be set for you:\n\n``` javascript\nform.submit('example.org/upload', function(err, res) {\n console.log(res.statusCode);\n});\n```\n\nTo use custom headers and pre-known length in parts:\n\n``` javascript\nvar CRLF = '\\r\\n';\nvar form = new FormData();\n\nvar options = {\n header: CRLF + '--' + form.getBoundary() + CRLF + 'X-Custom-Header: 123' + CRLF + CRLF,\n knownLength: 1\n};\n\nform.append('my_buffer', buffer, options);\n\nform.submit('http://example.com/', function(err, res) {\n if (err) throw err;\n console.log('Done');\n});\n```\n\nForm-Data can recognize and fetch all the required information from common types of streams (```fs.readStream```, ```http.response``` and ```mikeal's request```), for some other types of streams you'd need to provide \"file\"-related information manually:\n\n``` javascript\nsomeModule.stream(function(err, stdout, stderr) {\n if (err) throw err;\n\n var form = new FormData();\n\n form.append('file', stdout, {\n filename: 'unicycle.jpg', // ... or:\n filepath: 'photos/toys/unicycle.jpg',\n contentType: 'image/jpeg',\n knownLength: 19806\n });\n\n form.submit('http://example.com/', function(err, res) {\n if (err) throw err;\n console.log('Done');\n });\n});\n```\n\nThe `filepath` property overrides `filename` and may contain a relative path. This is typically used when uploading [multiple files from a directory](https://wicg.github.io/entries-api/#dom-htmlinputelement-webkitdirectory).\n\nFor edge cases, like POST request to URL with query string or to pass HTTP auth credentials, object can be passed to `form.submit()` as first parameter:\n\n``` javascript\nform.submit({\n host: 'example.com',\n path: '/probably.php?extra=params',\n auth: 'username:password'\n}, function(err, res) {\n console.log(res.statusCode);\n});\n```\n\nIn case you need to also send custom HTTP headers with the POST request, you can use the `headers` key in first parameter of `form.submit()`:\n\n``` javascript\nform.submit({\n host: 'example.com',\n path: '/surelynot.php',\n headers: {'x-test-header': 'test-header-value'}\n}, function(err, res) {\n console.log(res.statusCode);\n});\n```\n\n### Integration with other libraries\n\n#### Request\n\nForm submission using [request](https://github.com/request/request):\n\n```javascript\nvar formData = {\n my_field: 'my_value',\n my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),\n};\n\nrequest.post({url:'http://service.com/upload', formData: formData}, function(err, httpResponse, body) {\n if (err) {\n return console.error('upload failed:', err);\n }\n console.log('Upload successful! Server responded with:', body);\n});\n```\n\nFor more details see [request readme](https://github.com/request/request#multipartform-data-multipart-form-uploads).\n\n#### node-fetch\n\nYou can also submit a form using [node-fetch](https://github.com/bitinn/node-fetch):\n\n```javascript\nvar form = new FormData();\n\nform.append('a', 1);\n\nfetch('http://example.com', { method: 'POST', body: form })\n .then(function(res) {\n return res.json();\n }).then(function(json) {\n console.log(json);\n });\n```\n\n## Notes\n\n- ```getLengthSync()``` method DOESN'T calculate length for streams, use ```knownLength``` options as workaround.\n- Starting version `2.x` FormData has dropped support for `node@0.10.x`.\n\n## License\n\nForm-Data is released under the [MIT](License) license.\n# mixin-deep [](https://www.npmjs.com/package/mixin-deep) [](https://npmjs.org/package/mixin-deep) [](https://npmjs.org/package/mixin-deep) [](https://travis-ci.org/jonschlinkert/mixin-deep)\n\n> Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save mixin-deep\n```\n\n## Usage\n\n```js\nvar mixinDeep = require('mixin-deep');\n\nmixinDeep({a: {aa: 'aa'}}, {a: {bb: 'bb'}}, {a: {cc: 'cc'}});\n//=> { a: { aa: 'aa', bb: 'bb', cc: 'cc' } }\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [defaults-deep](https://www.npmjs.com/package/defaults-deep): Like `extend` but recursively copies only the missing properties/values to the target object. | [homepage](https://github.com/jonschlinkert/defaults-deep \"Like `extend` but recursively copies only the missing properties/values to the target object.\")\n* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow \"Extend an object with the properties of additional objects. node.js/javascript util.\")\n* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep \"Recursively merge values in a javascript object.\")\n* [mixin-object](https://www.npmjs.com/package/mixin-object): Mixin the own and inherited properties of other objects onto the first object. Pass an… [more](https://github.com/jonschlinkert/mixin-object) | [homepage](https://github.com/jonschlinkert/mixin-object \"Mixin the own and inherited properties of other objects onto the first object. Pass an empty object as the first arg to shallow clone.\")\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on December 09, 2017._\n# json-stringify-safe\n\nLike JSON.stringify, but doesn't throw on circular references.\n\n## Usage\n\nTakes the same arguments as `JSON.stringify`.\n\n```javascript\nvar stringify = require('json-stringify-safe');\nvar circularObj = {};\ncircularObj.circularRef = circularObj;\ncircularObj.list = [ circularObj, circularObj ];\nconsole.log(stringify(circularObj, null, 2));\n```\n\nOutput:\n\n```json\n{\n \"circularRef\": \"[Circular]\",\n \"list\": [\n \"[Circular]\",\n \"[Circular]\"\n ]\n}\n```\n\n## Details\n\n```\nstringify(obj, serializer, indent, decycler)\n```\n\nThe first three arguments are the same as to JSON.stringify. The last\nis an argument that's only used when the object has been seen already.\n\nThe default `decycler` function returns the string `'[Circular]'`.\nIf, for example, you pass in `function(k,v){}` (return nothing) then it\nwill prune cycles. If you pass in `function(k,v){ return {foo: 'bar'}}`,\nthen cyclical objects will always be represented as `{\"foo\":\"bar\"}` in\nthe result.\n\n```\nstringify.getSerialize(serializer, decycler)\n```\n\nReturns a serializer that can be used elsewhere. This is the actual\nfunction that's passed to JSON.stringify.\n\n**Note** that the function returned from `getSerialize` is stateful for now, so\ndo **not** use it more than once.\n# lodash.clonedeep v4.5.0\n\nThe [lodash](https://lodash.com/) method `_.cloneDeep` exported as a [Node.js](https://nodejs.org/) module.\n\n## Installation\n\nUsing npm:\n```bash\n$ {sudo -H} npm i -g npm\n$ npm i --save lodash.clonedeep\n```\n\nIn Node.js:\n```js\nvar cloneDeep = require('lodash.clonedeep');\n```\n\nSee the [documentation](https://lodash.com/docs#cloneDeep) or [package source](https://github.com/lodash/lodash/blob/4.5.0-npm-packages/lodash.clonedeep) for more details.\n# htmlparser2\n\n[](https://npmjs.org/package/htmlparser2)\n[](https://npmjs.org/package/htmlparser2)\n[](http://travis-ci.org/fb55/htmlparser2)\n[](https://coveralls.io/r/fb55/htmlparser2)\n\nA forgiving HTML/XML/RSS parser. The parser can handle streams and provides a callback interface.\n\n## Installation\n\tnpm install htmlparser2\n\nA live demo of htmlparser2 is available [here](https://astexplorer.net/#/2AmVrGuGVJ).\n\n## Usage\n\n```javascript\nvar htmlparser = require(\"htmlparser2\");\nvar parser = new htmlparser.Parser({\n\tonopentag: function(name, attribs){\n\t\tif(name === \"script\" && attribs.type === \"text/javascript\"){\n\t\t\tconsole.log(\"JS! Hooray!\");\n\t\t}\n\t},\n\tontext: function(text){\n\t\tconsole.log(\"-->\", text);\n\t},\n\tonclosetag: function(tagname){\n\t\tif(tagname === \"script\"){\n\t\t\tconsole.log(\"That's it?!\");\n\t\t}\n\t}\n}, {decodeEntities: true});\nparser.write(\"Xyz <script type='text/javascript'>var foo = '<<bar>>';</ script>\");\nparser.end();\n```\n\nOutput (simplified):\n\n```\n--> Xyz\nJS! Hooray!\n--> var foo = '<<bar>>';\nThat's it?!\n```\n\n## Documentation\n\nRead more about the parser and its options in the [wiki](https://github.com/fb55/htmlparser2/wiki/Parser-options).\n\n## Get a DOM\nThe `DomHandler` (known as `DefaultHandler` in the original `htmlparser` module) produces a DOM (document object model) that can be manipulated using the [`DomUtils`](https://github.com/fb55/DomUtils) helper.\n\nThe `DomHandler`, while still bundled with this module, was moved to its [own module](https://github.com/fb55/domhandler). Have a look at it for further information.\n\n## Parsing RSS/RDF/Atom Feeds\n\n```javascript\nnew htmlparser.FeedHandler(function(<error> error, <object> feed){\n ...\n});\n```\n\nNote: While the provided feed handler works for most feeds, you might want to use [danmactough/node-feedparser](https://github.com/danmactough/node-feedparser), which is much better tested and actively maintained.\n\n## Performance\n\nAfter having some artificial benchmarks for some time, __@AndreasMadsen__ published his [`htmlparser-benchmark`](https://github.com/AndreasMadsen/htmlparser-benchmark), which benchmarks HTML parses based on real-world websites.\n\nAt the time of writing, the latest versions of all supported parsers show the following performance characteristics on [Travis CI](https://travis-ci.org/AndreasMadsen/htmlparser-benchmark/builds/10805007) (please note that Travis doesn't guarantee equal conditions for all tests):\n\n```\ngumbo-parser : 34.9208 ms/file ± 21.4238\nhtml-parser : 24.8224 ms/file ± 15.8703\nhtml5 : 419.597 ms/file ± 264.265\nhtmlparser : 60.0722 ms/file ± 384.844\nhtmlparser2-dom: 12.0749 ms/file ± 6.49474\nhtmlparser2 : 7.49130 ms/file ± 5.74368\nhubbub : 30.4980 ms/file ± 16.4682\nlibxmljs : 14.1338 ms/file ± 18.6541\nparse5 : 22.0439 ms/file ± 15.3743\nsax : 49.6513 ms/file ± 26.6032\n```\n\n## How does this module differ from [node-htmlparser](https://github.com/tautologistics/node-htmlparser)?\n\nThis is a fork of the `htmlparser` module. The main difference is that this is intended to be used only with node (it runs on other platforms using [browserify](https://github.com/substack/node-browserify)). `htmlparser2` was rewritten multiple times and, while it maintains an API that's compatible with `htmlparser` in most cases, the projects don't share any code anymore.\n\nThe parser now provides a callback interface close to [sax.js](https://github.com/isaacs/sax-js) (originally targeted at [readabilitySAX](https://github.com/fb55/readabilitysax)). As a result, old handlers won't work anymore.\n\nThe `DefaultHandler` and the `RssHandler` were renamed to clarify their purpose (to `DomHandler` and `FeedHandler`). The old names are still available when requiring `htmlparser2`, your code should work as expected.\n# w3c-hr-time\n\nThis module implements the W3C [High Resolution Time Level 2][HR-TIME] specification. It provides exactly three exports:\n\n- `Performance` class\n- `getGlobalMonotonicClockMS(): number`\n- `clockIsAccurate: boolean`\n\nIn all APIs, a \"high-resolution timestamp\" means a number in milliseconds that may have a fractional part, if the system clock is accurate enough (see \"Clock accuracy\" section below). It is identical to the [`DOMHighResTimeStamp`][] type in the High Resolution Time spec.\n\nPortability is paramount to this module. It uses only APIs exposed from Node.js core like `Date.now()` and `process.hrtime()` and does not use or require any native modules. It also employs the [browser-process-hrtime][] module for graceful degrades for platforms that do not have `process.hrtime()` (such as browsers).\n\n## `Performance` class\n\n```js\nconst { Performance } = require(\"w3c-hr-time\");\nconst performance = new Performance();\n\nconsole.log(performance.timeOrigin);\n// Prints a number close to Date.now() but that may have fractional parts, like\n// 1514888563819.351.\n\nconsole.log(new Date(performance.timeOrigin));\n// Prints a date close to new Date(), like 2018-01-02T10:22:43.819Z.\n\nsetTimeout(() => {\n console.log(performance.now());\n // Prints a number close to 5000, like 5008.023059.\n}, 5000);\n```\n\nPerhaps the most interesting export is the [`Performance`][] class. By constructing the class, you can get an instance quite similar to the `window.performance` object in browsers. Specifically, the following APIs are implemented:\n\n* [`performance.now(): number`][`Performance#now()`] returns the high-resolution duration since the construction of the `Performance` object.\n* [`performance.timeOrigin: number`][`Performance#timeOrigin`] is a high-resolution timestamp of the `Performance` object's construction, expressed in [Unix time][].\n* [`performance.toJSON(): object`][`Performance#toJSON()`] returns an object with `timeOrigin` property set to the corresponding value of this object. This allows serializing the `Performance` object with `JSON.stringify()`. In browsers, the returned object may contain additional properties such as `navigation` and `timing`. However, those properties are specific to browser navigation and are unsuitable for a Node.js implementation. Furthermore, they are specified not in the High Resolution Time spec but in [Navigation Timing][NAVIGATION-TIMING], and are thereby outside the scope of this module.\n\n### Limitations\n\nThis module does not aim for full [Web IDL][WEBIDL] conformance, so things like `performance.toJSON.call({})` will not throw `TypeError`s like it does in browsers. If you need full Web IDL conformance, you may be interested in the [webidl2js][] module.\n\nThe `Performance` class provided also does not have `mark()`, `measure()`, `getEntries()`, and such functions. They are specified in other specs than High Resolution Timing, such as [User Timing][USER-TIMING] (marks and measures) and [Performance Timeline][PERFORMANCE-TIMELINE] (entries management). Those specs extend the definition of the `Performance` class defined in High Resolution Timing, and to implement those specs you can extend the `Performance` class exported by this module.\n\nDue to the limitations of the APIs exposed through Node.js, the construction of a `Performance` object may take up to 1 millisecond to gather information for high-resolution `timeOrigin`.\n\n## Global monotonic clock\n\nThe High Resolution Time spec defines a [global monotonic clock][] that is \"shared by time origin's *[sic]*, is monotonically increasing and not subject to system clock adjustments or system clock skew, and whose reference point is the Unix time.\"\n\nThis module exports a function `getGlobalMonotonicClockMS()` that is the basis of all timing functions used my this module when a monotonic time is required. It returns a high-resolution timestamp whose zero value is at some arbitrary point in the past. (For the current high-resolution timestamp based on the Unix epoch, use `new Performance().timeOrigin` instead.)\n\n```js\nconst { getGlobalMonotonicClockMS } = require(\"w3c-hr-time\");\n\nconst start = getGlobalMonotonicClockMS();\nconsole.log(start);\n// Prints a millisecond timestamp based on an arbitrary point in the past, like\n// 280249733.012151.\n\nsetTimeout(() => {\n console.log(getGlobalMonotonicClockMS() - a);\n // Prints a number close to 5000, like 5006.156536.\n}, 5000);\n```\n\nUnlike other functions that return only integer timestamps if the system clock does not provide enough resolution, this function may still return timestamps with fractional parts on those systems with less accurate clocks. See \"Clock accuracy\" section below for more information.\n\n## Clock accuracy\n\nThe High Resolution Time spec [states][HR-TIME §4] that\n\n> A [`DOMHighResTimeStamp`][] *SHOULD* represent a time in milliseconds accurate to 5 microseconds - see [8. Privacy and Security][HR-TIME §8].\n>\n> If the User Agent is unable to provide a time value accurate to 5 microseconds due to hardware or software constraints, the User Agent can represent a [`DOMHighResTimeStamp`][] as a time in milliseconds accurate to a millisecond.\n\nThis module implements this suggestion faithfully. It executes a test at `require()`-time to determine if the system clock (both `Date.now()` and `process.hrtime()`) is accurate enough to 5 microseconds. The result of this test can be accessed through the exported `clockIsAccurate` boolean value.\n\n```js\nconst { Performance, clockIsAccurate } = require(\"w3c-hr-time\");\n\nconst performance = new Performance();\n\nif (!clockIsAccurate) {\n console.assert(Number.isInteger(performance.timeOrigin));\n console.assert(Number.isInteger(performance.now()));\n}\n```\n\nIf `clockIsAccurate` is false, `performance.timeOrigin` and `performance.now()` are always rounded to millisecond accuracy. `getGlobalMonotonicClockMS()` however is exempt from this requirement due to its best-effort nature, and the fact that it is not an API exposed by the High Resolution Time spec.\n\n## Clock drift\n\n[Clock drift][clock drift] can be observed through system or user clock adjustments -- that is, the speed at which `Date.now()` changes may be faster or slower than real time if there is a pending adjustment to the system clock, for example through NTP synchronizing.\n\nIn the spec, the [global monotonic clock][] is defined to be immune to such drifts. Correspondingly, the APIs exposed through this module that are defined using the global monotonic clock such as `performance.now()` and `getGlobalMonotonicClockMS()` are also guaranteed to reflect real time.\n\nFor example, if `performance.now()` returns 1000, it is guaranteed that the time of this call is exactly one second since the construction of the `Performance` object. But the difference in `Date.now()`'s value from the construction of the `Performance` object to when `performance.now()` returns 1000 may not be exactly 1000. You may also see `performance.now() - Date.now()` diverge over time as a result of clock drifts.\n\nOn the other hand, `performance.timeOrigin` returns the *[Unix time][]* at which the `Performance` object is constructed and relies on the current time exposed through `Date.now()`. That means that it is susceptible to clock drifts that has occurred before the `Performance` object was constructed.\n\n## Supporting w3c-hr-time\n\nThe jsdom project (including w3c-hr-time) is a community-driven project maintained by a team of [volunteers](https://github.com/orgs/jsdom/people). You could support us by:\n\n- [Getting professional support for w3c-hr-time](https://tidelift.com/subscription/pkg/npm-w3c-hr-time?utm_source=npm-w3c-hr-time&utm_medium=referral&utm_campaign=readme) as part of a Tidelift subscription. Tidelift helps making open source sustainable for us while giving teams assurances for maintenance, licensing, and security.\n- Contributing directly to the project.\n\n## License\n\nThis software is licensed under the MIT license. See LICENSE.md file for more detail.\n\n[HR-TIME]: https://w3c.github.io/hr-time/\n[NAVIGATION-TIMING]: https://w3c.github.io/navigation-timing/\n[PERFORMANCE-TIMELINE]: https://w3c.github.io/performance-timeline/\n[USER-TIMING]: https://w3c.github.io/user-timing/\n[WEBIDL]: https://heycam.github.io/webidl/\n\n[HR-TIME §4]: https://w3c.github.io/hr-time/#dom-domhighrestimestamp\n[HR-TIME §8]: https://w3c.github.io/hr-time/#privacy-security\n\n[`DOMHighResTimeStamp`]: https://w3c.github.io/hr-time/#dom-domhighrestimestamp\n[`Performance`]: https://w3c.github.io/hr-time/#dfn-performance\n[`Performance#now()`]: https://w3c.github.io/hr-time/#dom-performance-now\n[`Performance#timeOrigin`]: https://w3c.github.io/hr-time/#dom-performance-timeorigin\n[`Performance#toJSON()`]: https://w3c.github.io/hr-time/#dom-performance-tojson\n[browser-process-hrtime]: https://www.npmjs.com/package/browser-process-hrtime\n[clock drift]: https://en.wikipedia.org/wiki/Clock_drift\n[global monotonic clock]: https://w3c.github.io/hr-time/#dfn-global-monotonic-clock\n[Unix time]: https://en.wikipedia.org/wiki/Unix_time\n[webidl2js]: https://github.com/jsdom/webidl2js\nsemver(1) -- The semantic versioner for npm\n===========================================\n\n## Install\n\n```bash\nnpm install --save semver\n````\n\n## Usage\n\nAs a node module:\n\n```js\nconst semver = require('semver')\n\nsemver.valid('1.2.3') // '1.2.3'\nsemver.valid('a.b.c') // null\nsemver.clean(' =v1.2.3 ') // '1.2.3'\nsemver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true\nsemver.gt('1.2.3', '9.8.7') // false\nsemver.lt('1.2.3', '9.8.7') // true\nsemver.minVersion('>=1.0.0') // '1.0.0'\nsemver.valid(semver.coerce('v2')) // '2.0.0'\nsemver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'\n```\n\nAs a command-line utility:\n\n```\n$ semver -h\n\nA JavaScript implementation of the https://semver.org/ specification\nCopyright Isaac Z. Schlueter\n\nUsage: semver [options] <version> [<version> [...]]\nPrints valid versions sorted by SemVer precedence\n\nOptions:\n-r --range <range>\n Print versions that match the specified range.\n\n-i --increment [<level>]\n Increment a version by the specified level. Level can\n be one of: major, minor, patch, premajor, preminor,\n prepatch, or prerelease. Default level is 'patch'.\n Only one version may be specified.\n\n--preid <identifier>\n Identifier to be used to prefix premajor, preminor,\n prepatch or prerelease version increments.\n\n-l --loose\n Interpret versions and ranges loosely\n\n-p --include-prerelease\n Always include prerelease versions in range matching\n\n-c --coerce\n Coerce a string into SemVer if possible\n (does not imply --loose)\n\nProgram exits successfully if any valid version satisfies\nall supplied ranges, and prints all satisfying versions.\n\nIf no satisfying versions are found, then exits failure.\n\nVersions are printed in ascending order, so supplying\nmultiple versions to the utility will just sort them.\n```\n\n## Versions\n\nA \"version\" is described by the `v2.0.0` specification found at\n<https://semver.org/>.\n\nA leading `\"=\"` or `\"v\"` character is stripped off and ignored.\n\n## Ranges\n\nA `version range` is a set of `comparators` which specify versions\nthat satisfy the range.\n\nA `comparator` is composed of an `operator` and a `version`. The set\nof primitive `operators` is:\n\n* `<` Less than\n* `<=` Less than or equal to\n* `>` Greater than\n* `>=` Greater than or equal to\n* `=` Equal. If no operator is specified, then equality is assumed,\n so this operator is optional, but MAY be included.\n\nFor example, the comparator `>=1.2.7` would match the versions\n`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6`\nor `1.1.0`.\n\nComparators can be joined by whitespace to form a `comparator set`,\nwhich is satisfied by the **intersection** of all of the comparators\nit includes.\n\nA range is composed of one or more comparator sets, joined by `||`. A\nversion matches a range if and only if every comparator in at least\none of the `||`-separated comparator sets is satisfied by the version.\n\nFor example, the range `>=1.2.7 <1.3.0` would match the versions\n`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`,\nor `1.1.0`.\n\nThe range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`,\n`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`.\n\n### Prerelease Tags\n\nIf a version has a prerelease tag (for example, `1.2.3-alpha.3`) then\nit will only be allowed to satisfy comparator sets if at least one\ncomparator with the same `[major, minor, patch]` tuple also has a\nprerelease tag.\n\nFor example, the range `>1.2.3-alpha.3` would be allowed to match the\nversion `1.2.3-alpha.7`, but it would *not* be satisfied by\n`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically \"greater\nthan\" `1.2.3-alpha.3` according to the SemVer sort rules. The version\nrange only accepts prerelease tags on the `1.2.3` version. The\nversion `3.4.5` *would* satisfy the range, because it does not have a\nprerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`.\n\nThe purpose for this behavior is twofold. First, prerelease versions\nfrequently are updated very quickly, and contain many breaking changes\nthat are (by the author's design) not yet fit for public consumption.\nTherefore, by default, they are excluded from range matching\nsemantics.\n\nSecond, a user who has opted into using a prerelease version has\nclearly indicated the intent to use *that specific* set of\nalpha/beta/rc versions. By including a prerelease tag in the range,\nthe user is indicating that they are aware of the risk. However, it\nis still not appropriate to assume that they have opted into taking a\nsimilar risk on the *next* set of prerelease versions.\n\nNote that this behavior can be suppressed (treating all prerelease\nversions as if they were normal versions, for the purpose of range\nmatching) by setting the `includePrerelease` flag on the options\nobject to any\n[functions](https://github.com/npm/node-semver#functions) that do\nrange matching.\n\n#### Prerelease Identifiers\n\nThe method `.inc` takes an additional `identifier` string argument that\nwill append the value of the string as a prerelease identifier:\n\n```javascript\nsemver.inc('1.2.3', 'prerelease', 'beta')\n// '1.2.4-beta.0'\n```\n\ncommand-line example:\n\n```bash\n$ semver 1.2.3 -i prerelease --preid beta\n1.2.4-beta.0\n```\n\nWhich then can be used to increment further:\n\n```bash\n$ semver 1.2.4-beta.0 -i prerelease\n1.2.4-beta.1\n```\n\n### Advanced Range Syntax\n\nAdvanced range syntax desugars to primitive comparators in\ndeterministic ways.\n\nAdvanced ranges may be combined in the same way as primitive\ncomparators using white space or `||`.\n\n#### Hyphen Ranges `X.Y.Z - A.B.C`\n\nSpecifies an inclusive set.\n\n* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4`\n\nIf a partial version is provided as the first version in the inclusive\nrange, then the missing pieces are replaced with zeroes.\n\n* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4`\n\nIf a partial version is provided as the second version in the\ninclusive range, then all versions that start with the supplied parts\nof the tuple are accepted, but nothing that would be greater than the\nprovided tuple parts.\n\n* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0`\n* `1.2.3 - 2` := `>=1.2.3 <3.0.0`\n\n#### X-Ranges `1.2.x` `1.X` `1.2.*` `*`\n\nAny of `X`, `x`, or `*` may be used to \"stand in\" for one of the\nnumeric values in the `[major, minor, patch]` tuple.\n\n* `*` := `>=0.0.0` (Any version satisfies)\n* `1.x` := `>=1.0.0 <2.0.0` (Matching major version)\n* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions)\n\nA partial version range is treated as an X-Range, so the special\ncharacter is in fact optional.\n\n* `\"\"` (empty string) := `*` := `>=0.0.0`\n* `1` := `1.x.x` := `>=1.0.0 <2.0.0`\n* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0`\n\n#### Tilde Ranges `~1.2.3` `~1.2` `~1`\n\nAllows patch-level changes if a minor version is specified on the\ncomparator. Allows minor-level changes if not.\n\n* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0`\n* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`)\n* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`)\n* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0`\n* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`)\n* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`)\n* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n\n#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4`\n\nAllows changes that do not modify the left-most non-zero digit in the\n`[major, minor, patch]` tuple. In other words, this allows patch and\nminor updates for versions `1.0.0` and above, patch updates for\nversions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`.\n\nMany authors treat a `0.x` version as if the `x` were the major\n\"breaking-change\" indicator.\n\nCaret ranges are ideal when an author may make breaking changes\nbetween `0.2.4` and `0.3.0` releases, which is a common practice.\nHowever, it presumes that there will *not* be breaking changes between\n`0.2.4` and `0.2.5`. It allows for changes that are presumed to be\nadditive (but non-breaking), according to commonly observed practices.\n\n* `^1.2.3` := `>=1.2.3 <2.0.0`\n* `^0.2.3` := `>=0.2.3 <0.3.0`\n* `^0.0.3` := `>=0.0.3 <0.0.4`\n* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in\n the `1.2.3` version will be allowed, if they are greater than or\n equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but\n `1.2.4-beta.2` would not, because it is a prerelease of a\n different `[major, minor, patch]` tuple.\n* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the\n `0.0.3` version *only* will be allowed, if they are greater than or\n equal to `beta`. So, `0.0.3-pr.2` would be allowed.\n\nWhen parsing caret ranges, a missing `patch` value desugars to the\nnumber `0`, but will allow flexibility within that value, even if the\nmajor and minor versions are both `0`.\n\n* `^1.2.x` := `>=1.2.0 <2.0.0`\n* `^0.0.x` := `>=0.0.0 <0.1.0`\n* `^0.0` := `>=0.0.0 <0.1.0`\n\nA missing `minor` and `patch` values will desugar to zero, but also\nallow flexibility within those values, even if the major version is\nzero.\n\n* `^1.x` := `>=1.0.0 <2.0.0`\n* `^0.x` := `>=0.0.0 <1.0.0`\n\n### Range Grammar\n\nPutting all this together, here is a Backus-Naur grammar for ranges,\nfor the benefit of parser authors:\n\n```bnf\nrange-set ::= range ( logical-or range ) *\nlogical-or ::= ( ' ' ) * '||' ( ' ' ) *\nrange ::= hyphen | simple ( ' ' simple ) * | ''\nhyphen ::= partial ' - ' partial\nsimple ::= primitive | partial | tilde | caret\nprimitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial\npartial ::= xr ( '.' xr ( '.' xr qualifier ? )? )?\nxr ::= 'x' | 'X' | '*' | nr\nnr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) *\ntilde ::= '~' partial\ncaret ::= '^' partial\nqualifier ::= ( '-' pre )? ( '+' build )?\npre ::= parts\nbuild ::= parts\nparts ::= part ( '.' part ) *\npart ::= nr | [-0-9A-Za-z]+\n```\n\n## Functions\n\nAll methods and classes take a final `options` object argument. All\noptions in this object are `false` by default. The options supported\nare:\n\n- `loose` Be more forgiving about not-quite-valid semver strings.\n (Any resulting output will always be 100% strict compliant, of\n course.) For backwards compatibility reasons, if the `options`\n argument is a boolean value instead of an object, it is interpreted\n to be the `loose` param.\n- `includePrerelease` Set to suppress the [default\n behavior](https://github.com/npm/node-semver#prerelease-tags) of\n excluding prerelease tagged versions from ranges unless they are\n explicitly opted into.\n\nStrict-mode Comparators and Ranges will be strict about the SemVer\nstrings that they parse.\n\n* `valid(v)`: Return the parsed version, or null if it's not valid.\n* `inc(v, release)`: Return the version incremented by the release\n type (`major`, `premajor`, `minor`, `preminor`, `patch`,\n `prepatch`, or `prerelease`), or null if it's not valid\n * `premajor` in one call will bump the version up to the next major\n version and down to a prerelease of that major version.\n `preminor`, and `prepatch` work the same way.\n * If called from a non-prerelease version, the `prerelease` will work the\n same as `prepatch`. It increments the patch version, then makes a\n prerelease. If the input version is already a prerelease it simply\n increments it.\n* `prerelease(v)`: Returns an array of prerelease components, or null\n if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]`\n* `major(v)`: Return the major version number.\n* `minor(v)`: Return the minor version number.\n* `patch(v)`: Return the patch version number.\n* `intersects(r1, r2, loose)`: Return true if the two supplied ranges\n or comparators intersect.\n* `parse(v)`: Attempt to parse a string as a semantic version, returning either\n a `SemVer` object or `null`.\n\n### Comparison\n\n* `gt(v1, v2)`: `v1 > v2`\n* `gte(v1, v2)`: `v1 >= v2`\n* `lt(v1, v2)`: `v1 < v2`\n* `lte(v1, v2)`: `v1 <= v2`\n* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent,\n even if they're not the exact same string. You already know how to\n compare strings.\n* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`.\n* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call\n the corresponding function above. `\"===\"` and `\"!==\"` do simple\n string comparison, but are included for completeness. Throws if an\n invalid comparison string is provided.\n* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if\n `v2` is greater. Sorts in ascending order if passed to `Array.sort()`.\n* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions\n in descending order when passed to `Array.sort()`.\n* `diff(v1, v2)`: Returns difference between two versions by the release type\n (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`),\n or null if the versions are the same.\n\n### Comparators\n\n* `intersects(comparator)`: Return true if the comparators intersect\n\n### Ranges\n\n* `validRange(range)`: Return the valid range or null if it's not valid\n* `satisfies(version, range)`: Return true if the version satisfies the\n range.\n* `maxSatisfying(versions, range)`: Return the highest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minSatisfying(versions, range)`: Return the lowest version in the list\n that satisfies the range, or `null` if none of them do.\n* `minVersion(range)`: Return the lowest version that can possibly match\n the given range.\n* `gtr(version, range)`: Return `true` if version is greater than all the\n versions possible in the range.\n* `ltr(version, range)`: Return `true` if version is less than all the\n versions possible in the range.\n* `outside(version, range, hilo)`: Return true if the version is outside\n the bounds of the range in either the high or low direction. The\n `hilo` argument must be either the string `'>'` or `'<'`. (This is\n the function called by `gtr` and `ltr`.)\n* `intersects(range)`: Return true if any of the ranges comparators intersect\n\nNote that, since ranges may be non-contiguous, a version might not be\ngreater than a range, less than a range, *or* satisfy a range! For\nexample, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9`\nuntil `2.0.0`, so the version `1.2.10` would not be greater than the\nrange (because `2.0.1` satisfies, which is higher), nor less than the\nrange (since `1.2.8` satisfies, which is lower), and it also does not\nsatisfy the range.\n\nIf you want to know if a version satisfies or does not satisfy a\nrange, use the `satisfies(version, range)` function.\n\n### Coercion\n\n* `coerce(version)`: Coerces a string to semver if possible\n\nThis aims to provide a very forgiving translation of a non-semver string to\nsemver. It looks for the first digit in a string, and consumes all\nremaining characters which satisfy at least a partial semver (e.g., `1`,\n`1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer\nversions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All\nsurrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes\n`3.4.0`). Only text which lacks digits will fail coercion (`version one`\nis not valid). The maximum length for any semver component considered for\ncoercion is 16 characters; longer components will be ignored\n(`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any\nsemver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value\ncomponents are invalid (`9999999999999999.4.7.4` is likely invalid).\nwide-align\n----------\n\nA wide-character aware text alignment function for use in terminals / on the\nconsole.\n\n### Usage\n\n```\nvar align = require('wide-align')\n\n// Note that if you view this on a unicode console, all of the slashes are\n// aligned. This is because on a console, all narrow characters are\n// an en wide and all wide characters are an em. In browsers, this isn't\n// held to and wide characters like \"古\" can be less than two narrow\n// characters even with a fixed width font.\n\nconsole.log(align.center('abc', 10)) // ' abc '\nconsole.log(align.center('古古古', 10)) // ' 古古古 '\nconsole.log(align.left('abc', 10)) // 'abc '\nconsole.log(align.left('古古古', 10)) // '古古古 '\nconsole.log(align.right('abc', 10)) // ' abc'\nconsole.log(align.right('古古古', 10)) // ' 古古古'\n```\n\n### Functions\n\n#### `align.center(str, length)` → `str`\n\nReturns *str* with spaces added to both sides such that that it is *length*\nchars long and centered in the spaces.\n\n#### `align.left(str, length)` → `str`\n\nReturns *str* with spaces to the right such that it is *length* chars long.\n\n### `align.right(str, length)` → `str`\n\nReturns *str* with spaces to the left such that it is *length* chars long.\n\n### Origins\n\nThese functions were originally taken from \n[cliui](https://npmjs.com/package/cliui). Changes include switching to the\nMUCH faster pad generation function from\n[lodash](https://npmjs.com/package/lodash), making center alignment pad\nboth sides and adding left alignment.\n# signal-exit\n\n[](https://travis-ci.org/tapjs/signal-exit)\n[](https://coveralls.io/r/tapjs/signal-exit?branch=master)\n[](https://www.npmjs.com/package/signal-exit)\n[](https://github.com/conventional-changelog/standard-version)\n\nWhen you want to fire an event no matter how a process exits:\n\n* reaching the end of execution.\n* explicitly having `process.exit(code)` called.\n* having `process.kill(pid, sig)` called.\n* receiving a fatal signal from outside the process\n\nUse `signal-exit`.\n\n```js\nvar onExit = require('signal-exit')\n\nonExit(function (code, signal) {\n console.log('process exited!')\n})\n```\n\n## API\n\n`var remove = onExit(function (code, signal) {}, options)`\n\nThe return value of the function is a function that will remove the\nhandler.\n\nNote that the function *only* fires for signals if the signal would\ncause the proces to exit. That is, there are no other listeners, and\nit is a fatal signal.\n\n## Options\n\n* `alwaysLast`: Run this handler after any other signal or exit\n handlers. This causes `process.emit` to be monkeypatched.\n# Deprecated!\n\nAs of Feb 11th 2020, request is fully deprecated. No new changes are expected land. In fact, none have landed for some time.\n\nFor more information about why request is deprecated and possible alternatives refer to\n[this issue](https://github.com/request/request/issues/3142).\n\n# Request - Simplified HTTP client\n\n[](https://nodei.co/npm/request/)\n\n[](https://travis-ci.org/request/request)\n[](https://codecov.io/github/request/request?branch=master)\n[](https://coveralls.io/r/request/request)\n[](https://david-dm.org/request/request)\n[](https://snyk.io/test/npm/request)\n[](https://gitter.im/request/request?utm_source=badge)\n\n## Super simple to use\n\nRequest is designed to be the simplest way possible to make http calls. It supports HTTPS and follows redirects by default.\n\n```js\nconst request = require('request');\nrequest('http://www.google.com', function (error, response, body) {\n console.error('error:', error); // Print the error if one occurred\n console.log('statusCode:', response && response.statusCode); // Print the response status code if a response was received\n console.log('body:', body); // Print the HTML for the Google homepage.\n});\n```\n\n## Table of contents\n\n- [Streaming](#streaming)\n- [Promises & Async/Await](#promises--asyncawait)\n- [Forms](#forms)\n- [HTTP Authentication](#http-authentication)\n- [Custom HTTP Headers](#custom-http-headers)\n- [OAuth Signing](#oauth-signing)\n- [Proxies](#proxies)\n- [Unix Domain Sockets](#unix-domain-sockets)\n- [TLS/SSL Protocol](#tlsssl-protocol)\n- [Support for HAR 1.2](#support-for-har-12)\n- [**All Available Options**](#requestoptions-callback)\n\nRequest also offers [convenience methods](#convenience-methods) like\n`request.defaults` and `request.post`, and there are\nlots of [usage examples](#examples) and several\n[debugging techniques](#debugging).\n\n---\n\n## Streaming\n\nYou can stream any response to a file stream.\n\n```js\nrequest('http://google.com/doodle.png').pipe(fs.createWriteStream('doodle.png'))\n```\n\nYou can also stream a file to a PUT or POST request. This method will also check the file extension against a mapping of file extensions to content-types (in this case `application/json`) and use the proper `content-type` in the PUT request (if the headers don’t already provide one).\n\n```js\nfs.createReadStream('file.json').pipe(request.put('http://mysite.com/obj.json'))\n```\n\nRequest can also `pipe` to itself. When doing so, `content-type` and `content-length` are preserved in the PUT headers.\n\n```js\nrequest.get('http://google.com/img.png').pipe(request.put('http://mysite.com/img.png'))\n```\n\nRequest emits a \"response\" event when a response is received. The `response` argument will be an instance of [http.IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage).\n\n```js\nrequest\n .get('http://google.com/img.png')\n .on('response', function(response) {\n console.log(response.statusCode) // 200\n console.log(response.headers['content-type']) // 'image/png'\n })\n .pipe(request.put('http://mysite.com/img.png'))\n```\n\nTo easily handle errors when streaming requests, listen to the `error` event before piping:\n\n```js\nrequest\n .get('http://mysite.com/doodle.png')\n .on('error', function(err) {\n console.error(err)\n })\n .pipe(fs.createWriteStream('doodle.png'))\n```\n\nNow let’s get fancy.\n\n```js\nhttp.createServer(function (req, resp) {\n if (req.url === '/doodle.png') {\n if (req.method === 'PUT') {\n req.pipe(request.put('http://mysite.com/doodle.png'))\n } else if (req.method === 'GET' || req.method === 'HEAD') {\n request.get('http://mysite.com/doodle.png').pipe(resp)\n }\n }\n})\n```\n\nYou can also `pipe()` from `http.ServerRequest` instances, as well as to `http.ServerResponse` instances. The HTTP method, headers, and entity-body data will be sent. Which means that, if you don't really care about security, you can do:\n\n```js\nhttp.createServer(function (req, resp) {\n if (req.url === '/doodle.png') {\n const x = request('http://mysite.com/doodle.png')\n req.pipe(x)\n x.pipe(resp)\n }\n})\n```\n\nAnd since `pipe()` returns the destination stream in ≥ Node 0.5.x you can do one line proxying. :)\n\n```js\nreq.pipe(request('http://mysite.com/doodle.png')).pipe(resp)\n```\n\nAlso, none of this new functionality conflicts with requests previous features, it just expands them.\n\n```js\nconst r = request.defaults({'proxy':'http://localproxy.com'})\n\nhttp.createServer(function (req, resp) {\n if (req.url === '/doodle.png') {\n r.get('http://google.com/doodle.png').pipe(resp)\n }\n})\n```\n\nYou can still use intermediate proxies, the requests will still follow HTTP forwards, etc.\n\n[back to top](#table-of-contents)\n\n---\n\n## Promises & Async/Await\n\n`request` supports both streaming and callback interfaces natively. If you'd like `request` to return a Promise instead, you can use an alternative interface wrapper for `request`. These wrappers can be useful if you prefer to work with Promises, or if you'd like to use `async`/`await` in ES2017.\n\nSeveral alternative interfaces are provided by the request team, including:\n- [`request-promise`](https://github.com/request/request-promise) (uses [Bluebird](https://github.com/petkaantonov/bluebird) Promises)\n- [`request-promise-native`](https://github.com/request/request-promise-native) (uses native Promises)\n- [`request-promise-any`](https://github.com/request/request-promise-any) (uses [any-promise](https://www.npmjs.com/package/any-promise) Promises)\n\nAlso, [`util.promisify`](https://nodejs.org/api/util.html#util_util_promisify_original), which is available from Node.js v8.0 can be used to convert a regular function that takes a callback to return a promise instead.\n\n[back to top](#table-of-contents)\n\n---\n\n## Forms\n\n`request` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads. For `multipart/related` refer to the `multipart` API.\n\n#### application/x-www-form-urlencoded (URL-Encoded Forms)\n\nURL-encoded forms are simple.\n\n```js\nrequest.post('http://service.com/upload', {form:{key:'value'}})\n// or\nrequest.post('http://service.com/upload').form({key:'value'})\n// or\nrequest.post({url:'http://service.com/upload', form: {key:'value'}}, function(err,httpResponse,body){ /* ... */ })\n```\n\n#### multipart/form-data (Multipart Form Uploads)\n\nFor `multipart/form-data` we use the [form-data](https://github.com/form-data/form-data) library by [@felixge](https://github.com/felixge). For the most cases, you can pass your upload form data via the `formData` option.\n\n```js\nconst formData = {\n // Pass a simple key-value pair\n my_field: 'my_value',\n // Pass data via Buffers\n my_buffer: Buffer.from([1, 2, 3]),\n // Pass data via Streams\n my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),\n // Pass multiple values /w an Array\n attachments: [\n fs.createReadStream(__dirname + '/attachment1.jpg'),\n fs.createReadStream(__dirname + '/attachment2.jpg')\n ],\n // Pass optional meta-data with an 'options' object with style: {value: DATA, options: OPTIONS}\n // Use case: for some types of streams, you'll need to provide \"file\"-related information manually.\n // See the `form-data` README for more information about options: https://github.com/form-data/form-data\n custom_file: {\n value: fs.createReadStream('/dev/urandom'),\n options: {\n filename: 'topsecret.jpg',\n contentType: 'image/jpeg'\n }\n }\n};\nrequest.post({url:'http://service.com/upload', formData: formData}, function optionalCallback(err, httpResponse, body) {\n if (err) {\n return console.error('upload failed:', err);\n }\n console.log('Upload successful! Server responded with:', body);\n});\n```\n\nFor advanced cases, you can access the form-data object itself via `r.form()`. This can be modified until the request is fired on the next cycle of the event-loop. (Note that this calling `form()` will clear the currently set form data for that request.)\n\n```js\n// NOTE: Advanced use-case, for normal use see 'formData' usage above\nconst r = request.post('http://service.com/upload', function optionalCallback(err, httpResponse, body) {...})\nconst form = r.form();\nform.append('my_field', 'my_value');\nform.append('my_buffer', Buffer.from([1, 2, 3]));\nform.append('custom_file', fs.createReadStream(__dirname + '/unicycle.jpg'), {filename: 'unicycle.jpg'});\n```\nSee the [form-data README](https://github.com/form-data/form-data) for more information & examples.\n\n#### multipart/related\n\nSome variations in different HTTP implementations require a newline/CRLF before, after, or both before and after the boundary of a `multipart/related` request (using the multipart option). This has been observed in the .NET WebAPI version 4.0. You can turn on a boundary preambleCRLF or postamble by passing them as `true` to your request options.\n\n```js\n request({\n method: 'PUT',\n preambleCRLF: true,\n postambleCRLF: true,\n uri: 'http://service.com/upload',\n multipart: [\n {\n 'content-type': 'application/json',\n body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})\n },\n { body: 'I am an attachment' },\n { body: fs.createReadStream('image.png') }\n ],\n // alternatively pass an object containing additional options\n multipart: {\n chunked: false,\n data: [\n {\n 'content-type': 'application/json',\n body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})\n },\n { body: 'I am an attachment' }\n ]\n }\n },\n function (error, response, body) {\n if (error) {\n return console.error('upload failed:', error);\n }\n console.log('Upload successful! Server responded with:', body);\n })\n```\n\n[back to top](#table-of-contents)\n\n---\n\n## HTTP Authentication\n\n```js\nrequest.get('http://some.server.com/').auth('username', 'password', false);\n// or\nrequest.get('http://some.server.com/', {\n 'auth': {\n 'user': 'username',\n 'pass': 'password',\n 'sendImmediately': false\n }\n});\n// or\nrequest.get('http://some.server.com/').auth(null, null, true, 'bearerToken');\n// or\nrequest.get('http://some.server.com/', {\n 'auth': {\n 'bearer': 'bearerToken'\n }\n});\n```\n\nIf passed as an option, `auth` should be a hash containing values:\n\n- `user` || `username`\n- `pass` || `password`\n- `sendImmediately` (optional)\n- `bearer` (optional)\n\nThe method form takes parameters\n`auth(username, password, sendImmediately, bearer)`.\n\n`sendImmediately` defaults to `true`, which causes a basic or bearer\nauthentication header to be sent. If `sendImmediately` is `false`, then\n`request` will retry with a proper authentication header after receiving a\n`401` response from the server (which must contain a `WWW-Authenticate` header\nindicating the required authentication method).\n\nNote that you can also specify basic authentication using the URL itself, as\ndetailed in [RFC 1738](http://www.ietf.org/rfc/rfc1738.txt). Simply pass the\n`user:password` before the host with an `@` sign:\n\n```js\nconst username = 'username',\n password = 'password',\n url = 'http://' + username + ':' + password + '@some.server.com';\n\nrequest({url}, function (error, response, body) {\n // Do more stuff with 'body' here\n});\n```\n\nDigest authentication is supported, but it only works with `sendImmediately`\nset to `false`; otherwise `request` will send basic authentication on the\ninitial request, which will probably cause the request to fail.\n\nBearer authentication is supported, and is activated when the `bearer` value is\navailable. The value may be either a `String` or a `Function` returning a\n`String`. Using a function to supply the bearer token is particularly useful if\nused in conjunction with `defaults` to allow a single function to supply the\nlast known token at the time of sending a request, or to compute one on the fly.\n\n[back to top](#table-of-contents)\n\n---\n\n## Custom HTTP Headers\n\nHTTP Headers, such as `User-Agent`, can be set in the `options` object.\nIn the example below, we call the github API to find out the number\nof stars and forks for the request repository. This requires a\ncustom `User-Agent` header as well as https.\n\n```js\nconst request = require('request');\n\nconst options = {\n url: 'https://api.github.com/repos/request/request',\n headers: {\n 'User-Agent': 'request'\n }\n};\n\nfunction callback(error, response, body) {\n if (!error && response.statusCode == 200) {\n const info = JSON.parse(body);\n console.log(info.stargazers_count + \" Stars\");\n console.log(info.forks_count + \" Forks\");\n }\n}\n\nrequest(options, callback);\n```\n\n[back to top](#table-of-contents)\n\n---\n\n## OAuth Signing\n\n[OAuth version 1.0](https://tools.ietf.org/html/rfc5849) is supported. The\ndefault signing algorithm is\n[HMAC-SHA1](https://tools.ietf.org/html/rfc5849#section-3.4.2):\n\n```js\n// OAuth1.0 - 3-legged server side flow (Twitter example)\n// step 1\nconst qs = require('querystring')\n , oauth =\n { callback: 'http://mysite.com/callback/'\n , consumer_key: CONSUMER_KEY\n , consumer_secret: CONSUMER_SECRET\n }\n , url = 'https://api.twitter.com/oauth/request_token'\n ;\nrequest.post({url:url, oauth:oauth}, function (e, r, body) {\n // Ideally, you would take the body in the response\n // and construct a URL that a user clicks on (like a sign in button).\n // The verifier is only available in the response after a user has\n // verified with twitter that they are authorizing your app.\n\n // step 2\n const req_data = qs.parse(body)\n const uri = 'https://api.twitter.com/oauth/authenticate'\n + '?' + qs.stringify({oauth_token: req_data.oauth_token})\n // redirect the user to the authorize uri\n\n // step 3\n // after the user is redirected back to your server\n const auth_data = qs.parse(body)\n , oauth =\n { consumer_key: CONSUMER_KEY\n , consumer_secret: CONSUMER_SECRET\n , token: auth_data.oauth_token\n , token_secret: req_data.oauth_token_secret\n , verifier: auth_data.oauth_verifier\n }\n , url = 'https://api.twitter.com/oauth/access_token'\n ;\n request.post({url:url, oauth:oauth}, function (e, r, body) {\n // ready to make signed requests on behalf of the user\n const perm_data = qs.parse(body)\n , oauth =\n { consumer_key: CONSUMER_KEY\n , consumer_secret: CONSUMER_SECRET\n , token: perm_data.oauth_token\n , token_secret: perm_data.oauth_token_secret\n }\n , url = 'https://api.twitter.com/1.1/users/show.json'\n , qs =\n { screen_name: perm_data.screen_name\n , user_id: perm_data.user_id\n }\n ;\n request.get({url:url, oauth:oauth, qs:qs, json:true}, function (e, r, user) {\n console.log(user)\n })\n })\n})\n```\n\nFor [RSA-SHA1 signing](https://tools.ietf.org/html/rfc5849#section-3.4.3), make\nthe following changes to the OAuth options object:\n* Pass `signature_method : 'RSA-SHA1'`\n* Instead of `consumer_secret`, specify a `private_key` string in\n [PEM format](http://how2ssl.com/articles/working_with_pem_files/)\n\nFor [PLAINTEXT signing](http://oauth.net/core/1.0/#anchor22), make\nthe following changes to the OAuth options object:\n* Pass `signature_method : 'PLAINTEXT'`\n\nTo send OAuth parameters via query params or in a post body as described in The\n[Consumer Request Parameters](http://oauth.net/core/1.0/#consumer_req_param)\nsection of the oauth1 spec:\n* Pass `transport_method : 'query'` or `transport_method : 'body'` in the OAuth\n options object.\n* `transport_method` defaults to `'header'`\n\nTo use [Request Body Hash](https://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html) you can either\n* Manually generate the body hash and pass it as a string `body_hash: '...'`\n* Automatically generate the body hash by passing `body_hash: true`\n\n[back to top](#table-of-contents)\n\n---\n\n## Proxies\n\nIf you specify a `proxy` option, then the request (and any subsequent\nredirects) will be sent via a connection to the proxy server.\n\nIf your endpoint is an `https` url, and you are using a proxy, then\nrequest will send a `CONNECT` request to the proxy server *first*, and\nthen use the supplied connection to connect to the endpoint.\n\nThat is, first it will make a request like:\n\n```\nHTTP/1.1 CONNECT endpoint-server.com:80\nHost: proxy-server.com\nUser-Agent: whatever user agent you specify\n```\n\nand then the proxy server make a TCP connection to `endpoint-server`\non port `80`, and return a response that looks like:\n\n```\nHTTP/1.1 200 OK\n```\n\nAt this point, the connection is left open, and the client is\ncommunicating directly with the `endpoint-server.com` machine.\n\nSee [the wikipedia page on HTTP Tunneling](https://en.wikipedia.org/wiki/HTTP_tunnel)\nfor more information.\n\nBy default, when proxying `http` traffic, request will simply make a\nstandard proxied `http` request. This is done by making the `url`\nsection of the initial line of the request a fully qualified url to\nthe endpoint.\n\nFor example, it will make a single request that looks like:\n\n```\nHTTP/1.1 GET http://endpoint-server.com/some-url\nHost: proxy-server.com\nOther-Headers: all go here\n\nrequest body or whatever\n```\n\nBecause a pure \"http over http\" tunnel offers no additional security\nor other features, it is generally simpler to go with a\nstraightforward HTTP proxy in this case. However, if you would like\nto force a tunneling proxy, you may set the `tunnel` option to `true`.\n\nYou can also make a standard proxied `http` request by explicitly setting\n`tunnel : false`, but **note that this will allow the proxy to see the traffic\nto/from the destination server**.\n\nIf you are using a tunneling proxy, you may set the\n`proxyHeaderWhiteList` to share certain headers with the proxy.\n\nYou can also set the `proxyHeaderExclusiveList` to share certain\nheaders only with the proxy and not with destination host.\n\nBy default, this set is:\n\n```\naccept\naccept-charset\naccept-encoding\naccept-language\naccept-ranges\ncache-control\ncontent-encoding\ncontent-language\ncontent-length\ncontent-location\ncontent-md5\ncontent-range\ncontent-type\nconnection\ndate\nexpect\nmax-forwards\npragma\nproxy-authorization\nreferer\nte\ntransfer-encoding\nuser-agent\nvia\n```\n\nNote that, when using a tunneling proxy, the `proxy-authorization`\nheader and any headers from custom `proxyHeaderExclusiveList` are\n*never* sent to the endpoint server, but only to the proxy server.\n\n### Controlling proxy behaviour using environment variables\n\nThe following environment variables are respected by `request`:\n\n * `HTTP_PROXY` / `http_proxy`\n * `HTTPS_PROXY` / `https_proxy`\n * `NO_PROXY` / `no_proxy`\n\nWhen `HTTP_PROXY` / `http_proxy` are set, they will be used to proxy non-SSL requests that do not have an explicit `proxy` configuration option present. Similarly, `HTTPS_PROXY` / `https_proxy` will be respected for SSL requests that do not have an explicit `proxy` configuration option. It is valid to define a proxy in one of the environment variables, but then override it for a specific request, using the `proxy` configuration option. Furthermore, the `proxy` configuration option can be explicitly set to false / null to opt out of proxying altogether for that request.\n\n`request` is also aware of the `NO_PROXY`/`no_proxy` environment variables. These variables provide a granular way to opt out of proxying, on a per-host basis. It should contain a comma separated list of hosts to opt out of proxying. It is also possible to opt of proxying when a particular destination port is used. Finally, the variable may be set to `*` to opt out of the implicit proxy configuration of the other environment variables.\n\nHere's some examples of valid `no_proxy` values:\n\n * `google.com` - don't proxy HTTP/HTTPS requests to Google.\n * `google.com:443` - don't proxy HTTPS requests to Google, but *do* proxy HTTP requests to Google.\n * `google.com:443, yahoo.com:80` - don't proxy HTTPS requests to Google, and don't proxy HTTP requests to Yahoo!\n * `*` - ignore `https_proxy`/`http_proxy` environment variables altogether.\n\n[back to top](#table-of-contents)\n\n---\n\n## UNIX Domain Sockets\n\n`request` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:\n\n```js\n/* Pattern */ 'http://unix:SOCKET:PATH'\n/* Example */ request.get('http://unix:/absolute/path/to/unix.socket:/request/path')\n```\n\nNote: The `SOCKET` path is assumed to be absolute to the root of the host file system.\n\n[back to top](#table-of-contents)\n\n---\n\n## TLS/SSL Protocol\n\nTLS/SSL Protocol options, such as `cert`, `key` and `passphrase`, can be\nset directly in `options` object, in the `agentOptions` property of the `options` object, or even in `https.globalAgent.options`. Keep in mind that, although `agentOptions` allows for a slightly wider range of configurations, the recommended way is via `options` object directly, as using `agentOptions` or `https.globalAgent.options` would not be applied in the same way in proxied environments (as data travels through a TLS connection instead of an http/https agent).\n\n```js\nconst fs = require('fs')\n , path = require('path')\n , certFile = path.resolve(__dirname, 'ssl/client.crt')\n , keyFile = path.resolve(__dirname, 'ssl/client.key')\n , caFile = path.resolve(__dirname, 'ssl/ca.cert.pem')\n , request = require('request');\n\nconst options = {\n url: 'https://api.some-server.com/',\n cert: fs.readFileSync(certFile),\n key: fs.readFileSync(keyFile),\n passphrase: 'password',\n ca: fs.readFileSync(caFile)\n};\n\nrequest.get(options);\n```\n\n### Using `options.agentOptions`\n\nIn the example below, we call an API that requires client side SSL certificate\n(in PEM format) with passphrase protected private key (in PEM format) and disable the SSLv3 protocol:\n\n```js\nconst fs = require('fs')\n , path = require('path')\n , certFile = path.resolve(__dirname, 'ssl/client.crt')\n , keyFile = path.resolve(__dirname, 'ssl/client.key')\n , request = require('request');\n\nconst options = {\n url: 'https://api.some-server.com/',\n agentOptions: {\n cert: fs.readFileSync(certFile),\n key: fs.readFileSync(keyFile),\n // Or use `pfx` property replacing `cert` and `key` when using private key, certificate and CA certs in PFX or PKCS12 format:\n // pfx: fs.readFileSync(pfxFilePath),\n passphrase: 'password',\n securityOptions: 'SSL_OP_NO_SSLv3'\n }\n};\n\nrequest.get(options);\n```\n\nIt is able to force using SSLv3 only by specifying `secureProtocol`:\n\n```js\nrequest.get({\n url: 'https://api.some-server.com/',\n agentOptions: {\n secureProtocol: 'SSLv3_method'\n }\n});\n```\n\nIt is possible to accept other certificates than those signed by generally allowed Certificate Authorities (CAs).\nThis can be useful, for example, when using self-signed certificates.\nTo require a different root certificate, you can specify the signing CA by adding the contents of the CA's certificate file to the `agentOptions`.\nThe certificate the domain presents must be signed by the root certificate specified:\n\n```js\nrequest.get({\n url: 'https://api.some-server.com/',\n agentOptions: {\n ca: fs.readFileSync('ca.cert.pem')\n }\n});\n```\n\nThe `ca` value can be an array of certificates, in the event you have a private or internal corporate public-key infrastructure hierarchy. For example, if you want to connect to https://api.some-server.com which presents a key chain consisting of:\n1. its own public key, which is signed by:\n2. an intermediate \"Corp Issuing Server\", that is in turn signed by: \n3. a root CA \"Corp Root CA\";\n\nyou can configure your request as follows:\n\n```js\nrequest.get({\n url: 'https://api.some-server.com/',\n agentOptions: {\n ca: [\n fs.readFileSync('Corp Issuing Server.pem'),\n fs.readFileSync('Corp Root CA.pem')\n ]\n }\n});\n```\n\n[back to top](#table-of-contents)\n\n---\n\n## Support for HAR 1.2\n\nThe `options.har` property will override the values: `url`, `method`, `qs`, `headers`, `form`, `formData`, `body`, `json`, as well as construct multipart data and read files from disk when `request.postData.params[].fileName` is present without a matching `value`.\n\nA validation step will check if the HAR Request format matches the latest spec (v1.2) and will skip parsing if not matching.\n\n```js\n const request = require('request')\n request({\n // will be ignored\n method: 'GET',\n uri: 'http://www.google.com',\n\n // HTTP Archive Request Object\n har: {\n url: 'http://www.mockbin.com/har',\n method: 'POST',\n headers: [\n {\n name: 'content-type',\n value: 'application/x-www-form-urlencoded'\n }\n ],\n postData: {\n mimeType: 'application/x-www-form-urlencoded',\n params: [\n {\n name: 'foo',\n value: 'bar'\n },\n {\n name: 'hello',\n value: 'world'\n }\n ]\n }\n }\n })\n\n // a POST request will be sent to http://www.mockbin.com\n // with body an application/x-www-form-urlencoded body:\n // foo=bar&hello=world\n```\n\n[back to top](#table-of-contents)\n\n---\n\n## request(options, callback)\n\nThe first argument can be either a `url` or an `options` object. The only required option is `uri`; all others are optional.\n\n- `uri` || `url` - fully qualified uri or a parsed url object from `url.parse()`\n- `baseUrl` - fully qualified uri string used as the base url. Most useful with `request.defaults`, for example when you want to do many requests to the same domain. If `baseUrl` is `https://example.com/api/`, then requesting `/end/point?test=true` will fetch `https://example.com/api/end/point?test=true`. When `baseUrl` is given, `uri` must also be a string.\n- `method` - http method (default: `\"GET\"`)\n- `headers` - http headers (default: `{}`)\n\n---\n\n- `qs` - object containing querystring values to be appended to the `uri`\n- `qsParseOptions` - object containing options to pass to the [qs.parse](https://github.com/hapijs/qs#parsing-objects) method. Alternatively pass options to the [querystring.parse](https://nodejs.org/docs/v0.12.0/api/querystring.html#querystring_querystring_parse_str_sep_eq_options) method using this format `{sep:';', eq:':', options:{}}`\n- `qsStringifyOptions` - object containing options to pass to the [qs.stringify](https://github.com/hapijs/qs#stringifying) method. Alternatively pass options to the [querystring.stringify](https://nodejs.org/docs/v0.12.0/api/querystring.html#querystring_querystring_stringify_obj_sep_eq_options) method using this format `{sep:';', eq:':', options:{}}`. For example, to change the way arrays are converted to query strings using the `qs` module pass the `arrayFormat` option with one of `indices|brackets|repeat`\n- `useQuerystring` - if true, use `querystring` to stringify and parse\n querystrings, otherwise use `qs` (default: `false`). Set this option to\n `true` if you need arrays to be serialized as `foo=bar&foo=baz` instead of the\n default `foo[0]=bar&foo[1]=baz`.\n\n---\n\n- `body` - entity body for PATCH, POST and PUT requests. Must be a `Buffer`, `String` or `ReadStream`. If `json` is `true`, then `body` must be a JSON-serializable object.\n- `form` - when passed an object or a querystring, this sets `body` to a querystring representation of value, and adds `Content-type: application/x-www-form-urlencoded` header. When passed no options, a `FormData` instance is returned (and is piped to request). See \"Forms\" section above.\n- `formData` - data to pass for a `multipart/form-data` request. See\n [Forms](#forms) section above.\n- `multipart` - array of objects which contain their own headers and `body`\n attributes. Sends a `multipart/related` request. See [Forms](#forms) section\n above.\n - Alternatively you can pass in an object `{chunked: false, data: []}` where\n `chunked` is used to specify whether the request is sent in\n [chunked transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding)\n In non-chunked requests, data items with body streams are not allowed.\n- `preambleCRLF` - append a newline/CRLF before the boundary of your `multipart/form-data` request.\n- `postambleCRLF` - append a newline/CRLF at the end of the boundary of your `multipart/form-data` request.\n- `json` - sets `body` to JSON representation of value and adds `Content-type: application/json` header. Additionally, parses the response body as JSON.\n- `jsonReviver` - a [reviver function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse) that will be passed to `JSON.parse()` when parsing a JSON response body.\n- `jsonReplacer` - a [replacer function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) that will be passed to `JSON.stringify()` when stringifying a JSON request body.\n\n---\n\n- `auth` - a hash containing values `user` || `username`, `pass` || `password`, and `sendImmediately` (optional). See documentation above.\n- `oauth` - options for OAuth HMAC-SHA1 signing. See documentation above.\n- `hawk` - options for [Hawk signing](https://github.com/hueniverse/hawk). The `credentials` key must contain the necessary signing info, [see hawk docs for details](https://github.com/hueniverse/hawk#usage-example).\n- `aws` - `object` containing AWS signing information. Should have the properties `key`, `secret`, and optionally `session` (note that this only works for services that require session as part of the canonical string). Also requires the property `bucket`, unless you’re specifying your `bucket` as part of the path, or the request doesn’t use a bucket (i.e. GET Services). If you want to use AWS sign version 4 use the parameter `sign_version` with value `4` otherwise the default is version 2. If you are using SigV4, you can also include a `service` property that specifies the service name. **Note:** you need to `npm install aws4` first.\n- `httpSignature` - options for the [HTTP Signature Scheme](https://github.com/joyent/node-http-signature/blob/master/http_signing.md) using [Joyent's library](https://github.com/joyent/node-http-signature). The `keyId` and `key` properties must be specified. See the docs for other options.\n\n---\n\n- `followRedirect` - follow HTTP 3xx responses as redirects (default: `true`). This property can also be implemented as function which gets `response` object as a single argument and should return `true` if redirects should continue or `false` otherwise.\n- `followAllRedirects` - follow non-GET HTTP 3xx responses as redirects (default: `false`)\n- `followOriginalHttpMethod` - by default we redirect to HTTP method GET. you can enable this property to redirect to the original HTTP method (default: `false`)\n- `maxRedirects` - the maximum number of redirects to follow (default: `10`)\n- `removeRefererHeader` - removes the referer header when a redirect happens (default: `false`). **Note:** if true, referer header set in the initial request is preserved during redirect chain.\n\n---\n\n- `encoding` - encoding to be used on `setEncoding` of response data. If `null`, the `body` is returned as a `Buffer`. Anything else **(including the default value of `undefined`)** will be passed as the [encoding](http://nodejs.org/api/buffer.html#buffer_buffer) parameter to `toString()` (meaning this is effectively `utf8` by default). (**Note:** if you expect binary data, you should set `encoding: null`.)\n- `gzip` - if `true`, add an `Accept-Encoding` header to request compressed content encodings from the server (if not already present) and decode supported content encodings in the response. **Note:** Automatic decoding of the response content is performed on the body data returned through `request` (both through the `request` stream and passed to the callback function) but is not performed on the `response` stream (available from the `response` event) which is the unmodified `http.IncomingMessage` object which may contain compressed data. See example below.\n- `jar` - if `true`, remember cookies for future use (or define your custom cookie jar; see examples section)\n\n---\n\n- `agent` - `http(s).Agent` instance to use\n- `agentClass` - alternatively specify your agent's class name\n- `agentOptions` - and pass its options. **Note:** for HTTPS see [tls API doc for TLS/SSL options](http://nodejs.org/api/tls.html#tls_tls_connect_options_callback) and the [documentation above](#using-optionsagentoptions).\n- `forever` - set to `true` to use the [forever-agent](https://github.com/request/forever-agent) **Note:** Defaults to `http(s).Agent({keepAlive:true})` in node 0.12+\n- `pool` - an object describing which agents to use for the request. If this option is omitted the request will use the global agent (as long as your options allow for it). Otherwise, request will search the pool for your custom agent. If no custom agent is found, a new agent will be created and added to the pool. **Note:** `pool` is used only when the `agent` option is not specified.\n - A `maxSockets` property can also be provided on the `pool` object to set the max number of sockets for all agents created (ex: `pool: {maxSockets: Infinity}`).\n - Note that if you are sending multiple requests in a loop and creating\n multiple new `pool` objects, `maxSockets` will not work as intended. To\n work around this, either use [`request.defaults`](#requestdefaultsoptions)\n with your pool options or create the pool object with the `maxSockets`\n property outside of the loop.\n- `timeout` - integer containing number of milliseconds, controls two timeouts.\n - **Read timeout**: Time to wait for a server to send response headers (and start the response body) before aborting the request.\n - **Connection timeout**: Sets the socket to timeout after `timeout` milliseconds of inactivity. Note that increasing the timeout beyond the OS-wide TCP connection timeout will not have any effect ([the default in Linux can be anywhere from 20-120 seconds][linux-timeout])\n\n[linux-timeout]: http://www.sekuda.com/overriding_the_default_linux_kernel_20_second_tcp_socket_connect_timeout\n\n---\n\n- `localAddress` - local interface to bind for network connections.\n- `proxy` - an HTTP proxy to be used. Supports proxy Auth with Basic Auth, identical to support for the `url` parameter (by embedding the auth info in the `uri`)\n- `strictSSL` - if `true`, requires SSL certificates be valid. **Note:** to use your own certificate authority, you need to specify an agent that was created with that CA as an option.\n- `tunnel` - controls the behavior of\n [HTTP `CONNECT` tunneling](https://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_tunneling)\n as follows:\n - `undefined` (default) - `true` if the destination is `https`, `false` otherwise\n - `true` - always tunnel to the destination by making a `CONNECT` request to\n the proxy\n - `false` - request the destination as a `GET` request.\n- `proxyHeaderWhiteList` - a whitelist of headers to send to a\n tunneling proxy.\n- `proxyHeaderExclusiveList` - a whitelist of headers to send\n exclusively to a tunneling proxy and not to destination.\n\n---\n\n- `time` - if `true`, the request-response cycle (including all redirects) is timed at millisecond resolution. When set, the following properties are added to the response object:\n - `elapsedTime` Duration of the entire request/response in milliseconds (*deprecated*).\n - `responseStartTime` Timestamp when the response began (in Unix Epoch milliseconds) (*deprecated*).\n - `timingStart` Timestamp of the start of the request (in Unix Epoch milliseconds).\n - `timings` Contains event timestamps in millisecond resolution relative to `timingStart`. If there were redirects, the properties reflect the timings of the final request in the redirect chain:\n - `socket` Relative timestamp when the [`http`](https://nodejs.org/api/http.html#http_event_socket) module's `socket` event fires. This happens when the socket is assigned to the request.\n - `lookup` Relative timestamp when the [`net`](https://nodejs.org/api/net.html#net_event_lookup) module's `lookup` event fires. This happens when the DNS has been resolved.\n - `connect`: Relative timestamp when the [`net`](https://nodejs.org/api/net.html#net_event_connect) module's `connect` event fires. This happens when the server acknowledges the TCP connection.\n - `response`: Relative timestamp when the [`http`](https://nodejs.org/api/http.html#http_event_response) module's `response` event fires. This happens when the first bytes are received from the server.\n - `end`: Relative timestamp when the last bytes of the response are received.\n - `timingPhases` Contains the durations of each request phase. If there were redirects, the properties reflect the timings of the final request in the redirect chain:\n - `wait`: Duration of socket initialization (`timings.socket`)\n - `dns`: Duration of DNS lookup (`timings.lookup` - `timings.socket`)\n - `tcp`: Duration of TCP connection (`timings.connect` - `timings.socket`)\n - `firstByte`: Duration of HTTP server response (`timings.response` - `timings.connect`)\n - `download`: Duration of HTTP download (`timings.end` - `timings.response`)\n - `total`: Duration entire HTTP round-trip (`timings.end`)\n\n- `har` - a [HAR 1.2 Request Object](http://www.softwareishard.com/blog/har-12-spec/#request), will be processed from HAR format into options overwriting matching values *(see the [HAR 1.2 section](#support-for-har-12) for details)*\n- `callback` - alternatively pass the request's callback in the options object\n\nThe callback argument gets 3 arguments:\n\n1. An `error` when applicable (usually from [`http.ClientRequest`](http://nodejs.org/api/http.html#http_class_http_clientrequest) object)\n2. An [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) object (Response object)\n3. The third is the `response` body (`String` or `Buffer`, or JSON object if the `json` option is supplied)\n\n[back to top](#table-of-contents)\n\n---\n\n## Convenience methods\n\nThere are also shorthand methods for different HTTP METHODs and some other conveniences.\n\n### request.defaults(options)\n\nThis method **returns a wrapper** around the normal request API that defaults\nto whatever options you pass to it.\n\n**Note:** `request.defaults()` **does not** modify the global request API;\ninstead, it **returns a wrapper** that has your default settings applied to it.\n\n**Note:** You can call `.defaults()` on the wrapper that is returned from\n`request.defaults` to add/override defaults that were previously defaulted.\n\nFor example:\n```js\n//requests using baseRequest() will set the 'x-token' header\nconst baseRequest = request.defaults({\n headers: {'x-token': 'my-token'}\n})\n\n//requests using specialRequest() will include the 'x-token' header set in\n//baseRequest and will also include the 'special' header\nconst specialRequest = baseRequest.defaults({\n headers: {special: 'special value'}\n})\n```\n\n### request.METHOD()\n\nThese HTTP method convenience functions act just like `request()` but with a default method already set for you:\n\n- *request.get()*: Defaults to `method: \"GET\"`.\n- *request.post()*: Defaults to `method: \"POST\"`.\n- *request.put()*: Defaults to `method: \"PUT\"`.\n- *request.patch()*: Defaults to `method: \"PATCH\"`.\n- *request.del() / request.delete()*: Defaults to `method: \"DELETE\"`.\n- *request.head()*: Defaults to `method: \"HEAD\"`.\n- *request.options()*: Defaults to `method: \"OPTIONS\"`.\n\n### request.cookie()\n\nFunction that creates a new cookie.\n\n```js\nrequest.cookie('key1=value1')\n```\n### request.jar()\n\nFunction that creates a new cookie jar.\n\n```js\nrequest.jar()\n```\n\n### response.caseless.get('header-name')\n\nFunction that returns the specified response header field using a [case-insensitive match](https://tools.ietf.org/html/rfc7230#section-3.2)\n\n```js\nrequest('http://www.google.com', function (error, response, body) {\n // print the Content-Type header even if the server returned it as 'content-type' (lowercase)\n console.log('Content-Type is:', response.caseless.get('Content-Type')); \n});\n```\n\n[back to top](#table-of-contents)\n\n---\n\n## Debugging\n\nThere are at least three ways to debug the operation of `request`:\n\n1. Launch the node process like `NODE_DEBUG=request node script.js`\n (`lib,request,otherlib` works too).\n\n2. Set `require('request').debug = true` at any time (this does the same thing\n as #1).\n\n3. Use the [request-debug module](https://github.com/request/request-debug) to\n view request and response headers and bodies.\n\n[back to top](#table-of-contents)\n\n---\n\n## Timeouts\n\nMost requests to external servers should have a timeout attached, in case the\nserver is not responding in a timely manner. Without a timeout, your code may\nhave a socket open/consume resources for minutes or more.\n\nThere are two main types of timeouts: **connection timeouts** and **read\ntimeouts**. A connect timeout occurs if the timeout is hit while your client is\nattempting to establish a connection to a remote machine (corresponding to the\n[connect() call][connect] on the socket). A read timeout occurs any time the\nserver is too slow to send back a part of the response.\n\nThese two situations have widely different implications for what went wrong\nwith the request, so it's useful to be able to distinguish them. You can detect\ntimeout errors by checking `err.code` for an 'ETIMEDOUT' value. Further, you\ncan detect whether the timeout was a connection timeout by checking if the\n`err.connect` property is set to `true`.\n\n```js\nrequest.get('http://10.255.255.1', {timeout: 1500}, function(err) {\n console.log(err.code === 'ETIMEDOUT');\n // Set to `true` if the timeout was a connection timeout, `false` or\n // `undefined` otherwise.\n console.log(err.connect === true);\n process.exit(0);\n});\n```\n\n[connect]: http://linux.die.net/man/2/connect\n\n## Examples:\n\n```js\n const request = require('request')\n , rand = Math.floor(Math.random()*100000000).toString()\n ;\n request(\n { method: 'PUT'\n , uri: 'http://mikeal.iriscouch.com/testjs/' + rand\n , multipart:\n [ { 'content-type': 'application/json'\n , body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}})\n }\n , { body: 'I am an attachment' }\n ]\n }\n , function (error, response, body) {\n if(response.statusCode == 201){\n console.log('document saved as: http://mikeal.iriscouch.com/testjs/'+ rand)\n } else {\n console.log('error: '+ response.statusCode)\n console.log(body)\n }\n }\n )\n```\n\nFor backwards-compatibility, response compression is not supported by default.\nTo accept gzip-compressed responses, set the `gzip` option to `true`. Note\nthat the body data passed through `request` is automatically decompressed\nwhile the response object is unmodified and will contain compressed data if\nthe server sent a compressed response.\n\n```js\n const request = require('request')\n request(\n { method: 'GET'\n , uri: 'http://www.google.com'\n , gzip: true\n }\n , function (error, response, body) {\n // body is the decompressed response body\n console.log('server encoded the data as: ' + (response.headers['content-encoding'] || 'identity'))\n console.log('the decoded data is: ' + body)\n }\n )\n .on('data', function(data) {\n // decompressed data as it is received\n console.log('decoded chunk: ' + data)\n })\n .on('response', function(response) {\n // unmodified http.IncomingMessage object\n response.on('data', function(data) {\n // compressed data as it is received\n console.log('received ' + data.length + ' bytes of compressed data')\n })\n })\n```\n\nCookies are disabled by default (else, they would be used in subsequent requests). To enable cookies, set `jar` to `true` (either in `defaults` or `options`).\n\n```js\nconst request = request.defaults({jar: true})\nrequest('http://www.google.com', function () {\n request('http://images.google.com')\n})\n```\n\nTo use a custom cookie jar (instead of `request`’s global cookie jar), set `jar` to an instance of `request.jar()` (either in `defaults` or `options`)\n\n```js\nconst j = request.jar()\nconst request = request.defaults({jar:j})\nrequest('http://www.google.com', function () {\n request('http://images.google.com')\n})\n```\n\nOR\n\n```js\nconst j = request.jar();\nconst cookie = request.cookie('key1=value1');\nconst url = 'http://www.google.com';\nj.setCookie(cookie, url);\nrequest({url: url, jar: j}, function () {\n request('http://images.google.com')\n})\n```\n\nTo use a custom cookie store (such as a\n[`FileCookieStore`](https://github.com/mitsuru/tough-cookie-filestore)\nwhich supports saving to and restoring from JSON files), pass it as a parameter\nto `request.jar()`:\n\n```js\nconst FileCookieStore = require('tough-cookie-filestore');\n// NOTE - currently the 'cookies.json' file must already exist!\nconst j = request.jar(new FileCookieStore('cookies.json'));\nrequest = request.defaults({ jar : j })\nrequest('http://www.google.com', function() {\n request('http://images.google.com')\n})\n```\n\nThe cookie store must be a\n[`tough-cookie`](https://github.com/SalesforceEng/tough-cookie)\nstore and it must support synchronous operations; see the\n[`CookieStore` API docs](https://github.com/SalesforceEng/tough-cookie#api)\nfor details.\n\nTo inspect your cookie jar after a request:\n\n```js\nconst j = request.jar()\nrequest({url: 'http://www.google.com', jar: j}, function () {\n const cookie_string = j.getCookieString(url); // \"key1=value1; key2=value2; ...\"\n const cookies = j.getCookies(url);\n // [{key: 'key1', value: 'value1', domain: \"www.google.com\", ...}, ...]\n})\n```\n\n[back to top](#table-of-contents)\n# to-arraybuffer [](https://travis-ci.org/jhiesey/to-arraybuffer)\n\n[](https://saucelabs.com/u/to-arraybuffer)\n\nConvert from a Buffer to an ArrayBuffer as fast as possible.\n\nNote that in some cases the returned ArrayBuffer is backed by the same memory as the original\nBuffer (but in other cases it is a copy), so **modifying the ArrayBuffer is not recommended**.\n\nThis module is designed to work both in node.js and in all browsers with ArrayBuffer support\nwhen using [the Buffer implementation provided by Browserify](https://www.npmjs.com/package/buffer).\n\n## Usage\n\n``` js\nvar toArrayBuffer = require('to-arraybuffer')\n\nvar buffer = new Buffer(100)\n// Fill the buffer with some data\n\nvar ab = toArrayBuffer(buffer)\n// `ab` now contains the same data as `buffer`\n```\n\n## License\n\nMIT\nsymbol-tree\n===========\n[](https://travis-ci.org/jsdom/js-symbol-tree) [](https://coveralls.io/github/jsdom/js-symbol-tree?branch=master)\n\nTurn any collection of objects into its own efficient tree or linked list using `Symbol`.\n\nThis library has been designed to provide an efficient backing data structure for DOM trees. You can also use this library as an efficient linked list. Any meta data is stored on your objects directly, which ensures any kind of insertion or deletion is performed in constant time. Because an ES6 `Symbol` is used, the meta data does not interfere with your object in any way.\n\nNode.js 4+, io.js and modern browsers are supported.\n\nExample\n-------\nA linked list:\n\n```javascript\nconst SymbolTree = require('symbol-tree');\nconst tree = new SymbolTree();\n\nlet a = {foo: 'bar'}; // or `new Whatever()`\nlet b = {foo: 'baz'};\nlet c = {foo: 'qux'};\n\ntree.insertBefore(b, a); // insert a before b\ntree.insertAfter(b, c); // insert c after b\n\nconsole.log(tree.nextSibling(a) === b);\nconsole.log(tree.nextSibling(b) === c);\nconsole.log(tree.previousSibling(c) === b);\n\ntree.remove(b);\nconsole.log(tree.nextSibling(a) === c);\n```\n\nA tree:\n\n```javascript\nconst SymbolTree = require('symbol-tree');\nconst tree = new SymbolTree();\n\nlet parent = {};\nlet a = {};\nlet b = {};\nlet c = {};\n\ntree.prependChild(parent, a); // insert a as the first child\ntree.appendChild(parent,c ); // insert c as the last child\ntree.insertAfter(a, b); // insert b after a, it now has the same parent as a\n\nconsole.log(tree.firstChild(parent) === a);\nconsole.log(tree.nextSibling(tree.firstChild(parent)) === b);\nconsole.log(tree.lastChild(parent) === c);\n\nlet grandparent = {};\ntree.prependChild(grandparent, parent);\nconsole.log(tree.firstChild(tree.firstChild(grandparent)) === a);\n```\n\nSee [api.md](api.md) for more documentation.\n\nTesting\n-------\nMake sure you install the dependencies first:\n\n npm install\n\nYou can now run the unit tests by executing:\n\n npm test\n\nThe line and branch coverage should be 100%.\n\nAPI Documentation\n-----------------\n<a name=\"module_symbol-tree\"></a>\n\n## symbol-tree\n**Author**: Joris van der Wel <joris@jorisvanderwel.com> \n\n* [symbol-tree](#module_symbol-tree)\n * [SymbolTree](#exp_module_symbol-tree--SymbolTree) ⏏\n * [new SymbolTree([description])](#new_module_symbol-tree--SymbolTree_new)\n * [.initialize(object)](#module_symbol-tree--SymbolTree+initialize) ⇒ <code>Object</code>\n * [.hasChildren(object)](#module_symbol-tree--SymbolTree+hasChildren) ⇒ <code>Boolean</code>\n * [.firstChild(object)](#module_symbol-tree--SymbolTree+firstChild) ⇒ <code>Object</code>\n * [.lastChild(object)](#module_symbol-tree--SymbolTree+lastChild) ⇒ <code>Object</code>\n * [.previousSibling(object)](#module_symbol-tree--SymbolTree+previousSibling) ⇒ <code>Object</code>\n * [.nextSibling(object)](#module_symbol-tree--SymbolTree+nextSibling) ⇒ <code>Object</code>\n * [.parent(object)](#module_symbol-tree--SymbolTree+parent) ⇒ <code>Object</code>\n * [.lastInclusiveDescendant(object)](#module_symbol-tree--SymbolTree+lastInclusiveDescendant) ⇒ <code>Object</code>\n * [.preceding(object, [options])](#module_symbol-tree--SymbolTree+preceding) ⇒ <code>Object</code>\n * [.following(object, [options])](#module_symbol-tree--SymbolTree+following) ⇒ <code>Object</code>\n * [.childrenToArray(parent, [options])](#module_symbol-tree--SymbolTree+childrenToArray) ⇒ <code>Array.<Object></code>\n * [.ancestorsToArray(object, [options])](#module_symbol-tree--SymbolTree+ancestorsToArray) ⇒ <code>Array.<Object></code>\n * [.treeToArray(root, [options])](#module_symbol-tree--SymbolTree+treeToArray) ⇒ <code>Array.<Object></code>\n * [.childrenIterator(parent, [options])](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>\n * [.previousSiblingsIterator(object)](#module_symbol-tree--SymbolTree+previousSiblingsIterator) ⇒ <code>Object</code>\n * [.nextSiblingsIterator(object)](#module_symbol-tree--SymbolTree+nextSiblingsIterator) ⇒ <code>Object</code>\n * [.ancestorsIterator(object)](#module_symbol-tree--SymbolTree+ancestorsIterator) ⇒ <code>Object</code>\n * [.treeIterator(root, options)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>\n * [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>\n * [.childrenCount(parent)](#module_symbol-tree--SymbolTree+childrenCount) ⇒ <code>Number</code>\n * [.compareTreePosition(left, right)](#module_symbol-tree--SymbolTree+compareTreePosition) ⇒ <code>Number</code>\n * [.remove(removeObject)](#module_symbol-tree--SymbolTree+remove) ⇒ <code>Object</code>\n * [.insertBefore(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertBefore) ⇒ <code>Object</code>\n * [.insertAfter(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertAfter) ⇒ <code>Object</code>\n * [.prependChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+prependChild) ⇒ <code>Object</code>\n * [.appendChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+appendChild) ⇒ <code>Object</code>\n\n<a name=\"exp_module_symbol-tree--SymbolTree\"></a>\n\n### SymbolTree ⏏\n**Kind**: Exported class \n<a name=\"new_module_symbol-tree--SymbolTree_new\"></a>\n\n#### new SymbolTree([description])\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [description] | <code>string</code> | <code>"'SymbolTree data'"</code> | Description used for the Symbol |\n\n<a name=\"module_symbol-tree--SymbolTree+initialize\"></a>\n\n#### symbolTree.initialize(object) ⇒ <code>Object</code>\nYou can use this function to (optionally) initialize an object right after its creation,\nto take advantage of V8's fast properties. Also useful if you would like to\nfreeze your object.\n\n`O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - object \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+hasChildren\"></a>\n\n#### symbolTree.hasChildren(object) ⇒ <code>Boolean</code>\nReturns `true` if the object has any children. Otherwise it returns `false`.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+firstChild\"></a>\n\n#### symbolTree.firstChild(object) ⇒ <code>Object</code>\nReturns the first child of the given object.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+lastChild\"></a>\n\n#### symbolTree.lastChild(object) ⇒ <code>Object</code>\nReturns the last child of the given object.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+previousSibling\"></a>\n\n#### symbolTree.previousSibling(object) ⇒ <code>Object</code>\nReturns the previous sibling of the given object.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+nextSibling\"></a>\n\n#### symbolTree.nextSibling(object) ⇒ <code>Object</code>\nReturns the next sibling of the given object.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+parent\"></a>\n\n#### symbolTree.parent(object) ⇒ <code>Object</code>\nReturn the parent of the given object.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+lastInclusiveDescendant\"></a>\n\n#### symbolTree.lastInclusiveDescendant(object) ⇒ <code>Object</code>\nFind the inclusive descendant that is last in tree order of the given object.\n\n* `O(n)` (worst case) where `n` is the depth of the subtree of `object`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+preceding\"></a>\n\n#### symbolTree.preceding(object, [options]) ⇒ <code>Object</code>\nFind the preceding object (A) of the given object (B).\nAn object A is preceding an object B if A and B are in the same tree\nand A comes before B in tree order.\n\n* `O(n)` (worst case)\n* `O(1)` (amortized when walking the entire tree)\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| object | <code>Object</code> | |\n| [options] | <code>Object</code> | |\n| [options.root] | <code>Object</code> | If set, `root` must be an inclusive ancestor of the return value (or else null is returned). This check _assumes_ that `root` is also an inclusive ancestor of the given `object` |\n\n<a name=\"module_symbol-tree--SymbolTree+following\"></a>\n\n#### symbolTree.following(object, [options]) ⇒ <code>Object</code>\nFind the following object (A) of the given object (B).\nAn object A is following an object B if A and B are in the same tree\nand A comes after B in tree order.\n\n* `O(n)` (worst case) where `n` is the amount of objects in the entire tree\n* `O(1)` (amortized when walking the entire tree)\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| object | <code>Object</code> | | |\n| [options] | <code>Object</code> | | |\n| [options.root] | <code>Object</code> | | If set, `root` must be an inclusive ancestor of the return value (or else null is returned). This check _assumes_ that `root` is also an inclusive ancestor of the given `object` |\n| [options.skipChildren] | <code>Boolean</code> | <code>false</code> | If set, ignore the children of `object` |\n\n<a name=\"module_symbol-tree--SymbolTree+childrenToArray\"></a>\n\n#### symbolTree.childrenToArray(parent, [options]) ⇒ <code>Array.<Object></code>\nAppend all children of the given object to an array.\n\n* `O(n)` where `n` is the amount of children of the given `parent`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| parent | <code>Object</code> | | |\n| [options] | <code>Object</code> | | |\n| [options.array] | <code>Array.<Object></code> | <code>[]</code> | |\n| [options.filter] | <code>function</code> | | Function to test each object before it is added to the array. Invoked with arguments (object). Should return `true` if an object is to be included. |\n| [options.thisArg] | <code>\\*</code> | | Value to use as `this` when executing `filter`. |\n\n<a name=\"module_symbol-tree--SymbolTree+ancestorsToArray\"></a>\n\n#### symbolTree.ancestorsToArray(object, [options]) ⇒ <code>Array.<Object></code>\nAppend all inclusive ancestors of the given object to an array.\n\n* `O(n)` where `n` is the amount of ancestors of the given `object`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| object | <code>Object</code> | | |\n| [options] | <code>Object</code> | | |\n| [options.array] | <code>Array.<Object></code> | <code>[]</code> | |\n| [options.filter] | <code>function</code> | | Function to test each object before it is added to the array. Invoked with arguments (object). Should return `true` if an object is to be included. |\n| [options.thisArg] | <code>\\*</code> | | Value to use as `this` when executing `filter`. |\n\n<a name=\"module_symbol-tree--SymbolTree+treeToArray\"></a>\n\n#### symbolTree.treeToArray(root, [options]) ⇒ <code>Array.<Object></code>\nAppend all descendants of the given object to an array (in tree order).\n\n* `O(n)` where `n` is the amount of objects in the sub-tree of the given `object`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| root | <code>Object</code> | | |\n| [options] | <code>Object</code> | | |\n| [options.array] | <code>Array.<Object></code> | <code>[]</code> | |\n| [options.filter] | <code>function</code> | | Function to test each object before it is added to the array. Invoked with arguments (object). Should return `true` if an object is to be included. |\n| [options.thisArg] | <code>\\*</code> | | Value to use as `this` when executing `filter`. |\n\n<a name=\"module_symbol-tree--SymbolTree+childrenIterator\"></a>\n\n#### symbolTree.childrenIterator(parent, [options]) ⇒ <code>Object</code>\nIterate over all children of the given object\n\n* `O(1)` for a single iteration\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - An iterable iterator (ES6) \n\n| Param | Type | Default |\n| --- | --- | --- |\n| parent | <code>Object</code> | | \n| [options] | <code>Object</code> | | \n| [options.reverse] | <code>Boolean</code> | <code>false</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+previousSiblingsIterator\"></a>\n\n#### symbolTree.previousSiblingsIterator(object) ⇒ <code>Object</code>\nIterate over all the previous siblings of the given object. (in reverse tree order)\n\n* `O(1)` for a single iteration\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - An iterable iterator (ES6) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+nextSiblingsIterator\"></a>\n\n#### symbolTree.nextSiblingsIterator(object) ⇒ <code>Object</code>\nIterate over all the next siblings of the given object. (in tree order)\n\n* `O(1)` for a single iteration\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - An iterable iterator (ES6) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+ancestorsIterator\"></a>\n\n#### symbolTree.ancestorsIterator(object) ⇒ <code>Object</code>\nIterate over all inclusive ancestors of the given object\n\n* `O(1)` for a single iteration\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - An iterable iterator (ES6) \n\n| Param | Type |\n| --- | --- |\n| object | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+treeIterator\"></a>\n\n#### symbolTree.treeIterator(root, options) ⇒ <code>Object</code>\nIterate over all descendants of the given object (in tree order).\n\nWhere `n` is the amount of objects in the sub-tree of the given `root`:\n\n* `O(n)` (worst case for a single iteration)\n* `O(n)` (amortized, when completing the iterator)\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - An iterable iterator (ES6) \n\n| Param | Type | Default |\n| --- | --- | --- |\n| root | <code>Object</code> | | \n| options | <code>Object</code> | | \n| [options.reverse] | <code>Boolean</code> | <code>false</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+index\"></a>\n\n#### symbolTree.index(child) ⇒ <code>Number</code>\nFind the index of the given object (the number of preceding siblings).\n\n* `O(n)` where `n` is the amount of preceding siblings\n* `O(1)` (amortized, if the tree is not modified)\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Number</code> - The number of preceding siblings, or -1 if the object has no parent \n\n| Param | Type |\n| --- | --- |\n| child | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+childrenCount\"></a>\n\n#### symbolTree.childrenCount(parent) ⇒ <code>Number</code>\nCalculate the number of children.\n\n* `O(n)` where `n` is the amount of children\n* `O(1)` (amortized, if the tree is not modified)\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| parent | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+compareTreePosition\"></a>\n\n#### symbolTree.compareTreePosition(left, right) ⇒ <code>Number</code>\nCompare the position of an object relative to another object. A bit set is returned:\n\n<ul>\n <li>DISCONNECTED : 1</li>\n <li>PRECEDING : 2</li>\n <li>FOLLOWING : 4</li>\n <li>CONTAINS : 8</li>\n <li>CONTAINED_BY : 16</li>\n</ul>\n\nThe semantics are the same as compareDocumentPosition in DOM, with the exception that\nDISCONNECTED never occurs with any other bit.\n\nwhere `n` and `m` are the amount of ancestors of `left` and `right`;\nwhere `o` is the amount of children of the lowest common ancestor of `left` and `right`:\n\n* `O(n + m + o)` (worst case)\n* `O(n + m)` (amortized, if the tree is not modified)\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n\n| Param | Type |\n| --- | --- |\n| left | <code>Object</code> | \n| right | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+remove\"></a>\n\n#### symbolTree.remove(removeObject) ⇒ <code>Object</code>\nRemove the object from this tree.\nHas no effect if already removed.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - removeObject \n\n| Param | Type |\n| --- | --- |\n| removeObject | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+insertBefore\"></a>\n\n#### symbolTree.insertBefore(referenceObject, newObject) ⇒ <code>Object</code>\nInsert the given object before the reference object.\n`newObject` is now the previous sibling of `referenceObject`.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - newObject \n**Throws**:\n\n- <code>Error</code> If the newObject is already present in this SymbolTree\n\n| Param | Type |\n| --- | --- |\n| referenceObject | <code>Object</code> | \n| newObject | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+insertAfter\"></a>\n\n#### symbolTree.insertAfter(referenceObject, newObject) ⇒ <code>Object</code>\nInsert the given object after the reference object.\n`newObject` is now the next sibling of `referenceObject`.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - newObject \n**Throws**:\n\n- <code>Error</code> If the newObject is already present in this SymbolTree\n\n| Param | Type |\n| --- | --- |\n| referenceObject | <code>Object</code> | \n| newObject | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+prependChild\"></a>\n\n#### symbolTree.prependChild(referenceObject, newObject) ⇒ <code>Object</code>\nInsert the given object as the first child of the given reference object.\n`newObject` is now the first child of `referenceObject`.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - newObject \n**Throws**:\n\n- <code>Error</code> If the newObject is already present in this SymbolTree\n\n| Param | Type |\n| --- | --- |\n| referenceObject | <code>Object</code> | \n| newObject | <code>Object</code> | \n\n<a name=\"module_symbol-tree--SymbolTree+appendChild\"></a>\n\n#### symbolTree.appendChild(referenceObject, newObject) ⇒ <code>Object</code>\nInsert the given object as the last child of the given reference object.\n`newObject` is now the last child of `referenceObject`.\n\n* `O(1)`\n\n**Kind**: instance method of [<code>SymbolTree</code>](#exp_module_symbol-tree--SymbolTree) \n**Returns**: <code>Object</code> - newObject \n**Throws**:\n\n- <code>Error</code> If the newObject is already present in this SymbolTree\n\n| Param | Type |\n| --- | --- |\n| referenceObject | <code>Object</code> | \n| newObject | <code>Object</code> |\n# htmlnano\n[](http://badge.fury.io/js/htmlnano)\n[](https://travis-ci.org/posthtml/htmlnano)\n\nModular HTML minifier, built on top of the [PostHTML](https://github.com/posthtml/posthtml). Inspired by [cssnano](http://cssnano.co/).\n\n> The author of htmlnano is available for hire as a full stack web developer: https://kirillmaltsev.net/services\n\n## [Benchmark](https://github.com/maltsev/html-minifiers-benchmark/blob/master/README.md)\n[html-minifier@3.5.20]: https://www.npmjs.com/package/html-minifier\n[htmlnano@0.2.0]: https://www.npmjs.com/package/htmlnano\n\n| Website | Source (KB) | [html-minifier@3.5.20] | [htmlnano@0.2.0] |\n|---------|------------:|----------------:|-----------:|\n| [stackoverflow.com](http://stackoverflow.com/) | 258 | 205 | 218 |\n| [github.com](http://github.com/) | 63 | 51 | 56 |\n| [en.wikipedia.org](https://en.wikipedia.org/wiki/Main_Page) | 77 | 69 | 74 |\n| [npmjs.com](https://www.npmjs.com/features) | 32 | 29 | 30 |\n| **Avg. minify rate** | 0% | **15%** | **9%** |\n\n## Usage\n### Gulp\n```bash\nnpm install --save-dev gulp-htmlnano\n```\n\n```js\nconst gulp = require('gulp');\nconst htmlnano = require('gulp-htmlnano');\nconst options = {\n removeComments: false\n};\n\ngulp.task('default', function() {\n return gulp\n .src('./index.html')\n .pipe(htmlnano(options))\n .pipe(gulp.dest('./build'));\n});\n```\n\n### Javascript\n```js\nconst htmlnano = require('htmlnano');\nconst options = {\n removeEmptyAttributes: false, // Disable the module \"removeEmptyAttributes\"\n collapseWhitespace: 'conservative' // Pass options to the module \"collapseWhitespace\"\n};\n// posthtml, posthtml-render, and posthtml-parse options\nconst postHtmlOptions = {\n sync: true, // https://github.com/posthtml/posthtml#usage\n lowerCaseTags: true, // https://github.com/posthtml/posthtml-parser#options\n quoteAllAttributes: false, // https://github.com/posthtml/posthtml-render#options\n};\n\nhtmlnano\n // \"preset\" arg might be skipped (see \"Presets\" section below for more info)\n // \"postHtmlOptions\" arg might be skipped\n .process(html, options, preset, postHtmlOptions)\n .then(function (result) {\n // result.html is minified\n })\n .catch(function (err) {\n console.error(err);\n });\n```\n\n### PostHTML\nJust add `htmlnano` as a final plugin:\n```js\nconst posthtml = require('posthtml');\nconst options = {\n removeComments: false, // Disable the module \"removeComments\"\n collapseWhitespace: 'conservative' // Pass options to the module \"collapseWhitespace\"\n};\nconst posthtmlPlugins = [\n /* other PostHTML plugins */\n\n require('htmlnano')(options)\n];\n\nconst postHtmlOptions = {\n // See PostHTML docs\n};\n\nposthtml(posthtmlPlugins)\n .process(html, posthtmlOptions)\n .then(function (result) {\n // result.html is minified\n })\n .catch(function (err) {\n console.error(err);\n });\n```\n\n## Presets\nA preset is just an object with modules config.\n\nCurrently the following presets are available:\n- [safe](https://github.com/posthtml/htmlnano/blob/master/lib/presets/safe.es6) — a default preset for minifying a regular HTML in a safe way (without breaking anything)\n- [ampSafe](https://github.com/posthtml/htmlnano/blob/master/lib/presets/ampSafe.es6) - same as `safe` preset but for [AMP pages](https://www.ampproject.org/)\n- [max](https://github.com/posthtml/htmlnano/blob/master/lib/presets/max.es6) - maximal minification (might break some pages)\n\nYou can use them the following way:\n```js\nconst htmlnano = require('htmlnano');\nconst ampSafePreset = require('htmlnano').presets.ampSafe;\nconst options = {\n // Your options\n};\n\nhtmlnano\n .process(html, options, ampSafePreset)\n .then(function (result) {\n // result.html is minified\n })\n .catch(function (err) {\n console.error(err);\n });\n```\n\nIf you skip `preset` argument [`safe`](https://github.com/posthtml/htmlnano/blob/master/lib/presets/safe.es6) preset would be used by default.\n\nIf you'd like to define your very own config without any presets pass an empty object as a preset:\n```js\nconst htmlnano = require('htmlnano');\nconst options = {\n // Your options\n};\n\nhtmlnano\n .process(html, options, {})\n .then(function (result) {\n // result.html is minified\n })\n .catch(function (err) {\n console.error(err);\n });\n```\n\nYou might create also your own presets:\n```js\nconst htmlnano = require('htmlnano');\n// Preset for minifying email templates\nconst emailPreset = {\n mergeStyles: true,\n minifyCss: {\n safe: true\n },\n};\n\nconst options = {\n // Some specific options\n};\n\nhtmlnano\n .process(html, options, emailPreset)\n .then(function (result) {\n // result.html is minified\n })\n .catch(function (err) {\n console.error(err);\n });\n```\n\nFeel free [to submit a PR](https://github.com/posthtml/htmlnano/issues/new) with your preset if it might be useful for other developers as well.\n\n## Modules\nBy default the modules should only perform safe transforms, see the module documentation below for details.\nYou can disable modules by passing `false` as option, and enable them by passing `true`.\n\n### collapseAttributeWhitespace\nCollapse redundant white spaces in list-like attributes (`class`, `rel`, `ping`).\n\n##### Example\nSource:\n```html\n<div class=\" content page \"></div>\n```\n\nMinified:\n```html\n<div class=\"content page\"></div>\n```\n\n### collapseWhitespace\nCollapses redundant white spaces (including new lines). It doesn’t affect white spaces in the elements `<style>`, `<textarea>`, `<script>` and `<pre>`.\n\n##### Options\n- `conservative` — collapses all redundant white spaces to 1 space (default)\n- `all` — collapses all redundant white spaces\n\n##### Side effects\n`<i>hello</i> <i>world</i>` after minification will be rendered as `helloworld`.\nTo prevent that use `conservative` option (this is the default option).\n\n##### Example\nSource:\n```html\n<div>\n hello world!\n <style>div { color: red; } </style>\n</div>\n```\n\nMinified (with `all`):\n```html\n<div>hello world!<style>div { color: red; } </style></div>\n```\n\nMinified (with `conservative`):\n```html\n<div> hello world! <style>div { color: red; } </style> </div>\n```\n\n### deduplicateAttributeValues\nRemove duplicate values from list-like attributes (`class`, `rel`, `ping`).\n\n##### Example\nSource:\n```html\n<div class=\"sidebar left sidebar\"></div>\n```\n\nMinified:\n```html\n<div class=\"sidebar left\"></div>\n```\n\n### removeComments\n##### Options\n- `safe` – removes all HTML comments except the conditional comments and [`<!--noindex--><!--/noindex-->`](https://yandex.com/support/webmaster/controlling-robot/html.xml) (default)\n- `all` — removes all HTML comments\n\n##### Example\nSource:\n```html\n<div><!-- test --></div>\n```\n\nMinified:\n```html\n<div></div>\n```\n\n### removeEmptyAttributes\nRemoves empty [safe-to-remove](https://github.com/posthtml/htmlnano/blob/master/lib/modules/removeEmptyAttributes.es6) attributes.\n\n##### Side effects\nThis module could break your styles or JS if you use selectors with attributes:\n```CSS\nimg[style=\"\"] {\n margin: 10px;\n}\n```\n\n##### Example\nSource:\n```html\n<img src=\"foo.jpg\" alt=\"\" style=\"\">\n```\n\nMinified:\n```html\n<img src=\"foo.jpg\" alt=\"\">\n```\n\n### removeUnusedCss\n\nRemoves unused CSS inside `<style>` tags with either [uncss](https://github.com/uncss/uncss)\nor [PurgeCSS](https://github.com/FullHuman/purgecss).\n\n#### With uncss\n\n##### Options\nSee [the documentation of uncss](https://github.com/uncss/uncss) for all supported options.\n\nuncss options can be passed directly to the `removeUnusedCss` module:\n```js\nhtmlnano.process(html, {\n removeUnusedCss: {\n ignore: ['.do-not-remove']\n }\n});\n```\n\nThe following uncss options are ignored if passed to the module:\n\n- `stylesheets`\n- `ignoreSheets`\n- `raw`\n\n#### With PurgeCSS\n\nUse PurgeCSS instead of uncss by adding `tool: 'purgeCSS'` to the options.\n\n##### Options\n\nSee [the documentation of PurgeCSS](https://www.purgecss.com) for all supported options.\n\nPurgeCSS options can be passed directly to the `removeUnusedCss` module:\n```js\nhtmlnano.process(html, {\n removeUnusedCss: {\n tool: 'purgeCSS',\n whitelist: ['.do-not-remove']\n }\n});\n```\n\nThe following PurgeCSS options are ignored if passed to the module:\n\n- `content`\n- `css`\n- `extractors`\n\n##### Example\nSource:\n```html\n<div class=\"b\">\n <style>\n .a {\n margin: 10px 10px 10px 10px;\n }\n .b {\n color: #ff0000;\n }\n </style>\n</div>\n```\n\nOptimized:\n```html\n<div class=\"b\">\n <style>\n .b {\n color: #ff0000;\n }\n </style>\n</div>\n```\n\n### minifyCss\nMinifies CSS with [cssnano](http://cssnano.co/) inside `<style>` tags and `style` attributes.\n\n##### Options\nSee [the documentation of cssnano](http://cssnano.co/optimisations/) for all supported optimizations.\nBy default CSS is minified with preset `default`, which shouldn't have any side-effects.\n\nTo use another preset or disabled some optimizations pass options to `minifyCss` module:\n```js\nhtmlnano.process(html, {\n minifyCss: {\n preset: ['default', {\n discardComments: {\n removeAll: true,\n },\n }]\n }\n});\n```\n\n##### Example\nSource:\n```html\n<div>\n <style>\n h1 {\n margin: 10px 10px 10px 10px;\n color: #ff0000;\n }\n </style>\n</div>\n```\n\nMinified:\n```html\n<div>\n <style>h1{margin:10px;color:red}</style>\n</div>\n```\n\n### minifyJs\nMinifies JS using [Terser](https://github.com/fabiosantoscode/terser) inside `<script>` tags.\n\n##### Options\nSee [the documentation of Terser](https://github.com/fabiosantoscode/terser#api-reference) for all supported options.\nTerser options can be passed directly to the `minifyJs` module:\n```js\nhtmlnano.process(html, {\n minifyJs: {\n output: { quote_style: 1 },\n },\n});\n```\n\n##### Example\nSource:\n```html\n<div>\n <script>\n /* comment */\n const foo = function () {\n\n };\n </script>\n</div>\n```\n\nMinified:\n```html\n<div>\n <script>const foo=function(){};</script>\n</div>\n```\n\n### minifyJson\nMinifies JSON inside `<script type=\"application/json\"></script>`.\n\n##### Example\nSource:\n```html\n<script type=\"application/json\">\n{\n \"user\": \"me\"\n}\n</script>\n```\n\nMinified:\n```html\n<script type=\"application/json\">{\"user\":\"me\"}</script>\n```\n\n### minifySvg\nMinifies SVG inside `<svg>` tags using [SVGO](https://github.com/svg/svgo/).\n\n##### Options\nSee [the documentation of SVGO](https://github.com/svg/svgo/blob/master/README.md) for all supported options.\nSVGO options can be passed directly to the `minifySvg` module:\n```js\nhtmlnano.process(html, {\n minifySvg: {\n plugins: [\n { collapseGroups: false },\n ],\n },\n});\n```\n\n##### Example\nSource:\n```html\n<svg version=\"1.1\" baseProfile=\"full\" width=\"300\" height=\"200\" xmlns=\"http://www.w3.org/2000/svg\">\n <rect width=\"100%\" height=\"100%\" fill=\"red\" />\n\n <circle cx=\"150\" cy=\"100\" r=\"80\" fill=\"green\" />\n\n <text x=\"150\" y=\"125\" font-size=\"60\" text-anchor=\"middle\" fill=\"white\">SVG</text>\n</svg>`\n```\n\nMinified:\n```html\n<svg baseProfile=\"full\" width=\"300\" height=\"200\" xmlns=\"http://www.w3.org/2000/svg\"><rect width=\"100%\" height=\"100%\" fill=\"red\"/><circle cx=\"150\" cy=\"100\" r=\"80\" fill=\"green\"/><text x=\"150\" y=\"125\" font-size=\"60\" text-anchor=\"middle\" fill=\"#fff\">SVG</text></svg>\n```\n\n### removeRedundantAttributes\nRemoves redundant attributes from tags if they contain default values:\n- `method=\"get\"` from `<form>`\n- `type=\"text\"` from `<input>`\n- `type=\"submit\"` from `<button>`\n- `language=\"javascript\"` and `type=\"text/javascript\"` from `<script>`\n- `charset` from `<script>` if it's an external script\n- `media=\"all\"` from `<style>` and `<link>`\n\n##### Options\nThis module is disabled by default, change option to true to enable this module.\n\n##### Side effects\nThis module could break your styles or JS if you use selectors with attributes:\n```CSS\nform[method=\"get\"] {\n color: red;\n}\n```\n\n##### Example\nSource:\n```html\n<form method=\"get\">\n <input type=\"text\">\n</form>\n```\n\nMinified:\n```html\n<form>\n <input>\n</form>\n```\n\n### collapseBooleanAttributes\nCollapses boolean attributes (like `disabled`) to the minimized form.\n\n##### Options\nIf your document uses [AMP](https://www.ampproject.org/), set the `amphtml` flag\nto collapse additonal, AMP-specific boolean attributes:\n```Json\n\"collapseBooleanAttributes\": {\n \"amphtml\": true\n}\n```\n\n##### Side effects\nThis module could break your styles or JS if you use selectors with attributes:\n```CSS\nbutton[disabled=\"disabled\"] {\n color: red;\n}\n```\n\n##### Example\nSource:\n```html\n<button disabled=\"disabled\">click</button>\n<script defer=\"\"></script>\n```\n\nMinified:\n```html\n<button disabled>click</button>\n<script defer></script>\n```\n\n### mergeStyles\nMerges multiple `<style>` with the same `media` and `type` into one tag.\n`<style scoped>...</style>` are skipped.\n\n##### Example\nSource:\n```html\n<style>h1 { color: red }</style>\n<style media=\"print\">div { color: blue }</style>\n\n<style type=\"text/css\" media=\"print\">a {}</style>\n<style>div { font-size: 20px }</style>\n```\n\nMinified:\n```html\n<style>h1 { color: red } div { font-size: 20px }</style>\n<style media=\"print\">div { color: blue } a {}</style>\n```\n\n### mergeScripts\nMerge multiple `<script>` with the same attributes (`id, class, type, async, defer`) into one (last) tag.\n\n##### Side effects\nIt could break your code if the tags with different attributes share the same variable scope.\nSee the example below.\n\n##### Example\nSource:\n```html\n<script>const foo = 'A:1';</script>\n<script class=\"test\">foo = 'B:1';</script>\n<script type=\"text/javascript\">foo = 'A:2';</script>\n<script defer>foo = 'C:1';</script>\n<script>foo = 'A:3';</script>\n<script defer=\"defer\">foo = 'C:2';</script>\n<script class=\"test\" type=\"text/javascript\">foo = 'B:2';</script>\n```\n\nMinified:\n```html\n<script>const foo = 'A:1'; foo = 'A:2'; foo = 'A:3';</script>\n<script defer=\"defer\">foo = 'C:1'; foo = 'C:2';</script>\n<script class=\"test\" type=\"text/javascript\">foo = 'B:1'; foo = 'B:2';</script>\n```\n\n### custom\nIt's also possible to pass custom modules in the minifier.\nAs a function:\n```js\nconst options = {\n custom: function (tree, options) {\n // Some minification\n return tree;\n }\n};\n```\n\nOr as a list of functions:\n```js\nconst options = {\n custom: [\n function (tree, options) {\n // Some minification\n return tree;\n },\n\n function (tree, options) {\n // Some other minification\n return tree;\n }\n ]\n};\n```\n\n`options` is an object with all options that were passed to the plugin.\n\n## Contribute\nSince the minifier is modular, it's very easy to add new modules:\n\n1. Create a ES6-file inside `lib/modules/` with a function that does some minification. For example you can check [`lib/modules/example.es6`](https://github.com/posthtml/htmlnano/blob/master/lib/modules/example.es6).\n\n2. Add the module in [the modules array](https://github.com/posthtml/htmlnano/blob/master/lib/htmlnano.es6#L5). The modules are applied from top to bottom. So you can choose the order for your module.\n\n3. Create a JS-file inside `test/modules/` with some unit-tests.\n\n4. Describe your module in the section \"[Modules](https://github.com/posthtml/htmlnano/blob/master/README.md#modules)\".\n\n5. Send me a pull request.\n\nOther types of contribution (bug fixes, documentation improves, etc) are also welcome!\nWould like to contribute, but don't have any ideas what to do? Check out [our issues](https://github.com/posthtml/htmlnano/labels/help%20wanted).\n<!-- TITLE/ -->\n\n<h1>domain-browser</h1>\n\n<!-- /TITLE -->\n\n<!-- BADGES/ -->\n\n<span class=\"badge-travisci\"><a href=\"http://travis-ci.org/bevry/domain-browser\" title=\"Check this project's build status on TravisCI\"><img src=\"https://img.shields.io/travis/bevry/domain-browser/master.svg\" alt=\"Travis CI Build Status\" /></a></span>\n<span class=\"badge-npmversion\"><a href=\"https://npmjs.org/package/domain-browser\" title=\"View this project on NPM\"><img src=\"https://img.shields.io/npm/v/domain-browser.svg\" alt=\"NPM version\" /></a></span>\n<span class=\"badge-npmdownloads\"><a href=\"https://npmjs.org/package/domain-browser\" title=\"View this project on NPM\"><img src=\"https://img.shields.io/npm/dm/domain-browser.svg\" alt=\"NPM downloads\" /></a></span>\n<span class=\"badge-daviddm\"><a href=\"https://david-dm.org/bevry/domain-browser\" title=\"View the status of this project's dependencies on DavidDM\"><img src=\"https://img.shields.io/david/bevry/domain-browser.svg\" alt=\"Dependency Status\" /></a></span>\n<span class=\"badge-daviddmdev\"><a href=\"https://david-dm.org/bevry/domain-browser#info=devDependencies\" title=\"View the status of this project's development dependencies on DavidDM\"><img src=\"https://img.shields.io/david/dev/bevry/domain-browser.svg\" alt=\"Dev Dependency Status\" /></a></span>\n<br class=\"badge-separator\" />\n<span class=\"badge-patreon\"><a href=\"https://patreon.com/bevry\" title=\"Donate to this project using Patreon\"><img src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /></a></span>\n<span class=\"badge-opencollective\"><a href=\"https://opencollective.com/bevry\" title=\"Donate to this project using Open Collective\"><img src=\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\" alt=\"Open Collective donate button\" /></a></span>\n<span class=\"badge-gratipay\"><a href=\"https://www.gratipay.com/bevry\" title=\"Donate weekly to this project using Gratipay\"><img src=\"https://img.shields.io/badge/gratipay-donate-yellow.svg\" alt=\"Gratipay donate button\" /></a></span>\n<span class=\"badge-flattr\"><a href=\"https://flattr.com/profile/balupton\" title=\"Donate to this project using Flattr\"><img src=\"https://img.shields.io/badge/flattr-donate-yellow.svg\" alt=\"Flattr donate button\" /></a></span>\n<span class=\"badge-paypal\"><a href=\"https://bevry.me/paypal\" title=\"Donate to this project using Paypal\"><img src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /></a></span>\n<span class=\"badge-bitcoin\"><a href=\"https://bevry.me/bitcoin\" title=\"Donate once-off to this project using Bitcoin\"><img src=\"https://img.shields.io/badge/bitcoin-donate-yellow.svg\" alt=\"Bitcoin donate button\" /></a></span>\n<span class=\"badge-wishlist\"><a href=\"https://bevry.me/wishlist\" title=\"Buy an item on our wishlist for us\"><img src=\"https://img.shields.io/badge/wishlist-donate-yellow.svg\" alt=\"Wishlist browse button\" /></a></span>\n<br class=\"badge-separator\" />\n<span class=\"badge-slackin\"><a href=\"https://slack.bevry.me\" title=\"Join this project's slack community\"><img src=\"https://slack.bevry.me/badge.svg\" alt=\"Slack community badge\" /></a></span>\n\n<!-- /BADGES -->\n\n<!-- DESCRIPTION/ -->\n\nNode's domain module for the web browser. This is merely an evented try...catch with the same API as node, nothing more.\n\n<!-- /DESCRIPTION -->\n\n<!-- INSTALL/ -->\n\n<h2>Install</h2>\n\n<a href=\"https://npmjs.com\" title=\"npm is a package manager for javascript\"><h3>NPM</h3></a><ul>\n<li>Install: <code>npm install --save domain-browser</code></li>\n<li>Module: <code>require('domain-browser')</code></li></ul>\n\n<a href=\"http://browserify.org\" title=\"Browserify lets you require('modules') in the browser by bundling up all of your dependencies\"><h3>Browserify</h3></a><ul>\n<li>Install: <code>npm install --save domain-browser</code></li>\n<li>Module: <code>require('domain-browser')</code></li>\n<li>CDN URL: <code>//wzrd.in/bundle/domain-browser@1.2.0</code></li></ul>\n\n<a href=\"http://enderjs.com\" title=\"Ender is a full featured package manager for your browser\"><h3>Ender</h3></a><ul>\n<li>Install: <code>ender add domain-browser</code></li>\n<li>Module: <code>require('domain-browser')</code></li></ul>\n\n<h3><a href=\"https://github.com/bevry/editions\" title=\"Editions are the best way to produce and consume packages you care about.\">Editions</a></h3>\n\n<p>This package is published with the following editions:</p>\n\n<ul><li><code>domain-browser</code> aliases <code>domain-browser/source/index.js</code></li>\n<li><code>domain-browser/source/index.js</code> is Source + ES5 + <a href=\"https://nodejs.org/dist/latest-v5.x/docs/api/modules.html\" title=\"Node/CJS Modules\">Require</a></li></ul>\n\n<!-- /INSTALL -->\n\n<!-- HISTORY/ -->\n\n<h2>History</h2>\n\n<a href=\"https://github.com/bevry/domain-browser/blob/master/HISTORY.md#files\">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>\n\n<!-- /HISTORY -->\n\n<!-- BACKERS/ -->\n\n<h2>Backers</h2>\n\n<h3>Maintainers</h3>\n\nThese amazing people are maintaining this project:\n\n<ul><li><a href=\"http://balupton.com\">Benjamin Lupton</a> — <a href=\"https://github.com/bevry/domain-browser/commits?author=balupton\" title=\"View the GitHub contributions of Benjamin Lupton on repository bevry/domain-browser\">view contributions</a></li></ul>\n\n<h3>Sponsors</h3>\n\nNo sponsors yet! Will you be the first?\n\n<span class=\"badge-patreon\"><a href=\"https://patreon.com/bevry\" title=\"Donate to this project using Patreon\"><img src=\"https://img.shields.io/badge/patreon-donate-yellow.svg\" alt=\"Patreon donate button\" /></a></span>\n<span class=\"badge-opencollective\"><a href=\"https://opencollective.com/bevry\" title=\"Donate to this project using Open Collective\"><img src=\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\" alt=\"Open Collective donate button\" /></a></span>\n<span class=\"badge-gratipay\"><a href=\"https://www.gratipay.com/bevry\" title=\"Donate weekly to this project using Gratipay\"><img src=\"https://img.shields.io/badge/gratipay-donate-yellow.svg\" alt=\"Gratipay donate button\" /></a></span>\n<span class=\"badge-flattr\"><a href=\"https://flattr.com/profile/balupton\" title=\"Donate to this project using Flattr\"><img src=\"https://img.shields.io/badge/flattr-donate-yellow.svg\" alt=\"Flattr donate button\" /></a></span>\n<span class=\"badge-paypal\"><a href=\"https://bevry.me/paypal\" title=\"Donate to this project using Paypal\"><img src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" alt=\"PayPal donate button\" /></a></span>\n<span class=\"badge-bitcoin\"><a href=\"https://bevry.me/bitcoin\" title=\"Donate once-off to this project using Bitcoin\"><img src=\"https://img.shields.io/badge/bitcoin-donate-yellow.svg\" alt=\"Bitcoin donate button\" /></a></span>\n<span class=\"badge-wishlist\"><a href=\"https://bevry.me/wishlist\" title=\"Buy an item on our wishlist for us\"><img src=\"https://img.shields.io/badge/wishlist-donate-yellow.svg\" alt=\"Wishlist browse button\" /></a></span>\n\n<h3>Contributors</h3>\n\nThese amazing people have contributed code to this project:\n\n<ul><li><a href=\"http://balupton.com\">Benjamin Lupton</a> — <a href=\"https://github.com/bevry/domain-browser/commits?author=balupton\" title=\"View the GitHub contributions of Benjamin Lupton on repository bevry/domain-browser\">view contributions</a></li>\n<li><a href=\"http://evansolomon.me\">Evan Solomon</a> — <a href=\"https://github.com/bevry/domain-browser/commits?author=evansolomon\" title=\"View the GitHub contributions of Evan Solomon on repository bevry/domain-browser\">view contributions</a></li>\n<li><a href=\"http://substack.neocities.org/\">James Halliday</a> — <a href=\"https://github.com/bevry/domain-browser/commits?author=substack\" title=\"View the GitHub contributions of James Halliday on repository bevry/domain-browser\">view contributions</a></li>\n<li><a href=\"twitter.com/guybedford\">Guy Bedford</a> — <a href=\"https://github.com/bevry/domain-browser/commits?author=guybedford\" title=\"View the GitHub contributions of Guy Bedford on repository bevry/domain-browser\">view contributions</a></li>\n<li><a href=\"https://github.com/TrySound\">Bogdan Chadkin</a> — <a href=\"https://github.com/bevry/domain-browser/commits?author=TrySound\" title=\"View the GitHub contributions of Bogdan Chadkin on repository bevry/domain-browser\">view contributions</a></li></ul>\n\n<a href=\"https://github.com/bevry/domain-browser/blob/master/CONTRIBUTING.md#files\">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>\n\n<!-- /BACKERS -->\n\n<!-- LICENSE/ -->\n\n<h2>License</h2>\n\nUnless stated otherwise all works are:\n\n<ul><li>Copyright © 2013+ <a href=\"http://bevry.me\">Bevry Pty Ltd</a></li></ul>\n\nand licensed under:\n\n<ul><li><a href=\"http://spdx.org/licenses/MIT.html\">MIT License</a></li></ul>\n\n<!-- /LICENSE -->\n# ASBuild\n\nA simple build tool for [AssemblyScript](https://assemblyscript.org) projects, similar to `cargo`, etc.\n\n## Usage\n```\nasb [entry file] [options] -- [args passed to asc]\n```\n\n### Background\n\nAssemblyScript greater than v0.14.4 provides a `asconfig.json` configuration file that can be used to describe the options for building a project. ASBuild uses this and some adds defaults to create an easier CLI interface.\n\n### Defaults\n\n#### Project structure\n\n```\nproject/\n package.json \n asconfig.json\n assembly/\n index.ts\n build/\n release/\n project.wasm\n debug/\n project.wasm\n```\n - If no entry file passed and no `entry` field is in `asconfig.json`, `project/assembly/index.ts` is assumed.\n - `asconfig.json` allows for options for different compile targets, e.g. release, debug, etc. `asc` defaults to the release target.\n - The default build directory is `./build`, and artifacts are placed at `./build/<target>/packageName.wasm`.\n\n### Workspaces\n\nIf a `workspace` field is added to a top level `asconfig.json` file, then each path in the array is built and placed into the top level `outDir`.\n\nFor example,\n\n`asconfig.json`:\n```json\n{\n \"workspace\": [\"a\", \"b\"]\n}\n```\n\nRunning `asb` in the directory below will use the top level build directory to place all the binaries.\n\n```\nproject/\n package.json\n asconfig.json\n a/\n asconfig.json\n assembly/\n index.ts\n b/\n asconfig.json\n assembly/\n index.ts\n build/\n release/\n a.wasm\n b.wasm\n debug/\n a.wasm\n b.wasm\n```\n\nTo see an example in action check out the [test workspace](./test)\n# node-is-arrayish [](https://travis-ci.org/Qix-/node-is-arrayish) [](https://coveralls.io/r/Qix-/node-is-arrayish)\n> Determines if an object can be used like an Array\n\n## Example\n```javascript\nvar isArrayish = require('is-arrayish');\n\nisArrayish([]); // true\nisArrayish({__proto__: []}); // true\nisArrayish({}); // false\nisArrayish({length:10}); // false\n```\n\n## License\nLicensed under the [MIT License](http://opensource.org/licenses/MIT).\nYou can find a copy of it in [LICENSE](LICENSE).\n# normalize-package-data [](https://travis-ci.org/npm/normalize-package-data)\n\nnormalize-package-data exports a function that normalizes package metadata. This data is typically found in a package.json file, but in principle could come from any source - for example the npm registry.\n\nnormalize-package-data is used by [read-package-json](https://npmjs.org/package/read-package-json) to normalize the data it reads from a package.json file. In turn, read-package-json is used by [npm](https://npmjs.org/package/npm) and various npm-related tools.\n\n## Installation\n\n```\nnpm install normalize-package-data\n```\n\n## Usage\n\nBasic usage is really simple. You call the function that normalize-package-data exports. Let's call it `normalizeData`.\n\n```javascript\nnormalizeData = require('normalize-package-data')\npackageData = require(\"./package.json\")\nnormalizeData(packageData)\n// packageData is now normalized\n```\n\n#### Strict mode\n\nYou may activate strict validation by passing true as the second argument.\n\n```javascript\nnormalizeData = require('normalize-package-data')\npackageData = require(\"./package.json\")\nnormalizeData(packageData, true)\n// packageData is now normalized\n```\n\nIf strict mode is activated, only Semver 2.0 version strings are accepted. Otherwise, Semver 1.0 strings are accepted as well. Packages must have a name, and the name field must not have contain leading or trailing whitespace.\n\n#### Warnings\n\nOptionally, you may pass a \"warning\" function. It gets called whenever the `normalizeData` function encounters something that doesn't look right. It indicates less than perfect input data.\n\n```javascript\nnormalizeData = require('normalize-package-data')\npackageData = require(\"./package.json\")\nwarnFn = function(msg) { console.error(msg) }\nnormalizeData(packageData, warnFn)\n// packageData is now normalized. Any number of warnings may have been logged.\n```\n\nYou may combine strict validation with warnings by passing `true` as the second argument, and `warnFn` as third.\n\nWhen `private` field is set to `true`, warnings will be suppressed.\n\n### Potential exceptions\n\nIf the supplied data has an invalid name or version vield, `normalizeData` will throw an error. Depending on where you call `normalizeData`, you may want to catch these errors so can pass them to a callback.\n\n## What normalization (currently) entails\n\n* The value of `name` field gets trimmed (unless in strict mode).\n* The value of the `version` field gets cleaned by `semver.clean`. See [documentation for the semver module](https://github.com/isaacs/node-semver).\n* If `name` and/or `version` fields are missing, they are set to empty strings.\n* If `files` field is not an array, it will be removed.\n* If `bin` field is a string, then `bin` field will become an object with `name` set to the value of the `name` field, and `bin` set to the original string value.\n* If `man` field is a string, it will become an array with the original string as its sole member.\n* If `keywords` field is string, it is considered to be a list of keywords separated by one or more white-space characters. It gets converted to an array by splitting on `\\s+`.\n* All people fields (`author`, `maintainers`, `contributors`) get converted into objects with name, email and url properties.\n* If `bundledDependencies` field (a typo) exists and `bundleDependencies` field does not, `bundledDependencies` will get renamed to `bundleDependencies`.\n* If the value of any of the dependencies fields (`dependencies`, `devDependencies`, `optionalDependencies`) is a string, it gets converted into an object with familiar `name=>value` pairs.\n* The values in `optionalDependencies` get added to `dependencies`. The `optionalDependencies` array is left untouched.\n* As of v2: Dependencies that point at known hosted git providers (currently: github, bitbucket, gitlab) will have their URLs canonicalized, but protocols will be preserved.\n* As of v2: Dependencies that use shortcuts for hosted git providers (`org/proj`, `github:org/proj`, `bitbucket:org/proj`, `gitlab:org/proj`, `gist:docid`) will have the shortcut left in place. (In the case of github, the `org/proj` form will be expanded to `github:org/proj`.) THIS MARKS A BREAKING CHANGE FROM V1, where the shorcut was previously expanded to a URL.\n* If `description` field does not exist, but `readme` field does, then (more or less) the first paragraph of text that's found in the readme is taken as value for `description`.\n* If `repository` field is a string, it will become an object with `url` set to the original string value, and `type` set to `\"git\"`.\n* If `repository.url` is not a valid url, but in the style of \"[owner-name]/[repo-name]\", `repository.url` will be set to git+https://github.com/[owner-name]/[repo-name].git\n* If `bugs` field is a string, the value of `bugs` field is changed into an object with `url` set to the original string value.\n* If `bugs` field does not exist, but `repository` field points to a repository hosted on GitHub, the value of the `bugs` field gets set to an url in the form of https://github.com/[owner-name]/[repo-name]/issues . If the repository field points to a GitHub Gist repo url, the associated http url is chosen.\n* If `bugs` field is an object, the resulting value only has email and url properties. If email and url properties are not strings, they are ignored. If no valid values for either email or url is found, bugs field will be removed.\n* If `homepage` field is not a string, it will be removed.\n* If the url in the `homepage` field does not specify a protocol, then http is assumed. For example, `myproject.org` will be changed to `http://myproject.org`.\n* If `homepage` field does not exist, but `repository` field points to a repository hosted on GitHub, the value of the `homepage` field gets set to an url in the form of https://github.com/[owner-name]/[repo-name]#readme . If the repository field points to a GitHub Gist repo url, the associated http url is chosen.\n\n### Rules for name field\n\nIf `name` field is given, the value of the name field must be a string. The string may not:\n\n* start with a period.\n* contain the following characters: `/@\\s+%`\n* contain any characters that would need to be encoded for use in urls.\n* resemble the word `node_modules` or `favicon.ico` (case doesn't matter).\n\n### Rules for version field\n\nIf `version` field is given, the value of the version field must be a valid *semver* string, as determined by the `semver.valid` method. See [documentation for the semver module](https://github.com/isaacs/node-semver).\n\n### Rules for license field\n\nThe `license` field should be a valid *SPDX license expression* or one of the special values allowed by [validate-npm-package-license](https://npmjs.com/package/validate-npm-package-license). See [documentation for the license field in package.json](https://docs.npmjs.com/files/package.json#license).\n\n## Credits\n\nThis package contains code based on read-package-json written by Isaac Z. Schlueter. Used with permisson.\n\n## License\n\nnormalize-package-data is released under the [BSD 2-Clause License](http://opensource.org/licenses/MIT). \nCopyright (c) 2013 Meryn Stol\n# axios // helpers\n\nThe modules found in `helpers/` should be generic modules that are _not_ specific to the domain logic of axios. These modules could theoretically be published to npm on their own and consumed by other modules or apps. Some examples of generic modules are things like:\n\n- Browser polyfills\n- Managing cookies\n- Parsing HTTP headers\n# [postcss][postcss]-discard-duplicates\n\n> Discard duplicate rules in your CSS files with PostCSS.\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-discard-duplicates) do:\n\n```\nnpm install postcss-discard-duplicates --save\n```\n\n## Example\n\nThis module will remove all duplicate rules from your stylesheets. It works on\nat rules, normal rules and declarations. Note that this module does not have any\nresponsibility for normalising declarations, selectors or whitespace, so that it\nconsiders these two rules to be different:\n\n```css\nh1, h2 {\n color: blue;\n}\n\nh2, h1 {\n color: blue;\n}\n```\n\nIt has to assume that your rules have already been transformed by another\nprocessor, otherwise it would be responsible for too many things.\n\n### Input\n\n```css\nh1 {\n margin: 0 auto;\n margin: 0 auto\n}\n\nh1 {\n margin: 0 auto\n}\n```\n\n### Output\n\n```css\nh1 {\n margin: 0 auto\n}\n```\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n[postcss]: https://github.com/postcss/postcss\n# cross-spawn\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]\n\n[npm-url]:https://npmjs.org/package/cross-spawn\n[downloads-image]:http://img.shields.io/npm/dm/cross-spawn.svg\n[npm-image]:http://img.shields.io/npm/v/cross-spawn.svg\n[travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn\n[travis-image]:http://img.shields.io/travis/moxystudio/node-cross-spawn/master.svg\n[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn\n[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg\n[codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn\n[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg\n[david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn\n[david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg\n[david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev\n[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.svg\n[greenkeeper-image]:https://badges.greenkeeper.io/moxystudio/node-cross-spawn.svg\n[greenkeeper-url]:https://greenkeeper.io/\n\nA cross platform solution to node's spawn and spawnSync.\n\n## Installation\n\n`$ npm install cross-spawn`\n\n## Why\n\nNode has issues when using spawn on Windows:\n\n- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318)\n- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix))\n- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367)\n- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`)\n- Has an [issue](https://github.com/moxystudio/node-cross-spawn/issues/82) with command shims (files in `node_modules/.bin/`), where arguments with quotes and parenthesis would result in [invalid syntax error](https://github.com/moxystudio/node-cross-spawn/blob/e77b8f22a416db46b6196767bcd35601d7e11d54/test/index.test.js#L149)\n- No `options.shell` support on node `<v4.8`\n\nAll these issues are handled correctly by `cross-spawn`.\nThere are some known modules, such as [win-spawn](https://github.com/ForbesLindesay/win-spawn), that try to solve this but they are either broken or provide faulty escaping of shell arguments.\n\n## Usage\n\nExactly the same way as node's [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) or [`spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options), so it's a drop in replacement.\n\n```js\nconst spawn = require('cross-spawn');\n\n// Spawn NPM asynchronously\nconst child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });\n\n// Spawn NPM synchronously\nconst result = spawn.sync('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' });\n```\n\n## Caveats\n\n### Using `options.shell` as an alternative to `cross-spawn`\n\nStarting from node `v4.8`, `spawn` has a `shell` option that allows you run commands from within a shell. This new option solves\nthe [PATHEXT](https://github.com/joyent/node/issues/2318) issue but:\n\n- It's not supported in node `<v4.8`\n- You must manually escape the command and arguments which is very error prone, specially when passing user input\n- There are a lot of other unresolved issues from the [Why](#why) section that you must take into account\n\nIf you are using the `shell` option to spawn a command in a cross platform way, consider using `cross-spawn` instead. You have been warned.\n\n### `options.shell` support\n\nWhile `cross-spawn` adds support for `options.shell` in node `<v4.8`, all of its enhancements are disabled.\n\nThis mimics the Node.js behavior. More specifically, the command and its arguments will not be automatically escaped nor shebang support will be offered. This is by design because if you are using `options.shell` you are probably targeting a specific platform anyway and you don't want things to get into your way.\n\n### Shebangs support\n\nWhile `cross-spawn` handles shebangs on Windows, its support is limited. More specifically, it just supports `#!/usr/bin/env <program>` where `<program>` must not contain any arguments. \nIf you would like to have the shebang support improved, feel free to contribute via a pull-request.\n\nRemember to always test your code on Windows!\n\n## Tests\n\n`$ npm test` \n`$ npm test -- --watch` during development\n\n## License\n\nReleased under the [MIT License](http://www.opensource.org/licenses/mit-license.php).\n# HAR Schema [![version][npm-version]][npm-url] [![License][npm-license]][license-url]\n\n> JSON Schema for HTTP Archive ([HAR][spec]).\n\n[![Build Status][travis-image]][travis-url]\n[![Downloads][npm-downloads]][npm-url]\n[![Code Climate][codeclimate-quality]][codeclimate-url]\n[![Coverage Status][codeclimate-coverage]][codeclimate-url]\n[![Dependency Status][dependencyci-image]][dependencyci-url]\n[![Dependencies][david-image]][david-url]\n\n## Install\n\n```bash\nnpm install --only=production --save har-schema\n```\n\n## Usage\n\nCompatible with any [JSON Schema validation tool][validator].\n\n----\n> :copyright: [ahmadnassri.com](https://www.ahmadnassri.com/) · \n> License: [ISC][license-url] · \n> Github: [@ahmadnassri](https://github.com/ahmadnassri) · \n> Twitter: [@ahmadnassri](https://twitter.com/ahmadnassri)\n\n[license-url]: http://choosealicense.com/licenses/isc/\n\n[travis-url]: https://travis-ci.org/ahmadnassri/har-schema\n[travis-image]: https://img.shields.io/travis/ahmadnassri/har-schema.svg?style=flat-square\n\n[npm-url]: https://www.npmjs.com/package/har-schema\n[npm-license]: https://img.shields.io/npm/l/har-schema.svg?style=flat-square\n[npm-version]: https://img.shields.io/npm/v/har-schema.svg?style=flat-square\n[npm-downloads]: https://img.shields.io/npm/dm/har-schema.svg?style=flat-square\n\n[codeclimate-url]: https://codeclimate.com/github/ahmadnassri/har-schema\n[codeclimate-quality]: https://img.shields.io/codeclimate/github/ahmadnassri/har-schema.svg?style=flat-square\n[codeclimate-coverage]: https://img.shields.io/codeclimate/coverage/github/ahmadnassri/har-schema.svg?style=flat-square\n\n[david-url]: https://david-dm.org/ahmadnassri/har-schema\n[david-image]: https://img.shields.io/david/ahmadnassri/har-schema.svg?style=flat-square\n\n[dependencyci-url]: https://dependencyci.com/github/ahmadnassri/har-schema\n[dependencyci-image]: https://dependencyci.com/github/ahmadnassri/har-schema/badge?style=flat-square\n\n[spec]: https://github.com/ahmadnassri/har-spec/blob/master/versions/1.2.md\n[validator]: https://github.com/ahmadnassri/har-validator\n# MDN data\n\n[https://github.com/mdn/data](https://github.com/mdn/data)\n\nMaintained by the [MDN team at Mozilla](https://wiki.mozilla.org/MDN).\n\nThis repository contains general data for Web technologies.\n\nThis data is used in MDN documentation, to build\n[information boxes](https://developer.mozilla.org/en-US/docs/Web/CSS/background)\nor [sidebar navigation](https://developer.mozilla.org/en-US/docs/Web/API/Window).\nExternal tools have started to make use of this data as well.\nFor example, the [CSSTree](https://github.com/csstree/csstree/) CSS parser.\n\n[](https://www.npmjs.com/package/mdn-data)\n[](https://travis-ci.org/mdn/data)\n\n## Repository contents\n\nThere's a top-level directory for each broad area covered: for example, \"api\",\n\"css\", \"svg\". Inside each of these directories is one or more\nJSON files containing the data.\n\n### api\nContains data about Web APIs:\n* API inheritance (interface inheritance and mixin implementations)\n\n### css\n Contains data about:\n* CSS at-rules\n* CSS properties\n* CSS selectors\n* CSS syntaxes\n* CSS types\n* CSS units\n\nRead more about [CSS data](https://github.com/mdn/data/blob/master/css/readme.md) and the format of the files.\n\n### l10n\nThe l10n folder contains localization strings that are used in the various\njson files throughout this repository.\n\n## Problems?\n\nIf you find a problem, please [file an issue](https://github.com/mdn/data/issues/new).\n\n## Contributing\n\nWe're very happy to accept contributions to this data. Please familiarize yourself\nwith the schema for the data you're editing, and send us a pull request. See also the [Contributing file](https://github.com/mdn/data/blob/master/CONTRIBUTING.md) for more information.\n\n## See also\n* [https://github.com/mdn/browser-compat-data](https://github.com/mdn/browser-compat-data)\nfor compatibility data for Web technologies.\n# to-regex-range [](https://www.npmjs.com/package/to-regex-range) [](https://npmjs.org/package/to-regex-range) [](https://npmjs.org/package/to-regex-range) [](https://travis-ci.org/micromatch/to-regex-range)\n\n> Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.78 million test assertions.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save to-regex-range\n```\n\nInstall with [yarn](https://yarnpkg.com):\n\n```sh\n$ yarn add to-regex-range\n```\n\n<details>\n<summary><strong>What does this do?</strong></summary>\n\n<br>\n\nThis libary generates the `source` string to be passed to `new RegExp()` for matching a range of numbers.\n\n**Example**\n\n```js\nvar toRegexRange = require('to-regex-range');\nvar regex = new RegExp(toRegexRange('15', '95'));\n```\n\nA string is returned so that you can do whatever you need with it before passing it to `new RegExp()` (like adding `^` or `$` boundaries, defining flags, or combining it another string).\n\n<br>\n\n</details>\n\n<details>\n<summary><strong>Why use this library?</strong></summary>\n\n<br>\n\n### Convenience\n\nCreating regular expressions for matching numbers gets deceptively complicated pretty fast.\n\nFor example, let's say you need a validation regex for matching part of a user-id, postal code, social security number, tax id, etc:\n\n* regex for matching `1` => `/1/` (easy enough)\n* regex for matching `1` through `5` => `/[1-5]/` (not bad...)\n* regex for matching `1` or `5` => `/(1|5)/` (still easy...)\n* regex for matching `1` through `50` => `/([1-9]|[1-4][0-9]|50)/` (uh-oh...)\n* regex for matching `1` through `55` => `/([1-9]|[1-4][0-9]|5[0-5])/` (no prob, I can do this...)\n* regex for matching `1` through `555` => `/([1-9]|[1-9][0-9]|[1-4][0-9]{2}|5[0-4][0-9]|55[0-5])/` (maybe not...)\n* regex for matching `0001` through `5555` => `/(0{3}[1-9]|0{2}[1-9][0-9]|0[1-9][0-9]{2}|[1-4][0-9]{3}|5[0-4][0-9]{2}|55[0-4][0-9]|555[0-5])/` (okay, I get the point!)\n\nThe numbers are contrived, but they're also really basic. In the real world you might need to generate a regex on-the-fly for validation.\n\n**Learn more**\n\nIf you're interested in learning more about [character classes](http://www.regular-expressions.info/charclass.html) and other regex features, I personally have always found [regular-expressions.info](http://www.regular-expressions.info/charclass.html) to be pretty useful.\n\n### Heavily tested\n\nAs of April 27, 2017, this library runs [2,783,483 test assertions](./test/test.js) against generated regex-ranges to provide brute-force verification that results are indeed correct.\n\nTests run in ~870ms on my MacBook Pro, 2.5 GHz Intel Core i7.\n\n### Highly optimized\n\nGenerated regular expressions are highly optimized:\n\n* duplicate sequences and character classes are reduced using quantifiers\n* smart enough to use `?` conditionals when number(s) or range(s) can be positive or negative\n* uses fragment caching to avoid processing the same exact string more than once\n\n<br>\n\n</details>\n\n## Usage\n\nAdd this library to your javascript application with the following line of code\n\n```js\nvar toRegexRange = require('to-regex-range');\n```\n\nThe main export is a function that takes two integers: the `min` value and `max` value (formatted as strings or numbers).\n\n```js\nvar source = toRegexRange('15', '95');\n//=> 1[5-9]|[2-8][0-9]|9[0-5]\n\nvar re = new RegExp('^' + source + '$');\nconsole.log(re.test('14')); //=> false\nconsole.log(re.test('50')); //=> true\nconsole.log(re.test('94')); //=> true\nconsole.log(re.test('96')); //=> false\n```\n\n## Options\n\n### options.capture\n\n**Type**: `boolean`\n\n**Deafault**: `undefined`\n\nWrap the returned value in parentheses when there is more than one regex condition. Useful when you're dynamically generating ranges.\n\n```js\nconsole.log(toRegexRange('-10', '10'));\n//=> -[1-9]|-?10|[0-9]\n\nconsole.log(toRegexRange('-10', '10', {capture: true}));\n//=> (-[1-9]|-?10|[0-9])\n```\n\n### options.shorthand\n\n**Type**: `boolean`\n\n**Deafault**: `undefined`\n\nUse the regex shorthand for `[0-9]`:\n\n```js\nconsole.log(toRegexRange('0', '999999'));\n//=> [0-9]|[1-9][0-9]{1,5}\n\nconsole.log(toRegexRange('0', '999999', {shorthand: true}));\n//=> \\d|[1-9]\\d{1,5}\n```\n\n### options.relaxZeros\n\n**Type**: `boolean`\n\n**Default**: `true`\n\nThis option only applies to **negative zero-padded ranges**. By default, when a negative zero-padded range is defined, the number of leading zeros is relaxed using `-0*`.\n\n```js\nconsole.log(toRegexRange('-001', '100'));\n//=> -0*1|0{2}[0-9]|0[1-9][0-9]|100\n\nconsole.log(toRegexRange('-001', '100', {relaxZeros: false}));\n//=> -0{2}1|0{2}[0-9]|0[1-9][0-9]|100\n```\n\n<details>\n<summary><strong>Why are zeros relaxed for negative zero-padded ranges by default?</strong></summary>\n\nConsider the following.\n\n```js\nvar regex = toRegexRange('-001', '100');\n```\n\n_Note that `-001` and `100` are both three digits long_.\n\nIn most zero-padding implementations, only a single leading zero is enough to indicate that zero-padding should be applied. Thus, the leading zeros would be \"corrected\" on the negative range in the example to `-01`, instead of `-001`, to make total length of each string no greater than the length of the largest number in the range (in other words, `-001` is 4 digits, but `100` is only three digits).\n\nIf zeros were not relaxed by default, you might expect the resulting regex of the above pattern to match `-001` - given that it's defined that way in the arguments - _but it wouldn't_. It would, however, match `-01`. This gets even more ambiguous with large ranges, like `-01` to `1000000`.\n\nThus, we relax zeros by default to provide a more predictable experience for users.\n\n</details>\n\n## Examples\n\n| **Range** | **Result** | **Compile time** | \n| --- | --- | --- |\n| `toRegexRange('5, 5')` | `5` | _33μs_ |\n| `toRegexRange('5, 6')` | `5\\|6` | _53μs_ |\n| `toRegexRange('29, 51')` | `29\\|[34][0-9]\\|5[01]` | _699μs_ |\n| `toRegexRange('31, 877')` | `3[1-9]\\|[4-9][0-9]\\|[1-7][0-9]{2}\\|8[0-6][0-9]\\|87[0-7]` | _711μs_ |\n| `toRegexRange('111, 555')` | `11[1-9]\\|1[2-9][0-9]\\|[2-4][0-9]{2}\\|5[0-4][0-9]\\|55[0-5]` | _62μs_ |\n| `toRegexRange('-10, 10')` | `-[1-9]\\|-?10\\|[0-9]` | _74μs_ |\n| `toRegexRange('-100, -10')` | `-1[0-9]\\|-[2-9][0-9]\\|-100` | _49μs_ |\n| `toRegexRange('-100, 100')` | `-[1-9]\\|-?[1-9][0-9]\\|-?100\\|[0-9]` | _45μs_ |\n| `toRegexRange('001, 100')` | `0{2}[1-9]\\|0[1-9][0-9]\\|100` | _158μs_ |\n| `toRegexRange('0010, 1000')` | `0{2}1[0-9]\\|0{2}[2-9][0-9]\\|0[1-9][0-9]{2}\\|1000` | _61μs_ |\n| `toRegexRange('1, 2')` | `1\\|2` | _10μs_ |\n| `toRegexRange('1, 5')` | `[1-5]` | _24μs_ |\n| `toRegexRange('1, 10')` | `[1-9]\\|10` | _23μs_ |\n| `toRegexRange('1, 100')` | `[1-9]\\|[1-9][0-9]\\|100` | _30μs_ |\n| `toRegexRange('1, 1000')` | `[1-9]\\|[1-9][0-9]{1,2}\\|1000` | _52μs_ |\n| `toRegexRange('1, 10000')` | `[1-9]\\|[1-9][0-9]{1,3}\\|10000` | _47μs_ |\n| `toRegexRange('1, 100000')` | `[1-9]\\|[1-9][0-9]{1,4}\\|100000` | _44μs_ |\n| `toRegexRange('1, 1000000')` | `[1-9]\\|[1-9][0-9]{1,5}\\|1000000` | _49μs_ |\n| `toRegexRange('1, 10000000')` | `[1-9]\\|[1-9][0-9]{1,6}\\|10000000` | _63μs_ |\n\n## Heads up!\n\n**Order of arguments**\n\nWhen the `min` is larger than the `max`, values will be flipped to create a valid range:\n\n```js\ntoRegexRange('51', '29');\n```\n\nIs effectively flipped to:\n\n```js\ntoRegexRange('29', '51');\n//=> 29|[3-4][0-9]|5[0-1]\n```\n\n**Steps / increments**\n\nThis library does not support steps (increments). A pr to add support would be welcome.\n\n## History\n\n### v2.0.0 - 2017-04-21\n\n**New features**\n\nAdds support for zero-padding!\n\n### v1.0.0\n\n**Optimizations**\n\nRepeating ranges are now grouped using quantifiers. rocessing time is roughly the same, but the generated regex is much smaller, which should result in faster matching.\n\n## Attribution\n\nInspired by the python library [range-regex](https://github.com/dimka665/range-regex).\n\n## About\n\n### Related projects\n\n* [expand-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See… [more](https://github.com/jonschlinkert/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range \"Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See the benchmarks. Used by micromatch.\")\n* [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or `step` to… [more](https://github.com/jonschlinkert/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range \"Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n* [repeat-element](https://www.npmjs.com/package/repeat-element): Create an array by repeating the given value n times. | [homepage](https://github.com/jonschlinkert/repeat-element \"Create an array by repeating the given value n times.\")\n* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string \"Repeat the given string n times. Fastest implementation for repeating a string.\")\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n### Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n### Running tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 27, 2017._\n# which-module\n\n> Find the module object for something that was require()d\n\n[](https://travis-ci.org/nexdrew/which-module)\n[](https://coveralls.io/github/nexdrew/which-module?branch=master)\n[](https://github.com/conventional-changelog/standard-version)\n\nFind the `module` object in `require.cache` for something that was `require()`d\nor `import`ed - essentially a reverse `require()` lookup.\n\nUseful for libs that want to e.g. lookup a filename for a module or submodule\nthat it did not `require()` itself.\n\n## Install and Usage\n\n```\nnpm install --save which-module\n```\n\n```js\nconst whichModule = require('which-module')\n\nconsole.log(whichModule(require('something')))\n// Module {\n// id: '/path/to/project/node_modules/something/index.js',\n// exports: [Function],\n// parent: ...,\n// filename: '/path/to/project/node_modules/something/index.js',\n// loaded: true,\n// children: [],\n// paths: [ '/path/to/project/node_modules/something/node_modules',\n// '/path/to/project/node_modules',\n// '/path/to/node_modules',\n// '/path/node_modules',\n// '/node_modules' ] }\n```\n\n## API\n\n### `whichModule(exported)`\n\nReturn the [`module` object](https://nodejs.org/api/modules.html#modules_the_module_object),\nif any, that represents the given argument in the `require.cache`.\n\n`exported` can be anything that was previously `require()`d or `import`ed as a\nmodule, submodule, or dependency - which means `exported` is identical to the\n`module.exports` returned by this method.\n\nIf `exported` did not come from the `exports` of a `module` in `require.cache`,\nthen this method returns `null`.\n\n## License\n\nISC © Contributors\nA JSON with color names and its values. Based on http://dev.w3.org/csswg/css-color/#named-colors.\n\n[](https://nodei.co/npm/color-name/)\n\n```js\nvar colors = require('color-name');\ncolors.red //[255,0,0]\n```\n\n<a href=\"LICENSE\"><img src=\"https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg\" width=\"120\"/></a>\n# exec-sh\n\n[](https://nodei.co/npm/exec-sh/)\n\n[](https://www.npmjs.com/package/exec-sh)\n[](https://travis-ci.org/tsertkov/exec-sh)\n[](https://coveralls.io/r/tsertkov/exec-sh?branch=master)\n[](https://david-dm.org/tsertkov/exec-sh)\n\n> Execute shell command forwarding all stdio streams.\n\n## Features\n\nexec-sh is a wrapper for [`child_process.spawn`](http://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) with some improvements:\n\n- Cross platform command execution:\n - Windows: `cmd /C COMMAND`\n - others: `sh -c COMMAND`\n- Fowrards all stdio streams to current terminal (by default):\n - `execSh(\"bash\")`\n - `execsh(\"echo -n Say: && read i && echo Said:$i\")`\n- stdout and stderr are passed to callback when available\n - `execSh(\"pwd\", console.log)`\n\n## Showcase\n```javascript\n// JavaScript\n\nexecSh(\"echo hello exec-sh && bash\", { cwd: \"/home\" }, function(err){\n if (err) {\n console.log(\"Exit code: \", err.code);\n }\n});\n```\n\n```sh\n# Terminal output: interactive bash session\n\nhello exec-sh\nbash-3.2$ pwd\n/home\nbash-3.2$ exit 99\nexit\nExit code: 99\n```\n\n## Usage\n\n```javascript\nvar execSh = require(\"../\");\n\n// run interactive bash shell\nexecSh(\"echo lorem && bash\", { cwd: \"/home\" }, function(err){\n if (err) {\n console.log(\"Exit code: \", err.code);\n return;\n }\n\n // collect streams output\n var child = execSh([\"bash -c id\", \"echo lorem >&2\"], true,\n function(err, stdout, stderr){\n console.log(\"error: \", err);\n console.log(\"stdout: \", stdout);\n console.log(\"stderr: \", stderr);\n });\n});\n```\n\n## Promise Interface\n\n```javascript\nvar execShPromise = require(\"exec-sh\").promise;\n\n// run interactive bash shell\nconst run = async () => {\n let out;\n\n try {\n out = await execShPromise('pwd', true);\n } catch (e) {\n console.log('Error: ', e);\n console.log('Stderr: ', e.stderr);\n console.log('Stdout: ', e.stdout);\n\n return e;\n }\n\n console.log('out: ', out.stdout, out.stderr);\n}\n\nrun();\n```\n\n## Public API\n\n### `execSh(command, [options], [callback])`\n\nExecute shell command forwarding all stdio.\n\n**Parameters:**\n\n- `command {String|Array}` - The command to run, or array of commands\n- `[options] {Object|TRUE}` - Options object passed directly to [`child_process.spawn`](http://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options), when `TRUE` then `{ stdio: null }` used\n- `[callback] {Function}` - `callback(err, stdout, stderr)`\n - `err {Error|NULL}` - Error object. Has `code` property containing last command exit code when available\n - `stdout {String|NULL}` - aggregated stdout or `NULL` if not available\n - `stderr {String|NULL}` - aggregated stderr or `NULL` if not available\n\n**Return Values:**\n\nReturns [ChildProcess](http://nodejs.org/api/child_process.html#child_process_class_childprocess) object.\n\n## Private API\nComplete API Documentation including private and public methods is generated from source code by JSDoc tool and is [available here](https://s3.eu-central-1.amazonaws.com/tsertkov-artifacts/exec-sh/master/jsdoc/index.html).\n\n## Code Coverage\nCode coverage report for all files is [available here](https://s3.eu-central-1.amazonaws.com/tsertkov-artifacts/exec-sh/master/coverage/index.html).\n\n## Scripts\n\n- `npm test` - run tests\n- `npm run jsdoc` - build jsdoc\n- `npm run dev` - run tests continuously\n\n## License\n\nThe MIT License (MIT)\n# assemblyscript-json\n\nJSON encoder / decoder for AssemblyScript.\n\nSpecial thanks to https://github.com/MaxGraey/bignum.wasm for basic unit testing infra for AssemblyScript.\n\n# Limitations\n\nThis is developed for use in smart contracts written in AssemblyScript for https://github.com/nearprotocol/nearcore.\nThis imposes such limitations:\n- Float numbers not supported\n- We assume that memory never needs to be deallocated (cause these contracts are short-lived).\n\nNote that this mostly just defines the way it's currently implemented. Contributors are welcome to fix limitations.\n\n# Usage\n\n## Encoding JSON\n\n```ts\n// Make sure memory allocator is available\nimport \"allocator/arena\";\n// Import encoder\nimport { JSONEncoder } from \"path/to/module\";\n\n// Create encoder\nlet encoder = new JSONEncoder();\n\n// Construct necessary object\nencoder.pushObject(\"obj\");\nencoder.setInteger(\"int\", 10);\nencoder.setString(\"str\", \"\");\nencoder.popObject();\n\n// Get serialized data\nlet json: Uint8Array = encoder.serialize();\n\n// Or get serialized data as string\nlet jsonString: String = encoder.toString();\n\n```\n\n## Parsing JSON\n\n```ts\n// Make sure memory allocator is available\nimport \"allocator/arena\";\n// Import decoder\nimport { JSONDecoder, JSONHandler } from \"path/to/module\";\n\n// Events need to be received by custom object extending JSONHandler.\n// NOTE: All methods are optional to implement.\nclass MyJSONEventsHandler extends JSONHandler {\n setString(name: string, value: string): void {\n // Handle field\n }\n\n setBoolean(name: string, value: bool): void {\n // Handle field\n }\n\n setNull(name: string): void {\n // Handle field\n }\n\n setInteger(name: string, value: i32): void {\n // Handle field\n }\n\n pushArray(name: string): bool {\n // Handle array start\n // true means that nested object needs to be traversed, false otherwise\n // Note that returning false means JSONDecoder.startIndex need to be updated by handler\n return true;\n }\n\n popArray(): void {\n // Handle array end\n }\n\n pushObject(name: string): bool {\n // Handle object start\n // true means that nested object needs to be traversed, false otherwise\n // Note that returning false means JSONDecoder.startIndex need to be updated by handler\n return true;\n }\n\n popObject(): void {\n // Handle object end\n }\n}\n\n// Create decoder\nlet decoder = new JSONDecoder<MyJSONEventsHandler>(new MyJSONEventsHandler());\n\n// Let's assume JSON data is available in this variable\nlet json: Uint8Array = ...;\n\n// Parse JSON\ndecoder.deserialize(json); // This will send events to MyJSONEventsHandler\n\n```\n\n## JSON namespace\n\n```ts\nimport { JSON } from \"path/to/module\";\n\n// Can use JS parse api\nlet jsonObj: JSON.Object = JSON.parse(`{\"hello\": \"world\"}`);\n\n// Can then use a key to read from the object if you know it's type\nlet world = jsonObj.getString(\"hello\");\n\n// If you don't know what the type of the value\nlet unknown = jsonObj.getValue(\"hello\")\n\nunknown.isString // true;\n```\nterser\n======\n\n\n\nA JavaScript parser and mangler/compressor toolkit for ES6+.\n\n*note*: You can support this project on patreon: <a target=\"_blank\" rel=\"nofollow\" href=\"https://www.patreon.com/fabiosantoscode\"><img src=\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\" alt=\"patron\" width=\"100px\" height=\"auto\"></a>. Check out PATRONS.md for our first-tier patrons.\n\nTerser recommends you use RollupJS to bundle your modules, as that produces smaller code overall.\n\n*Beautification* has been undocumented and is *being removed* from terser, we recommend you use [prettier](https://npmjs.com/package/prettier).\n\n[](https://travis-ci.org/terser-js/terser)\n\nFind the changelog in [CHANGELOG.md](https://github.com/terser-js/terser/blob/master/CHANGELOG.md)\n\nA JavaScript parser, mangler/compressor and beautifier toolkit for ES6+.\n\nWhy choose terser?\n------------------\n\n`uglify-es` is [no longer maintained](https://github.com/mishoo/UglifyJS2/issues/3156#issuecomment-392943058) and `uglify-js` does not support ES6+.\n\n**`terser`** is a fork of `uglify-es` that retains API and CLI compatibility\nwith `uglify-es` and `uglify-js@3`.\n\nInstall\n-------\n\nFirst make sure you have installed the latest version of [node.js](http://nodejs.org/)\n(You may need to restart your computer after this step).\n\nFrom NPM for use as a command line app:\n\n npm install terser -g\n\nFrom NPM for programmatic use:\n\n npm install terser\n \n# Command line usage\n\n terser [input files] [options]\n\nTerser can take multiple input files. It's recommended that you pass the\ninput files first, then pass the options. Terser will parse input files\nin sequence and apply any compression options. The files are parsed in the\nsame global scope, that is, a reference from a file to some\nvariable/function declared in another file will be matched properly.\n\nIf no input file is specified, Terser will read from STDIN.\n\nIf you wish to pass your options before the input files, separate the two with\na double dash to prevent input files being used as option arguments:\n\n terser --compress --mangle -- input.js\n\n### Command line options\n\n```\n -h, --help Print usage information.\n `--help options` for details on available options.\n -V, --version Print version number.\n -p, --parse <options> Specify parser options:\n `acorn` Use Acorn for parsing.\n `bare_returns` Allow return outside of functions.\n Useful when minifying CommonJS\n modules and Userscripts that may\n be anonymous function wrapped (IIFE)\n by the .user.js engine `caller`.\n `expression` Parse a single expression, rather than\n a program (for parsing JSON).\n `spidermonkey` Assume input files are SpiderMonkey\n AST format (as JSON).\n -c, --compress [options] Enable compressor/specify compressor options:\n `pure_funcs` List of functions that can be safely\n removed when their return values are\n not used.\n -m, --mangle [options] Mangle names/specify mangler options:\n `reserved` List of names that should not be mangled.\n --mangle-props [options] Mangle properties/specify mangler options:\n `builtins` Mangle property names that overlaps\n with standard JavaScript globals.\n `debug` Add debug prefix and suffix.\n `domprops` Mangle property names that overlaps\n with DOM properties.\n `keep_quoted` Only mangle unquoted properties.\n `regex` Only mangle matched property names.\n `reserved` List of names that should not be mangled.\n -b, --beautify [options] Specify output options:\n `preamble` Preamble to prepend to the output. You\n can use this to insert a comment, for\n example for licensing information.\n This will not be parsed, but the source\n map will adjust for its presence.\n `quote_style` Quote style:\n 0 - auto\n 1 - single\n 2 - double\n 3 - original\n `wrap_iife` Wrap IIFEs in parenthesis. Note: you may\n want to disable `negate_iife` under\n compressor options.\n -o, --output <file> Output file path (default STDOUT). Specify `ast` or\n `spidermonkey` to write Terser or SpiderMonkey AST\n as JSON to STDOUT respectively.\n --comments [filter] Preserve copyright comments in the output. By\n default this works like Google Closure, keeping\n JSDoc-style comments that contain \"@license\" or\n \"@preserve\". You can optionally pass one of the\n following arguments to this flag:\n - \"all\" to keep all comments\n - a valid JS RegExp like `/foo/` or `/^!/` to\n keep only matching comments.\n Note that currently not *all* comments can be\n kept when compression is on, because of dead\n code removal or cascading statements into\n sequences.\n --config-file <file> Read `minify()` options from JSON file.\n -d, --define <expr>[=value] Global definitions.\n --ecma <version> Specify ECMAScript release: 5, 6, 7 or 8.\n -e, --enclose [arg[:value]] Embed output in a big function with configurable\n arguments and values.\n --ie8 Support non-standard Internet Explorer 8.\n Equivalent to setting `ie8: true` in `minify()`\n for `compress`, `mangle` and `output` options.\n By default Terser will not try to be IE-proof.\n --keep-classnames Do not mangle/drop class names.\n --keep-fnames Do not mangle/drop function names. Useful for\n code relying on Function.prototype.name.\n --module Input is an ES6 module. If `compress` or `mangle` is\n enabled then the `toplevel` option will be enabled.\n --name-cache <file> File to hold mangled name mappings.\n --safari10 Support non-standard Safari 10/11.\n Equivalent to setting `safari10: true` in `minify()`\n for `mangle` and `output` options.\n By default `terser` will not work around\n Safari 10/11 bugs.\n --source-map [options] Enable source map/specify source map options:\n `base` Path to compute relative paths from input files.\n `content` Input source map, useful if you're compressing\n JS that was generated from some other original\n code. Specify \"inline\" if the source map is\n included within the sources.\n `filename` Name and/or location of the output source.\n `includeSources` Pass this flag if you want to include\n the content of source files in the\n source map as sourcesContent property.\n `root` Path to the original source to be included in\n the source map.\n `url` If specified, path to the source map to append in\n `//# sourceMappingURL`.\n --timings Display operations run time on STDERR.\n --toplevel Compress and/or mangle variables in top level scope.\n --verbose Print diagnostic messages.\n --warn Print warning messages.\n --wrap <name> Embed everything in a big function, making the\n “exports” and “global” variables available. You\n need to pass an argument to this option to\n specify the name that your module will take\n when included in, say, a browser.\n```\n\nSpecify `--output` (`-o`) to declare the output file. Otherwise the output\ngoes to STDOUT.\n\n## CLI source map options\n\nTerser can generate a source map file, which is highly useful for\ndebugging your compressed JavaScript. To get a source map, pass\n`--source-map --output output.js` (source map will be written out to\n`output.js.map`).\n\nAdditional options:\n\n- `--source-map \"filename='<NAME>'\"` to specify the name of the source map.\n\n- `--source-map \"root='<URL>'\"` to pass the URL where the original files can be found.\n\n- `--source-map \"url='<URL>'\"` to specify the URL where the source map can be found.\n Otherwise Terser assumes HTTP `X-SourceMap` is being used and will omit the\n `//# sourceMappingURL=` directive.\n\nFor example:\n\n terser js/file1.js js/file2.js \\\n -o foo.min.js -c -m \\\n --source-map \"root='http://foo.com/src',url='foo.min.js.map'\"\n\nThe above will compress and mangle `file1.js` and `file2.js`, will drop the\noutput in `foo.min.js` and the source map in `foo.min.js.map`. The source\nmapping will refer to `http://foo.com/src/js/file1.js` and\n`http://foo.com/src/js/file2.js` (in fact it will list `http://foo.com/src`\nas the source map root, and the original files as `js/file1.js` and\n`js/file2.js`).\n\n### Composed source map\n\nWhen you're compressing JS code that was output by a compiler such as\nCoffeeScript, mapping to the JS code won't be too helpful. Instead, you'd\nlike to map back to the original code (i.e. CoffeeScript). Terser has an\noption to take an input source map. Assuming you have a mapping from\nCoffeeScript → compiled JS, Terser can generate a map from CoffeeScript →\ncompressed JS by mapping every token in the compiled JS to its original\nlocation.\n\nTo use this feature pass `--source-map \"content='/path/to/input/source.map'\"`\nor `--source-map \"content=inline\"` if the source map is included inline with\nthe sources.\n\n## CLI compress options\n\nYou need to pass `--compress` (`-c`) to enable the compressor. Optionally\nyou can pass a comma-separated list of [compress options](#compress-options).\n\nOptions are in the form `foo=bar`, or just `foo` (the latter implies\na boolean option that you want to set `true`; it's effectively a\nshortcut for `foo=true`).\n\nExample:\n\n terser file.js -c toplevel,sequences=false\n\n## CLI mangle options\n\nTo enable the mangler you need to pass `--mangle` (`-m`). The following\n(comma-separated) options are supported:\n\n- `toplevel` (default `false`) -- mangle names declared in the top level scope.\n\n- `eval` (default `false`) -- mangle names visible in scopes where `eval` or `with` are used.\n\nWhen mangling is enabled but you want to prevent certain names from being\nmangled, you can declare those names with `--mangle reserved` — pass a\ncomma-separated list of names. For example:\n\n terser ... -m reserved=['$','require','exports']\n\nto prevent the `require`, `exports` and `$` names from being changed.\n\n### CLI mangling property names (`--mangle-props`)\n\n**Note:** THIS **WILL** BREAK YOUR CODE. A good rule of thumb is not to use this unless you know exactly what you're doing and how this works and read this section until the end.\n\nMangling property names is a separate step, different from variable name mangling. Pass\n`--mangle-props` to enable it. The least dangerous\nway to use this is to use the `regex` option like so:\n\n```\nterser example.js -c -m --mangle-props regex=/_$/\n```\n\nThis will mangle all properties that start with an \nunderscore. So you can use it to mangle internal methods.\n\nBy default, it will mangle all properties in the\ninput code with the exception of built in DOM properties and properties\nin core JavaScript classes, which is what will break your code if you don't:\n\n1. Control all the code you're mangling\n2. Avoid using a module bundler, as they usually will call Terser on each file individually, making it impossible to pass mangled objects between modules.\n3. Avoid calling functions like `defineProperty` or `hasOwnProperty`, because they refer to object properties using strings and will break your code if you don't know what you are doing.\n\nAn example:\n\n```javascript\n// example.js\nvar x = {\n baz_: 0,\n foo_: 1,\n calc: function() {\n return this.foo_ + this.baz_;\n }\n};\nx.bar_ = 2;\nx[\"baz_\"] = 3;\nconsole.log(x.calc());\n```\nMangle all properties (except for JavaScript `builtins`) (**very** unsafe):\n```bash\n$ terser example.js -c -m --mangle-props\n```\n```javascript\nvar x={o:0,_:1,l:function(){return this._+this.o}};x.t=2,x.o=3,console.log(x.l());\n```\nMangle all properties except for `reserved` properties (still very unsafe):\n```bash\n$ terser example.js -c -m --mangle-props reserved=[foo_,bar_]\n```\n```javascript\nvar x={o:0,foo_:1,_:function(){return this.foo_+this.o}};x.bar_=2,x.o=3,console.log(x._());\n```\nMangle all properties matching a `regex` (not as unsafe but still unsafe):\n```bash\n$ terser example.js -c -m --mangle-props regex=/_$/\n```\n```javascript\nvar x={o:0,_:1,calc:function(){return this._+this.o}};x.l=2,x.o=3,console.log(x.calc());\n```\n\nCombining mangle properties options:\n```bash\n$ terser example.js -c -m --mangle-props regex=/_$/,reserved=[bar_]\n```\n```javascript\nvar x={o:0,_:1,calc:function(){return this._+this.o}};x.bar_=2,x.o=3,console.log(x.calc());\n```\n\nIn order for this to be of any use, we avoid mangling standard JS names by\ndefault (`--mangle-props builtins` to override).\n\nA default exclusion file is provided in `tools/domprops.json` which should\ncover most standard JS and DOM properties defined in various browsers. Pass\n`--mangle-props domprops` to disable this feature.\n\nA regular expression can be used to define which property names should be\nmangled. For example, `--mangle-props regex=/^_/` will only mangle property\nnames that start with an underscore.\n\nWhen you compress multiple files using this option, in order for them to\nwork together in the end we need to ensure somehow that one property gets\nmangled to the same name in all of them. For this, pass `--name-cache filename.json`\nand Terser will maintain these mappings in a file which can then be reused.\nIt should be initially empty. Example:\n\n```bash\n$ rm -f /tmp/cache.json # start fresh\n$ terser file1.js file2.js --mangle-props --name-cache /tmp/cache.json -o part1.js\n$ terser file3.js file4.js --mangle-props --name-cache /tmp/cache.json -o part2.js\n```\n\nNow, `part1.js` and `part2.js` will be consistent with each other in terms\nof mangled property names.\n\nUsing the name cache is not necessary if you compress all your files in a\nsingle call to Terser.\n\n### Mangling unquoted names (`--mangle-props keep_quoted`)\n\nUsing quoted property name (`o[\"foo\"]`) reserves the property name (`foo`)\nso that it is not mangled throughout the entire script even when used in an\nunquoted style (`o.foo`). Example:\n\n```javascript\n// stuff.js\nvar o = {\n \"foo\": 1,\n bar: 3\n};\no.foo += o.bar;\nconsole.log(o.foo);\n```\n```bash\n$ terser stuff.js --mangle-props keep_quoted -c -m\n```\n```javascript\nvar o={foo:1,o:3};o.foo+=o.o,console.log(o.foo);\n```\n\n### Debugging property name mangling\n\nYou can also pass `--mangle-props debug` in order to mangle property names\nwithout completely obscuring them. For example the property `o.foo`\nwould mangle to `o._$foo$_` with this option. This allows property mangling\nof a large codebase while still being able to debug the code and identify\nwhere mangling is breaking things.\n\n```bash\n$ terser stuff.js --mangle-props debug -c -m\n```\n```javascript\nvar o={_$foo$_:1,_$bar$_:3};o._$foo$_+=o._$bar$_,console.log(o._$foo$_);\n```\n\nYou can also pass a custom suffix using `--mangle-props debug=XYZ`. This would then\nmangle `o.foo` to `o._$foo$XYZ_`. You can change this each time you compile a\nscript to identify how a property got mangled. One technique is to pass a\nrandom number on every compile to simulate mangling changing with different\ninputs (e.g. as you update the input script with new properties), and to help\nidentify mistakes like writing mangled keys to storage.\n\n# API Reference\n\nAssuming installation via NPM, you can load Terser in your application\nlike this:\n```javascript\nvar Terser = require(\"terser\");\n```\nBrowser loading is also supported:\n```html\n<script src=\"node_modules/source-map/dist/source-map.min.js\"></script>\n<script src=\"dist/bundle.min.js\"></script>\n```\n\nThere is a single high level function, **`minify(code, options)`**,\nwhich will perform all minification [phases](#minify-options) in a configurable\nmanner. By default `minify()` will enable the options [`compress`](#compress-options)\nand [`mangle`](#mangle-options). Example:\n```javascript\nvar code = \"function add(first, second) { return first + second; }\";\nvar result = Terser.minify(code);\nconsole.log(result.error); // runtime error, or `undefined` if no error\nconsole.log(result.code); // minified output: function add(n,d){return n+d}\n```\n\nYou can `minify` more than one JavaScript file at a time by using an object\nfor the first argument where the keys are file names and the values are source\ncode:\n```javascript\nvar code = {\n \"file1.js\": \"function add(first, second) { return first + second; }\",\n \"file2.js\": \"console.log(add(1 + 2, 3 + 4));\"\n};\nvar result = Terser.minify(code);\nconsole.log(result.code);\n// function add(d,n){return d+n}console.log(add(3,7));\n```\n\nThe `toplevel` option:\n```javascript\nvar code = {\n \"file1.js\": \"function add(first, second) { return first + second; }\",\n \"file2.js\": \"console.log(add(1 + 2, 3 + 4));\"\n};\nvar options = { toplevel: true };\nvar result = Terser.minify(code, options);\nconsole.log(result.code);\n// console.log(3+7);\n```\n\nThe `nameCache` option:\n```javascript\nvar options = {\n mangle: {\n toplevel: true,\n },\n nameCache: {}\n};\nvar result1 = Terser.minify({\n \"file1.js\": \"function add(first, second) { return first + second; }\"\n}, options);\nvar result2 = Terser.minify({\n \"file2.js\": \"console.log(add(1 + 2, 3 + 4));\"\n}, options);\nconsole.log(result1.code);\n// function n(n,r){return n+r}\nconsole.log(result2.code);\n// console.log(n(3,7));\n```\n\nYou may persist the name cache to the file system in the following way:\n```javascript\nvar cacheFileName = \"/tmp/cache.json\";\nvar options = {\n mangle: {\n properties: true,\n },\n nameCache: JSON.parse(fs.readFileSync(cacheFileName, \"utf8\"))\n};\nfs.writeFileSync(\"part1.js\", Terser.minify({\n \"file1.js\": fs.readFileSync(\"file1.js\", \"utf8\"),\n \"file2.js\": fs.readFileSync(\"file2.js\", \"utf8\")\n}, options).code, \"utf8\");\nfs.writeFileSync(\"part2.js\", Terser.minify({\n \"file3.js\": fs.readFileSync(\"file3.js\", \"utf8\"),\n \"file4.js\": fs.readFileSync(\"file4.js\", \"utf8\")\n}, options).code, \"utf8\");\nfs.writeFileSync(cacheFileName, JSON.stringify(options.nameCache), \"utf8\");\n```\n\nAn example of a combination of `minify()` options:\n```javascript\nvar code = {\n \"file1.js\": \"function add(first, second) { return first + second; }\",\n \"file2.js\": \"console.log(add(1 + 2, 3 + 4));\"\n};\nvar options = {\n toplevel: true,\n compress: {\n global_defs: {\n \"@console.log\": \"alert\"\n },\n passes: 2\n },\n output: {\n beautify: false,\n preamble: \"/* minified */\"\n }\n};\nvar result = Terser.minify(code, options);\nconsole.log(result.code);\n// /* minified */\n// alert(10);\"\n```\n\nTo produce warnings:\n```javascript\nvar code = \"function f(){ var u; return 2 + 3; }\";\nvar options = { warnings: true };\nvar result = Terser.minify(code, options);\nconsole.log(result.error); // runtime error, `undefined` in this case\nconsole.log(result.warnings); // [ 'Dropping unused variable u [0:1,18]' ]\nconsole.log(result.code); // function f(){return 5}\n```\n\nAn error example:\n```javascript\nvar result = Terser.minify({\"foo.js\" : \"if (0) else console.log(1);\"});\nconsole.log(JSON.stringify(result.error));\n// {\"message\":\"Unexpected token: keyword (else)\",\"filename\":\"foo.js\",\"line\":1,\"col\":7,\"pos\":7}\n```\nNote: unlike `uglify-js@2.x`, the Terser API does not throw errors.\nTo achieve a similar effect one could do the following:\n```javascript\nvar result = Terser.minify(code, options);\nif (result.error) throw result.error;\n```\n\n## Minify options\n\n- `ecma` (default `undefined`) - pass `5`, `6`, `7` or `8` to override `parse`,\n `compress` and `output` options.\n\n- `warnings` (default `false`) — pass `true` to return compressor warnings\n in `result.warnings`. Use the value `\"verbose\"` for more detailed warnings.\n\n- `parse` (default `{}`) — pass an object if you wish to specify some\n additional [parse options](#parse-options).\n\n- `compress` (default `{}`) — pass `false` to skip compressing entirely.\n Pass an object to specify custom [compress options](#compress-options).\n\n- `mangle` (default `true`) — pass `false` to skip mangling names, or pass\n an object to specify [mangle options](#mangle-options) (see below).\n\n - `mangle.properties` (default `false`) — a subcategory of the mangle option.\n Pass an object to specify custom [mangle property options](#mangle-properties-options).\n\n- `module` (default `false`) — Use when minifying an ES6 module. \"use strict\"\n is implied and names can be mangled on the top scope. If `compress` or\n `mangle` is enabled then the `toplevel` option will be enabled.\n\n- `output` (default `null`) — pass an object if you wish to specify\n additional [output options](#output-options). The defaults are optimized\n for best compression.\n\n- `sourceMap` (default `false`) - pass an object if you wish to specify\n [source map options](#source-map-options).\n\n- `toplevel` (default `false`) - set to `true` if you wish to enable top level\n variable and function name mangling and to drop unused variables and functions.\n\n- `nameCache` (default `null`) - pass an empty object `{}` or a previously\n used `nameCache` object if you wish to cache mangled variable and\n property names across multiple invocations of `minify()`. Note: this is\n a read/write property. `minify()` will read the name cache state of this\n object and update it during minification so that it may be\n reused or externally persisted by the user.\n\n- `ie8` (default `false`) - set to `true` to support IE8.\n\n- `keep_classnames` (default: `undefined`) - pass `true` to prevent discarding or mangling\n of class names. Pass a regular expression to only keep class names matching that regex.\n\n- `keep_fnames` (default: `false`) - pass `true` to prevent discarding or mangling\n of function names. Pass a regular expression to only keep class names matching that regex.\n Useful for code relying on `Function.prototype.name`. If the top level minify option\n `keep_classnames` is `undefined` it will be overridden with the value of the top level\n minify option `keep_fnames`.\n\n- `safari10` (default: `false`) - pass `true` to work around Safari 10/11 bugs in\n loop scoping and `await`. See `safari10` options in [`mangle`](#mangle-options)\n and [`output`](#output-options) for details.\n\n## Minify options structure\n\n```javascript\n{\n parse: {\n // parse options\n },\n compress: {\n // compress options\n },\n mangle: {\n // mangle options\n\n properties: {\n // mangle property options\n }\n },\n output: {\n // output options\n },\n sourceMap: {\n // source map options\n },\n ecma: 5, // specify one of: 5, 6, 7 or 8\n keep_classnames: false,\n keep_fnames: false,\n ie8: false,\n module: false,\n nameCache: null, // or specify a name cache object\n safari10: false,\n toplevel: false,\n warnings: false,\n}\n```\n\n### Source map options\n\nTo generate a source map:\n```javascript\nvar result = Terser.minify({\"file1.js\": \"var a = function() {};\"}, {\n sourceMap: {\n filename: \"out.js\",\n url: \"out.js.map\"\n }\n});\nconsole.log(result.code); // minified output\nconsole.log(result.map); // source map\n```\n\nNote that the source map is not saved in a file, it's just returned in\n`result.map`. The value passed for `sourceMap.url` is only used to set\n`//# sourceMappingURL=out.js.map` in `result.code`. The value of\n`filename` is only used to set `file` attribute (see [the spec][sm-spec])\nin source map file.\n\nYou can set option `sourceMap.url` to be `\"inline\"` and source map will\nbe appended to code.\n\nYou can also specify sourceRoot property to be included in source map:\n```javascript\nvar result = Terser.minify({\"file1.js\": \"var a = function() {};\"}, {\n sourceMap: {\n root: \"http://example.com/src\",\n url: \"out.js.map\"\n }\n});\n```\n\nIf you're compressing compiled JavaScript and have a source map for it, you\ncan use `sourceMap.content`:\n```javascript\nvar result = Terser.minify({\"compiled.js\": \"compiled code\"}, {\n sourceMap: {\n content: \"content from compiled.js.map\",\n url: \"minified.js.map\"\n }\n});\n// same as before, it returns `code` and `map`\n```\n\nIf you're using the `X-SourceMap` header instead, you can just omit `sourceMap.url`.\n\n## Parse options\n\n- `bare_returns` (default `false`) -- support top level `return` statements\n\n- `ecma` (default: `8`) -- specify one of `5`, `6`, `7` or `8`. Note: this setting\n is not presently enforced except for ES8 optional trailing commas in function\n parameter lists and calls with `ecma` `8`.\n\n- `html5_comments` (default `true`)\n\n- `shebang` (default `true`) -- support `#!command` as the first line\n\n## Compress options\n\n- `arrows` (default: `true`) -- Converts `()=>{return x}` to `()=>x`. Class\n and object literal methods will also be converted to arrow expressions if\n the resultant code is shorter: `m(){return x}` becomes `m:()=>x`.\n\n- `arguments` (default: `false`) -- replace `arguments[index]` with function\n parameter name whenever possible.\n\n- `booleans` (default: `true`) -- various optimizations for boolean context,\n for example `!!a ? b : c → a ? b : c`\n\n- `booleans_as_integers` (default: `false`) -- Turn booleans into 0 and 1, also\n makes comparisons with booleans use `==` and `!=` instead of `===` and `!==`.\n\n- `collapse_vars` (default: `true`) -- Collapse single-use non-constant variables,\n side effects permitting.\n\n- `comparisons` (default: `true`) -- apply certain optimizations to binary nodes,\n e.g. `!(a <= b) → a > b` (only when `unsafe_comps`), attempts to negate binary\n nodes, e.g. `a = !b && !c && !d && !e → a=!(b||c||d||e)` etc.\n\n- `computed_props` (default: `true`) -- Transforms constant computed properties\n into regular ones: `{[\"computed\"]: 1}` is converted to `{computed: 1}`.\n\n- `conditionals` (default: `true`) -- apply optimizations for `if`-s and conditional\n expressions\n\n- `dead_code` (default: `true`) -- remove unreachable code\n\n- `defaults` (default: `true`) -- Pass `false` to disable most default\n enabled `compress` transforms. Useful when you only want to enable a few\n `compress` options while disabling the rest.\n\n- `directives` (default: `true`) -- remove redundant or non-standard directives\n\n- `drop_console` (default: `false`) -- Pass `true` to discard calls to\n `console.*` functions. If you wish to drop a specific function call\n such as `console.info` and/or retain side effects from function arguments\n after dropping the function call then use `pure_funcs` instead.\n\n- `drop_debugger` (default: `true`) -- remove `debugger;` statements\n\n- `ecma` (default: `5`) -- Pass `6` or greater to enable `compress` options that\n will transform ES5 code into smaller ES6+ equivalent forms.\n\n- `evaluate` (default: `true`) -- attempt to evaluate constant expressions\n\n- `expression` (default: `false`) -- Pass `true` to preserve completion values\n from terminal statements without `return`, e.g. in bookmarklets.\n\n- `global_defs` (default: `{}`) -- see [conditional compilation](#conditional-compilation)\n\n- `hoist_funs` (default: `false`) -- hoist function declarations\n\n- `hoist_props` (default: `true`) -- hoist properties from constant object and\n array literals into regular variables subject to a set of constraints. For example:\n `var o={p:1, q:2}; f(o.p, o.q);` is converted to `f(1, 2);`. Note: `hoist_props`\n works best with `mangle` enabled, the `compress` option `passes` set to `2` or higher,\n and the `compress` option `toplevel` enabled.\n\n- `hoist_vars` (default: `false`) -- hoist `var` declarations (this is `false`\n by default because it seems to increase the size of the output in general)\n\n- `if_return` (default: `true`) -- optimizations for if/return and if/continue\n\n- `inline` (default: `true`) -- inline calls to function with simple/`return` statement:\n - `false` -- same as `0`\n - `0` -- disabled inlining\n - `1` -- inline simple functions\n - `2` -- inline functions with arguments\n - `3` -- inline functions with arguments and variables\n - `true` -- same as `3`\n\n- `join_vars` (default: `true`) -- join consecutive `var` statements\n\n- `keep_classnames` (default: `false`) -- Pass `true` to prevent the compressor from\n discarding class names. Pass a regular expression to only keep class names matching\n that regex. See also: the `keep_classnames` [mangle option](#mangle).\n\n- `keep_fargs` (default: `true`) -- Prevents the compressor from discarding unused\n function arguments. You need this for code which relies on `Function.length`.\n\n- `keep_fnames` (default: `false`) -- Pass `true` to prevent the\n compressor from discarding function names. Pass a regular expression to only keep\n class names matching that regex. Useful for code relying on `Function.prototype.name`.\n See also: the `keep_fnames` [mangle option](#mangle).\n\n- `keep_infinity` (default: `false`) -- Pass `true` to prevent `Infinity` from\n being compressed into `1/0`, which may cause performance issues on Chrome.\n\n- `loops` (default: `true`) -- optimizations for `do`, `while` and `for` loops\n when we can statically determine the condition.\n\n- `module` (default `false`) -- Pass `true` when compressing an ES6 module. Strict\n mode is implied and the `toplevel` option as well.\n\n- `negate_iife` (default: `true`) -- negate \"Immediately-Called Function Expressions\"\n where the return value is discarded, to avoid the parens that the\n code generator would insert.\n\n- `passes` (default: `1`) -- The maximum number of times to run compress.\n In some cases more than one pass leads to further compressed code. Keep in\n mind more passes will take more time.\n\n- `properties` (default: `true`) -- rewrite property access using the dot notation, for\n example `foo[\"bar\"] → foo.bar`\n\n- `pure_funcs` (default: `null`) -- You can pass an array of names and\n Terser will assume that those functions do not produce side\n effects. DANGER: will not check if the name is redefined in scope.\n An example case here, for instance `var q = Math.floor(a/b)`. If\n variable `q` is not used elsewhere, Terser will drop it, but will\n still keep the `Math.floor(a/b)`, not knowing what it does. You can\n pass `pure_funcs: [ 'Math.floor' ]` to let it know that this\n function won't produce any side effect, in which case the whole\n statement would get discarded. The current implementation adds some\n overhead (compression will be slower).\n\n- `pure_getters` (default: `\"strict\"`) -- If you pass `true` for\n this, Terser will assume that object property access\n (e.g. `foo.bar` or `foo[\"bar\"]`) doesn't have any side effects.\n Specify `\"strict\"` to treat `foo.bar` as side-effect-free only when\n `foo` is certain to not throw, i.e. not `null` or `undefined`.\n\n- `reduce_funcs` (default: `true`) -- Allows single-use functions to be\n inlined as function expressions when permissible allowing further\n optimization. Enabled by default. Option depends on `reduce_vars`\n being enabled. Some code runs faster in the Chrome V8 engine if this\n option is disabled. Does not negatively impact other major browsers.\n\n- `reduce_vars` (default: `true`) -- Improve optimization on variables assigned with and\n used as constant values.\n\n- `sequences` (default: `true`) -- join consecutive simple statements using the\n comma operator. May be set to a positive integer to specify the maximum number\n of consecutive comma sequences that will be generated. If this option is set to\n `true` then the default `sequences` limit is `200`. Set option to `false` or `0`\n to disable. The smallest `sequences` length is `2`. A `sequences` value of `1`\n is grandfathered to be equivalent to `true` and as such means `200`. On rare\n occasions the default sequences limit leads to very slow compress times in which\n case a value of `20` or less is recommended.\n\n- `side_effects` (default: `true`) -- Pass `false` to disable potentially dropping\n functions marked as \"pure\". A function call is marked as \"pure\" if a comment\n annotation `/*@__PURE__*/` or `/*#__PURE__*/` immediately precedes the call. For\n example: `/*@__PURE__*/foo();`\n\n- `switches` (default: `true`) -- de-duplicate and remove unreachable `switch` branches\n\n- `toplevel` (default: `false`) -- drop unreferenced functions (`\"funcs\"`) and/or\n variables (`\"vars\"`) in the top level scope (`false` by default, `true` to drop\n both unreferenced functions and variables)\n\n- `top_retain` (default: `null`) -- prevent specific toplevel functions and\n variables from `unused` removal (can be array, comma-separated, RegExp or\n function. Implies `toplevel`)\n\n- `typeofs` (default: `true`) -- Transforms `typeof foo == \"undefined\"` into\n `foo === void 0`. Note: recommend to set this value to `false` for IE10 and\n earlier versions due to known issues.\n\n- `unsafe` (default: `false`) -- apply \"unsafe\" transformations\n ([details](#the-unsafe-compress-option)).\n\n- `unsafe_arrows` (default: `false`) -- Convert ES5 style anonymous function\n expressions to arrow functions if the function body does not reference `this`.\n Note: it is not always safe to perform this conversion if code relies on the\n the function having a `prototype`, which arrow functions lack.\n This transform requires that the `ecma` compress option is set to `6` or greater.\n\n- `unsafe_comps` (default: `false`) -- Reverse `<` and `<=` to `>` and `>=` to\n allow improved compression. This might be unsafe when an at least one of two\n operands is an object with computed values due the use of methods like `get`,\n or `valueOf`. This could cause change in execution order after operands in the\n comparison are switching. Compression only works if both `comparisons` and\n `unsafe_comps` are both set to true.\n\n- `unsafe_Function` (default: `false`) -- compress and mangle `Function(args, code)`\n when both `args` and `code` are string literals.\n\n- `unsafe_math` (default: `false`) -- optimize numerical expressions like\n `2 * x * 3` into `6 * x`, which may give imprecise floating point results.\n\n- `unsafe_methods` (default: false) -- Converts `{ m: function(){} }` to\n `{ m(){} }`. `ecma` must be set to `6` or greater to enable this transform.\n If `unsafe_methods` is a RegExp then key/value pairs with keys matching the\n RegExp will be converted to concise methods.\n Note: if enabled there is a risk of getting a \"`<method name>` is not a\n constructor\" TypeError should any code try to `new` the former function.\n\n- `unsafe_proto` (default: `false`) -- optimize expressions like\n `Array.prototype.slice.call(a)` into `[].slice.call(a)`\n\n- `unsafe_regexp` (default: `false`) -- enable substitutions of variables with\n `RegExp` values the same way as if they are constants.\n\n- `unsafe_undefined` (default: `false`) -- substitute `void 0` if there is a\n variable named `undefined` in scope (variable name will be mangled, typically\n reduced to a single character)\n\n- `unused` (default: `true`) -- drop unreferenced functions and variables (simple\n direct variable assignments do not count as references unless set to `\"keep_assign\"`)\n\n- `warnings` (default: `false`) -- display warnings when dropping unreachable\n code or unused declarations etc.\n\n## Mangle options\n\n- `eval` (default `false`) -- Pass `true` to mangle names visible in scopes\n where `eval` or `with` are used.\n\n- `keep_classnames` (default `false`) -- Pass `true` to not mangle class names.\n Pass a regular expression to only keep class names matching that regex.\n See also: the `keep_classnames` [compress option](#compress-options).\n\n- `keep_fnames` (default `false`) -- Pass `true` to not mangle function names.\n Pass a regular expression to only keep class names matching that regex.\n Useful for code relying on `Function.prototype.name`. See also: the `keep_fnames`\n [compress option](#compress-options).\n\n- `module` (default `false`) -- Pass `true` an ES6 modules, where the toplevel\n scope is not the global scope. Implies `toplevel`.\n\n- `reserved` (default `[]`) -- Pass an array of identifiers that should be\n excluded from mangling. Example: `[\"foo\", \"bar\"]`.\n\n- `toplevel` (default `false`) -- Pass `true` to mangle names declared in the\n top level scope.\n\n- `safari10` (default `false`) -- Pass `true` to work around the Safari 10 loop\n iterator [bug](https://bugs.webkit.org/show_bug.cgi?id=171041)\n \"Cannot declare a let variable twice\".\n See also: the `safari10` [output option](#output-options).\n\nExamples:\n\n```javascript\n// test.js\nvar globalVar;\nfunction funcName(firstLongName, anotherLongName) {\n var myVariable = firstLongName + anotherLongName;\n}\n```\n```javascript\nvar code = fs.readFileSync(\"test.js\", \"utf8\");\n\nTerser.minify(code).code;\n// 'function funcName(a,n){}var globalVar;'\n\nTerser.minify(code, { mangle: { reserved: ['firstLongName'] } }).code;\n// 'function funcName(firstLongName,a){}var globalVar;'\n\nTerser.minify(code, { mangle: { toplevel: true } }).code;\n// 'function n(n,a){}var a;'\n```\n\n### Mangle properties options\n\n- `builtins` (default: `false`) -- Use `true` to allow the mangling of builtin\n DOM properties. Not recommended to override this setting.\n\n- `debug` (default: `false`) -— Mangle names with the original name still present.\n Pass an empty string `\"\"` to enable, or a non-empty string to set the debug suffix.\n\n- `keep_quoted` (default: `false`) -— Only mangle unquoted property names.\n\n- `regex` (default: `null`) -— Pass a RegExp literal to only mangle property\n names matching the regular expression.\n\n- `reserved` (default: `[]`) -- Do not mangle property names listed in the\n `reserved` array.\n\n## Output options\n\nThe code generator tries to output shortest code possible by default. In\ncase you want beautified output, pass `--beautify` (`-b`). Optionally you\ncan pass additional arguments that control the code output:\n\n- `ascii_only` (default `false`) -- escape Unicode characters in strings and\n regexps (affects directives with non-ascii characters becoming invalid)\n\n- `beautify` (default `true`) -- whether to actually beautify the output.\n Passing `-b` will set this to true, but you might need to pass `-b` even\n when you want to generate minified code, in order to specify additional\n arguments, so you can use `-b beautify=false` to override it.\n\n- `braces` (default `false`) -- always insert braces in `if`, `for`,\n `do`, `while` or `with` statements, even if their body is a single\n statement.\n\n- `comments` (default `false`) -- pass `true` or `\"all\"` to preserve all\n comments, `\"some\"` to preserve some comments, a regular expression string\n (e.g. `/^!/`) or a function.\n\n- `ecma` (default `5`) -- set output printing mode. Set `ecma` to `6` or\n greater to emit shorthand object properties - i.e.: `{a}` instead of `{a: a}`.\n The `ecma` option will only change the output in direct control of the\n beautifier. Non-compatible features in the abstract syntax tree will still\n be output as is. For example: an `ecma` setting of `5` will **not** convert\n ES6+ code to ES5.\n\n- `indent_level` (default `4`)\n\n- `indent_start` (default `0`) -- prefix all lines by that many spaces\n\n- `inline_script` (default `true`) -- escape HTML comments and the slash in\n occurrences of `</script>` in strings\n\n- `keep_quoted_props` (default `false`) -- when turned on, prevents stripping\n quotes from property names in object literals.\n\n- `max_line_len` (default `false`) -- maximum line length (for minified code)\n\n- `preamble` (default `null`) -- when passed it must be a string and\n it will be prepended to the output literally. The source map will\n adjust for this text. Can be used to insert a comment containing\n licensing information, for example.\n\n- `quote_keys` (default `false`) -- pass `true` to quote all keys in literal\n objects\n\n- `quote_style` (default `0`) -- preferred quote style for strings (affects\n quoted property names and directives as well):\n - `0` -- prefers double quotes, switches to single quotes when there are\n more double quotes in the string itself. `0` is best for gzip size.\n - `1` -- always use single quotes\n - `2` -- always use double quotes\n - `3` -- always use the original quotes\n\n- `safari10` (default `false`) -- set this option to `true` to work around\n the [Safari 10/11 await bug](https://bugs.webkit.org/show_bug.cgi?id=176685).\n See also: the `safari10` [mangle option](#mangle-options).\n\n- `semicolons` (default `true`) -- separate statements with semicolons. If\n you pass `false` then whenever possible we will use a newline instead of a\n semicolon, leading to more readable output of minified code (size before\n gzip could be smaller; size after gzip insignificantly larger).\n\n- `shebang` (default `true`) -- preserve shebang `#!` in preamble (bash scripts)\n\n- `webkit` (default `false`) -- enable workarounds for WebKit bugs.\n PhantomJS users should set this option to `true`.\n\n- `wrap_iife` (default `false`) -- pass `true` to wrap immediately invoked\n function expressions. See\n [#640](https://github.com/mishoo/UglifyJS2/issues/640) for more details.\n\n# Miscellaneous\n\n### Keeping copyright notices or other comments\n\nYou can pass `--comments` to retain certain comments in the output. By\ndefault it will keep JSDoc-style comments that contain \"@preserve\",\n\"@license\" or \"@cc_on\" (conditional compilation for IE). You can pass\n`--comments all` to keep all the comments, or a valid JavaScript regexp to\nkeep only comments that match this regexp. For example `--comments /^!/`\nwill keep comments like `/*! Copyright Notice */`.\n\nNote, however, that there might be situations where comments are lost. For\nexample:\n```javascript\nfunction f() {\n /** @preserve Foo Bar */\n function g() {\n // this function is never called\n }\n return something();\n}\n```\n\nEven though it has \"@preserve\", the comment will be lost because the inner\nfunction `g` (which is the AST node to which the comment is attached to) is\ndiscarded by the compressor as not referenced.\n\nThe safest comments where to place copyright information (or other info that\nneeds to be kept in the output) are comments attached to toplevel nodes.\n\n### The `unsafe` `compress` option\n\nIt enables some transformations that *might* break code logic in certain\ncontrived cases, but should be fine for most code. It assumes that standard\nbuilt-in ECMAScript functions and classes have not been altered or replaced.\nYou might want to try it on your own code; it should reduce the minified size.\nSome examples of the optimizations made when this option is enabled:\n\n- `new Array(1, 2, 3)` or `Array(1, 2, 3)` → `[ 1, 2, 3 ]`\n- `new Object()` → `{}`\n- `String(exp)` or `exp.toString()` → `\"\" + exp`\n- `new Object/RegExp/Function/Error/Array (...)` → we discard the `new`\n- `\"foo bar\".substr(4)` → `\"bar\"`\n\n### Conditional compilation\n\nYou can use the `--define` (`-d`) switch in order to declare global\nvariables that Terser will assume to be constants (unless defined in\nscope). For example if you pass `--define DEBUG=false` then, coupled with\ndead code removal Terser will discard the following from the output:\n```javascript\nif (DEBUG) {\n console.log(\"debug stuff\");\n}\n```\n\nYou can specify nested constants in the form of `--define env.DEBUG=false`.\n\nTerser will warn about the condition being always false and about dropping\nunreachable code; for now there is no option to turn off only this specific\nwarning, you can pass `warnings=false` to turn off *all* warnings.\n\nAnother way of doing that is to declare your globals as constants in a\nseparate file and include it into the build. For example you can have a\n`build/defines.js` file with the following:\n```javascript\nvar DEBUG = false;\nvar PRODUCTION = true;\n// etc.\n```\n\nand build your code like this:\n\n terser build/defines.js js/foo.js js/bar.js... -c\n\nTerser will notice the constants and, since they cannot be altered, it\nwill evaluate references to them to the value itself and drop unreachable\ncode as usual. The build will contain the `const` declarations if you use\nthem. If you are targeting < ES6 environments which does not support `const`,\nusing `var` with `reduce_vars` (enabled by default) should suffice.\n\n### Conditional compilation API\n\nYou can also use conditional compilation via the programmatic API. With the difference that the\nproperty name is `global_defs` and is a compressor property:\n\n```javascript\nvar result = Terser.minify(fs.readFileSync(\"input.js\", \"utf8\"), {\n compress: {\n dead_code: true,\n global_defs: {\n DEBUG: false\n }\n }\n});\n```\n\nTo replace an identifier with an arbitrary non-constant expression it is\nnecessary to prefix the `global_defs` key with `\"@\"` to instruct Terser\nto parse the value as an expression:\n```javascript\nTerser.minify(\"alert('hello');\", {\n compress: {\n global_defs: {\n \"@alert\": \"console.log\"\n }\n }\n}).code;\n// returns: 'console.log(\"hello\");'\n```\n\nOtherwise it would be replaced as string literal:\n```javascript\nTerser.minify(\"alert('hello');\", {\n compress: {\n global_defs: {\n \"alert\": \"console.log\"\n }\n }\n}).code;\n// returns: '\"console.log\"(\"hello\");'\n```\n\n### Using native Terser AST with `minify()`\n```javascript\n// example: parse only, produce native Terser AST\n\nvar result = Terser.minify(code, {\n parse: {},\n compress: false,\n mangle: false,\n output: {\n ast: true,\n code: false // optional - faster if false\n }\n});\n\n// result.ast contains native Terser AST\n```\n```javascript\n// example: accept native Terser AST input and then compress and mangle\n// to produce both code and native AST.\n\nvar result = Terser.minify(ast, {\n compress: {},\n mangle: {},\n output: {\n ast: true,\n code: true // optional - faster if false\n }\n});\n\n// result.ast contains native Terser AST\n// result.code contains the minified code in string form.\n```\n\n### Working with Terser AST\n\nTraversal and transformation of the native AST can be performed through\n[`TreeWalker`](https://github.com/fabiosantoscode/terser/blob/master/lib/ast.js) and\n[`TreeTransformer`](https://github.com/fabiosantoscode/terser/blob/master/lib/transform.js)\nrespectively.\n\nLargely compatible native AST examples can be found in the original UglifyJS\ndocumentation. See: [tree walker](http://lisperator.net/uglifyjs/walk) and\n[tree transform](http://lisperator.net/uglifyjs/transform).\n\n### ESTree / SpiderMonkey AST\n\nTerser has its own abstract syntax tree format; for\n[practical reasons](http://lisperator.net/blog/uglifyjs-why-not-switching-to-spidermonkey-ast/)\nwe can't easily change to using the SpiderMonkey AST internally. However,\nTerser now has a converter which can import a SpiderMonkey AST.\n\nFor example [Acorn][acorn] is a super-fast parser that produces a\nSpiderMonkey AST. It has a small CLI utility that parses one file and dumps\nthe AST in JSON on the standard output. To use Terser to mangle and\ncompress that:\n\n acorn file.js | terser -p spidermonkey -m -c\n\nThe `-p spidermonkey` option tells Terser that all input files are not\nJavaScript, but JS code described in SpiderMonkey AST in JSON. Therefore we\ndon't use our own parser in this case, but just transform that AST into our\ninternal AST.\n\n### Use Acorn for parsing\n\nMore for fun, I added the `-p acorn` option which will use Acorn to do all\nthe parsing. If you pass this option, Terser will `require(\"acorn\")`.\n\nAcorn is really fast (e.g. 250ms instead of 380ms on some 650K code), but\nconverting the SpiderMonkey tree that Acorn produces takes another 150ms so\nin total it's a bit more than just using Terser's own parser.\n\n[acorn]: https://github.com/ternjs/acorn\n[sm-spec]: https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k\n\n### Terser Fast Minify Mode\n\nIt's not well known, but whitespace removal and symbol mangling accounts\nfor 95% of the size reduction in minified code for most JavaScript - not\nelaborate code transforms. One can simply disable `compress` to speed up\nTerser builds by 3 to 4 times.\n\n| d3.js | size | gzip size | time (s) |\n| --- | ---: | ---: | ---: |\n| original | 451,131 | 108,733 | - |\n| terser@3.7.5 mangle=false, compress=false | 316,600 | 85,245 | 0.82 |\n| terser@3.7.5 mangle=true, compress=false | 220,216 | 72,730 | 1.45 |\n| terser@3.7.5 mangle=true, compress=true | 212,046 | 70,954 | 5.87 |\n| babili@0.1.4 | 210,713 | 72,140 | 12.64 |\n| babel-minify@0.4.3 | 210,321 | 72,242 | 48.67 |\n| babel-minify@0.5.0-alpha.01eac1c3 | 210,421 | 72,238 | 14.17 |\n\nTo enable fast minify mode from the CLI use:\n```\nterser file.js -m\n```\nTo enable fast minify mode with the API use:\n```js\nTerser.minify(code, { compress: false, mangle: true });\n```\n\n#### Source maps and debugging\n\nVarious `compress` transforms that simplify, rearrange, inline and remove code\nare known to have an adverse effect on debugging with source maps. This is\nexpected as code is optimized and mappings are often simply not possible as\nsome code no longer exists. For highest fidelity in source map debugging\ndisable the `compress` option and just use `mangle`.\n\n### Compiler assumptions\n\nTo allow for better optimizations, the compiler makes various assumptions:\n\n- `.toString()` and `.valueOf()` don't have side effects, and for built-in\n objects they have not been overridden.\n- `undefined`, `NaN` and `Infinity` have not been externally redefined.\n- `arguments.callee`, `arguments.caller` and `Function.prototype.caller` are not used.\n- The code doesn't expect the contents of `Function.prototype.toString()` or\n `Error.prototype.stack` to be anything in particular.\n- Getting and setting properties on a plain object does not cause other side effects\n (using `.watch()` or `Proxy`).\n- Object properties can be added, removed and modified (not prevented with\n `Object.defineProperty()`, `Object.defineProperties()`, `Object.freeze()`,\n `Object.preventExtensions()` or `Object.seal()`).\n\n### Build Tools and Adaptors using Terser\n\nhttps://www.npmjs.com/browse/depended/terser\n\n### Replacing `uglify-es` with `terser` in a project using `yarn`\n\nA number of JS bundlers and uglify wrappers are still using buggy versions\nof `uglify-es` and have not yet upgraded to `terser`. If you are using `yarn`\nyou can add the following alias to your project's `package.json` file:\n\n```js\n \"resolutions\": {\n \"uglify-es\": \"npm:terser\"\n }\n```\n\nto use `terser` instead of `uglify-es` in all deeply nested dependencies\nwithout changing any code.\n\nNote: for this change to take effect you must run the following commands\nto remove the existing `yarn` lock file and reinstall all packages:\n\n```\n$ rm -rf node_modules yarn.lock\n$ yarn\n```\n\n# Reporting issues\n\nIn the terser CLI we use [source-map-support](https://npmjs.com/source-map-support) to produce good error stacks. In your own app, you're expected to enable source-map-support (read their docs) to have nice stack traces that will make good issues.\n\n# README.md Patrons:\n\n*note*: You can support this project on patreon: <a target=\"_blank\" rel=\"nofollow\" href=\"https://www.patreon.com/terser_ecmacomp_maintainer\"><img src=\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\" alt=\"patron\" width=\"100px\" height=\"auto\"></a>. Check out PATRONS.md for our first-tier patrons.\n\n * CKEditor \n * 38elements \n# near-sdk-as\nCollection of packages used in developing NEAR smart contracts in AssemblyScript including:\n\n- [`runtime`](./assembly/runtime) - AssemblyScript near runtime library\n- [`bindgen`](./bindgen) - AssemblyScript transformer that adds the bindings needed to (de)serialize input and outputs.\n- [`wasm-mock-vm`](https://github.com/nearprotocol/wasm-mock-vm) - Core of the NEAR VM compiled to WebAssembly used for writing unit tests.\n- [`VM Runtime`](./runtime) - A NearVM Simulator for making contract calls.\n- [`@as-pect/cli`](https://github.com/jtenner/as-pect) - AssemblyScript testing framework similar to jest.\n\n## To Install\n```\nyarn add -D near-sdk-as\n```\n\n## License\n\n`near-sdk-as` is distributed under the terms of both the MIT license and the Apache License (Version 2.0).\n\nSee [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.\n# <img src=\"docs_app/assets/Rx_Logo_S.png\" alt=\"RxJS Logo\" width=\"86\" height=\"86\"> RxJS: Reactive Extensions For JavaScript\n\n[](https://circleci.com/gh/ReactiveX/rxjs/tree/6.x)\n[](http://badge.fury.io/js/%40reactivex%2Frxjs)\n[](https://gitter.im/Reactive-Extensions/RxJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\n# RxJS 6 Stable\n\n### MIGRATION AND RELEASE INFORMATION:\n\nFind out how to update to v6, **automatically update your TypeScript code**, and more!\n\n- [Current home is MIGRATION.md](./docs_app/content/guide/v6/migration.md)\n\n### FOR V 5.X PLEASE GO TO [THE 5.0 BRANCH](https://github.com/ReactiveX/rxjs/tree/5.x)\n\nReactive Extensions Library for JavaScript. This is a rewrite of [Reactive-Extensions/RxJS](https://github.com/Reactive-Extensions/RxJS) and is the latest production-ready version of RxJS. This rewrite is meant to have better performance, better modularity, better debuggable call stacks, while staying mostly backwards compatible, with some breaking changes that reduce the API surface.\n\n[Apache 2.0 License](LICENSE.txt)\n\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Contribution Guidelines](CONTRIBUTING.md)\n- [Maintainer Guidelines](doc_app/content/maintainer-guidelines.md)\n- [API Documentation](https://rxjs.dev/)\n\n## Versions In This Repository\n\n- [master](https://github.com/ReactiveX/rxjs/commits/master) - This is all of the current, unreleased work, which is against v6 of RxJS right now\n- [stable](https://github.com/ReactiveX/rxjs/commits/stable) - This is the branch for the latest version you'd get if you do `npm install rxjs`\n\n## Important\n\nBy contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.\n\n## Installation and Usage\n\n### ES6 via npm\n\n```sh\nnpm install rxjs\n```\n\nIt's recommended to pull in the Observable creation methods you need directly from `'rxjs'` as shown below with `range`. And you can pull in any operator you need from one spot, under `'rxjs/operators'`.\n\n```ts\nimport { range } from \"rxjs\";\nimport { map, filter } from \"rxjs/operators\";\n\nrange(1, 200)\n .pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n )\n .subscribe(x => console.log(x));\n```\n\nHere, we're using the built-in `pipe` method on Observables to combine operators. See [pipeable operators](https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md) for more information.\n\n### CommonJS via npm\n\nTo install this library for CommonJS (CJS) usage, use the following command:\n\n```sh\nnpm install rxjs\n```\n\n(Note: destructuring available in Node 8+)\n\n```js\nconst { range } = require('rxjs');\nconst { map, filter } = require('rxjs/operators');\n\nrange(1, 200).pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n).subscribe(x => console.log(x));\n```\n\n### CDN\n\nFor CDN, you can use [unpkg](https://unpkg.com/):\n\nhttps://unpkg.com/rxjs/bundles/rxjs.umd.min.js\n\nThe global namespace for rxjs is `rxjs`:\n\n```js\nconst { range } = rxjs;\nconst { map, filter } = rxjs.operators;\n\nrange(1, 200)\n .pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n )\n .subscribe(x => console.log(x));\n```\n\n## Goals\n\n- Smaller overall bundles sizes\n- Provide better performance than preceding versions of RxJS\n- To model/follow the [Observable Spec Proposal](https://github.com/zenparsing/es-observable) to the observable\n- Provide more modular file structure in a variety of formats\n- Provide more debuggable call stacks than preceding versions of RxJS\n\n## Building/Testing\n\n- `npm run build_all` - builds everything\n- `npm test` - runs tests\n- `npm run test_no_cache` - run test with `ts-node` set to false\n\n## Performance Tests\n\nRun `npm run build_perf` or `npm run perf` to run the performance tests with `protractor`.\n\nRun `npm run perf_micro [operator]` to run micro performance test benchmarking operator.\n\n## Adding documentation\n\nWe appreciate all contributions to the documentation of any type. All of the information needed to get the docs app up and running locally as well as how to contribute can be found in the [documentation directory](./docs_app).\n\n## Generating PNG marble diagrams\n\nThe script `npm run tests2png` requires some native packages installed locally: `imagemagick`, `graphicsmagick`, and `ghostscript`.\n\nFor Mac OS X with [Homebrew](http://brew.sh/):\n\n- `brew install imagemagick`\n- `brew install graphicsmagick`\n- `brew install ghostscript`\n- You may need to install the Ghostscript fonts manually:\n - Download the tarball from the [gs-fonts project](https://sourceforge.net/projects/gs-fonts)\n - `mkdir -p /usr/local/share/ghostscript && tar zxvf /path/to/ghostscript-fonts.tar.gz -C /usr/local/share/ghostscript`\n\nFor Debian Linux:\n\n- `sudo add-apt-repository ppa:dhor/myway`\n- `apt-get install imagemagick`\n- `apt-get install graphicsmagick`\n- `apt-get install ghostscript`\n\nFor Windows and other Operating Systems, check the download instructions here:\n\n- http://imagemagick.org\n- http://www.graphicsmagick.org\n- http://www.ghostscript.com/\n# <img src=\"docs_app/assets/Rx_Logo_S.png\" alt=\"RxJS Logo\" width=\"86\" height=\"86\"> RxJS: Reactive Extensions For JavaScript\n\n[](https://circleci.com/gh/ReactiveX/rxjs/tree/6.x)\n[](http://badge.fury.io/js/%40reactivex%2Frxjs)\n[](https://gitter.im/Reactive-Extensions/RxJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\n# RxJS 6 Stable\n\n### MIGRATION AND RELEASE INFORMATION:\n\nFind out how to update to v6, **automatically update your TypeScript code**, and more!\n\n- [Current home is MIGRATION.md](./docs_app/content/guide/v6/migration.md)\n\n### FOR V 5.X PLEASE GO TO [THE 5.0 BRANCH](https://github.com/ReactiveX/rxjs/tree/5.x)\n\nReactive Extensions Library for JavaScript. This is a rewrite of [Reactive-Extensions/RxJS](https://github.com/Reactive-Extensions/RxJS) and is the latest production-ready version of RxJS. This rewrite is meant to have better performance, better modularity, better debuggable call stacks, while staying mostly backwards compatible, with some breaking changes that reduce the API surface.\n\n[Apache 2.0 License](LICENSE.txt)\n\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Contribution Guidelines](CONTRIBUTING.md)\n- [Maintainer Guidelines](doc_app/content/maintainer-guidelines.md)\n- [API Documentation](https://rxjs.dev/)\n\n## Versions In This Repository\n\n- [master](https://github.com/ReactiveX/rxjs/commits/master) - This is all of the current, unreleased work, which is against v6 of RxJS right now\n- [stable](https://github.com/ReactiveX/rxjs/commits/stable) - This is the branch for the latest version you'd get if you do `npm install rxjs`\n\n## Important\n\nBy contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.\n\n## Installation and Usage\n\n### ES6 via npm\n\n```sh\nnpm install rxjs\n```\n\nIt's recommended to pull in the Observable creation methods you need directly from `'rxjs'` as shown below with `range`. And you can pull in any operator you need from one spot, under `'rxjs/operators'`.\n\n```ts\nimport { range } from \"rxjs\";\nimport { map, filter } from \"rxjs/operators\";\n\nrange(1, 200)\n .pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n )\n .subscribe(x => console.log(x));\n```\n\nHere, we're using the built-in `pipe` method on Observables to combine operators. See [pipeable operators](https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md) for more information.\n\n### CommonJS via npm\n\nTo install this library for CommonJS (CJS) usage, use the following command:\n\n```sh\nnpm install rxjs\n```\n\n(Note: destructuring available in Node 8+)\n\n```js\nconst { range } = require('rxjs');\nconst { map, filter } = require('rxjs/operators');\n\nrange(1, 200).pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n).subscribe(x => console.log(x));\n```\n\n### CDN\n\nFor CDN, you can use [unpkg](https://unpkg.com/):\n\nhttps://unpkg.com/rxjs/bundles/rxjs.umd.min.js\n\nThe global namespace for rxjs is `rxjs`:\n\n```js\nconst { range } = rxjs;\nconst { map, filter } = rxjs.operators;\n\nrange(1, 200)\n .pipe(\n filter(x => x % 2 === 1),\n map(x => x + x)\n )\n .subscribe(x => console.log(x));\n```\n\n## Goals\n\n- Smaller overall bundles sizes\n- Provide better performance than preceding versions of RxJS\n- To model/follow the [Observable Spec Proposal](https://github.com/zenparsing/es-observable) to the observable\n- Provide more modular file structure in a variety of formats\n- Provide more debuggable call stacks than preceding versions of RxJS\n\n## Building/Testing\n\n- `npm run build_all` - builds everything\n- `npm test` - runs tests\n- `npm run test_no_cache` - run test with `ts-node` set to false\n\n## Performance Tests\n\nRun `npm run build_perf` or `npm run perf` to run the performance tests with `protractor`.\n\nRun `npm run perf_micro [operator]` to run micro performance test benchmarking operator.\n\n## Adding documentation\n\nWe appreciate all contributions to the documentation of any type. All of the information needed to get the docs app up and running locally as well as how to contribute can be found in the [documentation directory](./docs_app).\n\n## Generating PNG marble diagrams\n\nThe script `npm run tests2png` requires some native packages installed locally: `imagemagick`, `graphicsmagick`, and `ghostscript`.\n\nFor Mac OS X with [Homebrew](http://brew.sh/):\n\n- `brew install imagemagick`\n- `brew install graphicsmagick`\n- `brew install ghostscript`\n- You may need to install the Ghostscript fonts manually:\n - Download the tarball from the [gs-fonts project](https://sourceforge.net/projects/gs-fonts)\n - `mkdir -p /usr/local/share/ghostscript && tar zxvf /path/to/ghostscript-fonts.tar.gz -C /usr/local/share/ghostscript`\n\nFor Debian Linux:\n\n- `sudo add-apt-repository ppa:dhor/myway`\n- `apt-get install imagemagick`\n- `apt-get install graphicsmagick`\n- `apt-get install ghostscript`\n\nFor Windows and other Operating Systems, check the download instructions here:\n\n- http://imagemagick.org\n- http://www.graphicsmagick.org\n- http://www.ghostscript.com/\n# BIP39\n\n[](https://travis-ci.org/bitcoinjs/bip39)\n[](https://www.npmjs.org/package/bip39)\n\n[](https://github.com/feross/standard)\n\nJavaScript implementation of [Bitcoin BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki): Mnemonic code for generating deterministic keys\n\n## Reminder for developers\n\n***Please remember to allow recovery from mnemonic phrases that have invalid checksums (or that you don't have the wordlist)***\n\nWhen a checksum is invalid, warn the user that the phrase is not something generated by your app, and ask if they would like to use it anyway. This way, your app only needs to hold the wordlists for your supported languages, but you can recover phrases made by other apps in other languages.\n\nHowever, there should be other checks in place, such as checking to make sure the user is inputting 12 words or more separated by a space. ie. `phrase.trim().split(/\\s+/g).length >= 12`\n\n## Examples\n``` js\n// Generate a random mnemonic (uses crypto.randomBytes under the hood), defaults to 128-bits of entropy\nvar mnemonic = bip39.generateMnemonic()\n// => 'seed sock milk update focus rotate barely fade car face mechanic mercy'\n\nbip39.mnemonicToSeedHex('basket actual')\n// => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'\n\nbip39.mnemonicToSeed('basket actual')\n// => <Buffer 5c f2 d4 a8 b0 35 5e 90 29 5b df c5 65 a0 22 a4 09 af 06 3d 53 65 bb 57 bf 74 d9 52 8f 49 4b fa 44 00 f5 3d 83 49 b8 0f da e4 40 82 d7 f9 54 1e 1d ba 2b ...>\n\nbip39.validateMnemonic(mnemonic)\n// => true\n\nbip39.validateMnemonic('basket actual')\n// => false\n```\n\n``` js\nvar bip39 = require('bip39')\n\n// defaults to BIP39 English word list\n// uses HEX strings for entropy\nvar mnemonic = bip39.entropyToMnemonic('00000000000000000000000000000000')\n// => zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong\n\n// reversible\nbip39.mnemonicToEntropy(mnemonic)\n// => '133755ff'\n```\n# npmlog\n\nThe logger util that npm uses.\n\nThis logger is very basic. It does the logging for npm. It supports\ncustom levels and colored output.\n\nBy default, logs are written to stderr. If you want to send log messages\nto outputs other than streams, then you can change the `log.stream`\nmember, or you can just listen to the events that it emits, and do\nwhatever you want with them.\n\n# Installation\n\n```console\nnpm install npmlog --save\n```\n\n# Basic Usage\n\n```javascript\nvar log = require('npmlog')\n\n// additional stuff ---------------------------+\n// message ----------+ |\n// prefix ----+ | |\n// level -+ | | |\n// v v v v\n log.info('fyi', 'I have a kitty cat: %j', myKittyCat)\n```\n\n## log.level\n\n* {String}\n\nThe level to display logs at. Any logs at or above this level will be\ndisplayed. The special level `silent` will prevent anything from being\ndisplayed ever.\n\n## log.record\n\n* {Array}\n\nAn array of all the log messages that have been entered.\n\n## log.maxRecordSize\n\n* {Number}\n\nThe maximum number of records to keep. If log.record gets bigger than\n10% over this value, then it is sliced down to 90% of this value.\n\nThe reason for the 10% window is so that it doesn't have to resize a\nlarge array on every log entry.\n\n## log.prefixStyle\n\n* {Object}\n\nA style object that specifies how prefixes are styled. (See below)\n\n## log.headingStyle\n\n* {Object}\n\nA style object that specifies how the heading is styled. (See below)\n\n## log.heading\n\n* {String} Default: \"\"\n\nIf set, a heading that is printed at the start of every line.\n\n## log.stream\n\n* {Stream} Default: `process.stderr`\n\nThe stream where output is written.\n\n## log.enableColor()\n\nForce colors to be used on all messages, regardless of the output\nstream.\n\n## log.disableColor()\n\nDisable colors on all messages.\n\n## log.enableProgress()\n\nEnable the display of log activity spinner and progress bar\n\n## log.disableProgress()\n\nDisable the display of a progress bar\n\n## log.enableUnicode()\n\nForce the unicode theme to be used for the progress bar.\n\n## log.disableUnicode()\n\nDisable the use of unicode in the progress bar.\n\n## log.setGaugeTemplate(template)\n\nSet a template for outputting the progress bar. See the [gauge documentation] for details.\n\n[gauge documentation]: https://npmjs.com/package/gauge\n\n## log.setGaugeThemeset(themes)\n\nSelect a themeset to pick themes from for the progress bar. See the [gauge documentation] for details.\n\n## log.pause()\n\nStop emitting messages to the stream, but do not drop them.\n\n## log.resume()\n\nEmit all buffered messages that were written while paused.\n\n## log.log(level, prefix, message, ...)\n\n* `level` {String} The level to emit the message at\n* `prefix` {String} A string prefix. Set to \"\" to skip.\n* `message...` Arguments to `util.format`\n\nEmit a log message at the specified level.\n\n## log\\[level](prefix, message, ...)\n\nFor example,\n\n* log.silly(prefix, message, ...)\n* log.verbose(prefix, message, ...)\n* log.info(prefix, message, ...)\n* log.http(prefix, message, ...)\n* log.warn(prefix, message, ...)\n* log.error(prefix, message, ...)\n\nLike `log.log(level, prefix, message, ...)`. In this way, each level is\ngiven a shorthand, so you can do `log.info(prefix, message)`.\n\n## log.addLevel(level, n, style, disp)\n\n* `level` {String} Level indicator\n* `n` {Number} The numeric level\n* `style` {Object} Object with fg, bg, inverse, etc.\n* `disp` {String} Optional replacement for `level` in the output.\n\nSets up a new level with a shorthand function and so forth.\n\nNote that if the number is `Infinity`, then setting the level to that\nwill cause all log messages to be suppressed. If the number is\n`-Infinity`, then the only way to show it is to enable all log messages.\n\n## log.newItem(name, todo, weight)\n\n* `name` {String} Optional; progress item name.\n* `todo` {Number} Optional; total amount of work to be done. Default 0.\n* `weight` {Number} Optional; the weight of this item relative to others. Default 1.\n\nThis adds a new `are-we-there-yet` item tracker to the progress tracker. The\nobject returned has the `log[level]` methods but is otherwise an\n`are-we-there-yet` `Tracker` object.\n\n## log.newStream(name, todo, weight)\n\nThis adds a new `are-we-there-yet` stream tracker to the progress tracker. The\nobject returned has the `log[level]` methods but is otherwise an\n`are-we-there-yet` `TrackerStream` object.\n\n## log.newGroup(name, weight)\n\nThis adds a new `are-we-there-yet` tracker group to the progress tracker. The\nobject returned has the `log[level]` methods but is otherwise an\n`are-we-there-yet` `TrackerGroup` object.\n\n# Events\n\nEvents are all emitted with the message object.\n\n* `log` Emitted for all messages\n* `log.<level>` Emitted for all messages with the `<level>` level.\n* `<prefix>` Messages with prefixes also emit their prefix as an event.\n\n# Style Objects\n\nStyle objects can have the following fields:\n\n* `fg` {String} Color for the foreground text\n* `bg` {String} Color for the background\n* `bold`, `inverse`, `underline` {Boolean} Set the associated property\n* `bell` {Boolean} Make a noise (This is pretty annoying, probably.)\n\n# Message Objects\n\nEvery log event is emitted with a message object, and the `log.record`\nlist contains all of them that have been created. They have the\nfollowing fields:\n\n* `id` {Number}\n* `level` {String}\n* `prefix` {String}\n* `message` {String} Result of `util.format()`\n* `messageRaw` {Array} Arguments to `util.format()`\n\n# Blocking TTYs\n\nWe use [`set-blocking`](https://npmjs.com/package/set-blocking) to set\nstderr and stdout blocking if they are tty's and have the setBlocking call.\nThis is a work around for an issue in early versions of Node.js 6.x, which\nmade stderr and stdout non-blocking on OSX. (They are always blocking\nWindows and were never blocking on Linux.) `npmlog` needs them to be blocking\nso that it can allow output to stdout and stderr to be interlaced.\n# regexpu-core [](https://travis-ci.org/mathiasbynens/regexpu-core) [](https://codecov.io/gh/mathiasbynens/regexpu-core)\n\n_regexpu_ is a source code transpiler that enables the use of ES2015 Unicode regular expressions in JavaScript-of-today (ES5).\n\n_regexpu-core_ contains _regexpu_’s core functionality, i.e. `rewritePattern(pattern, flag)`, which enables rewriting regular expressions that make use of [the ES2015 `u` flag](https://mathiasbynens.be/notes/es6-unicode-regex) into equivalent ES5-compatible regular expression patterns.\n\n## Installation\n\nTo use _regexpu-core_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):\n\n```bash\nnpm install regexpu-core --save\n```\n\nThen, `require` it:\n\n```js\nconst rewritePattern = require('regexpu-core');\n```\n\n## API\n\nThis module exports a single function named `rewritePattern`.\n\n### `rewritePattern(pattern, flags, options)`\n\nThis function takes a string that represents a regular expression pattern as well as a string representing its flags, and returns an ES5-compatible version of the pattern.\n\n```js\nrewritePattern('foo.bar', 'u');\n// → 'foo(?:[\\\\0-\\\\t\\\\x0B\\\\f\\\\x0E-\\\\u2027\\\\u202A-\\\\uD7FF\\\\uDC00-\\\\uFFFF]|[\\\\uD800-\\\\uDBFF][\\\\uDC00-\\\\uDFFF]|[\\\\uD800-\\\\uDBFF])bar'\n\nrewritePattern('[\\\\u{1D306}-\\\\u{1D308}a-z]', 'u');\n// → '(?:[a-z]|\\\\uD834[\\\\uDF06-\\\\uDF08])'\n\nrewritePattern('[\\\\u{1D306}-\\\\u{1D308}a-z]', 'ui');\n// → '(?:[a-z\\\\u017F\\\\u212A]|\\\\uD834[\\\\uDF06-\\\\uDF08])'\n```\n\n_regexpu-core_ can rewrite non-ES6 regular expressions too, which is useful to demonstrate how their behavior changes once the `u` and `i` flags are added:\n\n```js\n// In ES5, the dot operator only matches BMP symbols:\nrewritePattern('foo.bar');\n// → 'foo(?:[\\\\0-\\\\t\\\\x0B\\\\f\\\\x0E-\\\\u2027\\\\u202A-\\\\uFFFF])bar'\n\n// But with the ES2015 `u` flag, it matches astral symbols too:\nrewritePattern('foo.bar', 'u');\n// → 'foo(?:[\\\\0-\\\\t\\\\x0B\\\\f\\\\x0E-\\\\u2027\\\\u202A-\\\\uD7FF\\\\uDC00-\\\\uFFFF]|[\\\\uD800-\\\\uDBFF][\\\\uDC00-\\\\uDFFF]|[\\\\uD800-\\\\uDBFF])bar'\n```\n\nThe optional `options` argument recognizes the following properties:\n\n#### `dotAllFlag` (default: `false`)\n\nSetting this option to `true` enables support for [the `s` (`dotAll`) flag](https://github.com/mathiasbynens/es-regexp-dotall-flag).\n\n```js\nrewritePattern('.');\n// → '[\\\\0-\\\\t\\\\x0B\\\\f\\\\x0E-\\\\u2027\\\\u202A-\\\\uFFFF]'\n\nrewritePattern('.', '', {\n 'dotAllFlag': true\n});\n// → '[\\\\0-\\\\t\\\\x0B\\\\f\\\\x0E-\\\\u2027\\\\u202A-\\\\uFFFF]'\n\nrewritePattern('.', 's', {\n 'dotAllFlag': true\n});\n// → '[\\\\0-\\\\uFFFF]'\n\nrewritePattern('.', 'su', {\n 'dotAllFlag': true\n});\n// → '(?:[\\\\0-\\\\uD7FF\\\\uE000-\\\\uFFFF]|[\\\\uD800-\\\\uDBFF][\\\\uDC00-\\\\uDFFF]|[\\\\uD800-\\\\uDBFF](?![\\\\uDC00-\\\\uDFFF])|(?:[^\\\\uD800-\\\\uDBFF]|^)[\\\\uDC00-\\\\uDFFF])'\n```\n\n#### `unicodePropertyEscape` (default: `false`)\n\nSetting this option to `true` enables [support for Unicode property escapes](property-escapes.md):\n\n```js\nrewritePattern('\\\\p{Script_Extensions=Anatolian_Hieroglyphs}', 'u', {\n 'unicodePropertyEscape': true\n});\n// → '(?:\\\\uD811[\\\\uDC00-\\\\uDE46])'\n```\n\n#### `lookbehind` (default: `false`)\n\nSetting this option to `true` enables support for [lookbehind assertions](https://github.com/tc39/proposal-regexp-lookbehind).\n\n```js\nrewritePattern('(?<=.)a', '', {\n 'lookbehind': true\n});\n// → '(?<=[\\\\0-\\\\t\\\\x0B\\\\f\\\\x0E-\\\\u2027\\\\u202A-\\\\uFFFF])a'\n```\n\n#### `namedGroup` (default: `false`)\n\nSetting this option to `true` enables support for [named capture groups](https://github.com/tc39/proposal-regexp-named-groups).\n\n```js\nrewritePattern('(?<name>.)\\k<name>', '', {\n 'namedGroup': true\n});\n// → '(.)\\1'\n```\n\n#### `onNamedGroup`\n\nThis option is a function that gets called when a named capture group is found. It receives two parameters:\nthe name of the group, and its index.\n\n```js\nrewritePattern('(?<name>.)\\k<name>', '', {\n 'namedGroup': true,\n onNamedGroup(name, index) {\n console.log(name, index);\n // → 'name', 1\n }\n});\n```\n\n#### `useUnicodeFlag` (default: `false`)\n\nSetting this option to `true` enables the use of Unicode code point escapes of the form `\\u{…}`. Note that in regular expressions, such escape sequences only work correctly when the ES2015 `u` flag is set. Enabling this setting often results in more compact output, although there are cases (such as `\\p{Lu}`) where it actually _increases_ the output size.\n\n```js\nrewritePattern('\\\\p{Script_Extensions=Anatolian_Hieroglyphs}', 'u', {\n 'unicodePropertyEscape': true,\n 'useUnicodeFlag': true\n});\n// → '[\\\\u{14400}-\\\\u{14646}]'\n```\n\n## Author\n\n| [](https://twitter.com/mathias \"Follow @mathias on Twitter\") |\n|---|\n| [Mathias Bynens](https://mathiasbynens.be/) |\n\n## License\n\n_regexpu-core_ is available under the [MIT](https://mths.be/mit) license.\ncss-color-names\n===============\n\nA JSON Object of css color names mapped to their hex value\n\nUsage\n-----\n\n``` js\nvar csscolors = require('css-color-names');\nconsole.dir(csscolors);\n```\n\nyields\n\n``` json\n{\n \"aqua\": \"#00ffff\",\n \"aliceblue\": \"#f0f8ff\",\n \"antiquewhite\": \"#faebd7\",\n \"black\": \"#000000\",\n \"blue\": \"#0000ff\",\n ...\n}\n```\n\nHow was this list generated?\n----------------------------\n\nIn the Makefile you'll see a line like this:\n\n\t./getcolors.sh | ./stringify.js > $(FILE)\n\nThe first command scrapes a site for the list,\nand outputs the results separated by newlines. The\nsecond command creates the JSON object and outputs\nit to stdout, which then gets redirected into\n`css-color-names.json`\n\nInstallation\n------------\n\n npm install css-color-names\n\nLicense\n-------\n\nMIT\n# toidentifier\n\n[![NPM Version][npm-image]][npm-url]\n[![NPM Downloads][downloads-image]][downloads-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][codecov-image]][codecov-url]\n\n> Convert a string of words to a JavaScript identifier\n\n## Install\n\nThis is a [Node.js](https://nodejs.org/en/) module available through the\n[npm registry](https://www.npmjs.com/). Installation is done using the\n[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):\n\n```bash\n$ npm install toidentifier\n```\n\n## Example\n\n```js\nvar toIdentifier = require('toidentifier')\n\nconsole.log(toIdentifier('Bad Request'))\n// => \"BadRequest\"\n```\n\n## API\n\nThis CommonJS module exports a single default function: `toIdentifier`.\n\n### toIdentifier(string)\n\nGiven a string as the argument, it will be transformed according to\nthe following rules and the new string will be returned:\n\n1. Split into words separated by space characters (`0x20`).\n2. Upper case the first character of each word.\n3. Join the words together with no separator.\n4. Remove all non-word (`[0-9a-z_]`) characters.\n\n## License\n\n[MIT](LICENSE)\n\n[codecov-image]: https://img.shields.io/codecov/c/github/component/toidentifier.svg\n[codecov-url]: https://codecov.io/gh/component/toidentifier\n[downloads-image]: https://img.shields.io/npm/dm/toidentifier.svg\n[downloads-url]: https://npmjs.org/package/toidentifier\n[npm-image]: https://img.shields.io/npm/v/toidentifier.svg\n[npm-url]: https://npmjs.org/package/toidentifier\n[travis-image]: https://img.shields.io/travis/component/toidentifier/master.svg\n[travis-url]: https://travis-ci.org/component/toidentifier\n\n##\n\n[npm]: https://www.npmjs.com/\n\n[yarn]: https://yarnpkg.com/\n# grapheme-breaker\nA JavaScript implementation of the Unicode grapheme cluster breaking algorithm ([UAX #29](http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries))\n\n> It is important to recognize that what the user thinks of as a “character”—a basic unit of a writing system for a \n> language—may not be just a single Unicode code point. Instead, that basic unit may be made up of multiple Unicode \n> code points. To avoid ambiguity with the computer use of the term character, this is called a user-perceived character. \n> For example, “G” + acute-accent is a user-perceived character: users think of it as a single character, yet is actually \n> represented by two Unicode code points. These user-perceived characters are approximated by what is called a grapheme cluster, \n> which can be determined programmatically.\n\n## Installation\n\nYou can install via npm\n\n npm install grapheme-breaker\n\n## Example\n\n```javascript\nvar GraphemeBreaker = require('grapheme-breaker');\n\n// break a string into an array of grapheme clusters\n\nGraphemeBreaker.break('Z͑ͫ̓ͪ̂ͫ̽͏̴̙̤̞͉͚̯̞̠͍A̴̵̜̰͔ͫ͗͢L̠ͨͧͩ͘G̴̻͈͍͔̹̑͗̎̅͛́Ǫ̵̹̻̝̳͂̌̌͘!͖̬̰̙̗̿̋ͥͥ̂ͣ̐́́͜͞') // => ['Z͑ͫ̓ͪ̂ͫ̽͏̴̙̤̞͉͚̯̞̠͍', 'A̴̵̜̰͔ͫ͗͢', 'L̠ͨͧͩ͘', 'G̴̻͈͍͔̹̑͗̎̅͛́', 'Ǫ̵̹̻̝̳͂̌̌͘', '!͖̬̰̙̗̿̋ͥͥ̂ͣ̐́́͜͞']\n\n// or just count the number of grapheme clusters in a string\n\nGraphemeBreaker.countBreaks('Z͑ͫ̓ͪ̂ͫ̽͏̴̙̤̞͉͚̯̞̠͍A̴̵̜̰͔ͫ͗͢L̠ͨͧͩ͘G̴̻͈͍͔̹̑͗̎̅͛́Ǫ̵̹̻̝̳͂̌̌͘!͖̬̰̙̗̿̋ͥͥ̂ͣ̐́́͜͞') // => 6\n\n// use nextBreak and previousBreak to get break points starting \n// from anywhere in the string\nGraphemeBreaker.nextBreak('😜🇺🇸👍', 3) // => 6\nGraphemeBreaker.previousBreak('😜🇺🇸👍', 3) // => 2\n```\n\n## Development Notes\n\nIn order to use the library, you shouldn't need to know this, but if you're interested in\ncontributing or fixing bugs, these things might be of interest.\n\n* The `src/classes.coffee` file is automatically generated from `GraphemeBreakProperty.txt` in the Unicode \n database by `src/generate_data.coffee`. It should be rare that you need to run this, but\n you may if, for instance, you want to change the Unicode version.\n \n* You can run the tests using `npm test`. They are written using `mocha`, and generated from\n `GraphemeBreakTest.txt` from the Unicode database, which is included in the repository for performance\n reasons while running them.\n\n## License\n\nMIT\n# extend-shallow [](http://badge.fury.io/js/extend-shallow) [](https://travis-ci.org/jonschlinkert/extend-shallow)\n\n> Extend an object with the properties of additional objects. node.js/javascript util.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i extend-shallow --save\n```\n\n## Usage\n\n```js\nvar extend = require('extend-shallow');\n\nextend({a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\nPass an empty object to shallow clone:\n\n```js\nvar obj = {};\nextend(obj, {a: 'b'}, {c: 'd'})\n//=> {a: 'b', c: 'd'}\n```\n\n## Related\n\n* [extend-shallow](https://github.com/jonschlinkert/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util.\n* [for-own](https://github.com/jonschlinkert/for-own): Iterate over the own enumerable properties of an object, and return an object with properties… [more](https://github.com/jonschlinkert/for-own)\n* [for-in](https://github.com/jonschlinkert/for-in): Iterate over the own and inherited enumerable properties of an objecte, and return an object… [more](https://github.com/jonschlinkert/for-in)\n* [is-plain-object](https://github.com/jonschlinkert/is-plain-object): Returns true if an object was created by the `Object` constructor.\n* [isobject](https://github.com/jonschlinkert/isobject): Returns true if the value is an object and not an array or null.\n* [kind-of](https://github.com/jonschlinkert/kind-of): Get the native type of a value.\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on June 29, 2015._\n# ieee754 [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]\n\n[travis-image]: https://img.shields.io/travis/feross/ieee754/master.svg\n[travis-url]: https://travis-ci.org/feross/ieee754\n[npm-image]: https://img.shields.io/npm/v/ieee754.svg\n[npm-url]: https://npmjs.org/package/ieee754\n[downloads-image]: https://img.shields.io/npm/dm/ieee754.svg\n[downloads-url]: https://npmjs.org/package/ieee754\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n\n[![saucelabs][saucelabs-image]][saucelabs-url]\n\n[saucelabs-image]: https://saucelabs.com/browser-matrix/ieee754.svg\n[saucelabs-url]: https://saucelabs.com/u/ieee754\n\n### Read/write IEEE754 floating point numbers from/to a Buffer or array-like object.\n\n## install\n\n```\nnpm install ieee754\n```\n\n[Get supported ieee754 with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-ieee754?utm_source=npm-ieee754&utm_medium=referral&utm_campaign=readme)\n\n## methods\n\n`var ieee754 = require('ieee754')`\n\nThe `ieee754` object has the following functions:\n\n```\nieee754.read = function (buffer, offset, isLE, mLen, nBytes)\nieee754.write = function (buffer, value, offset, isLE, mLen, nBytes)\n```\n\nThe arguments mean the following:\n\n- buffer = the buffer\n- offset = offset into the buffer\n- value = value to set (only for `write`)\n- isLe = is little endian?\n- mLen = mantissa length\n- nBytes = number of bytes\n\n## what is ieee754?\n\nThe IEEE Standard for Floating-Point Arithmetic (IEEE 754) is a technical standard for floating-point computation. [Read more](http://en.wikipedia.org/wiki/IEEE_floating_point).\n\n## license\n\nBSD 3 Clause. Copyright (c) 2008, Fair Oaks Labs, Inc.\n# Near Bindings Generator \nTransforms the Assembyscript AST to serialize exported functions and add `encode` and `decode` functions for generating and parsing JSON strings.\n\n## Using via CLI\n\nAfter installling, `npm install nearprotocol/near-bindgen-as`, it can be added to the cli arguments of the assemblyscript compiler you must add the following:\n\n```bash\nasc <file> --transform near-bindgen-as ...\n```\n\nThis module also adds a binary `near-asc` which adds the default arguments required to build near contracts as well as the transformer.\n\n```bash\nnear-asc <input file> <output file>\n```\n\n## Using a script to compile\n\nAnother way is to add a file such as `asconfig.js` such as:\n\n```js\nconst compile = require(\"near-bindgen-as/compiler\").compile;\n\ncompile(\"assembly/index.ts\", // input file\n \"out/index.wasm\", // output file\n [\n // \"-O1\", // Optional arguments\n \"--debug\",\n \"--measure\"\n ],\n // Prints out the final cli arguments passed to compiler.\n {verbose: true}\n );\n```\n\nIt can then be built with `node asconfig.js`. There is an example of this in the test directory.\n# md5.js\n\n[](https://www.npmjs.org/package/md5.js)\n[](https://travis-ci.org/crypto-browserify/md5.js)\n[](https://david-dm.org/crypto-browserify/md5.js#info=dependencies)\n\n[](https://github.com/feross/standard)\n\nNode style `md5` on pure JavaScript.\n\nFrom [NIST SP 800-131A][1]: *md5 is no longer acceptable where collision resistance is required such as digital signatures.*\n\n## Example\n\n```js\nvar MD5 = require('md5.js')\n\nconsole.log(new MD5().update('42').digest('hex'))\n// => a1d0c6e83f027327d8461063f4ac58a6\n\nvar md5stream = new MD5()\nmd5stream.end('42')\nconsole.log(md5stream.read().toString('hex'))\n// => a1d0c6e83f027327d8461063f4ac58a6\n```\n\n## LICENSE [MIT](LICENSE)\n\n[1]: http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf\n# braces [](https://www.npmjs.com/package/braces) [](https://npmjs.org/package/braces) [](https://npmjs.org/package/braces) [](https://travis-ci.org/micromatch/braces) [](https://ci.appveyor.com/project/micromatch/braces)\n\n> Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support for the Bash 4.3 braces specification, without sacrificing speed.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save braces\n```\n\n## Why use braces?\n\nBrace patterns are great for matching ranges. Users (and implementors) shouldn't have to think about whether or not they will break their application (or yours) from accidentally defining an aggressive brace pattern. _Braces is the only library that offers a [solution to this problem](#performance)_.\n\n* **Safe(r)**: Braces isn't vulnerable to DoS attacks like [brace-expansion](https://github.com/juliangruber/brace-expansion), [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch) (a different bug than the [other regex DoS bug](https://medium.com/node-security/minimatch-redos-vulnerability-590da24e6d3c#.jew0b6mpc)).\n* **Accurate**: complete support for the [Bash 4.3 Brace Expansion](www.gnu.org/software/bash/) specification (passes all of the Bash braces tests)\n* **[fast and performant](#benchmarks)**: Starts fast, runs fast and [scales well](#performance) as patterns increase in complexity.\n* **Organized code base**: with parser and compiler that are eas(y|ier) to maintain and update when edge cases crop up.\n* **Well-tested**: thousands of test assertions. Passes 100% of the [minimatch](https://github.com/isaacs/minimatch) and [brace-expansion](https://github.com/juliangruber/brace-expansion) unit tests as well (as of the writing of this).\n\n## Usage\n\nThe main export is a function that takes one or more brace `patterns` and `options`.\n\n```js\nvar braces = require('braces');\nbraces(pattern[, options]);\n```\n\nBy default, braces returns an optimized regex-source string. To get an array of brace patterns, use `brace.expand()`.\n\nThe following section explains the difference in more detail. _(If you're curious about \"why\" braces does this by default, see [brace matching pitfalls](#brace-matching-pitfalls)_.\n\n### Optimized vs. expanded braces\n\n**Optimized**\n\nBy default, patterns are optimized for regex and matching:\n\n```js\nconsole.log(braces('a/{x,y,z}/b'));\n//=> ['a/(x|y|z)/b']\n```\n\n**Expanded**\n\nTo expand patterns the same way as Bash or [minimatch](https://github.com/isaacs/minimatch), use the [.expand](#expand) method:\n\n```js\nconsole.log(braces.expand('a/{x,y,z}/b'));\n//=> ['a/x/b', 'a/y/b', 'a/z/b']\n```\n\nOr use [options.expand](#optionsexpand):\n\n```js\nconsole.log(braces('a/{x,y,z}/b', {expand: true}));\n//=> ['a/x/b', 'a/y/b', 'a/z/b']\n```\n\n## Features\n\n* [lists](#lists): Supports \"lists\": `a/{b,c}/d` => `['a/b/d', 'a/c/d']`\n* [sequences](#sequences): Supports alphabetical or numerical \"sequences\" (ranges): `{1..3}` => `['1', '2', '3']`\n* [steps](#steps): Supports \"steps\" or increments: `{2..10..2}` => `['2', '4', '6', '8', '10']`\n* [escaping](#escaping)\n* [options](#options)\n\n### Lists\n\nUses [fill-range](https://github.com/jonschlinkert/fill-range) for expanding alphabetical or numeric lists:\n\n```js\nconsole.log(braces('a/{foo,bar,baz}/*.js'));\n//=> ['a/(foo|bar|baz)/*.js']\n\nconsole.log(braces.expand('a/{foo,bar,baz}/*.js'));\n//=> ['a/foo/*.js', 'a/bar/*.js', 'a/baz/*.js']\n```\n\n### Sequences\n\nUses [fill-range](https://github.com/jonschlinkert/fill-range) for expanding alphabetical or numeric ranges (bash \"sequences\"):\n\n```js\nconsole.log(braces.expand('{1..3}')); // ['1', '2', '3']\nconsole.log(braces.expand('a{01..03}b')); // ['a01b', 'a02b', 'a03b']\nconsole.log(braces.expand('a{1..3}b')); // ['a1b', 'a2b', 'a3b']\nconsole.log(braces.expand('{a..c}')); // ['a', 'b', 'c']\nconsole.log(braces.expand('foo/{a..c}')); // ['foo/a', 'foo/b', 'foo/c']\n\n// supports padded ranges\nconsole.log(braces('a{01..03}b')); //=> [ 'a(0[1-3])b' ]\nconsole.log(braces('a{001..300}b')); //=> [ 'a(0{2}[1-9]|0[1-9][0-9]|[12][0-9]{2}|300)b' ]\n```\n\n### Steps\n\nSteps, or increments, may be used with ranges:\n\n```js\nconsole.log(braces.expand('{2..10..2}'));\n//=> ['2', '4', '6', '8', '10']\n\nconsole.log(braces('{2..10..2}'));\n//=> ['(2|4|6|8|10)']\n```\n\nWhen the [.optimize](#optimize) method is used, or [options.optimize](#optionsoptimize) is set to true, sequences are passed to [to-regex-range](https://github.com/jonschlinkert/to-regex-range) for expansion.\n\n### Nesting\n\nBrace patterns may be nested. The results of each expanded string are not sorted, and left to right order is preserved.\n\n**\"Expanded\" braces**\n\n```js\nconsole.log(braces.expand('a{b,c,/{x,y}}/e'));\n//=> ['ab/e', 'ac/e', 'a/x/e', 'a/y/e']\n\nconsole.log(braces.expand('a/{x,{1..5},y}/c'));\n//=> ['a/x/c', 'a/1/c', 'a/2/c', 'a/3/c', 'a/4/c', 'a/5/c', 'a/y/c']\n```\n\n**\"Optimized\" braces**\n\n```js\nconsole.log(braces('a{b,c,/{x,y}}/e'));\n//=> ['a(b|c|/(x|y))/e']\n\nconsole.log(braces('a/{x,{1..5},y}/c'));\n//=> ['a/(x|([1-5])|y)/c']\n```\n\n### Escaping\n\n**Escaping braces**\n\nA brace pattern will not be expanded or evaluted if _either the opening or closing brace is escaped_:\n\n```js\nconsole.log(braces.expand('a\\\\{d,c,b}e'));\n//=> ['a{d,c,b}e']\n\nconsole.log(braces.expand('a{d,c,b\\\\}e'));\n//=> ['a{d,c,b}e']\n```\n\n**Escaping commas**\n\nCommas inside braces may also be escaped:\n\n```js\nconsole.log(braces.expand('a{b\\\\,c}d'));\n//=> ['a{b,c}d']\n\nconsole.log(braces.expand('a{d\\\\,c,b}e'));\n//=> ['ad,ce', 'abe']\n```\n\n**Single items**\n\nFollowing bash conventions, a brace pattern is also not expanded when it contains a single character:\n\n```js\nconsole.log(braces.expand('a{b}c'));\n//=> ['a{b}c']\n```\n\n## Options\n\n### options.maxLength\n\n**Type**: `Number`\n\n**Default**: `65,536`\n\n**Description**: Limit the length of the input string. Useful when the input string is generated or your application allows users to pass a string, et cetera.\n\n```js\nconsole.log(braces('a/{b,c}/d', { maxLength: 3 })); //=> throws an error\n```\n\n### options.expand\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\n**Description**: Generate an \"expanded\" brace pattern (this option is unncessary with the `.expand` method, which does the same thing).\n\n```js\nconsole.log(braces('a/{b,c}/d', {expand: true}));\n//=> [ 'a/b/d', 'a/c/d' ]\n```\n\n### options.optimize\n\n**Type**: `Boolean`\n\n**Default**: `true`\n\n**Description**: Enabled by default.\n\n```js\nconsole.log(braces('a/{b,c}/d'));\n//=> [ 'a/(b|c)/d' ]\n```\n\n### options.nodupes\n\n**Type**: `Boolean`\n\n**Default**: `true`\n\n**Description**: Duplicates are removed by default. To keep duplicates, pass `{nodupes: false}` on the options\n\n### options.rangeLimit\n\n**Type**: `Number`\n\n**Default**: `250`\n\n**Description**: When `braces.expand()` is used, or `options.expand` is true, brace patterns will automatically be [optimized](#optionsoptimize) when the difference between the range minimum and range maximum exceeds the `rangeLimit`. This is to prevent huge ranges from freezing your application.\n\nYou can set this to any number, or change `options.rangeLimit` to `Inifinity` to disable this altogether.\n\n**Examples**\n\n```js\n// pattern exceeds the \"rangeLimit\", so it's optimized automatically\nconsole.log(braces.expand('{1..1000}'));\n//=> ['([1-9]|[1-9][0-9]{1,2}|1000)']\n\n// pattern does not exceed \"rangeLimit\", so it's NOT optimized\nconsole.log(braces.expand('{1..100}'));\n//=> ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '100']\n```\n\n### options.transform\n\n**Type**: `Function`\n\n**Default**: `undefined`\n\n**Description**: Customize range expansion.\n\n```js\nvar range = braces.expand('x{a..e}y', {\n transform: function(str) {\n return 'foo' + str;\n }\n});\n\nconsole.log(range);\n//=> [ 'xfooay', 'xfooby', 'xfoocy', 'xfoody', 'xfooey' ]\n```\n\n### options.quantifiers\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\n**Description**: In regular expressions, quanitifiers can be used to specify how many times a token can be repeated. For example, `a{1,3}` will match the letter `a` one to three times.\n\nUnfortunately, regex quantifiers happen to share the same syntax as [Bash lists](#lists)\n\nThe `quantifiers` option tells braces to detect when [regex quantifiers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#quantifiers) are defined in the given pattern, and not to try to expand them as lists.\n\n**Examples**\n\n```js\nvar braces = require('braces');\nconsole.log(braces('a/b{1,3}/{x,y,z}'));\n//=> [ 'a/b(1|3)/(x|y|z)' ]\nconsole.log(braces('a/b{1,3}/{x,y,z}', {quantifiers: true}));\n//=> [ 'a/b{1,3}/(x|y|z)' ]\nconsole.log(braces('a/b{1,3}/{x,y,z}', {quantifiers: true, expand: true}));\n//=> [ 'a/b{1,3}/x', 'a/b{1,3}/y', 'a/b{1,3}/z' ]\n```\n\n### options.unescape\n\n**Type**: `Boolean`\n\n**Default**: `undefined`\n\n**Description**: Strip backslashes that were used for escaping from the result.\n\n## What is \"brace expansion\"?\n\nBrace expansion is a type of parameter expansion that was made popular by unix shells for generating lists of strings, as well as regex-like matching when used alongside wildcards (globs).\n\nIn addition to \"expansion\", braces are also used for matching. In other words:\n\n* [brace expansion](#brace-expansion) is for generating new lists\n* [brace matching](#brace-matching) is for filtering existing lists\n\n<details>\n<summary><strong>More about brace expansion</strong> (click to expand)</summary>\n\nThere are two main types of brace expansion:\n\n1. **lists**: which are defined using comma-separated values inside curly braces: `{a,b,c}`\n2. **sequences**: which are defined using a starting value and an ending value, separated by two dots: `a{1..3}b`. Optionally, a third argument may be passed to define a \"step\" or increment to use: `a{1..100..10}b`. These are also sometimes referred to as \"ranges\".\n\nHere are some example brace patterns to illustrate how they work:\n\n**Sets**\n\n```\n{a,b,c} => a b c\n{a,b,c}{1,2} => a1 a2 b1 b2 c1 c2\n```\n\n**Sequences**\n\n```\n{1..9} => 1 2 3 4 5 6 7 8 9\n{4..-4} => 4 3 2 1 0 -1 -2 -3 -4\n{1..20..3} => 1 4 7 10 13 16 19\n{a..j} => a b c d e f g h i j\n{j..a} => j i h g f e d c b a\n{a..z..3} => a d g j m p s v y\n```\n\n**Combination**\n\nSets and sequences can be mixed together or used along with any other strings.\n\n```\n{a,b,c}{1..3} => a1 a2 a3 b1 b2 b3 c1 c2 c3\nfoo/{a,b,c}/bar => foo/a/bar foo/b/bar foo/c/bar\n```\n\nThe fact that braces can be \"expanded\" from relatively simple patterns makes them ideal for quickly generating test fixtures, file paths, and similar use cases.\n\n## Brace matching\n\nIn addition to _expansion_, brace patterns are also useful for performing regular-expression-like matching.\n\nFor example, the pattern `foo/{1..3}/bar` would match any of following strings:\n\n```\nfoo/1/bar\nfoo/2/bar\nfoo/3/bar\n```\n\nBut not:\n\n```\nbaz/1/qux\nbaz/2/qux\nbaz/3/qux\n```\n\nBraces can also be combined with [glob patterns](https://github.com/jonschlinkert/micromatch) to perform more advanced wildcard matching. For example, the pattern `*/{1..3}/*` would match any of following strings:\n\n```\nfoo/1/bar\nfoo/2/bar\nfoo/3/bar\nbaz/1/qux\nbaz/2/qux\nbaz/3/qux\n```\n\n## Brace matching pitfalls\n\nAlthough brace patterns offer a user-friendly way of matching ranges or sets of strings, there are also some major disadvantages and potential risks you should be aware of.\n\n### tldr\n\n**\"brace bombs\"**\n\n* brace expansion can eat up a huge amount of processing resources\n* as brace patterns increase _linearly in size_, the system resources required to expand the pattern increase exponentially\n* users can accidentally (or intentially) exhaust your system's resources resulting in the equivalent of a DoS attack (bonus: no programming knowledge is required!)\n\nFor a more detailed explanation with examples, see the [geometric complexity](#geometric-complexity) section.\n\n### The solution\n\nJump to the [performance section](#performance) to see how Braces solves this problem in comparison to other libraries.\n\n### Geometric complexity\n\nAt minimum, brace patterns with sets limited to two elements have quadradic or `O(n^2)` complexity. But the complexity of the algorithm increases exponentially as the number of sets, _and elements per set_, increases, which is `O(n^c)`.\n\nFor example, the following sets demonstrate quadratic (`O(n^2)`) complexity:\n\n```\n{1,2}{3,4} => (2X2) => 13 14 23 24\n{1,2}{3,4}{5,6} => (2X2X2) => 135 136 145 146 235 236 245 246\n```\n\nBut add an element to a set, and we get a n-fold Cartesian product with `O(n^c)` complexity:\n\n```\n{1,2,3}{4,5,6}{7,8,9} => (3X3X3) => 147 148 149 157 158 159 167 168 169 247 248 \n 249 257 258 259 267 268 269 347 348 349 357 \n 358 359 367 368 369\n```\n\nNow, imagine how this complexity grows given that each element is a n-tuple:\n\n```\n{1..100}{1..100} => (100X100) => 10,000 elements (38.4 kB)\n{1..100}{1..100}{1..100} => (100X100X100) => 1,000,000 elements (5.76 MB)\n```\n\nAlthough these examples are clearly contrived, they demonstrate how brace patterns can quickly grow out of control.\n\n**More information**\n\nInterested in learning more about brace expansion?\n\n* [linuxjournal/bash-brace-expansion](http://www.linuxjournal.com/content/bash-brace-expansion)\n* [rosettacode/Brace_expansion](https://rosettacode.org/wiki/Brace_expansion)\n* [cartesian product](https://en.wikipedia.org/wiki/Cartesian_product)\n\n</details>\n\n## Performance\n\nBraces is not only screaming fast, it's also more accurate the other brace expansion libraries.\n\n### Better algorithms\n\nFortunately there is a solution to the [\"brace bomb\" problem](#brace-matching-pitfalls): _don't expand brace patterns into an array when they're used for matching_.\n\nInstead, convert the pattern into an optimized regular expression. This is easier said than done, and braces is the only library that does this currently.\n\n**The proof is in the numbers**\n\nMinimatch gets exponentially slower as patterns increase in complexity, braces does not. The following results were generated using `braces()` and `minimatch.braceExpand()`, respectively.\n\n| **Pattern** | **braces** | **[minimatch](https://github.com/isaacs/minimatch)** | \n| --- | --- | --- |\n| `{1..9007199254740991}`<sup class=\"footnote-ref\"><a href=\"#fn1\" id=\"fnref1\">[1]</a></sup> | `298 B` (5ms 459μs) | N/A (freezes) |\n| `{1..1000000000000000}` | `41 B` (1ms 15μs) | N/A (freezes) |\n| `{1..100000000000000}` | `40 B` (890μs) | N/A (freezes) |\n| `{1..10000000000000}` | `39 B` (2ms 49μs) | N/A (freezes) |\n| `{1..1000000000000}` | `38 B` (608μs) | N/A (freezes) |\n| `{1..100000000000}` | `37 B` (397μs) | N/A (freezes) |\n| `{1..10000000000}` | `35 B` (983μs) | N/A (freezes) |\n| `{1..1000000000}` | `34 B` (798μs) | N/A (freezes) |\n| `{1..100000000}` | `33 B` (733μs) | N/A (freezes) |\n| `{1..10000000}` | `32 B` (5ms 632μs) | `78.89 MB` (16s 388ms 569μs) |\n| `{1..1000000}` | `31 B` (1ms 381μs) | `6.89 MB` (1s 496ms 887μs) |\n| `{1..100000}` | `30 B` (950μs) | `588.89 kB` (146ms 921μs) |\n| `{1..10000}` | `29 B` (1ms 114μs) | `48.89 kB` (14ms 187μs) |\n| `{1..1000}` | `28 B` (760μs) | `3.89 kB` (1ms 453μs) |\n| `{1..100}` | `22 B` (345μs) | `291 B` (196μs) |\n| `{1..10}` | `10 B` (533μs) | `20 B` (37μs) |\n| `{1..3}` | `7 B` (190μs) | `5 B` (27μs) |\n\n### Faster algorithms\n\nWhen you need expansion, braces is still much faster.\n\n_(the following results were generated using `braces.expand()` and `minimatch.braceExpand()`, respectively)_\n\n| **Pattern** | **braces** | **[minimatch](https://github.com/isaacs/minimatch)** | \n| --- | --- | --- |\n| `{1..10000000}` | `78.89 MB` (2s 698ms 642μs) | `78.89 MB` (18s 601ms 974μs) |\n| `{1..1000000}` | `6.89 MB` (458ms 576μs) | `6.89 MB` (1s 491ms 621μs) |\n| `{1..100000}` | `588.89 kB` (20ms 728μs) | `588.89 kB` (156ms 919μs) |\n| `{1..10000}` | `48.89 kB` (2ms 202μs) | `48.89 kB` (13ms 641μs) |\n| `{1..1000}` | `3.89 kB` (1ms 796μs) | `3.89 kB` (1ms 958μs) |\n| `{1..100}` | `291 B` (424μs) | `291 B` (211μs) |\n| `{1..10}` | `20 B` (487μs) | `20 B` (72μs) |\n| `{1..3}` | `5 B` (166μs) | `5 B` (27μs) |\n\nIf you'd like to run these comparisons yourself, see [test/support/generate.js](test/support/generate.js).\n\n## Benchmarks\n\n### Running benchmarks\n\nInstall dev dependencies:\n\n```bash\nnpm i -d && npm benchmark\n```\n\n### Latest results\n\n```bash\nBenchmarking: (8 of 8)\n · combination-nested\n · combination\n · escaped\n · list-basic\n · list-multiple\n · no-braces\n · sequence-basic\n · sequence-multiple\n\n# benchmark/fixtures/combination-nested.js (52 bytes)\n brace-expansion x 4,756 ops/sec ±1.09% (86 runs sampled)\n braces x 11,202,303 ops/sec ±1.06% (88 runs sampled)\n minimatch x 4,816 ops/sec ±0.99% (87 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/combination.js (51 bytes)\n brace-expansion x 625 ops/sec ±0.87% (87 runs sampled)\n braces x 11,031,884 ops/sec ±0.72% (90 runs sampled)\n minimatch x 637 ops/sec ±0.84% (88 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/escaped.js (44 bytes)\n brace-expansion x 163,325 ops/sec ±1.05% (87 runs sampled)\n braces x 10,655,071 ops/sec ±1.22% (88 runs sampled)\n minimatch x 147,495 ops/sec ±0.96% (88 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/list-basic.js (40 bytes)\n brace-expansion x 99,726 ops/sec ±1.07% (83 runs sampled)\n braces x 10,596,584 ops/sec ±0.98% (88 runs sampled)\n minimatch x 100,069 ops/sec ±1.17% (86 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/list-multiple.js (52 bytes)\n brace-expansion x 34,348 ops/sec ±1.08% (88 runs sampled)\n braces x 9,264,131 ops/sec ±1.12% (88 runs sampled)\n minimatch x 34,893 ops/sec ±0.87% (87 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/no-braces.js (48 bytes)\n brace-expansion x 275,368 ops/sec ±1.18% (89 runs sampled)\n braces x 9,134,677 ops/sec ±0.95% (88 runs sampled)\n minimatch x 3,755,954 ops/sec ±1.13% (89 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/sequence-basic.js (41 bytes)\n brace-expansion x 5,492 ops/sec ±1.35% (87 runs sampled)\n braces x 8,485,034 ops/sec ±1.28% (89 runs sampled)\n minimatch x 5,341 ops/sec ±1.17% (87 runs sampled)\n\n fastest is braces\n\n# benchmark/fixtures/sequence-multiple.js (51 bytes)\n brace-expansion x 116 ops/sec ±0.77% (77 runs sampled)\n braces x 9,445,118 ops/sec ±1.32% (84 runs sampled)\n minimatch x 109 ops/sec ±1.16% (76 runs sampled)\n\n fastest is braces\n```\n\n## About\n\n<details>\n<summary><strong>Contributing</strong></summary>\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n</details>\n\n<details>\n<summary><strong>Running Tests</strong></summary>\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n</details>\n\n<details>\n<summary><strong>Building docs</strong></summary>\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n</details>\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets \"Expand POSIX bracket expressions (character classes) in glob patterns.\")\n* [extglob](https://www.npmjs.com/package/extglob): Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob… [more](https://github.com/micromatch/extglob) | [homepage](https://github.com/micromatch/extglob \"Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.\")\n* [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or `step` to… [more](https://github.com/jonschlinkert/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range \"Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`\")\n* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch \"Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.\")\n* [nanomatch](https://www.npmjs.com/package/nanomatch): Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… [more](https://github.com/micromatch/nanomatch) | [homepage](https://github.com/micromatch/nanomatch \"Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)\")\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 188 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 4 | [doowb](https://github.com/doowb) |\n| 1 | [es128](https://github.com/es128) |\n| 1 | [eush77](https://github.com/eush77) |\n| 1 | [hemanth](https://github.com/hemanth) |\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 17, 2018._\n\n<hr class=\"footnotes-sep\">\n<section class=\"footnotes\">\n<ol class=\"footnotes-list\">\n<li id=\"fn1\" class=\"footnote-item\">this is the largest safe integer allowed in JavaScript. <a href=\"#fnref1\" class=\"footnote-backref\">↩</a>\n\n</li>\n</ol>\n</section>\n"}}},{"rowIdx":561,"cells":{"repoName":{"kind":"string","value":"NearSocial_social-db"},"tree":{"kind":"string","value":"CHANGELOG.md\nCargo.toml\nREADME.md\nbuild_docker.sh\nbuild_local.sh\ncontract\n Cargo.toml\n src\n account.rs\n api.rs\n legacy.rs\n lib.rs\n node.rs\n permission.rs\n shared_storage.rs\n storage_tracker.rs\n upgrade.rs\n utils.rs\nintegration-tests\n Cargo.toml\n README.md\n build.rs\n src\n get_workspace_dir.rs\n set.rs\nmigration\n migrate.js\n package.json\nrust-toolchain.toml\ntest_local.sh\n"},"readme":{"kind":"string","value":"# Integration Tests\n\nThis directory contains integration tests for the Social DB contract.\n\nThe build script compiles the WASM contract automatically if there are changes\nin the contract source code.\n\nRun a specific integration test with:\n\n```bash\n cargo run --example set_method\n```\n# Social DB\n\n## Notes\n\n### Testnet account ID\n\nDeployed at `v1.social08.testnet`\n\nhttps://explorer.testnet.near.org/accounts/v1.social08.testnet\n\n### Mainnet account ID\n\nDeployed at `social.near`\n\nhttps://explorer.near.org/accounts/social.near\n\n### About empty keys\n\nIf a leaf value was originally string, e.g. `name`\n\n```json\n{\n \"alex.near\": {\n \"profile\": {\n \"name\": \"Alex\"\n }\n }\n}\n```\n\nAnd later some value was added under `name`, the name will be transformed to a node, and the value\nwill be moved to an empty key under this node. E.g. `name/foo = \"bar\"` is added.\n\n```json\n{\n \"alex.near\": {\n \"profile\": {\n \"name\": {\n \"\": \"Alex\",\n \"foo\": \"bar\"\n }\n }\n }\n}\n```\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md)\n\n## API\n\n### Storing data\n\nThe top level keys of the objects should be account IDs under which the data is stored. Those accounts are covering storage for the underlying data.\n\nThe predecessor_id or the signer public key should have permission to write under those keys.\nIf the predecessor_id matches the top level key, then it can write any data under that key, as long as it has a permission or at least 1 yoctoNEAR is attached.\n\nThe attached deposit will be transferred to the first key. If the account doesn't exist, it will be created (the predecessor_id should match).\n\n```rust\n#[payable]\npub fn set(&mut self, data: Value);\n```\n\nArguments:\n- `data` is an object to store. The leaf values should be strings or null values. String values will be added, while null values will be deleted.\n\nExamples:\n\n```js\nset({\n data: {\n \"alex.near\": {\n \"profile\": {\n \"name\": \"Alex\",\n \"image\": {\n \"url\": \"https://gkfjklgdfjkldfg\"\n }\n },\n }\n }\n})\n\nset({\n data: {\n \"alex.near\": {\n \"graph\": {\n \"follow\": {\n \"root.near\": \"\",\n \"bob.near\": \"\",\n }\n }\n }\n }\n})\n```\n\n### Reading data\n\nReturns the data for a list of given key patterns.\nIt takes one or more path patterns as arguments, and returns the matching data.\nThe path pattern is a string that can contain wildcards.\nFor example:\n- `alice.near/profile/**` will match the entire profile data of account `alice.near`.\n- `alice.near/profile/*` will match all the fields of the profile, but not the nested objects.\n- `alice.near/profile/name` will match only the name field of the profile.\n- `*/widget/*` will match all the widgets of all the accounts.\n\n```rust\npub struct GetOptions {\n pub with_block_height: Option<bool>,\n pub with_node_id: Option<bool>,\n pub return_deleted: Option<bool>,\n}\n\npub fn get(self, keys: Vec<String>, options: Option<GetOptions>) -> Value;\n```\n\nArguments:\n- `keys` - an array of key patterns to return.\n- `options` - optional argument to specify options.\n\nOptions:\n- `with_block_height` - if true, for every value and a node will add the block height of the data with the key `:block`.\n- `with_node_id` - if true, for every node will add the node index with the key `:node`.\n- `return_deleted` - if true, will include deleted keys with the value `null`.\n\nReturns the aggregated JSON object.\n\nExamples:\n\n```js\nget({keys: [\"alex.near/profile/name\"]})\n\nget({keys: [\"alex.near/profile/name\", \"root.near/profile/name\"]})\n\nget({keys: [\"alex.near/profile/name\", \"alex.near/profile/description\"]})\n\nget({keys: [\"alex.near/profile/tags/*\"]})\n\nget({keys: [\"alex.near/profile/**\"]})\n\nget({keys: [\"*/widget/*\"]})\n\nget({keys: [\"alex.near/profile/tags/*\"], options: {return_deleted: true}})\n```\n\n### Reading keys\n\nThe `keys` method allows to get the list of keys that match the path pattern.\nIt's useful for querying the data without reading values.\nIt also has an additional `options` field that can be used to specify the return type and whether to return deleted keys.\nFor example:\n- `alice.near/profile/*` will return the list of all the fields of the profile, but not the nested objects.\n- `*/profile/image/nft` will return the list of all the accounts that have an NFT image in their profile.\n- `alice.near/widget/*` with `return_deleted` option will return the list of all the widget names of the account, including the deleted ones.\n- `alice.near/widget/*` with `return_type` equal to `BlockHeight` will return the list of all the widget names of the account and the value will be the block height when the widget was last updated.\n- Note `**` is not supported by the `keys` method.\n\n```rust\npub enum KeysReturnType {\n True,\n BlockHeight,\n NodeId,\n}\n\npub struct KeysOptions {\n pub return_type: Option<KeysReturnType>,\n pub return_deleted: Option<bool>,\n pub values_only: Option<bool>,\n}\n\npub fn keys(self, keys: Vec<String>, options: Option<KeysOptions>) -> Value;\n```\n\nArguments:\n- `keys` - an array of key patterns to return.\n- `options` - optional argument to specify options.\n\nOptions:\n- `return_type` - if `BlockHeight`, will return the block height of the key instead of `true`, if `NodeId`, will return the node index of the key instead of `true`.\n- `return_deleted` - if true, will include deleted keys.\n- `values_only` - if `true`, only matches keys which value is not a node. It's needed to filter out deleted entries. Since a node can't be deleted right now.\n\nReturns the aggregated JSON object.\n\nExamples:\n\n```js\nkeys({keys: [\"alex.near/profile/*\"]})\n\nkeys({keys: [\"*/profile/image/nft\"]})\n\nkeys({keys: [\"alex.near/widget/*\"], options: {return_deleted: true}})\n\nkeys({keys: [\"alex.near/widget/*\"], options: {return_type: \"BlockHeight\", values_only: true}})\n```\n\n### Permissions\n\nSee https://explorer.testnet.near.org/transactions/3c7h9da1z5Px4JumNDsRaJtCDQaZHG46dsc2SnAj5LHx\\\n\n```rust\n#[payable]\npub fn grant_write_permission(\n &mut self,\n predecessor_id: Option<AccountId>,\n public_key: Option<PublicKey>,\n keys: Vec<String>,\n);\n```\n\n```rust\n/// Returns true if the permission is granted for a given account ID or a given public_key to\n/// any prefix of the key.\npub fn is_write_permission_granted(\n &self,\n predecessor_id: Option<AccountId>,\n public_key: Option<PublicKey>,\n key: String,\n) -> bool;\n```\n\n### Debugging\n\n```bash\nexport CONTRACT_ID=v1.social08.testnet\nexport ACCOUNT_ID=eugenethedream\n# Full contract data\nnear view $CONTRACT_ID get '{\"keys\":[\"**\"]}'\n# Full account's data\nnear view $CONTRACT_ID get '{\"keys\":[\"'$ACCOUNT_ID'/**\"]}'\n```\n"}}},{"rowIdx":562,"cells":{"repoName":{"kind":"string","value":"near_as-base58"},"tree":{"kind":"string","value":".github\n ISSUE_TEMPLATE\n BOUNTY.yml\n.travis.yml\nREADME.md\nas-pect.config.js\nassembly\n __tests__\n as-pect.d.ts\n roundtrip.spec.ts\n index.ts\n tsconfig.json\npackage.json\n"},"readme":{"kind":"string","value":"# as-base58\nBase58 encoder / decoder for AssemblyScript.\n\nSpecial thanks to https://github.com/cryptocoinjs/base-x for the javascript version.\n\n# Usage\n\n```ts\nimport { encode, decode } from \"as-base58\";\n\nconst input = \"ABCD1234\"\n\nassert(input = enocde(decode(\"ABCD1234\"));\n```\n"}}},{"rowIdx":563,"cells":{"repoName":{"kind":"string","value":"Panasthetik_near-supply-chain"},"tree":{"kind":"string","value":"README.md\nfinal_contract\n Cargo.toml\n build.bat\n build.sh\n src\n lib.rs\n models.rs\n utils.rs\n test.sh\nstarter_files\n lib.rs\n models.rs\n utils.rs\ntest_file\n test.rs\n"},"readme":{"kind":"string","value":"# near-supply-chain\nNear Protocol supply chain smart contract template in Rust for order tracking and administration.\n\n# Article / Tutorial\nThis will be published on Medium as a web3 tutorial.\n\n# Adaptable\nThe project can be adapted to your needs on Near Protocol, if you need a supply chain type contract to track orders, or a b2b application.\n"}}},{"rowIdx":564,"cells":{"repoName":{"kind":"string","value":"maxistyping_near-sdk-js-1"},"tree":{"kind":"string","value":".github\n ISSUE_TEMPLATE\n bug.yml\n config.yml\n feature.yml\n pull_request_template.md\n workflows\n tests.yml\nCODE_OF_CONDUCT.md\nCONTRIBUTING.md\nREADME.md\nRELEASE.md\nSECURITY.md\nTOOLING.md\nbenchmark\n README.md\n __tests__\n test-deploy-contract.ava.js\n test-expensive-calc.ava.js\n test-highlevel-collection.ava.js\n test-highlevel-minimal.ava.js\n test-lowlevel-api.ava.js\n test-lowlevel-minimal.ava.js\n util.js\n example-outcome.json\n jsconfig.json\n package.json\n src\n deploy-contract.js\n expensive-calc.js\n highlevel-collection.js\n highlevel-minimal.js\n lowlevel-api.js\n lowlevel-minimal.js\n tsconfig.json\nexamples\n __tests__\n standard-nft\n test_approval.ava.js\n test_core.ava.js\n test_enumeration.ava.js\n test-clean-state.ava.js\n test-counter.ava.js\n test-cross-contract-call-loop.ava.js\n test-cross-contract-call.ava.js\n test-fungible-token-lockable.ava.js\n test-fungible-token.ava.js\n test-nested-collections.ava.js\n test-non-fungible-token.ava.js\n test-parking-lot.ava.js\n test-programmatic-update.ava.js\n test-status-message-collections.ava.js\n test-status-message.ava.js\n jsconfig.json\n package.json\n src\n clean-state.js\n counter-lowlevel.js\n counter.js\n counter.ts\n cross-contract-call-loop.js\n cross-contract-call.js\n fungible-token-helper.ts\n fungible-token-lockable.js\n fungible-token.ts\n log.ts\n nested-collections.ts\n non-fungible-token-receiver.js\n non-fungible-token.js\n parking-lot.ts\n programmatic-update-after.ts\n programmatic-update-before.ts\n standard-nft\n my-nft.ts\n test-approval-receiver.ts\n test-token-receiver.ts\n status-message-collections.js\n status-message.js\n tsconfig.json\npackage.json\npackages\n near-contract-standards\n lib\n event.d.ts\n event.js\n index.d.ts\n index.js\n non_fungible_token\n approval\n approval_receiver.d.ts\n approval_receiver.js\n index.d.ts\n index.js\n core\n index.d.ts\n index.js\n receiver.d.ts\n receiver.js\n resolver.d.ts\n resolver.js\n enumeration\n index.d.ts\n index.js\n events.d.ts\n events.js\n impl.d.ts\n impl.js\n index.d.ts\n index.js\n metadata.d.ts\n metadata.js\n token.d.ts\n token.js\n utils.d.ts\n utils.js\n package.json\n src\n event.ts\n index.ts\n non_fungible_token\n approval\n approval_receiver.ts\n index.ts\n core\n index.ts\n receiver.ts\n resolver.ts\n enumeration\n index.ts\n events.ts\n impl.ts\n index.ts\n metadata.ts\n token.ts\n utils.ts\n tsconfig.json\n near-sdk-js\n README.md\n builder\n builder.c\n lib\n api.d.ts\n api.js\n cli\n abi.d.ts\n abi.js\n build-tools\n include-bytes.d.ts\n include-bytes.js\n near-bindgen-exporter.d.ts\n near-bindgen-exporter.js\n cli.d.ts\n cli.js\n post-install.d.ts\n post-install.js\n utils.d.ts\n utils.js\n collections\n index.d.ts\n index.js\n lookup-map.d.ts\n lookup-map.js\n lookup-set.d.ts\n lookup-set.js\n unordered-map.d.ts\n unordered-map.js\n unordered-set.d.ts\n unordered-set.js\n vector.d.ts\n vector.js\n index.d.ts\n index.js\n near-bindgen.d.ts\n near-bindgen.js\n promise.d.ts\n promise.js\n types\n account_id.d.ts\n account_id.js\n collections.d.ts\n collections.js\n gas.d.ts\n gas.js\n index.d.ts\n index.js\n primitives.d.ts\n primitives.js\n public_key.d.ts\n public_key.js\n vm_types.d.ts\n vm_types.js\n utils.d.ts\n utils.js\n version.d.ts\n version.js\n package.json\n src\n api.ts\n cli\n abi.ts\n build-tools\n include-bytes.ts\n near-bindgen-exporter.ts\n cli.ts\n post-install.ts\n utils.ts\n collections\n index.ts\n lookup-map.ts\n lookup-set.ts\n unordered-map.ts\n unordered-set.ts\n vector.ts\n index.ts\n near-bindgen.ts\n promise.ts\n types\n account_id.ts\n collections.ts\n gas.ts\n index.ts\n primitives.ts\n public_key.ts\n vm_types.ts\n utils.ts\n version.ts\n tsconfig.json\ntests\n README.md\n __tests__\n bytes.ava.js\n constructor_validation.ava.js\n decorators\n near_bindgen.ava.js\n payable.ava.js\n private.ava.js\n function-params.ava.js\n lookup-map.ava.js\n lookup-set.ava.js\n test-bigint-serialization.ava.js\n test-date-serialization.ava.js\n test-middlewares.ava.js\n test-public-key.ava.js\n test_context_api.ava.js\n test_highlevel_promise.ava.js\n test_log_panic_api.ava.js\n test_math_api.ava.js\n test_promise_api.ava.js\n test_storage_api.ava.js\n typescript.ava.js\n unordered-map.ava.js\n unordered-set.ava.js\n vector.ava.js\n jsconfig.json\n package.json\n src\n bigint-serialization.ts\n bytes.js\n constructor-validation\n 1-parameter-not-set-in-constructor.ts\n all-parameters-set-in-constructor.ts\n no-constructor.ts\n no-parameters-set-in-constructor.ts\n context_api.js\n date-serialization.ts\n decorators\n payable.ts\n private.ts\n require_init_false.ts\n require_init_true.ts\n function-params.js\n highlevel-promise.js\n log_panic_api.js\n lookup-map.js\n lookup-set.js\n math_api.js\n middlewares.ts\n model.js\n promise_api.js\n promise_batch_api.js\n public-key.js\n storage_api.js\n typescript.ts\n unordered-map.js\n unordered-set.js\n vector.js\n tsconfig.json\nturbo.json\n"},"readme":{"kind":"string","value":"> **Warning**\n>\n> This SDK is currently in **[`Alpha`](https://github.com/near/near-sdk-js/releases/)**.\n>\n> The JavaScript runtime has not been fully audited. For creating smart contracts that hold value please use [`near-sdk-rs`](https://github.com/near/near-sdk-rs).\n>\n> Help contribute!\n>\n> - [Report issues you encounter](https://github.com/near/near-sdk-js/issues) 🐞\n> - [Provide suggestions or feedback](https://github.com/near/near-sdk-js/discussions) 💡\n> - [Show us what you've built!](https://github.com/near/near-sdk-js/discussions/categories/show-and-tell) 💪\n\n# NEAR JavaScript SDK\n\n## Quick Start\n\nUse [`create-near-app`](https://github.com/near/create-near-app) to quickly get started writing smart contracts in JavaScript on NEAR.\n\n npx create-near-app\n\nThis will scaffold a basic template for you 😎\n\nLearn more in our [Quick Start guide](https://docs.near.org/develop/quickstart-guide).\n\n## Running Examples\n\nThere are a couple of contract examples in the project:\n\n- [Clean contract state](https://github.com/near/near-sdk-js/tree/develop/examples/src/clean-state.js)\n- [Counter using low level API](https://github.com/near/near-sdk-js/tree/develop/examples/src/counter-lowlevel.js)\n- [Counter in JavaScript](https://github.com/near/near-sdk-js/tree/develop/examples/src/counter.js)\n- [Counter in TypeScript](https://github.com/near/near-sdk-js/tree/develop/examples/src/counter.ts)\n- [Doing cross contract call](https://github.com/near/near-sdk-js/tree/develop/examples/src/cross-contract-call.js)\n- [Fungible token](https://github.com/near/near-sdk-js/tree/develop/examples/src/fungible-token.js)\n- [Lockable fungible token](https://github.com/near/near-sdk-js/tree/develop/examples/src/fungible-token-lockable.js)\n- [Non fungible token](https://github.com/near/near-sdk-js/tree/develop/examples/src/non-fungible-token.js)\n- [Non fungible token receiver contract](https://github.com/near/near-sdk-js/tree/develop/examples/src/non-fungible-token-receiver.js)\n- [Status message board](https://github.com/near/near-sdk-js/tree/develop/examples/src/status-message.js)\n- [Status message board with unique messages](https://github.com/near/near-sdk-js/tree/develop/examples/src/status-message-collections.js)\n- [Programmatic Update After Locking The Contract](https://github.com/near/near-sdk-js/tree/develop/examples/src/programmatic-update.js)\n\nTo build all examples, run `pnpm build` in `examples/`. To test all examples, run `pnpm test`. You can also build and test one specific example with `pnpm build:<example-name>` and `pnpm test:<example-name>`, see `examples/package.json`.\n\nTo deploy and call a contract on a NEAR node, use near-cli's `near deploy` and `near call`.\n\n## Test\n\nWe recommend to use near-workspaces to write tests for your smart contracts. See any of the examples for how tests are setup and written.\n\n## Error Handling in NEAR-SDK-JS\n\nIf you want to indicate an error happened and fail the transaction, just throw an error object in JavaScript. The compiled JavaScript contract includes error handling capability. It will catch throwed errors and automatically invoke `panic_utf8` with `\"{error.message}\\n:{error.stack}\"`. As a result, transaction will fail with `\"Smart contract panicked: {error.message}\\n{error.stack}\"` error message. You can also use an error utilities library to organize your errors, such as verror.\n\nWhen your JS code or library throws an error, uncaught, the transaction will also fail with GuestPanic error, with the error message and stacktrace.\n\nWhen call host function with inappropriate type, means incorrect number of arguments or arg is not expected type:\n\n- if arguments less than params, remaining argument are set as 'undefined'\n- if arguments more than params, remaining argument are ignored\n- if argument is different than the required type, it'll be coerced to required type\n- if argument is different than the required type but cannot be coerced, will throw runtime type error, also with message and stacktrace\n\n## Migrating from near-sdk-js 0.6.0\n\nIf you have a near-sdk-js 0.6.0 contract, you need to drop the `babel.config.json` because it is now inlined in near-sdk-js CLI.\n\nAlso `Bytes` type in 0.6.0 is replaced with `string` and `Uint8Array`. Because `Bytes` was an alias to `string`, this doesn't affect all collection APIs and most low level APIs. Some low level APIs below now also comes with a raw version, which ends with `Raw` and takes `Uint8Array` instead of `string`, for example, `storageRead` vs `storageReadRaw`. Some low level APIs have more sense to use `Uint8Array` instead of `string`, such as `sha256` and arguments for a function call type of promise, these are **BREAKING** changes. Please refer to next section for details: look for functions with `Uint8Array` argument and return types.\n\n## NEAR-SDK-JS API Reference\n\nAll NEAR blockchain provided functionality (host functions) are defined in `src/api.ts` and exported as `near`. You can use them by:\n\n```js\nimport { near } from \"near-sdk-js\";\n\n// near.<api doucmented below>. e.g.:\nlet signer = near.signerAccountId();\n```\n\nTo use nightly host functions, such as `altBn128G1Sum`, your contract need to be built with nightly enabled. Use:\n\n```\nexport NEAR_NIGHTLY=1\npnpm build\n```\n\n### About Type\n\nNEAR-SDK-JS is written in TypeScript, so every API function has a type specified by signature that looks familiar to JavaScript/TypeScript Developers. Two types in the signature need a special attention:\n\n- Most of the API take `bigint` instead of Number as type. This because JavaScript Number cannot hold 64 bit and 128 bit integer without losing precision.\n- For those API that takes or returns raw bytes, it is a JavaScript `Uint8Array`. You can use standard `Uint8Array` methods on it or decode it to string with `decode` or `str`. The differece between `decode` and `str` is: `decode` decode the array as UTF-8 sequence. `str` simply converts each Uint8 to one char with that char code.\n\n### Context API\n\n```\nfunction currentAccountId(): string;\nfunction signerAccountId(): string;\nfunction signerAccountPk(): Uint8Array;\nfunction predecessorAccountId(): string;\nfunction inputRaw(): Uint8Array;\nfunction input(): string;\nfunction blockIndex(): bigint;\nfunction blockHeight(): bigint;\nfunction blockTimestamp(): bigint;\nfunction epochHeight(): bigint;\nfunction storageUsage(): bigint\n```\n\n### Economics API\n\n```\nfunction accountBalance(): bigint;\nfunction accountLockedBalance(): bigint;\nfunction attachedDeposit(): bigint;\nfunction prepaidGas(): bigint;\nfunction usedGas(): bigint;\n```\n\n### Math API\n\n```\nfunction randomSeed(): Uint8Array;\nfunction sha256(value: Uint8Array): Uint8Array;\nfunction keccak256(value: Uint8Array): Uint8Array;\nfunction keccak512(value: Uint8Array): Uint8Array;\nfunction ripemd160(value: Uint8Array): Uint8Array;\nfunction ecrecover(hash: Uint8Array, sign: Uint8Array, v: bigint, malleability_flag: bigint): Uint8Array | null;\n```\n\n### Miscellaneous API\n\n```\nfunction valueReturnRaw(value: Uint8Array);\nfunction valueReturn(value: string);\nfunction panic(msg?: string);\nfunction panicUtf8(msg: Uint8Array);\nfunction logUtf8(msg: Uint8Array);\nfunction logUtf16(msg: Uint8Array);\nfunction log(...params: unknown[]);\n\n```\n\n### Promises API\n\n```\nfunction promiseCreate(account_id: string, method_name: string, arguments: Uint8Array, amount: bigint, gas: bigint): bigint;\nfunction promiseThen(promise_index: bigint, account_id: string, method_name: string, arguments: Uint8Array, amount: bigint, gas: bigint): bigint;\nfunction promiseAnd(...promise_idx: bigint): bigint;\nfunction promiseBatchCreate(account_id: string): bigint;\nfunction promiseBatchThen(promise_index: bigint, account_id: string): bigint;\n```\n\n### Promise API actions\n\n```\nfunction promiseBatchActionCreateAccount(promise_index: PromiseIndex);\nfunction promiseBatchActionDeployContract(promise_index: PromiseIndex, code: Uint8Array);\nfunction promiseBatchActionFunctionCall(promise_index: PromiseIndex, method_name: string, arguments: Uint8Array, amount: bigint, gas: bigint);\nfunction promiseBatchActionFunctionCallWeight(promise_index: PromiseIndex, method_name: string, arguments: Uint8Array, amount: bigint, gas: bigint, weight: bigint);\nfunction promiseBatchActionTransfer(promise_index: PromiseIndex, amount: bigint);\nfunction promiseBatchActionStake(promise_index: PromiseIndex, amount: bigint, public_key: Uint8Array);\nfunction promiseBatchActionAddKeyWithFullAccess(promise_index: PromiseIndex, public_key: Uint8Array, nonce: bigint);\nfunction promiseBatchActionAddKeyWithFunctionCall(promise_index: PromiseIndex, public_key: Uint8Array, nonce: bigint, allowance: bigint, receiver_id: string, method_names: string);\nfunction promiseBatchActionDeleteKey(promise_index: PromiseIndex, public_key: Uint8Array);\nfunction promiseBatchActionDeleteAccount(promise_index: PromiseIndex, beneficiary_id: string);\n```\n\n### Promise API results\n\n```\nfunction promiseResultsCount(): bigint;\nfunction promiseResultRaw(result_idx: PromiseIndex): Uint8Array;\nfunction promiseResult(result_idx: PromiseIndex): string;\nfunction promiseReturn(promise_idx: PromiseIndex);\n```\n\n### Storage API\n\n```\nfunction storageWriteRaw(key: Uint8Array, value: Uint8Array): boolean;\nfunction storageReadRaw(key: Uint8Array): Uint8Array | null;\nfunction storageRemoveRaw(key: Uint8Array): boolean;\nfunction storageHasKeyRaw(key: Uint8Array): boolean;\nfunction storageWrite(key: string, value: string): boolean;\nfunction storageRead(key: string): bigint;\nfunction storageRemove(key: string): bigint;\nfunction storageHasKey(key: string): bigint;\n```\n\n### Validator API\n\n```\nfunction validatorStake(account_id: string): bigint;\nfunction validatorTotalStake(): bigint;\n```\n\n### Alt BN128\n\n```\nfunction altBn128G1Multiexp(value: Uint8Array): Uint8Array;\nfunction altBn128G1Sum(value: Uint8Array): Uint8Array;\nfunction altBn128PairingCheck(value: Uint8Array): boolean;\n```\n\n### NearBindgen and other decorators\n\nYou can write a simple smart contract by only using low-level APIs, such as `near.input()`, `near.storageRead()`, etc. In this case, the API of your contract will consist of all the exported JS functions. You can find an example of such a contract [here](https://github.com/near/near-sdk-js/blob/develop/examples/src/counter-lowlevel.js).\n\nBut if you want to build a more complex contracts with ease, you can use decorators from this SDK that will handle serialization, deserialization, and other boilerplate operations for you.\n\nIn order to do that, your contract must be a class decorated with `@NearBindgen({})`. Each method in this class with `@call({})`, `@view({})`, and `@initialize({})` decorators will become functions of your smart contract. `call` functions can change state, and `view` functions can only read it.\n\nYour class must have a `constructor()`. You will not be able to call it, which is why it should not accept any parameters. You must declare all the parameters that you are planning to use in the constructor and set default values.\n\nThe simplest example of the contract that follows all these rules can be found [here](https://github.com/near/near-sdk-js/blob/develop/examples/src/status-message.js)\n\n`NearBindgen` decorator can accept `requireInit parameter`.\n\n```JS\n@NearBindgen({ requireInit: true })\nclass YourContract {\n ...\n}\n```\n\nIt is `false` by default, but if you will set it to `true`, it will prevent all the `call` functions from being executed before you initialize the state of the contract.\n\nIn order to initialize the contract, you need to add functions flagged with `@initialize({})` decorator.\n\n`@call({})` decorator can accept two parameters: `privateFunction` and `payableFunction`. They are both `false` by default.\n\n`privateFunction: true` can restrict access to this function to the contract itself.\n\n`payableFunction: true` will allow the function to accept payments (deposit). Without this flag, it will panic if any deposit was provided.\n\n### Collections\n\nA few useful on-chain persistent collections are provided. All keys, values and elements are of type `string`.\n\n#### Vector\n\nVector is an iterable implementation of vector that stores its content on the trie. Usage:\n\n```js\nimport {Vector} from 'near-sdk-js'\n\n// in contract class constructor:\nconstructor() {\n super()\n this.v = new Vector('my_prefix_')\n}\n\n// Override the deserializer to load vector from chain\ndeserialize() {\n super.deserialize()\n this.v = Object.assign(new Vector, this.v)\n}\n\nsomeMethod() {\n // insert\n this.v.push('abc')\n this.v.push('def')\n this.v.push('ghi')\n\n // batch insert, extend:\n this.v.extend(['xyz', '123'])\n\n // get\n let first = this.v.get(0)\n\n // remove, move the last element to the given index\n this.v.swapRemove(0)\n\n // replace\n this.v.replace(1, 'jkl')\n\n // remove the last\n this.v.pop()\n\n // len, isEmpty\n let len = this.v.length\n let isEmpty = this.v.isEmpty()\n\n // iterate\n for (let element of this.v) {\n near.log(element)\n }\n\n // toArray, convert to JavaScript Array\n let a = this.v.toArray()\n\n // clear\n ths.v.clear()\n}\n```\n\n#### LookupMap\n\nLookupMap is an non-iterable implementation of a map that stores its content directly on the trie. It's like a big hash map, but on trie. Usage:\n\n```js\nimport {LookupMap} from 'near-sdk-js'\n\n// in contract class constructor:\nconstructor() {\n super()\n this.m = new LookupMap('prefix_a')\n}\n\n// Override the deserializer to load vector from chain\ndeserialize() {\n super.deserialize()\n this.m = Object.assign(new LookupMap, this.m)\n}\n\nsomeMethod() {\n // insert\n this.m.set('abc', 'aaa')\n this.m.set('def', 'bbb')\n this.m.set('ghi', 'ccc')\n\n // batch insert, extend:\n this.m.extend([['xyz', '123'], ['key2', 'value2']])\n\n // check exist\n let exist = this.m.containsKey('abc')\n\n // get\n let value = this.m.get('abc')\n\n // remove\n this.m.remove('def')\n\n // replace\n this.m.set('ghi', 'ddd')\n}\n```\n\n#### LookupSet\n\nLookupSet is an non-iterable implementation of a set that stores its content directly on the trie. It's like LookupMap, but it only stores whether the value presents. Usage:\n\n```js\nimport {LookupSet} from 'near-sdk-js'\n\n// in contract class constructor:\nconstructor() {\n super()\n this.s = new LookupSet('prefix_b')\n}\n\n// Override the deserializer to load vector from chain\ndeserialize() {\n super.deserialize()\n this.s = Object.assign(new LookupSet, this.s)\n}\n\nsomeMethod() {\n // insert\n this.s.set('abc')\n this.s.set('def')\n this.s.set('ghi')\n\n // batch insert, extend:\n this.s.extend(['xyz', '123'])\n\n // check exist\n let exist = this.s.contains('abc')\n\n // remove\n this.s.remove('def')\n}\n```\n\n#### UnorderedMap\n\nUnorderedMap is an iterable implementation of a map that stores its content directly on the trie. Usage:\n\n```js\nimport {UnorderedMap} from 'near-sdk-js'\n\n// in contract class constructor:\nconstructor() {\n super()\n this.m = new UnorderedMap('prefix_c')\n}\n\n// Override the deserializer to load vector from chain\ndeserialize() {\n super.deserialize()\n this.m.keys = Object.assign(new Vector, this.m.keys)\n this.m.values = Object.assign(new Vector, this.m.values)\n this.m = Object.assign(new UnorderedMap, this.m)\n}\n\nsomeMethod() {\n // insert\n this.m.set('abc', 'aaa')\n this.m.set('def', 'bbb')\n this.m.set('ghi', 'ccc')\n\n // batch insert, extend:\n this.m.extend([['xyz', '123'], ['key2', 'value2']])\n\n // get\n let value = this.m.get('abc')\n\n // remove\n this.m.remove('def')\n\n // replace\n this.m.set('ghi', 'ddd')\n\n // len, isEmpty\n let len = this.m.length\n let isEmpty = this.m.isEmpty()\n\n // iterate\n for (let [k, v] of this.m) {\n near.log(k+v)\n }\n\n // toArray, convert to JavaScript Array\n let a = this.m.toArray()\n\n // clear\n this.m.clear()\n}\n```\n\n#### UnorderedSet\n\nUnorderedSet is an iterable implementation of a set that stores its content directly on the trie. It's like UnorderedMap but it only stores whether the value presents. Usage:\n\n```js\nimport {UnorderedSet} from 'near-sdk-js'\n\n// in contract class constructor:\nconstructor() {\n super()\n this.s = new UnorderedSet('prefix_d')\n}\n\n// Override the deserializer to load vector from chain\ndeserialize() {\n super.deserialize()\n this.s.elements = Object.assign(new Vector, this.s.elements)\n this.s = Object.assign(new UnorderedSet, this.s)\n}\n\nsomeMethod() {\n // insert\n this.s.set('abc')\n this.s.set('def')\n this.s.set('ghi')\n\n // batch insert, extend:\n this.s.extend(['xyz', '123'])\n\n // check exist\n let exist = this.s.contains('abc')\n\n // remove\n this.s.remove('def')\n\n // len, isEmpty\n let len = this.s.length\n let isEmpty = this.s.isEmpty()\n\n // iterate\n for (let e of this.s) {\n near.log(e)\n }\n\n // toArray, convert to JavaScript Array\n let a = this.s.toArray()\n\n // clear\n this.s.clear()\n}\n```\n\n### Highlevel Promise APIs\n\nWithin a contract class that decorated by `@Nearbindgen`, you can work a high level JavaScript class, called `NearPromise`. It's equivalently expressive as promise batch APIs but much shorter to write and can be chained like a JavaScript Promise.\n\nIn a `@call` method, you can return either a JavaScript value or a `NearPromise` object. In the later case, `@NearBindgen` will automatically `promiseReturn` it for you.\n\nUsage:\n\n```js\n// create new promise\nimport { NearPromise, near, includeBytes } from \"near-sdk-js\";\nimport { PublicKey } from \"near-sdk-js/lib/types\";\n\nlet promise = NearPromise.new(\"account-to-run-promise\");\n\n// possible promise actions, choose and chain what you need:\npromise\n .createAccount()\n .transfer(1_000_000_000_000_000_000_000_000_000_000_000_000n)\n .addFullAccessKey(new PublicKey(near.signerAccountPk()))\n .addAccessKey(\n new PublicKey(near.signerAccountPk()),\n 250000000000000000000000n, // allowance\n \"receiver_account_id\",\n \"allowed_function_names\"\n )\n .stake(100000000000000000000000000000n, new PublicKey(near.signerAccountPk()))\n .deployContract(includeBytes(\"path/to/contract.wasm\"))\n .functionCall(\n \"callee_contract_account_id\",\n inputArgs,\n 0, // amount\n 2 * Math.pow(10, 13) // gas\n )\n .functionCallWeight(\n \"callee_contract_account_id\",\n inputArgs,\n 0, // amount\n 2 * Math.pow(10, 13), // gas\n 1 // weight\n )\n .deleteKey(new PublicKey(near.signerAccountPk()))\n .deleteAccount(\"beneficial_account_id\");\n\nreturn promise;\n```\n\nIn the case of deploy contract, `includeBytes` is a helpful build-time util. You can include the content of a wasm contract, by using `includeBytes('path/to/contract.wasm')`.\n\nIn the case of `addFullAccessKey`, `addAccessKey` and `stake`, it takes a `PublicKey` object, you can find more details about it in the Types sections below.\n\nBesides above APIs to build something on top of an API, you can also chain promises with `.then` and `.and`, they're equivalent to promiseThen, promiseAnd:\n\n```js\n// assume promise, promise2 and promise3 are create with above APIs, with several actions added like above.\npromise.and(promise2).then(promise3); // promiseAnd of [promise_id, promise2_id], then promiseThen(promise_and_id, promise3_id)\n\nreturn promise;\n```\n\n### Types\n\nNEAR-SDK-JS also includes type defintions that are equivalent to that in Rust SDK / nearcore. You can browse them in near-sdk-js/src/types. Most of them are just type alias to string and bigint.\n\n#### Public Key\n\nPublic Key is representing a NEAR account's public key in a JavaScript class. You can either initiate a Public Key from binary data, or from a human readable string.\n\nThe binary data is in the same format as nearcore in `Uint8Array`. That's one byte to represent the curve type of the public key, either ed25519 (`0x0`), or secp256k1 (`0x1`), follows by the curve-specific public key data in bytes. Examples:\n\n```js\nnew PublicKey(near.signerAccountPk());\nlet pk = new PublicKey(\n new Uint8Array([\n // CurveType.ED25519 = 0\n 0,\n // ED25519 PublicKey data\n 186, 44, 216, 49, 157, 48, 151, 47, 23, 244, 137, 69, 78, 150, 54, 42, 30, 248,\n 110, 26, 205, 18, 137, 154, 10, 208, 26, 183, 65, 166, 223, 18,\n ])\n);\nlet pk = new PublicKey(\n new Uint8Array([\n // CurveType.SECP256K1 = 1\n 1,\n // SECP256K1 PublicKey data\n 242, 86, 198, 230, 200, 11, 33, 63, 42, 160, 176, 23, 68, 35, 93, 81, 92, 89,\n 68, 53, 190, 101, 27, 21, 136, 58, 16, 221, 71, 47, 166, 70, 206, 98, 234, 243,\n 103, 13, 197, 203, 145, 0, 160, 202, 42, 85, 178, 193, 71, 193, 233, 163, 140,\n 228, 40, 135, 142, 125, 70, 225, 251, 113, 74, 153,\n ])\n);\n```\n\nThe human readable form is `ed25519:` or `secp256k1:` following base58-encoded public key. And initialize the Public Key with `PublicKey.fromString`:\n\n```js\nPublicKey.fromString('ed25519:DXkVZkHd7WUUejCK7i74uAoZWy1w9AZqshhTHxhmqHuB`)\nPublicKey.fromString('secp256k1:5r22SrjrDvgY3wdQsnjgxkeAbU1VcM71FYvALEQWihjM3Xk4Be1CpETTqFccChQr4iJwDroSDVmgaWZv2AcXvYeL`)\n```\n\nOnce a PublicKey object is created, it can be used in high level promise APIs that takes a public key, such as `addFullAccessKey`, `addAccessKey` and `stake`.\n\n## How to use NEAR SDK JS on Windows\n\nYou can develop smart contracts on Windows using Windows Subsystem for Linux (WSL2).\nIn order to use WSL2, follow the next steps:\n\n- Run `PowerShell` as Administrator\n- Execute `wsl --install` to install Ubuntu and do additional setup automatically. Check more details [here](https://learn.microsoft.com/en-us/windows/wsl/install)\n- Restart your machine\n- `WSL2` will continue setup process on start. Setup your username and password when prompted.\n- Check [this](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl) guide to setup `npm`, `node`, `npx`, `VSCode` and other tools of your choice in order to start developing.\n\nIn case of any issues of setting up WSL2 make sure that:\n\n- Your Windows OS is up to date\n- Virtualisation is turned on in BIOS\n- `Windows Subsystem for Linux` and `Virtual Machine Platform` are turned on in `Windows Features` (Start -> Search -> Turn Windows Feature On or Off)\n# NEAR-SDK-JS Tests\n\nThis tests the functionality of high level APIs of NEAR-SDK-JS. Currently, it directly tests all collections and indirectly tests all decorators, serialization/deserialization, utils, code generation and some important APIs. Majority of near-sdk-js can be seen as tested.\n\n# Run tests\n\n```\npnpm install\npnpm build\npnpm test\n```\n\n# Add a new test\n\nCreate a test contract that covers the API you want to test in `src/`. Add a build command in `build.sh`. Write ava test in `__tests__`.\n# NEAR JavaScript SDK\n\n<p>\n <a href=\"https://www.npmjs.com/package/near-sdk-js\" target=\"_blank\">\n <img alt=\"Version\" src=\"https://img.shields.io/npm/v/near-sdk-js.svg\">\n </a>\n <img src=\"https://img.shields.io/badge/node-%3E%3D14%20%3C16.6.0%20%7C%7C%20%3E16.6.0-blue.svg\" />\n <img src=\"https://img.shields.io/badge/pnpm-%3E%3D7-blue.svg\" />\n <a href=\"https://docs.near.org/sdk/js/introduction\" target=\"_blank\">\n <img alt=\"Documentation\" src=\"https://img.shields.io/badge/documentation-yes-brightgreen.svg\" />\n </a>\n <a href=\"https://github.com/near/near-sdk-js/blob/develop/LICENSE\" target=\"_blank\">\n <img alt=\"License: LICENSE\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" />\n </a>\n <a href=\"https://github.com/near/near-sdk-js/blob/develop/LICENSE-APACHE\" target=\"_blank\">\n <img alt=\"License: LICENSE\" src=\"https://img.shields.io/badge/License-Apache-yellow.svg\" />\n </a>\n</p>\n\nA JavaScript library for writing NEAR smart contracts.\n\n> **Warning**\n>\n> This SDK is currently in **[`Alpha`](https://github.com/near/near-sdk-js/releases/)**.\n>\n> The JavaScript runtime has not been fully audited. For creating smart contracts that hold value please use [`near-sdk-rs`](https://github.com/near/near-sdk-rs).\n>\n> Help contribute!\n>\n> - [Report issues you encounter](https://github.com/near/near-sdk-js/issues) 🐞\n> - [Provide suggestions or feedback](https://github.com/near/near-sdk-js/discussions) 💡\n> - [Show us what you've built!](https://github.com/near/near-sdk-js/discussions/categories/show-and-tell) 💪\n\n## Prerequisites\n\n- node >=14 <16.6.0 || >16.6.0\n- pnpm >=7\n\n## Quick Start\n\nUse [`create-near-app`](https://github.com/near/create-near-app) to quickly get started writing smart contracts in JavaScript on NEAR.\n\n npx create-near-app\n\nThis will scaffold a basic template for you 😎\n\n## Documentation\n\n- [Learn how to use](https://docs.near.org/sdk/js/introduction) the library in your project\n- Check our [detailed examples and tutorials](https://docs.near.org/tutorials/welcome)\n- Find [source code examples](./examples) with common use cases\n- 🏠 Learn more about NEAR on our [Documentation website](https://docs.near.org/)\n\n## Contributing\n\nIf you are interested in contributing, please look at the [contributing guidelines](CONTRIBUTING.md).\n\n - [Report issues you encounter](https://github.com/near/near-sdk-js/issues) 🐞\n - [Provide suggestions or feedback](https://github.com/near/near-sdk-js/discussions) 💡\n - [Show us what you've built!](https://github.com/near/near-sdk-js/discussions/categories/show-and-tell) 💪\n\n## License\n\nThis repository is distributed under the terms of both the [MIT license](https://github.com/near/near-sdk-js/blob/develop/LICENSE) and the [Apache License](https://github.com/near/near-sdk-js/blob/develop/LICENSE-APACHE) (Version 2.0).\nSee [LICENSE](LICENSE) and [LICENSE-APACHE](LICENSE-APACHE) for details.\n# Gas and size benchmark compare to NEAR-SDK-RS\n\n## Summary\n\nNEAR-SDK-JS bundles a bytecode VM with the contract bytecode to a wasm file. Currently, the bytecode VM is the QuickJS runtime with interface to NEAR and the contract bytecode is compiled from JavaScript source code with QuickJS Compiler (QJSC).\n\nThis results in:\n\n- Size of a minimal contract is 500K, which is also the size of the bytecode VM.\n- Bytecode is more compact than wasm. Complex contract in JS adds less bytes to the equivalent wasm compiled from Rust, but due to the initial 500K size, the result contract is still bigger and within same order of magnitude: several hundred KB.\n- For contract that bottlenecks at calling the host functions are using similar gas in JS and Rust.\n- For contract that does a lot of computation in JS, the JS bytecode uses significantly more gas.\n- For a real world contract, if it doesn't including complex logic in JavaScript, it's usually sufficient, consider the complexity of the near contract standards.\n- For more complex logic, We suggest to bench the most expensive contract call, including most complex path of cross contract calls, to determine whether it fits 300T Gas limit.\n\n## Detailed gas benchmark\n\n### A minimal contract\n\n- RS lowlevel minimal contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 2.43T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.00005T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 5.08T\n- JS lowlevel minimal contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 7.07T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.11132T\n - WASM_INSTRUCTION : 4.53T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 9.72T\n\nIn the very minimal contract the JS adds about `1.8T` gas. The major difference is loading the QuickJS VM and near-sdk-js uses 4.53T Gas. The 500K contract loading just adds 0.1T Gas.\n\n### A highlevel minimal contract (using nearbindgen)\n\n- highlevel-minimal.ava › RS highlevel minimal contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 2.63T\n - BASE : 0.79G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 35.46G\n - READ_CACHED_TRIE_NODE : 4.56G\n - READ_MEMORY_BASE : 7.83G\n - READ_MEMORY_BYTE : 0.04G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - TOUCHING_TRIE_NODE : 32.2G\n - WASM_INSTRUCTION : 0.46G\n - WRITE_MEMORY_BASE : 2.8G\n - WRITE_MEMORY_BYTE : 0.04G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 5.28T\n- highlevel-minimal.ava › JS highlevel minimal contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 8.39T\n - BASE : 1.59G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 112.03G\n - READ_CACHED_TRIE_NODE : 6.84G\n - READ_MEMORY_BASE : 7.83G\n - READ_MEMORY_BYTE : 0.05G\n - READ_REGISTER_BASE : 2.52G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - STORAGE_WRITE_VALUE_BYTE : 0.06G\n - TOUCHING_TRIE_NODE : 48.31G\n - WASM_INSTRUCTION : 5.66T\n - WRITE_MEMORY_BASE : 5.61G\n - WRITE_MEMORY_BYTE : 0.05G\n - WRITE_REGISTER_BASE : 2.87G\n - WRITE_REGISTER_BYTE : 0.01G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 11.05T\n\nJS `@NearBindgen` is more expensive, the major difference is in `WASM_INSTRUCTION`, because `@NearBindgen` does some class, object manipulation work, but Rust `near_bindgen` is a compile time code generation macro. Deduct the 4.5T loading VM and near-sdk-js, it's about 1T gas overhead.\n\n### Low level API\n\n- RS lowlevel API contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 2.53T\n - BASE : 0.00026T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.00008T\n - READ_MEMORY_BASE : 0.00522T\n - READ_MEMORY_BYTE : 0.00008T\n - STORAGE_WRITE_BASE : 0.0642T\n - STORAGE_WRITE_KEY_BYTE : 0.0007T\n - STORAGE_WRITE_VALUE_BYTE : 0.00031T\n - TOUCHING_TRIE_NODE : 0.0322T\n - WASM_INSTRUCTION : 0.00002T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 5.18T\n- JS lowlevel API contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 7.8T\n - BASE : 0.00026T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.11119T\n - READ_MEMORY_BASE : 0.00522T\n - READ_MEMORY_BYTE : 0.00008T\n - STORAGE_WRITE_BASE : 0.0642T\n - STORAGE_WRITE_EVICTED_BYTE : 0.00032T\n - STORAGE_WRITE_KEY_BYTE : 0.0007T\n - STORAGE_WRITE_VALUE_BYTE : 0.00031T\n - TOUCHING_TRIE_NODE : 0.09661T\n - WASM_INSTRUCTION : 5.09T\n - WRITE_REGISTER_BASE : 0.00287T\n - WRITE_REGISTER_BYTE : 0.00004T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 10.45T\n- JS lowlevel API contract, call many\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 8.47T\n - BASE : 0.00265T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.11119T\n - READ_MEMORY_BASE : 0.0522T\n - READ_MEMORY_BYTE : 0.00076T\n - STORAGE_WRITE_BASE : 0.64197T\n - STORAGE_WRITE_EVICTED_BYTE : 0.00289T\n - STORAGE_WRITE_KEY_BYTE : 0.00705T\n - STORAGE_WRITE_VALUE_BYTE : 0.0031T\n - TOUCHING_TRIE_NODE : 0.04831T\n - WASM_INSTRUCTION : 5.14T\n - WRITE_REGISTER_BASE : 0.02579T\n - WRITE_REGISTER_BYTE : 0.00034T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 11.12T\n\nIn this case, JS lowlevel API contract uses same gas in the storage write API part (`STORAGE_WRITE_BASE` / `STORAGE_WRITE_KEY_BYTE` / `STORAGE_WRITE_VALUE_BYTE` ). The major excessive gas is due to the overhead of initialize QuickJS VM and loading near-sdk-js. We can see this more obviously by calling storage write for 10 times (\"call many tests\" in above).\n\n### Highlevel collection\n\n- RS highlevel collection contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 3.32T\n - BASE : 3.18G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 70.94G\n - READ_CACHED_TRIE_NODE : 95.76G\n - READ_MEMORY_BASE : 26.1G\n - READ_MEMORY_BYTE : 1.87G\n - READ_REGISTER_BASE : 5.03G\n - READ_REGISTER_BYTE : 0.03G\n - STORAGE_READ_BASE : 112.71G\n - STORAGE_READ_KEY_BYTE : 3.44G\n - STORAGE_READ_VALUE_BYTE : 0.19G\n - STORAGE_WRITE_BASE : 256.79G\n - STORAGE_WRITE_EVICTED_BYTE : 1.09G\n - STORAGE_WRITE_KEY_BYTE : 9.23G\n - STORAGE_WRITE_VALUE_BYTE : 7.75G\n - TOUCHING_TRIE_NODE : 257.63G\n - WASM_INSTRUCTION : 16.36G\n - WRITE_MEMORY_BASE : 8.41G\n - WRITE_MEMORY_BYTE : 0.74G\n - WRITE_REGISTER_BASE : 8.6G\n - WRITE_REGISTER_BYTE : 1.1G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 5.97T\n- JS highlevel collection contract\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 10.06T\n - BASE : 2.91G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 113.46G\n - READ_CACHED_TRIE_NODE : 72.96G\n - READ_MEMORY_BASE : 20.88G\n - READ_MEMORY_BYTE : 2G\n - READ_REGISTER_BASE : 5.03G\n - READ_REGISTER_BYTE : 0.03G\n - STORAGE_READ_BASE : 112.71G\n - STORAGE_READ_KEY_BYTE : 3.31G\n - STORAGE_READ_VALUE_BYTE : 0.53G\n - STORAGE_WRITE_BASE : 192.59G\n - STORAGE_WRITE_EVICTED_BYTE : 3.02G\n - STORAGE_WRITE_KEY_BYTE : 7.96G\n - STORAGE_WRITE_VALUE_BYTE : 9.49G\n - TOUCHING_TRIE_NODE : 209.33G\n - WASM_INSTRUCTION : 6.86T\n - WRITE_MEMORY_BASE : 8.41G\n - WRITE_MEMORY_BYTE : 0.9G\n - WRITE_REGISTER_BASE : 8.6G\n - WRITE_REGISTER_BYTE : 1.55G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 12.71T\n\nJS SDK's collection has about 1T overhead, deduct the 4.5T VM/near-sdk-js loading and 1T `@NearBindgen`. Note this benches the most complicated `UnorderedMap`, which gas usage is strictly greater than the other collections. And the gas used in actual writing the collection to storage is similar (`STORAGE_WRITE_BASE` / `STORAGE_WRITE_KEY_BYTE` / `STORAGE_WRITE_VALUE_BYTE` ).\n\n### Computational expensive contract\n\n- JS expensive contract, iterate 20000 times\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 123.26T\n - BASE : 1.85G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 112.09G\n - READ_CACHED_TRIE_NODE : 4.56G\n - READ_MEMORY_BASE : 10.44G\n - READ_MEMORY_BYTE : 0.07G\n - READ_REGISTER_BASE : 2.52G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - STORAGE_WRITE_VALUE_BYTE : 0.06G\n - TOUCHING_TRIE_NODE : 32.2G\n - WASM_INSTRUCTION : 120.54T\n - WRITE_MEMORY_BASE : 5.61G\n - WRITE_MEMORY_BYTE : 0.07G\n - WRITE_REGISTER_BASE : 2.87G\n - WRITE_REGISTER_BYTE : 0.04G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 125.91T\n- RS expensive contract. iterate 20000 times\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 3.01T\n - BASE : 1.85G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 67.77G\n - READ_CACHED_TRIE_NODE : 6.84G\n - READ_MEMORY_BASE : 10.44G\n - READ_MEMORY_BYTE : 0.06G\n - READ_REGISTER_BASE : 2.52G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - TOUCHING_TRIE_NODE : 48.31G\n - WASM_INSTRUCTION : 315.17G\n - WRITE_MEMORY_BASE : 5.61G\n - WRITE_MEMORY_BYTE : 0.07G\n - WRITE_REGISTER_BASE : 2.87G\n - WRITE_REGISTER_BYTE : 0.04G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 5.66T\n- RS expensive contract. iterate 10000 times\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 2.9T\n - BASE : 2.38G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 67.77G\n - READ_CACHED_TRIE_NODE : 13.68G\n - READ_MEMORY_BASE : 10.44G\n - READ_MEMORY_BYTE : 0.06G\n - READ_REGISTER_BASE : 5.03G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - TOUCHING_TRIE_NODE : 80.51G\n - WASM_INSTRUCTION : 158.89G\n - WRITE_MEMORY_BASE : 8.41G\n - WRITE_MEMORY_BYTE : 0.07G\n - WRITE_REGISTER_BASE : 8.6G\n - WRITE_REGISTER_BYTE : 0.04G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 5.56T\n- RS expensive contract. iterate 100 times\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 2.75T\n - BASE : 2.38G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 67.77G\n - READ_CACHED_TRIE_NODE : 13.68G\n - READ_MEMORY_BASE : 10.44G\n - READ_MEMORY_BYTE : 0.05G\n - READ_REGISTER_BASE : 5.03G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - TOUCHING_TRIE_NODE : 80.51G\n - WASM_INSTRUCTION : 4.02G\n - WRITE_MEMORY_BASE : 8.41G\n - WRITE_MEMORY_BYTE : 0.07G\n - WRITE_REGISTER_BASE : 8.6G\n - WRITE_REGISTER_BYTE : 0.03G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 5.4T\n- JS expensive contract, iterate 100 times\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 9.09T\n - BASE : 2.38G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 112.09G\n - READ_CACHED_TRIE_NODE : 13.68G\n - READ_MEMORY_BASE : 10.44G\n - READ_MEMORY_BYTE : 0.06G\n - READ_REGISTER_BASE : 5.03G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_READ_VALUE_BYTE : 0.01G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_EVICTED_BYTE : 0.06G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - STORAGE_WRITE_VALUE_BYTE : 0.06G\n - TOUCHING_TRIE_NODE : 80.51G\n - WASM_INSTRUCTION : 6.3T\n - WRITE_MEMORY_BASE : 8.41G\n - WRITE_MEMORY_BYTE : 0.07G\n - WRITE_REGISTER_BASE : 8.6G\n - WRITE_REGISTER_BYTE : 0.05G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 11.75T\n- JS expensive contract, iterate 10000 times\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 65.94T\n - BASE : 2.38G\n - CONTRACT_LOADING_BASE : 0.04G\n - CONTRACT_LOADING_BYTES : 112.09G\n - READ_CACHED_TRIE_NODE : 13.68G\n - READ_MEMORY_BASE : 10.44G\n - READ_MEMORY_BYTE : 0.06G\n - READ_REGISTER_BASE : 5.03G\n - READ_REGISTER_BYTE : 0G\n - STORAGE_READ_BASE : 56.36G\n - STORAGE_READ_KEY_BYTE : 0.15G\n - STORAGE_READ_VALUE_BYTE : 0.01G\n - STORAGE_WRITE_BASE : 64.2G\n - STORAGE_WRITE_EVICTED_BYTE : 0.06G\n - STORAGE_WRITE_KEY_BYTE : 0.35G\n - STORAGE_WRITE_VALUE_BYTE : 0.06G\n - TOUCHING_TRIE_NODE : 80.51G\n - WASM_INSTRUCTION : 63.15T\n - WRITE_MEMORY_BASE : 8.41G\n - WRITE_MEMORY_BYTE : 0.08G\n - WRITE_REGISTER_BASE : 8.6G\n - WRITE_REGISTER_BYTE : 0.06G\n - Gas used to refund unused gas: 223.18G\n - Total gas used: 68.59T\n\nIn this case, JS uses much more gas. Because JS Number is object and that's a lot of overhead compare to native integer arithmetic. It's even a lot of overhead compare to native float arithmetic. Also in QuickJS there's no JIT. If your contract does a lot of calculation or complex algorithm in JavaScript, it'd be better to do a similar benchmark.\n\n### Deploy and cross contract call\n\n- JS promise batch deploy contract and call\n\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 25.86T\n - CREATE_ACCOUNT : 0.09961T\n - DEPLOY_CONTRACT : 3.71T\n - FUNCTION_CALL : 2.32T\n - NEW_RECEIPT : 0.10806T\n - TRANSFER : 0.11512T\n - BASE : 0.00159T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.22386T\n - PROMISE_RETURN : 0.00056T\n - READ_MEMORY_BASE : 0.01566T\n - READ_MEMORY_BYTE : 1.97T\n - UTF8_DECODING_BASE : 0.00311T\n - UTF8_DECODING_BYTE : 0.00525T\n - WASM_INSTRUCTION : 14.86T\n - Gas used to execute the cross contract call: 41.9T\n - BASE : 0.00344T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.11228T\n - READ_MEMORY_BASE : 0.00261T\n - READ_MEMORY_BYTE : 0.0005T\n - READ_REGISTER_BASE : 0.01007T\n - READ_REGISTER_BYTE : 0T\n - WASM_INSTRUCTION : 5.47T\n - WRITE_MEMORY_BASE : 0.01122T\n - WRITE_MEMORY_BYTE : 0.00014T\n - WRITE_REGISTER_BASE : 0.01146T\n - WRITE_REGISTER_BYTE : 0.00019T\n - Gas used to refund unused gas for cross contract call: 0.22318T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 70.63T\n\n- RS promise batch deploy contract and call\n - Gas used to convert transaction to receipt: 2.43T\n - Gas used to execute the receipt (actual contract call): 10.89T\n - CREATE_ACCOUNT : 0.09961T\n - DEPLOY_CONTRACT : 3.71T\n - FUNCTION_CALL : 2.32T\n - NEW_RECEIPT : 0.10806T\n - TRANSFER : 0.11512T\n - BASE : 0.00159T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.11283T\n - PROMISE_RETURN : 0.00056T\n - READ_MEMORY_BASE : 0.01566T\n - READ_MEMORY_BYTE : 1.97T\n - UTF8_DECODING_BASE : 0.00311T\n - UTF8_DECODING_BYTE : 0.00525T\n - WASM_INSTRUCTION : 0.00038T\n - Gas used to execute the cross contract call: 41.9T\n - BASE : 0.00344T\n - CONTRACT_LOADING_BASE : 0.00004T\n - CONTRACT_LOADING_BYTES : 0.11228T\n - READ_MEMORY_BASE : 0.00261T\n - READ_MEMORY_BYTE : 0.0005T\n - READ_REGISTER_BASE : 0.01007T\n - READ_REGISTER_BYTE : 0T\n - WASM_INSTRUCTION : 5.47T\n - WRITE_MEMORY_BASE : 0.01122T\n - WRITE_MEMORY_BYTE : 0.00014T\n - WRITE_REGISTER_BASE : 0.01146T\n - WRITE_REGISTER_BYTE : 0.00019T\n - Gas used to refund unused gas for cross contract call: 0.22318T\n - Gas used to refund unused gas: 0.22318T\n - Total gas used: 55.67T\n\nIn this test, we use a JS contract and RS contract to both deploy a JS contract and cross contract call this newly deployed contract. We can see the gas to do the cross contract call is the same. JS SDK has a `~10T` overhead to parse a `~500K` contract in byte. This is because JS, either represent code in Uint8Array or string has some overhead while rust compiler can directly turn it into data section in wasm. In practice, a 10T overhead for a one time contract deploy is not a big deal.\n\n## Tips to do your own benchmark\n\nIf the above cases don't cover use case or you have a complex algorithm to implement in JavaScript, it's a good idea to benchmark your specific algorithm before choose near-sdk-js for your project.\n\nYou don't have to implement the exact algorithm to estimate the gas usage. Instead, you can find out the most expensive execution path of the algorithm, and estimate it by using the upper bound. For example, store the biggest possible objects into the collection and iterate for most possible times. Then goes to write the benchmark and the total gas cannot be more than 300T to be a valid contract. Also, if it has cross contract call, make sure the total gas, that's a sum of all cross contract calls, is less than 300T.\n\nTo add your benchmark, write a one function contract of your most expensive operation. And write a test to call this function. If it doesn't involve cross contract call or promises, creating such test is simple. You can refer to `bench/src/expensive-calc.js` and `bench/__tests__/test-expensive-calc.ava.js` on how to write such test and print the gas breakdown. If it involves create promises or cross contract calls, printing the gas breakdown is a little bit more complex, you can refer to `bench/__tests__/test-deploy-contract.ava.js` for the recipe.\n\n## Details of size benchmark\n\n### JS Contract\n\n```\n\n-rwxrwxr-x 1 bo bo 1009K Feb 9 10:49 ./build/deploy-contract.wasm\n-rwxrwxr-x 1 bo bo 506K Feb 8 12:11 ./build/expensive-calc.wasm\n-rwxrwxr-x 1 bo bo 512K Feb 7 15:57 ./build/highlevel-collection.wasm\n-rwxrwxr-x 1 bo bo 505K Feb 7 10:53 ./build/highlevel-minimal.wasm\n-rwxrwxr-x 1 bo bo 502K Feb 10 11:32 ./build/lowlevel-api.wasm\n-rwxrwxr-x 1 bo bo 502K Feb 10 11:47 ./build/lowlevel-minimal.wasm\n```\n\n### Rust Contract\n\n```\n-rwxrwxr-x 1 bo bo 509K Feb 10 10:02 ./res/deploy_contract.wasm\n-rwxrwxr-x 1 bo bo 306K Feb 8 12:18 ./res/expensive_calc.wasm\n-rwxrwxr-x 1 bo bo 320K Feb 8 11:26 ./res/highlevel_collection.wasm\n-rwxrwxr-x 1 bo bo 160K Feb 7 10:51 ./res/highlevel_minimal.wasm\n-rwxrwxr-x 1 bo bo 387 Feb 7 11:56 ./res/lowlevel_api.wasm\n-rwxrwxr-x 1 bo bo 219 Feb 7 10:33 ./res/lowlevel_minimal.wasm\n```\n\n## Appendix\n\n- Source code of the rust benchmark: https://github.com/near/sdk-rs-gas-benchmark\n"}}},{"rowIdx":565,"cells":{"repoName":{"kind":"string","value":"mehmetlevent_near_todo-crud"},"tree":{"kind":"string","value":"README.md\nasconfig.json\nassembly\n as_types.d.ts\n index.ts\n model.ts\n tsconfig.json\nindex.html\npackage.json\ntests\n index.js\n"},"readme":{"kind":"string","value":"# near_todo-crud\npatika.dev\n"}}},{"rowIdx":566,"cells":{"repoName":{"kind":"string","value":"gnoblin_roketo-hackathon-deblockle"},"tree":{"kind":"string","value":"Assets\n DampedSpringMotionCopier\n Code\n DampedSpringMotionCopier.Utils.cs\n DampedSpringMotionCopier.cs\n TooltipAttribute.cs\n Docs\n Html\n DampedSpringMotionCopier.html\n Scripts\n ActionProcessors\n CubeAction.cs\n DiagonalMoveAction.cs\n SideMoveAction.cs\n CubeActionsPack.cs\n CubeDataPack.cs\n CubePlacer.cs\n Gameplay\n ActionType.cs\n CubeRotator.cs\n GameCube.cs\n ServerDataCubeRotator.cs\n Managers\n FieldProcessor.cs\n GameProvider.cs\n InputManager.cs\n JSBackend.cs\n JSFunctions.cs\n UI\n EnterScreen.cs\n GameScreen.cs\n InputScreen.cs\n SwipeInfo.cs\nREADME.md\nfrontend\n Build\n Builds.framework.js\n Builds.loader.js\n TemplateData\n style.css\n css\n styles.css\n index2.html\n js\n index.js\n"},"readme":{"kind":"string","value":"# roketo-hackathon-deblockle\n\nUnity3d webgl client for Deblockle game \n(based on awesome https://github.com/uz0/lab2-vdikan-near-deblockle smart-contracts)\n\nVideo (showing the fresh version of the gameplay): \nhttps://user-images.githubusercontent.com/639995/188195681-000b0e63-94b3-4222-aa54-0778eac70a67.mp4\n\nPresentation: \nhttps://docs.google.com/presentation/d/1nQ_HPZU5ApasSOPYZY3grBk6u4I-cAoiqVNeKhRLluY/edit?usp=sharing\n\nDemo: no public demo yet :) \n(something broke down in unity<->web integration and more time was needed to debug)\n\nTodo: \n1. find the bug why the build stopped working.\n2. fix the list of external assets so the whole project can be open sourced.\n"}}},{"rowIdx":567,"cells":{"repoName":{"kind":"string","value":"near_near-abi-client-rs"},"tree":{"kind":"string","value":".github\n workflows\n release-plz.yml\n test.yml\nCHANGELOG.md\nCargo.toml\nREADME.md\nexamples\n delegator-generation\n Cargo.toml\n build.rs\n src\n adder.json\n lib.rs\n tests\n mod.rs\n delegator-macro\n Cargo.toml\n src\n adder.json\n lib.rs\n tests\n mod.rs\nnear-abi-client-impl\n CHANGELOG.md\n Cargo.toml\n README.md\n src\n lib.rs\nnear-abi-client-macros\n CHANGELOG.md\n Cargo.toml\n README.md\n src\n lib.rs\nnear-abi-client\n CHANGELOG.md\n Cargo.toml\n README.md\n src\n lib.rs\n tests\n adder.json\n mod.rs\nres\n adder.json\n"},"readme":{"kind":"string","value":"<!-- markdownlint-disable MD014 -->\n\n<div align=\"center\">\n\n <h1><code>near-abi-client-rs</code></h1>\n\n <p>\n <strong>Library to generate Rust client code with <a href=\"https://github.com/near/workspaces-rs\">workspaces-rs</a> from <a href=\"https://github.com/near/abi\">ABI schemas</a> on NEAR</strong>\n </p>\n\n <p>\n <a href=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml?query=branch%3Amain\"><img src=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml/badge.svg\" alt=\"Github CI Build\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/v/near-abi-client.svg?style=flat-square\" alt=\"Crates.io version\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/d/near-abi-client.svg?style=flat-square\" alt=\"Downloads\" /></a>\n </p>\n\n</div>\n\n## Release notes\n\n**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**\n\n## Usage\n\nThis crate supports two sets of APIs for users with different needs:\n* **Macro-driven**. Gives you a client in a single macro invocation.\n* **Generation-based**. Gives you more control and is transparent about what code you end up using, but requires more setup.\n\n### Macro API\n\nCheckout the [`delegator-macro`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-macro) example for a standalone project using macro API to get a client and use it.\n\nTo generate a struct named `ClientName` based on ABI located at `path/to/abi.json` (relative to the current file's directory):\n\n```rust\nmod mymod {\n near_abi_client::generate!(ClientName for \"path/to/abi.json\");\n}\n```\n\nPlacing the macro invocation inside a `mod` section is optional, but helps reducing unexpected behaviors such as name clashes.\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::ClientName { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\n### Generation API\n\nCheckout the [`delegator-generation`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-generation) example for a standalone project using generation API to generate a client and use it.\n\nFirst, we need our package to have a `build.rs` file that runs the generation step. The following snippet will generate the client in `abi.rs` under `path/to/out/dir`:\n\n```rust\nfn main() -> anyhow::Result<()> {\n near_abi_client::Generator::new(\"path/to/out/dir\".into())\n .file(\"path/to/abi.json\")\n .generate()?;\n Ok(())\n}\n```\n\nThe resulting file, however, is not included in your source set by itself. You have to include it manually; the recommended way is to create a mod with a custom path:\n\n```\n#[path = \"path/to/out/dir/abi.rs\"]\nmod mymod;\n```\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::AbiClient { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\nFeel free to explore what other methods `Generator` has to customize the resulting code (e.g. client struct name).\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as below, without any additional terms or conditions.\n\n## License\n\nLicensed under either of\n\n* Apache License, Version 2.0\n ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)\n* MIT license\n ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)\n\nat your option.\n<!-- markdownlint-disable MD014 -->\n\n<div align=\"center\">\n\n <h1><code>near-abi-client-rs</code></h1>\n\n <p>\n <strong>Library to generate Rust client code with <a href=\"https://github.com/near/workspaces-rs\">workspaces-rs</a> from <a href=\"https://github.com/near/abi\">ABI schemas</a> on NEAR</strong>\n </p>\n\n <p>\n <a href=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml?query=branch%3Amain\"><img src=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml/badge.svg\" alt=\"Github CI Build\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/v/near-abi-client.svg?style=flat-square\" alt=\"Crates.io version\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/d/near-abi-client.svg?style=flat-square\" alt=\"Downloads\" /></a>\n </p>\n\n</div>\n\n## Release notes\n\n**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**\n\n## Usage\n\nThis crate supports two sets of APIs for users with different needs:\n* **Macro-driven**. Gives you a client in a single macro invocation.\n* **Generation-based**. Gives you more control and is transparent about what code you end up using, but requires more setup.\n\n### Macro API\n\nCheckout the [`delegator-macro`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-macro) example for a standalone project using macro API to get a client and use it.\n\nTo generate a struct named `ClientName` based on ABI located at `path/to/abi.json` (relative to the current file's directory):\n\n```rust\nmod mymod {\n near_abi_client::generate!(ClientName for \"path/to/abi.json\");\n}\n```\n\nPlacing the macro invocation inside a `mod` section is optional, but helps reducing unexpected behaviors such as name clashes.\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::ClientName { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\n### Generation API\n\nCheckout the [`delegator-generation`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-generation) example for a standalone project using generation API to generate a client and use it.\n\nFirst, we need our package to have a `build.rs` file that runs the generation step. The following snippet will generate the client in `abi.rs` under `path/to/out/dir`:\n\n```rust\nfn main() -> anyhow::Result<()> {\n near_abi_client::Generator::new(\"path/to/out/dir\".into())\n .file(\"path/to/abi.json\")\n .generate()?;\n Ok(())\n}\n```\n\nThe resulting file, however, is not included in your source set by itself. You have to include it manually; the recommended way is to create a mod with a custom path:\n\n```\n#[path = \"path/to/out/dir/abi.rs\"]\nmod mymod;\n```\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::AbiClient { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\nFeel free to explore what other methods `Generator` has to customize the resulting code (e.g. client struct name).\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as below, without any additional terms or conditions.\n\n## License\n\nLicensed under either of\n\n* Apache License, Version 2.0\n ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)\n* MIT license\n ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)\n\nat your option.\n<!-- markdownlint-disable MD014 -->\n\n<div align=\"center\">\n\n <h1><code>near-abi-client-rs</code></h1>\n\n <p>\n <strong>Library to generate Rust client code with <a href=\"https://github.com/near/workspaces-rs\">workspaces-rs</a> from <a href=\"https://github.com/near/abi\">ABI schemas</a> on NEAR</strong>\n </p>\n\n <p>\n <a href=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml?query=branch%3Amain\"><img src=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml/badge.svg\" alt=\"Github CI Build\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/v/near-abi-client.svg?style=flat-square\" alt=\"Crates.io version\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/d/near-abi-client.svg?style=flat-square\" alt=\"Downloads\" /></a>\n </p>\n\n</div>\n\n## Release notes\n\n**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**\n\n## Usage\n\nThis crate supports two sets of APIs for users with different needs:\n* **Macro-driven**. Gives you a client in a single macro invocation.\n* **Generation-based**. Gives you more control and is transparent about what code you end up using, but requires more setup.\n\n### Macro API\n\nCheckout the [`delegator-macro`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-macro) example for a standalone project using macro API to get a client and use it.\n\nTo generate a struct named `ClientName` based on ABI located at `path/to/abi.json` (relative to the current file's directory):\n\n```rust\nmod mymod {\n near_abi_client::generate!(ClientName for \"path/to/abi.json\");\n}\n```\n\nPlacing the macro invocation inside a `mod` section is optional, but helps reducing unexpected behaviors such as name clashes.\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::ClientName { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\n### Generation API\n\nCheckout the [`delegator-generation`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-generation) example for a standalone project using generation API to generate a client and use it.\n\nFirst, we need our package to have a `build.rs` file that runs the generation step. The following snippet will generate the client in `abi.rs` under `path/to/out/dir`:\n\n```rust\nfn main() -> anyhow::Result<()> {\n near_abi_client::Generator::new(\"path/to/out/dir\".into())\n .file(\"path/to/abi.json\")\n .generate()?;\n Ok(())\n}\n```\n\nThe resulting file, however, is not included in your source set by itself. You have to include it manually; the recommended way is to create a mod with a custom path:\n\n```\n#[path = \"path/to/out/dir/abi.rs\"]\nmod mymod;\n```\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::AbiClient { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\nFeel free to explore what other methods `Generator` has to customize the resulting code (e.g. client struct name).\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as below, without any additional terms or conditions.\n\n## License\n\nLicensed under either of\n\n* Apache License, Version 2.0\n ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)\n* MIT license\n ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)\n\nat your option.\n<!-- markdownlint-disable MD014 -->\n\n<div align=\"center\">\n\n <h1><code>near-abi-client-rs</code></h1>\n\n <p>\n <strong>Library to generate Rust client code with <a href=\"https://github.com/near/workspaces-rs\">workspaces-rs</a> from <a href=\"https://github.com/near/abi\">ABI schemas</a> on NEAR</strong>\n </p>\n\n <p>\n <a href=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml?query=branch%3Amain\"><img src=\"https://github.com/near/near-abi-client-rs/actions/workflows/test.yml/badge.svg\" alt=\"Github CI Build\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/v/near-abi-client.svg?style=flat-square\" alt=\"Crates.io version\" /></a>\n <a href=\"https://crates.io/crates/near-abi-client\"><img src=\"https://img.shields.io/crates/d/near-abi-client.svg?style=flat-square\" alt=\"Downloads\" /></a>\n </p>\n\n</div>\n\n## Release notes\n\n**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**\n\n## Usage\n\nThis crate supports two sets of APIs for users with different needs:\n* **Macro-driven**. Gives you a client in a single macro invocation.\n* **Generation-based**. Gives you more control and is transparent about what code you end up using, but requires more setup.\n\n### Macro API\n\nCheckout the [`delegator-macro`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-macro) example for a standalone project using macro API to get a client and use it.\n\nTo generate a struct named `ClientName` based on ABI located at `path/to/abi.json` (relative to the current file's directory):\n\n```rust\nmod mymod {\n near_abi_client::generate!(ClientName for \"path/to/abi.json\");\n}\n```\n\nPlacing the macro invocation inside a `mod` section is optional, but helps reducing unexpected behaviors such as name clashes.\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::ClientName { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\n### Generation API\n\nCheckout the [`delegator-generation`](https://github.com/near/near-abi-client-rs/tree/main/examples/delegator-generation) example for a standalone project using generation API to generate a client and use it.\n\nFirst, we need our package to have a `build.rs` file that runs the generation step. The following snippet will generate the client in `abi.rs` under `path/to/out/dir`:\n\n```rust\nfn main() -> anyhow::Result<()> {\n near_abi_client::Generator::new(\"path/to/out/dir\".into())\n .file(\"path/to/abi.json\")\n .generate()?;\n Ok(())\n}\n```\n\nThe resulting file, however, is not included in your source set by itself. You have to include it manually; the recommended way is to create a mod with a custom path:\n\n```\n#[path = \"path/to/out/dir/abi.rs\"]\nmod mymod;\n```\n\nNow, assuming you have a `contract: near_workspaces::Contract` deployed, you can make a call like this:\n\n```rust\nlet contract = mymod::AbiClient { contract };\nlet res = contract\n .my_method_name(arg1, arg2)\n .await?;\n```\n\nFeel free to explore what other methods `Generator` has to customize the resulting code (e.g. client struct name).\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as below, without any additional terms or conditions.\n\n## License\n\nLicensed under either of\n\n* Apache License, Version 2.0\n ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)\n* MIT license\n ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)\n\nat your option.\n"}}},{"rowIdx":568,"cells":{"repoName":{"kind":"string","value":"mmurat_new_simple"},"tree":{"kind":"string","value":"README.md\nasconfig.json\nassembly\n index.ts\n tsconfig.json\nindex.js\npackage.json\ntests\n index.js\n"},"readme":{"kind":"string","value":"\n"}}},{"rowIdx":569,"cells":{"repoName":{"kind":"string","value":"hdriqi_piece-app"},"tree":{"kind":"string","value":"README.md\nbabel.config.js\npackage.json\npostcss.config.js\nsrc\n App.js\n assets\n how-it-works.svg\n components\n Activity.js\n Footer.js\n ImgCrop.js\n Loading.js\n Nav.js\n ProfileCard.js\n config.js\n index.html\n index.js\n near.js\n pages\n Explore.js\n Home.js\n Login.js\n Profile.js\n ProfileBalance.js\n ProfileEdit.js\n ProfileReward.js\n skynet.js\n store.js\n styles\n index.css\n tailwind.css\n utils.js\ntailwind.config.js\n"},"readme":{"kind":"string","value":"Piece Interface\n==================\n\nThe interface for Piece Protocol, An incentivized protocol both for creators and supporters. Piece Protocol is built on top of NEAR blockchain and Sia decentralized storage. \n\n[Try Piece on Sia](https://siasky.net/_AUBQQJF4mYSB2iqUx30ZA6U4iAMmezZDFeVMERZXXAXZQ)\n\nVideo Demo\n==========\n\n[<img src=\"https://i.ibb.co/TtDZfms/5f7324b0dd22apiece-thumbnail.png\">](https://www.loom.com/share/af2f558cdd2b43e9a8dae1a5d968447f)\n\nQuick Start\n===========\n\nTo run this project locally:\n\n1. Prerequisites: Make sure you've installed [Node.js] ≥ 12\n2. Install dependencies: `yarn install`\n3. Run the local development server: `yarn start` (see `package.json` for a\n full list of `scripts` you can run with `yarn`)\n\nSmart Contract\n==============\n\nThe smart contract was deployed at [dev-v1.piece.testnet](https://explorer.testnet.near.org/accounts/dev-v1.piece.testnet).\n\nYou can read the source code for the smart contract [here](https://github.com/hdriqi/piece-protocol).\n"}}},{"rowIdx":570,"cells":{"repoName":{"kind":"string","value":"Mrquinnd_nfnft"},"tree":{"kind":"string","value":"401.html\nREADME.md\nbackup.html\ncounter.html\ncss\n normalize.css\n spamnft.webflow.css\n webflow.css\ndiv.css\ndocuments\n angry_face.json\nidx.html\nimageClick.js\nimages\n elon.json\nindex.html\njs\n webflow.js\n"},"readme":{"kind":"string","value":"# nfnft - non-functional-non-fungible-token\n\nCounter component using JS + Jquery to perform asynchronous updates of an NFT infection counter.\n"}}},{"rowIdx":571,"cells":{"repoName":{"kind":"string","value":"lawcia_near-sweet-nfts"},"tree":{"kind":"string","value":"README.md\ncontract\n Cargo.toml\n README.md\n build.sh\n src\n approval.rs\n enumeration.rs\n internal.rs\n lib.rs\n metadata.rs\n mint.rs\n nft_core.rs\n royalty.rs\nfrontend\n README.md\n package.json\n public\n index.html\n manifest.json\n robots.txt\n src\n App.css\n components\n Banner.css\n Gallery.css\n Login.css\n Traits.css\n constants.ts\n index.css\n model.ts\n near\n config.ts\n react-app-env.d.ts\n reportWebVitals.ts\n setupTests.ts\n utils.ts\n tsconfig.json\n"},"readme":{"kind":"string","value":"# RUST Contract\n\n## Scripts\nAssumes you have a bash terminal\n\n- Build the contract `sh build.sh` or `bash build.sh`\n# NEAR Sweet NFTs\n\nChallenge 2: NEAR NFT Smart Contract\n\nThis website is a gallery for the Sweet NFTs on NEAR.\n\nHosted on Netlify: https://sweet-nfts-testnet-near.netlify.app/\n\nUsers can login using their NEAR Wallet, then they will be directed to see a list of NFTs.\n\nThey can select an NFT to Mint.\n\nMinted NFTs will then become disabled, preventing the user from minting.\n\nAfter navigating to https://wallet.testnet.near.org/?tab=collectibles, the user should then see their newly minted NFT in their collection.\n\nThis contract has been deployed on the testnet\n\n## Tech Stack\n\n- React\n- Rust\n- NEAR API\n# Getting Started with Create React App\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n### `yarn test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `yarn build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `yarn eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can’t go back!**\n\nIf you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.\n\nYou don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n"}}},{"rowIdx":572,"cells":{"repoName":{"kind":"string","value":"near_jsonrpc-benchmark"},"tree":{"kind":"string","value":".github\n ISSUE_TEMPLATE\n BOUNTY.yml\nREADME.md\nbenchmark.yml\nrun.sh\nview_access_key_list.yml\nview_account.yml\nview_call.yml\nview_state.yml\n"},"readme":{"kind":"string","value":"# NEAR JSON RPC benchmark\n\n## Install [`drill`](https://github.com/fcsonline/drill) with dependencies and run the benchmark\n\n* Install [`cargo`](https://doc.rust-lang.org/cargo/getting-started/installation.html)\n\n ```bash\n $ curl https://sh.rustup.rs -sSf | sh\n $ source $HOME/.cargo/env\n ```\n\n* Install dependencies\n\n ```bash\n $ sudo apt install -y build-essential pkg-config libssl-dev\n ```\n\n* Clone this repo\n\n ```bash\n $ git clone https://github.com/near/jsonrpc-benchmark\n ```\n\n* Navigate to the folder and run `drill`\n\n ```bash\n $ cd jsonrpc-benchmark/\n $ chmod a+x run.sh\n $ URL=\"http://localhost:3030\" ./run.sh # to run each method sequentially\n $ drill --benchmark benchmark.yml --stats # to run the methods concurrently\n ```\n\n## Reasoning for chosen methods to benchmark\n\nFor the benchmarking we decided to go with `testnet`. We have spin up the node on GCP `e2-standard-8` (which is recommended machine type for the rpc nodes).\n\nBefore writing a drill config we've investigated (manually) the logs of nginx on a few nodes to find out what kind of methods are the most frequent. Despite the \"easy\" methods (like `block`, `chunk`) there were some `query` view calls:\n\n* `view_state`\n* `view_account`\n* `view_access_key_list`\n\nIt was decided to go with those three. Also we've added `view_call` to call view method of some contract. We choose an existing account with contract and small (not empty) state.\n\nDuring the benchmark we're sending each of the four query requests and **the main metric currently is requests per second (rps)**\n\n## Benchmark results we've got\n\n### Request sent from another machine in the same region\n\n```\nView call method Total requests 3000\nView call method Successful requests 3000\nView call method Failed requests 0\nView call method Median time per request 16ms\nView call method Average time per request 20ms\nView call method Sample standard deviation 8ms\n\nTime taken for tests 15.7 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 191.18 [#/sec]\nMedian time per request 16ms\nAverage time per request 20ms\nSample standard deviation 8ms\nConcurrency 4\nIterations 3000\nRampup 5\nBase URL http://34.91.236.50:3030\n\nView access key list Total requests 3000\nView access key list Successful requests 3000\nView access key list Failed requests 0\nView access key list Median time per request 9ms\nView access key list Average time per request 9ms\nView access key list Sample standard deviation 6ms\n\nTime taken for tests 7.6 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 393.99 [#/sec]\nMedian time per request 9ms\nAverage time per request 9ms\nSample standard deviation 6ms\nConcurrency 4\nIterations 3000\nRampup 5\nBase URL http://34.91.236.50:3030\n\nView account Total requests 3000\nView account Successful requests 3000\nView account Failed requests 0\nView account Median time per request 8ms\nView account Average time per request 9ms\nView account Sample standard deviation 2ms\n\nTime taken for tests 7.5 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 398.99 [#/sec]\nMedian time per request 8ms\nAverage time per request 9ms\nSample standard deviation 2ms\nConcurrency 4\nIterations 3000\nRampup 5\nBase URL http://34.91.236.50:3030\n\nView state Total requests 3000\nView state Successful requests 3000\nView state Failed requests 0\nView state Median time per request 9ms\nView state Average time per request 9ms\nView state Sample standard deviation 6ms\n\nTime taken for tests 7.9 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 380.32 [#/sec]\nMedian time per request 9ms\nAverage time per request 9ms\nSample standard deviation 6ms\n```\n\n### Request sent from the same machine (locally)\n\n```\nView call method Total requests 3000\nView call method Successful requests 3000\nView call method Failed requests 0\nView call method Median time per request 8ms\nView call method Average time per request 8ms\nView call method Sample standard deviation 2ms\n\nTime taken for tests 7.1 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 419.84 [#/sec]\nMedian time per request 8ms\nAverage time per request 8ms\nSample standard deviation 2ms\nConcurrency 4\nIterations 3000\nRampup 5\nBase URL http://127.0.0.1:3030\n\nView access key list Total requests 3000\nView access key list Successful requests 3000\nView access key list Failed requests 0\nView access key list Median time per request 1ms\nView access key list Average time per request 1ms\nView access key list Sample standard deviation 1ms\n\nTime taken for tests 1.6 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 1894.98 [#/sec]\nMedian time per request 1ms\nAverage time per request 1ms\nSample standard deviation 1ms\nConcurrency 4\nIterations 3000\nRampup 5\nBase URL http://127.0.0.1:3030\n\nView account Total requests 3000\nView account Successful requests 3000\nView account Failed requests 0\nView account Median time per request 1ms\nView account Average time per request 1ms\nView account Sample standard deviation 1ms\n\nTime taken for tests 1.4 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 2079.54 [#/sec]\nMedian time per request 1ms\nAverage time per request 1ms\nSample standard deviation 1ms\nConcurrency 4\nIterations 3000\nRampup 5\nBase URL http://127.0.0.1:3030\n\nView state Total requests 3000\nView state Successful requests 3000\nView state Failed requests 0\nView state Median time per request 1ms\nView state Average time per request 1ms\nView state Sample standard deviation 1ms\n\nTime taken for tests 1.8 seconds\nTotal requests 3000\nSuccessful requests 3000\nFailed requests 0\nRequests per second 1680.33 [#/sec]\nMedian time per request 1ms\nAverage time per request 1ms\nSample standard deviation 1ms\n```\n"}}},{"rowIdx":573,"cells":{"repoName":{"kind":"string","value":"mhassanist_nftizer-nft-minter-smart-contract-near-protocol"},"tree":{"kind":"string","value":"Cargo.toml\nREADME.md\nsrc\n lib.rs\n"},"readme":{"kind":"string","value":"# NFTizer | NFT Minter on NEAR Protocol\n\nThis is a ready-to-use smart contract for minting NFTs on NEAR blockchain. Below is hwo you may use it. I'm assuming you already familiar with NEAR and have installed Rust blockchain and near-cli.\n\n## Smart Contract Sample Usage\n\n### Build\n\n```\nenv 'RUSTFLAGS=-C link-arg=-s' cargo build --target wasm32-unknown-unknown --release\n```\n\n### Deploy\n\n```\n$ near deploy --wasmFile target/wasm32-unknown-unknown/release/near_spring_nft.wasm --accountId nftizer.mhassanist.testnet\n```\n\n### Intialize the contract (call one time only)\n\n```\n$ near call nftizer.mhassanist.testnet new_default_meta '{\"owner_id\": \"'mhassanist.testnet'\"}' --accountId mhassanist.testnet\n```\n\n### Minting\n\nThe `receiver_id` param is the account that this minted NFT goes to.\n\n```\nnear call nftizer.mhassanist.testnet nft_mint '{\"token_id\": \"Yom3\", \"receiver_id\": \"'msaudi.testnet'\", \"token_metadata\": { \"title\": \"KidPhotos3\", \"description\": \"Beautiful Kids NFTs\", \"media\": \"https://bafybeiab33alpecxhqr4bciie7jfgwcgbc7yj27utdrcfa7uzx46mjff5q.ipfs.nftstorage.link/\", \"copies\": 1}}' --accountId mhassanist.testnet --deposit 0.1\n```\n"}}},{"rowIdx":574,"cells":{"repoName":{"kind":"string","value":"midou10_Near_Token_Contract"},"tree":{"kind":"string","value":".gitpod.yml\nREADME.md\nas-pect.config.js\nasconfig.js\nassembly\n __tests__\n as-pect.d.ts\n context.json\n main.spec.ts\n as_types.d.ts\n main.ts\n model.ts\n tsconfig.json\nbabel.config.json\ndist\n gray_near_logo.f4fe4645.svg\n index.html\n logo.b37d81ec.svg\n near.45fb95a6.svg\n src.e31bb0bc.css\npackage.json\nsrc\n App.css\n App.js\n App.prev.css\n App.prev.js\n App.test.js\n __mocks__\n fileMock.js\n assets\n gray_near_logo.svg\n logo.svg\n near.svg\n config.js\n context\n Auth.js\n data.js\n index.html\n index.js\n jest.init.js\n main.test.js\n utils\n api.js\n wallet\n login\n index.html\n"},"readme":{"kind":"string","value":"## Near decentralized app: token delegation app\n### Requirements\n##### IMPORTANT: Make sure you have the latest version of NEAR Shell and Node Version > 10.x \n\n1. [Node.js](https://nodejs.org/en/download/package-manager/)\n2. (optional) near-shell\n\n```\nnpm i -g near-shell\n```\n\n### To run on NEAR testnet\n\n```bash\nnpm install && npm dev\n```\n\nwith yarn:\n\n```bash\nyarn && yarn dev\n```\n\nNavigate to http://localhost:1234\n\nNOTE: Both contract and client-side code will auto-reload once you change source files.\n"}}},{"rowIdx":575,"cells":{"repoName":{"kind":"string","value":"happy-zhangbo_near-status-one"},"tree":{"kind":"string","value":".github\n dependabot.yml\n workflows\n tests.yml\n.gitpod.yml\n.travis.yml\nCargo.toml\nREADME-Gitpod.md\nREADME-Windows.md\nREADME.md\nborsh.js\nfrontend\n App.js\n config.js\n index.html\n index.js\nintegration-tests\n rs\n Cargo.toml\n src\n tests.rs\n ts\n main.ava.ts\npackage.json\nsrc\n lib.rs\n"},"readme":{"kind":"string","value":"Status Message\n==============\n\n[](https://gitpod.io/#https://github.com/near-examples/rust-status-message)\n\n<!-- MAGIC COMMENT: DO NOT DELETE! Everything above this line is hidden on NEAR Examples page -->\n\nThis smart contract saves and records the status messages of NEAR accounts that call it.\n\nWindows users: please visit the [Windows-specific README file](README-Windows.md).\n\n## Prerequisites\nEnsure `near-cli` is installed by running:\n\n```\nnear --version\n```\n\nIf needed, install `near-cli`:\n\n```\nnpm install near-cli -g\n```\n\nEnsure `Rust` is installed by running:\n\n```\nrustc --version\n```\n\nIf needed, install `Rust`:\n\n```\ncurl https://sh.rustup.rs -sSf | sh\n```\n\nInstall dependencies\n\n```\nnpm install\n```\n\n## Quick Start\nTo run this project locally:\n\n1. Prerequisites: Make sure you have Node.js ≥ 12 installed (https://nodejs.org), then use it to install yarn: `npm install --global yarn` (or just `npm i -g yarn`)\n2. Run the local development server: `yarn && yarn dev` (see package.json for a full list of scripts you can run with yarn)\nNow you'll have a local development environment backed by the NEAR TestNet! Running yarn dev will tell you the URL you can visit in your browser to see the app.\n\n## Building this contract\nTo make the build process compatible with multiple operating systems, the build process exists as a script in `package.json`.\nThere are a number of special flags used to compile the smart contract into the wasm file.\nRun this command to build and place the wasm file in the `res` directory:\n```bash\nnpm run build\n```\n\n**Note**: Instead of `npm`, users of [yarn](https://yarnpkg.com) may run:\n```bash\nyarn build\n```\n\n### Important\nIf you encounter an error similar to:\n>note: the `wasm32-unknown-unknown` target may not be installed\n\nThen run:\n\n```bash\nrustup target add wasm32-unknown-unknown\n```\n\n## Using this contract\n\n### Web app\n\nDeploy the smart contract to a specific account created with the NEAR Wallet. Then interact with the smart contract using near-api-js on the frontend.\n\nIf you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.testnet.near.org).\n\nMake sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following `near-cli` command:\n\n```\nnear login\n```\n\nDeploy the contract to your NEAR account:\n\n```bash\nnear deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME\n```\n\nBuild the frontend:\n\n```bash\nnpm start\n```\n\nIf all is successful the app should be live at `localhost:1234`!\n\n### Quickest deploy\nBuild and deploy this smart contract to an development account. This development account will be created automatically and is not intended to be permanent. Please see the \"Standard deploy\" section for creating a more personalized account to deploy to.\n\n```bash\nnear dev-deploy --wasmFile res/status_message.wasm --helperUrl https://near-contract-helper.onrender.com\n```\n\nBehind the scenes, this is creating an account and deploying a contract to it. On the console, notice a message like:\n\n>Done deploying to dev-1234567890123\n\nIn this instance, the account is `dev-1234567890123`. A file has been created containing the key to the account, located at `neardev/dev-account`. To make the next few steps easier, we're going to set an environment variable containing this development account id and use that when copy/pasting commands.\nRun this command to the environment variable:\n\n```bash\nsource neardev/dev-account.env\n```\n\nYou can tell if the environment variable is set correctly if your command line prints the account name after this command:\n```bash\necho $CONTRACT_NAME\n```\n\nThe next command will call the contract's `set_status` method:\n\n```bash\nnear call $CONTRACT_NAME set_status '{\"message\": \"aloha!\"}' --accountId $CONTRACT_NAME\n```\n\nTo retrieve the message from the contract, call `get_status` with the following:\n\n```bash\nnear view $CONTRACT_NAME get_status '{\"account_id\": \"'$CONTRACT_NAME'\"}'\n```\n\n### Standard deploy\nIn this option, the smart contract will get deployed to a specific account created with the NEAR Wallet.\n\nIf you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.testnet.near.org).\n\nMake sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following `near-cli` command:\n\n```\nnear login\n```\n\nDeploy the contract:\n\n```bash\nnear deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME\n```\n\nSet a status for your account:\n\n```bash\nnear call YOUR_ACCOUNT_NAME set_status '{\"message\": \"aloha friend\"}' --accountId YOUR_ACCOUNT_NAME\n```\n\nGet the status:\n\n```bash\nnear view YOUR_ACCOUNT_NAME get_status '{\"account_id\": \"YOUR_ACCOUNT_NAME\"}'\n```\n\nNote that these status messages are stored per account in a `HashMap`. See `src/lib.rs` for the code. We can try the same steps with another account to verify.\n**Note**: we're adding `NEW_ACCOUNT_NAME` for the next couple steps.\n\nThere are two ways to create a new account:\n - the NEAR Wallet (as we did before)\n - `near create_account NEW_ACCOUNT_NAME --masterAccount YOUR_ACCOUNT_NAME`\n\nNow call the contract on the first account (where it's deployed):\n\n```bash\nnear call YOUR_ACCOUNT_NAME set_status '{\"message\": \"bonjour\"}' --accountId NEW_ACCOUNT_NAME\n```\n\n```bash\nnear view YOUR_ACCOUNT_NAME get_status '{\"account_id\": \"NEW_ACCOUNT_NAME\"}'\n```\n\nReturns `bonjour`.\n\nMake sure the original status remains:\n\n```bash\nnear view YOUR_ACCOUNT_NAME get_status '{\"account_id\": \"YOUR_ACCOUNT_NAME\"}'\n```\n\n## Testing\nTo test run:\n```bash\ncargo test --package status-message -- --nocapture\n```\n"}}},{"rowIdx":576,"cells":{"repoName":{"kind":"string","value":"NEAR-BRASIL_ref"},"tree":{"kind":"string","value":".vscode\n launch.json\nREADME.md\nbackend\n .eslintrc.js\n docker-compose.db.yml\n docker-compose.migrate.yml\n docker-compose.studio.yml\n docker-compose.yml\n near_cli_examples\n croncat.sh\n ref-finance.sh\n nest-cli.json\n package-lock.json\n package.json\n prisma\n migrations\n 20210825064539_init\n migration.sql\n 20210825075802_token\n migration.sql\n 20210825080946_token2\n migration.sql\n 20210825100231_token_icon\n migration.sql\n 20210825100746_pool\n migration.sql\n 20210825110408_pool2\n migration.sql\n 20210825120632_shares\n migration.sql\n 20210825203311_symbol_in_tokenpool\n migration.sql\n 20210825205757_constrains\n migration.sql\n 20210826052733_volume\n migration.sql\n 20210830124958_decimals_in_pool\n migration.sql\n 20210831042116_liquidity\n migration.sql\n 20210831044217_chain_updates\n migration.sql\n 20210831044616_chain_updates\n migration.sql\n 20210831045947_new_chain_update_type\n migration.sql\n 20210831111604_timestamp\n migration.sql\n 20210831122328_decimals\n migration.sql\n 20210831124711_big_int\n migration.sql\n 20210831132704_datetime\n migration.sql\n 20210831132956_private_key\n migration.sql\n 20210901040902_timestamp_as_string\n migration.sql\n 20210901113804_created_at\n migration.sql\n 20210901114857_removed_shares\n migration.sql\n 20210902044444_history\n migration.sql\n 20210902050627_amounts_history\n migration.sql\n 20210903043950_farms01\n migration.sql\n 20210903121621_farms01\n migration.sql\n 20210906072545_tvl\n migration.sql\n migration_lock.toml\n seed.ts\n src\n app\n app.controller.spec.ts\n app.controller.ts\n app.module.ts\n app.service.spec.ts\n app.service.ts\n chain\n chain.module.ts\n chain.service.ts\n near\n indexer\n indexer.module.ts\n indexer.service.ts\n near.module.ts\n near.service.ts\n near.utils.ts\n ref.finance\n config.ts\n ref.module.ts\n ref.service.ts\n types.ts\n prisma\n prisma.module.ts\n prisma.service.ts\n tasks\n cron.module.ts\n cron.service.ts\n discord.service.ts\n tasks.module.ts\n tasks.service.ts\n configs\n config.interface.ts\n config.ts\n console-apps\n console-scripts.ts\n main.ts\n request-validation.pipe.ts\n standalone.ts\n utils.ts\n test\n app.e2e-spec.ts\n app.resolver.e2e-spec.ts\n jest-e2e.json\n userful-files\n polkadot-scripts-snippets.js\n polkastats.sql\n tsconfig.build.json\n tsconfig.json\nJust in case of auth\nRef Finance Tokens\nRef Finance Pools\nFARMS\nliquidity cron finished\ntokens cron finished\npools cron finished\nfarms cron finished\nmethod\nargs\nevents\ncicd\n acme.json\n config.yml\n docker-compose.yml\n traefik.yml\ndeploy.sh\nfrontend\n README.md\n docker-compose.yml\n package-lock.json\n package.json\n public\n index.html\n manifest.json\n robots.txt\n src\n App.css\n App.js\n App.test.js\n AuthProvider.js\n chain\n ChainProvider.js\n hooks\n useDebounce.js\n index.css\n index.js\n layout\n appBar.js\n components\n charts.js\n chimp.js\n index.js\n index.js\n layout.js\n login.js\n menu.js\n submenu.js\n logo.svg\n pages\n about.js\n accounts\n index.js\n status\n components\n components.js\n depositsGrid.js\n farmsGrid.js\n liquidityGrid.js\n poolsGrid.js\n index.js\n status.js\n utils.js\n admin.js\n change-log.js\n configuration.js\n dashboard\n dashboard.js\n index.js\n validators-history.js\n value-bar.js\n welcome.js\n index.js\n links.js\n system.js\n redux\n actions.js\n api.js\n reducers.js\n sagas.js\n reportWebVitals.js\n resources\n farms.js\n liquidity.js\n pools.js\n tokens.js\n routes.js\n setupTests.js\n utils.js\n"},"readme":{"kind":"string","value":"# Overview\n\nRef Status Explorer and Community Application\nThe application runs at https://ref.nearchaintools.com and is connected to NEAR blockchain mainnet data.\nProject page with the To-Do section and collected feedback from the community could be found [here](https://imiroslav.notion.site/NearTools-com-for-Ref-Finance-a0ea6c5e68dd4a88acf1c2203e7bcef4)\n\n# Instructions\n\n## Backend Installation\n\n### Install Dependencies\n\nInstall the dependencies for the application:\n\n```bash\nnpm install\n```\n\n### PostgreSQL with Docker\n\nSetup a development PostgreSQL with Docker. Follow `.env` which sets the required environments for PostgreSQL such as `POSTGRES_USER`, `POSTGRES_PASSWORD` and `POSTGRES_DB`. Update the variables as you wish and select a strong password.\n\nStart the PostgreSQL database\n\n```bash\ndocker-compose -f docker-compose.db.yml up -d\n# or\nnpm run docker:db\n```\n\n### Prisma Migrate\n\n[Prisma Migrate](https://github.com/prisma/prisma2/tree/master/docs/prisma-migrate) is used to manage the schema and migration of the database. Prisma datasource requires an environment variable `DATABASE_URL` for the connection to the PostgreSQL database. It takes variables from [.env](./.env) file which is also used by Prisma Migrate and for seeding the database. You can use [.env.example](./.env.example) to start with.\n\nUse Prisma Migrate in your [development environment](https://www.prisma.io/blog/prisma-migrate-preview-b5eno5g08d0b#evolving-the-schema-in-development) to\n\n1. Creates `migration.sql` file\n2. Updates Database Schema\n3. Generates Prisma Client\n\n```bash\nnpx prisma migrate dev\n# or\nnpm run migrate:dev\n```\n\nIf you like to customize your `migration.sql` file run the following command. After making your customizations run `npx prisma migrate dev` to apply it.\n\n```bash\nnpx prisma migrate dev --create-only\n# or\nnpm run migrate:dev:create\n```\n\nIf you are happy with your database changes you want to deploy those changes to your [production database](https://www.prisma.io/blog/prisma-migrate-preview-b5eno5g08d0b#applying-migrations-in-production-and-other-environments). Use `prisma migrate deploy` to apply all pending migrations, can also be used in CI/CD pipelines as it works without prompts.\n\n```bash\nnpx prisma migrate deploy\n# or\nnpm run migrate:deploy\n```\n### Seed the database data with this script\n\nExecute the script with this command:\n\n```bash\nnpm run seed\n```\n\n### Prisma: Prisma Schema Development\n\nUpdate the Prisma schema `prisma/schema.prisma` and after that run the following two commands:\n\n```bash\nnpx prisma generate\n# or in watch mode\nnpx prisma generate --watch\n# or\nnpm run prisma:generate\nnpm run prisma:generate:watch\n```\n\n### Prisma: Prisma Client JS\n\n[Prisma Client JS](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-client/api) is a type-safe database client auto-generated based on the data model. It could be used for futher development\n\nGenerate Prisma Client JS by running\n\n> **Note**: Every time you update [schema.prisma](prisma/schema.prisma) re-generate Prisma Client JS\n\n```bash\nnpx prisma generate\n# or\nnpm run prisma:generate\n```\n\n### Start NestJS Server\n\nIn case you would like to run API , you should deal with NestJS application. \n\n## Docker\n\nNest server is a Node.js application and it is easily [dockerized](https://nodejs.org/de/docs/guides/nodejs-docker-webapp/).\n\nSee the [Dockerfile](./Dockerfile) on how to build a Docker image of your Nest server.\n\nNow to build a Docker image of your own Nest server simply run:\n\n```bash\n# give your docker image a name\ndocker build -t <your username>/nest-prisma-server .\n# for example\ndocker build -t nest-prisma-server .\n```\n\nAfter Docker build your docker image you are ready to start up a docker container running the nest server:\n\n```bash\ndocker run -d -t -p 3000:3000 --env-file .env nest-prisma-server\n```\n\nNow open up [localhost:3000](http://localhost:3000) to verify that your nest server is running.\n\nWhen you run your NestJS application in a Docker container update your [.env](.env) file\n\n```diff\n- DB_HOST=localhost\n# replace with name of the database container\n+ DB_HOST=postgres\n\n# Prisma database connection\n+ DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}?schema=${DB_SCHEMA}&sslmode=prefer\n```\n\nIf `DATABASE_URL` is missing in the root `.env` file, which is loaded into the Docker container, the NestJS application will exit with the following error:\n\n```bash\n(node:19) UnhandledPromiseRejectionWarning: Error: error: Environment variable not found: DATABASE_URL.\n --> schema.prisma:3\n |\n 2 | provider = \"postgresql\"\n 3 | url = env(\"DATABASE_URL\")\n```\n### Docker Compose\n\nYou can also setup a the database and Nest application with the docker-compose\n\nFirst prepare `.env.production` file then run\n\n```bash\n# building new NestJS docker image\ndocker-compose build\n# or\nnpm run docker:build\n\n# start docker-compose\ndocker-compose up -d\n# or\nnpm run docker\n```\n\n**[⬆ back to top](#overview)**\n# Getting Started with Create React App\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n### `yarn test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `yarn build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `yarn eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can’t go back!**\n\nIf you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.\n\nYou don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n\n### Code Splitting\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)\n\n### Analyzing the Bundle Size\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)\n\n### Making a Progressive Web App\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)\n\n### Advanced Configuration\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)\n\n### Deployment\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)\n\n### `yarn build` fails to minify\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)\n"}}},{"rowIdx":577,"cells":{"repoName":{"kind":"string","value":"haardikk21_learnweb3-junior-ceramic"},"tree":{"kind":"string","value":".eslintrc.json\nREADME.md\nnext.config.js\npackage-lock.json\npackage.json\npages\n _app.js\n api\n hello.js\n index.js\npublic\n vercel.svg\nstyles\n Home.module.css\n globals.css\n"},"readme":{"kind":"string","value":"# Ceramic \n\n\n\nCeramic is a decentralized data network, that allows for building composable Web3 applications. Since Ceramic decentralizes application databases, application developers can reuse data across applications and make them automatically interoperable.\n\nIn the course of this article, we will dig deeper into what those statements actually mean, and why decentralized data is important in the first place.\n\n## Web3 and Data\nIn the past few years, we have seen Web3 trends like DeFi, NFTs, and more recently DAOs blow up. Smart contract platforms like Ethereum have shown us that dApps which act as legos, and can be composed together with other dApps to build entirely new dApps have a lot of value. This is particularly highlighted with tokens that build on top of other tokens, DeFi protocols which utilize other DeFi protocols, etc.\n\nCeramic allows you to bring that same type of composability to data on the internet. This can be any kind of data. Profiles, social connections, blog posts, identities, reputation, game assets, etc. \n\nThis is an abstract concept, and it is a bit tricky to try and define Ceramic Network as a single thing. Similar to Ethereum, which by itself is hard to define (what does it even mean to be a smart contract plaform?), it is easier to understand if we look at specific use cases that Ceramic can enable and examples of a vision for the future. Ethereum is much easier to understand when we look at exact examples like DeFi protocols, NFTs, DAOs etc - the same thinking can be applied while attempting to understand Ceramic.\n\n## Lack of data in Web3\nThe web3 market right now is mainly comprised of financial applications. Things to do with tokens and digital assets. This is somewhat due to design. Smart contracts are inherently limited in how much data can be stored in them, and there's only so much data functionality that can be built. \n\nAs we progress and dApps mature, the market demand for building more data-rich applications is increasing. Trends like decentralized social medias, decentralized reputation platforms, decentralized blogs, etc. is taking off, with a lot of technical approaches being taken, but lacking in one aspect or the other.\n\nIn Web2, these platforms were built as data silos. Your Twitter posts and social connections are locked into the Twitter platform - you cannot transfer your social connections on Twitter to Facebook, you cannot transfer your Twitter posts to Facebook, etc. They are all built as silos.\n\nThis will change. Ceramic is betting on interoperable applications and interoperable ecosystems being able to outcompete these siloed platforms. \n\n## So... What does Ceramic do?\nCeramic is building:\n\n1. A generalized data protocol\n2. where data can be modified only by the owner\n3. with high volume data processing\n4. with global data availability and consistency\n5. with support for fast querying\n6. with interoperable data across applications\n7. and community governance\n\nThis is a lot. This is also why Ceramic can be tricky to define on it's own. After all, just like Ethereum, it is a generalized protocol, albeit for data. \n\nTo achieve the true scale and vision of Ceramic, a lot of breakthroughs need to be achieved. If Ceramic is to become the decentralized database of the web, it needs to be able to scale massively - more than any centralized database today as none of them are storing data from the entire internet. \n\nData also needs to be made globally available, and it needs to be ensured that Ceramic node runners make that data available for the rest of the world and don't hijack it. \n\nAdditionally, not just storage, Ceramic also needs to be fast to query and retrieve data from. Users typically read much more data than they write, so fast reads and queries are extremely important for Ceramic to work at scale.\n\nAll of this while maintaining a high level of security and privacy over data, and ensuring that it doesn't come crashing down one day.\n\nIt is helpful to look at specific use cases that can be enabled by Ceramic today and the benefits of having a mutable, decentralized, general purpose data protocol.\n\n## Ceramic Use Cases\n\n### Decentralized Reputation\nReputation is highly tied into a person's identity. On Twitter, it's followers and likes. On Instagram, it is the hearts. On Reddit, it's Karma, and on StackOverflow, it's points.\n\nIn the web3 ecosystem today, dApps can hardly do better than centralized reputation systems like the above examples, with each platform having it's own reputation system. This is largely because storing large amounts of decentralized data that can change over time was not viable. And even if Ethereum Layer 2's were to reduce storage costs massively, what about non-Ethereum chains? What happens to your reputation when you switch to NEAR or Flow or Solana?\n\nEnter Ceramic.\n\ndApps can use Ceramic's data protocol to build standardized multi-chain reputation systems. A user can connect multiple wallets to their decentralized identity, belong from different blockchains, and data can be written to and updated from the user's decentralized data store on Ceramic.\n\nTherefore, regardless of what chain and dApp the user is using, they can carry around their reputation system with them.\n\n### Social Graphs\nSimilar to reputation, your social graph is also heavily centralized in today's world. Your Twitter followers, Facebook friends, LinkedIn connections, and Snapchat buddies are all differently siloed.\n\nWith censorship increasing on centralized social medias over time, and since social media companies are the biggest in the world with some of them having enough power to manipulate entire national elections, the need for decentralized social media has never been more.\n\nHowever, if we are building decentralized social media, let's try to do better than the old systems. Instead of locking users into a platform, we can actually allow for interoperability and optionality.\n\ndApps can follow standardized data models to store posts and social graphs. These social graphs are carried by the user to whatever dApp they want to use. This means products compete on which offers the best experience, not who has the most vendor lock-in.\n\nThis also allows for smaller players and startups with better products to achieve easier market penetration. They can utilize the underlying data that already exists, and when users sign up on their platform all their data is carried along with them. For bigger players, there can be financial incentives for providing a large amount of data for that datamodel.\n\n### Multi-Wallet and Multi-Chain Identity\n\nYou could extrapolate the decentralized reputation use case to achieve generalized multi-wallet and multi-chain identity for users. Instead of tying up data in smart contracts or offchain based on wallet addresses, data can be tied up to a user's decentralized identity which can be controlled by multiple wallets across multiple chains.\n\nThis way, multi-chain dApps can have a decentralized, yet single, source of truth for a user's data.\n\n## Ceramic's Multi Chain Architecture\nAt the lowest level, there is a decentralized identity. The most common approach to decentralized identities on Ceramic is something called a **3ID** (Three ID) - named after the team behind Ceramic Network called 3Box Labs.\n\nA user can link multiple wallets from multiple chains to a single 3ID. Currently, Ceramic supports more than 10 blockchains, and is continually adding support for more.\n\n3ID's can own data on Ceramic Network. Data on Ceramic is referred to as **Streams**. Each stream therefore has an owner (or multiple owners).\n\nStreams have unique **StreamID**'s, which remain the same over the lifetime of the stream. 3ID's can modify and update the contents of a Stream that they have ownership on.\n\nStreams have a **genesis** state, which is the initial data the Stream was created with. Following the genesis state, users can create **commits** on Streams, which represent modifications to the data. The latest state of a Stream can be computed by starting from the genesis state and applying all the commits one by one. The latest state is also referred to as the **tip** of a stream.\n\n## Using Ceramic\nCeramic provides a suite of high-level and low-level libraries and SDK's to work with, depending on the use case.\n\nFor common use cases, developers can use the high-level SDK - Self.ID - which abstracts away most of the complexities of working with 3ID's and Streams.\n\nFor complex or customized use cases, developers can work with a lower-level Ceramic HTTP Client, which connects to a Ceramic node they can run on their own (or the public nodes), and manage 3ID's and Stream data manually.\n\nFor the purposes of this tutorial, we will stick with the Self.ID high-level SDK, as otherwise this tutorial will become extremely large. If you're interested in digging deeper, do check out the *Recommended Resources* section below.\n\n### Self.ID\nSelf.ID is a single, high level, library that encapsulates 3ID accounts, creating and setting up a 3ID, underlying calls to Ceramic nodes, all in a single package optimized to work in a browser.\n\nThe SDK also includes popular use cases like multi-chain user profiles built in, which makes it very easy for developers to retrieve and store multi-chain data linked to a 3ID.\n\n## BUIDL\n\nWe will create a simple Next.js application, which uses Self.ID. It will allow users to login to the website using their wallet of choice, which will be linked to their 3ID. Then, we will allow the user to write some data to their decentralized profile, and be able to retrieve it from the Ceramic Network.\n\nFor verification of this level, we will ask you to enter your profile's StreamID at the end.\n\n- Let's get started by creating a new `next` app. Run the following command to create a new Next.js application inside a folder named `Ceramic-Tutorial`\n ```bash\n npx create-next-app@latest Ceramic-Tutorial\n ```\n and press `Enter` for all the question prompts. This should create the `Ceramic-Tutorial` folder and setup the `next` app inside it. It will also initialize a git repository you can push to GitHub after making changes.\n- Let's now install the Self.ID npm packages to get started. From inside the `Ceramic-Tutorial` folder, run the following in your terminal\n ```bash\n npm install @self.id/react @self.id/web\n ```\n- Let's also install the `ethers` and `web3modal` packages that we will be using to support wallet connections\n ```bash\n npm install ethers web3modal\n ```\n- Open up the `Ceramic-Tutorial` folder in your text editor of choice, and let's get to coding.\n- The first thing we need to do is add Self.ID's Provider to the application. The SDK exposes a `Provider` component that needs to be added to the root of your web app. This initiatalizes the Self.ID instance, connects to the Ceramic Network, and makes Ceramic-related functionality available all across your app.\n- To do this, note in your `pages` folder Next.js automatically created a file called `_app.js`. This is the root of your web-app, and all other pages you create are rendered according to the configuration present in this file. By default, it does nothing special, and just renders your page directly. In our case, we want to wrap every component of ours with the Self.ID provider.\n- First, let's import the `Provider` from Self.ID. Add the following line at the top of `_app.js`\n ```js\n import { Provider } from '@self.id/react';\n ```\n- Next, change the `MyApp` function in that file to return the `Component` wrapped inside a `Provider`\n ```js\n function MyApp({ Component, pageProps }) {\n return (\n <Provider client={{ ceramic: \"testnet-clay\" }}>\n <Component {...pageProps} />;\n </Provider>\n );\n }\n ```\n We also specified a configuration option for the Provider. Specifically, we said that we want the Provider to connect to the Clay Test Network for Ceramic.\n- Let's make sure everything is working fine so far. Run the following in your terminal\n ```bash\n npm run dev\n ```\n Your website should be up and running at `http://localhost:3000`. \n- Lastly, before we start writing code for the actual application, replace the CSS in `styles/Home.module.css` with the following:\n ```css\n .main {\n min-height: 100vh;\n }\n\n .navbar {\n height: 10%;\n width: 100%;\n display: flex;\n flex-direction: row;\n justify-content: space-between;\n padding-top: 1%;\n padding-bottom: 1%;\n padding-left: 2%;\n padding-right: 2%;\n background-color: orange;\n }\n\n .content {\n height: 80%;\n width: 100%;\n padding-left: 5%;\n padding-right: 5%;\n display: flex;\n flex-direction: column;\n align-items: center;\n }\n\n .flexCol {\n display: flex;\n flex-direction: column;\n align-items: center;\n }\n\n .connection {\n margin-top: 2%;\n }\n\n .mt2 {\n margin-top: 2%;\n }\n\n .subtitle {\n font-size: 20px;\n font-weight: 400;\n }\n\n .title {\n font-size: 24px;\n font-weight: 500;\n }\n\n .button {\n background-color: azure;\n padding: 0.5%;\n border-radius: 10%;\n border: 0px;\n font-size: 16px;\n cursor: pointer;\n }\n\n .button:hover {\n background-color: beige;\n }\n ```\n Since this is not a CSS tutorial, we will not be diving deep into these CSS properties, though you should be able to understand what these properties mean if you would like to dive deeper.\n- Alright, open up `pages/index.js` and remove everything currently present inside the `function Home() {...}`. We will replace the contents of that function with our code.\n- We will start by first initializing Web3Modal related code, as connecting a wallet is the first step. \n- Let's first import `Web3Provider` from `ethers`.\n ```jsx\n import { Web3Provider } from \"@ethersproject/providers\"\n ```\n- As before, let's create a reference using the `useRef` react hook to a Web3Modal instance, and create a helper function to get the Provider.\n ```jsx\n const web3ModalRef = useRef();\n \n const getProvider = async () => {\n const provider = await web3ModalRef.current.connect();\n const wrappedProvider = new Web3Provider(provider);\n return wrappedProvider;\n }\n ```\n This function will prompt the user to connect their Ethereum wallet, if not already connected, and then return a Web3Provider. However, if you try running it right now, it will fail because we have not yet initialized web3Modal. \n- Before we initialize Web3Modal, we will setup a React Hook provided to us by the Self.ID SDK. Self.ID provides a hook called `useViewerConnection` which gives us an easy way to connect and disconnect to the Ceramic Network.\n Add the following import\n ```jsx\n import { useViewerConnection } from \"@self.id/react\";\n ```\n And now in your `Home` function, do the following to initialize the hook\n ```jsx\n const [connection, connect, disconnect] = useViewerConnection();\n ```\n- Now that we have this, we can initialize Web3Modal. Add the following `useEffect` React Hook to your `Home` function.\n ```jsx\n useEffect(() => {\n if (connection.status !== \"connected\") {\n web3ModalRef.current = new Web3Modal({\n network: \"rinkeby\",\n providerOptions: {},\n disableInjectedProvider: false,\n });\n }\n }, [connection.status]);\n ```\n We have seen this code before many times. The only difference is the conditional here. We are checking that if the user has not yet been connected to Ceramic, we are going to initialize the web3Modal.\n- The last thing we need to be able to connect to the Ceramic Network is something called an `EthereumAuthProvider`. It is a class exported by the Self.ID SDK which takes an Ethereum provider and an address as an argument, and uses it to connect your Ethereum wallet to your 3ID.\n- To set that up, let us first import it\n ```jsx\n import { EthereumAuthProvider } from \"@self.id/web\";\n ```\n and then add the following helper functions\n ```jsx\n const connectToSelfID = async () => {\n const ethereumAuthProvider = await getEthereumAuthProvider();\n connect(ethereumAuthProvider);\n };\n\n const getEthereumAuthProvider = async () => {\n const wrappedProvider = await getProvider();\n const signer = wrappedProvider.getSigner();\n const address = await signer.getAddress();\n return new EthereumAuthProvider(wrappedProvider.provider, address);\n };\n ```\n `getEthereumAuthProvider` creates an instance of the `EthereumAuthProvider`. You may be wondering why we are passing it `wrappedProvider.provider` instead of `wrappedProvider` directly. It's because `ethers` abstracts away the low level provider calls with helper functions so it's easier for developers to use, but since not everyone uses ethers.js, Self.ID maintains a generic interface to actual provider specification, isntead of the `ethers` wrapped version. We can access the actual provider instance through the `provider` property on `wrappedProvider`.\n `connectToSelfID` takes this Ethereum Auth Provider, and calls the `connect` function that we got from the `useViewerConnection` hook which takes care of everything else for us.\n- Now, getting to the frontend a bit.\n- Add the following code to the end of your `Home` function\n ```jsx\n return (\n <div className={styles.main}>\n <div className={styles.navbar}>\n <span className={styles.title}>Ceramic Demo</span>\n {connection.status === \"connected\" ? (\n <span className={styles.subtitle}>Connected</span>\n ) : (\n <button\n onClick={connectToSelfID}\n className={styles.button}\n disabled={connection.status === \"connecting\"}\n >\n Connect\n </button>\n )}\n </div>\n\n <div className={styles.content}>\n <div className={styles.connection}>\n {connection.status === \"connected\" ? (\n <div>\n <span className={styles.subtitle}>\n Your 3ID is {connection.selfID.id}\n </span>\n <RecordSetter />\n </div>\n ) : (\n <span className={styles.subtitle}>\n Connect with your wallet to access your 3ID\n </span>\n )}\n </div>\n </div>\n </div>\n )\n ```\n For the explanation, here's what's happening. In the top right of the page, we conditionally render a button `Connect` that connects you to SelfID, or if you are already connected, it just says `Connected`.\n Then, in the main body of the page, if you are connected, we display your 3ID, and render a component called `RecordSetter` that we haven't yet created (we will soon). If you are not connected, we render some text asking you to connect your wallet first.\n- So far, we can connect to Ceramic Network through Self.ID, but what about actually storing and retrieving data on Ceramic?\n- We will consider the use case of building a decentralized profile on Ceramic. Thankfully, it is such a common use case that Self.ID comes with built in suport for creating and editing your profile. For the purposes of this tutorial, we will only set a Name to your 3ID and update it, but you can extend it to include all sorts of other properties like an avatar image, your social media links, a description, your age, gender, etc.\n- For readability, we will divide this into a second React component. This is the `RecordSetter` component we used above.\n- Start by creating a new component in the same file. Outside your `Home` function, create a new function like this\n ```jsx\n function RecordSetter() {\n \n }\n ```\n- We are going to use another hook provided to us by Self.ID called `useViewerRecord` which allows storing and retrieving profile information on Ceramic Network. Let's first import it\n ```jsx\n import { useViewerRecord } from \"@self.id/react\";\n ```\n- Now, let's use this hook in the `RecordSetter` component.\n ```jsx\n const record = useViewerRecord(\"basicProfile\");\n\n const updateRecordName = async (name) => {\n await record.merge({\n name: name,\n });\n };\n ```\n We also created a helper function to update the name stored in our record (data on Ceramic). It takes a parameter `name` and updates the record.\n- Lastly, let's also create a state variable for `name` that you can type out to update your record\n ```jsx\n const [name, setName] = useState(\"\");\n ```\n- For the frontend part, add the following at the end of your `RecordSetter` function\n ```jsx\n return (\n <div className={styles.content}>\n <div className={styles.mt2}>\n {record.content ? (\n <div className={styles.flexCol}>\n <span className={styles.subtitle}>\n Hello {record.content.name}!\n </span>\n\n <span>\n The above name was loaded from Ceramic Network. Try updating it\n below.\n </span>\n </div>\n ) : (\n <span>\n You do not have a profile record attached to your 3ID. Create a\n basic profile by setting a name below.\n </span>\n )}\n </div>\n\n <input\n type=\"text\"\n placeholder=\"Name\"\n value={name}\n onChange={(e) => setName(e.target.value)}\n className={styles.mt2}\n />\n <button onClick={() => updateRecordName(name)}>Update</button>\n </div>\n );\n ```\n This code basically renders a message `Hi ${name}` if you have set a name on your Ceramic profile record, otherwise it tells you that you do not have a profile set up yet and you can create one.\n You can create or update the profile by inputting text in the textbox and clicking the update button\n- We should be good to go at this point! Run\n ```bash\n npm run dev\n ```\n in your terminal, or refresh your webpage if you already had it running, and you should be able to connect to Ceramic Network through your Metamask wallet and set a name on your decentralized profile, and update it as well!\n \n---\n\nTo look at the final code for what we have built, you can visit [Github](https://github.com/LearnWeb3DAO/Ceramic).\n\nHopefully this article could give you a sneak peek into how to use Ceramic, and help you gain an understanding of why Ceramic is important. \n\nFor verification of this level, copy your entire `did:3id:...` string from the webpage and paste it below into the verification box.\n\nShow off your website on Discord in the showcase channel, and as always, feel free to ask any questions!\n"}}},{"rowIdx":578,"cells":{"repoName":{"kind":"string","value":"ketyung_tm_collections_contract"},"tree":{"kind":"string","value":"Cargo.toml\nLICENSE.md\nbuild.sh\nreadme.md\nsrc\n collections_manage.rs\n collections_view.rs\n ext.rs\n lib.rs\n tests.rs\n ticket_mint.rs\nterm_tests1.txt\n"},"readme":{"kind":"string","value":""}}},{"rowIdx":579,"cells":{"repoName":{"kind":"string","value":"lflozano_NCD---Near"},"tree":{"kind":"string","value":".idea\n misc.xml\n modules.xml\n vcs.xml\nREADME.md\nas-pect.config.js\nasconfig.json\npackage-lock.json\npackage.json\nsrc\n as_types.d.ts\n contrato\n __tests__\n as-pect.d.ts\n index.unit.spec.ts\n asconfig.json\n assembly\n index.ts\n model.ts\n tsconfig.json\n utils.ts\n"},"readme":{"kind":"string","value":"```sh\nnpm install\n```\n\nó\n\n```sh\nyarn install\n```\n\nUna vez hecho esto, podemos compilar el código.\n\n```sh\nnpm run build\n```\n\nó\n\n```sh\nyarn build\n```\n\nEl contrato compilado en WebAssembly se guarda en la carpeta `/build/release/`. Ahora solo es necesario desplegarlo en una cuenta de desarrollo.\n\n```sh\nnear dev-deploy build/debug/contrato.wasm\n```\n\n### Usando variables de entorno\n\nUna vez compilado y desplegado tu proyecto, vamos a requerir identificar la cuenta neardev. Esta la puedes encontrar en el archivo `/neardev/neardev`. Podemos almacenar este contrato en una variable de entorno ejecutando lo siguiente en la consola, y sustituyendo por tu cuenta de desarrollo:\n\n```sh\nexport CONTRATO=dev-0000000000000-000000000\n```\n\nHaciendo esto, podemos comprobar que la variable `CONTRATO` tiene almacenada nuestra cuenta dev.\n\n```sh\necho $CONTRATO\n```\n```\n\n```sh\nnpm install\n```\n\nó\n\n```sh\nyarn install\n```\n\nUna vez hecho esto, podemos compilar el código.\n\n```sh\nnpm run build\n```\n\nó\n\n```sh\nyarn build\n```\n\nEl contrato compilado en WebAssembly se guarda en la carpeta `/build/release/`. Ahora solo es necesario desplegarlo en una cuenta de desarrollo.\n\n```sh\nnear dev-deploy build/debug/contrato.wasm\n```\n\n### Usando variables de entorno\n\nUna vez compilado y desplegado tu proyecto, vamos a requerir identificar la cuenta neardev. Esta la puedes encontrar en el archivo `/neardev/neardev`. Podemos almacenar este contrato en una variable de entorno ejecutando lo siguiente en la consola, y sustituyendo por tu cuenta de desarrollo:\n\n```sh\nexport CONTRATO=dev-0000000000000-000000000\n```\n\nHaciendo esto, podemos comprobar que la variable `CONTRATO` tiene almacenada nuestra cuenta dev.\n\n```sh\necho $CONTRATO\n```\n\nEn este contrato tenemos las siguientes funciones:\n- `setSala(fecha: string)`: esta función nos permite crear la sala de la clase con un profesor asociado a esta. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear call dev-0000000000000-000000000 setSala '{\"fecha\":\"2022-06-16\"}' --accountId account.testnet\n```\nLa respuesta esperada a la ejecución de este comando debería ser:\n```sh\n'¡La sala fue dada de alta correctamente!'\n```\n- `getSalas()`: esta función nos permite ver las salas creadas hasta el momento con sus respectivo profesor, fecha, alumno, y si es que hubo alguien presente en ella con covid o no. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear view dev-0000000000000-000000000 getSalas\n```\nLa respuesta esperada a la ejecución de este comando debería ser:\n```\n[\n {\n profesor: 'account.testnet',\n fecha: '2022-06-16',\n alumnos: [],\n covid: false\n }\n]\n```\n- `setAlumnoSala`: esta función nos permite agregar un alumno a una sala con una determinada fecha y profesor. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear call dev-0000000000000-000000000 setAlumnoSala '{\"profesor\":\"account.testnet\", \"fecha\":\"2022-06-16\"}' --accountId account2.testnet\n```\nLa respuesta esperada a la ejecución de este comando debería ser:\n```\n'¡Se dio de alta al alumno en la clase seleccionada!'\n```\n- Re-ejecución de `getSalas()`: esta función nos permite ver las salas creadas hasta el momento con sus respectivo profesor, fecha, alumno, y si es que hubo alguien presente en ella con covid o no. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear view dev-0000000000000-000000000 getSalas\n```\nLa respuesta esperada a la ejecución de este comando `con el nuevo alumno` debería ser:\n```\n[\n {\n profesor: 'account.testnet',\n fecha: '2022-06-16',\n alumnos: [ { sender: 'account2.testnet' } ],\n covid: false\n }\n]\n```\n- `setCovid(fecha:string)`: esta función nos permite que una persona diga en qué fechas estuvo presente en salas en caso de que presente covid. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear call dev-0000000000000-000000000 setCovid '{\"fecha\":\"2022-06-16\"}' --accountId account.testnet\n```\nLa respuesta esperada a la ejecución de este comando `para un profesor` debería ser:\n```\n'Se dara aviso urgente a todos los integrantes de las clases que diste.'\n```\nLa respuesta esperada a la ejecución de este comando `para un alumno` debería ser:\n```\n'Se dara aviso urgente a todos los integrantes de las clases a las que asististe.'\n```\n- Última ejecución de `getSalas()`: esta función nos permite ver las salas creadas hasta el momento con sus respectivo profesor, fecha, alumno, y si es que hubo alguien presente en ella con covid o no. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear view dev-0000000000000-000000000 getSalas\n```\nLa respuesta esperada a la ejecución de este comando `ya sea con un profesor o alumno que avisó que tuvo covid ese día` debería ser:\n```\n[\n {\n profesor: 'account.testnet',\n fecha: '2022-06-16',\n alumnos: [ { sender: 'account2.testnet' } ],\n covid: true\n }\n]\n```\n-`setAyuda()`: esta función nos permite mandar una donación a las personas afectadas con Covid. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear call dev-0000000000000-000000000 setAyuda '' --accountId account.testnet\n```\nLa respuesta esperada a la ejecución de este comando debería ser:\n```\n'¡La ayuda esta en camino!'\n```\n-`getCovid()`: esta función nos permite ver a quien se envió o no la donación. Para poder ejecutarla tenemos que usar el siguiente comando:\n```\nnear view dev-0000000000000-000000000 getCovid\n```\n"}}},{"rowIdx":580,"cells":{"repoName":{"kind":"string","value":"NEARBuilders_Wallets"},"tree":{"kind":"string","value":"features.md\n|\n"},"readme":{"kind":"string","value":""}}},{"rowIdx":581,"cells":{"repoName":{"kind":"string","value":"pseudo-exchange_nym-spec"},"tree":{"kind":"string","value":".travis.yml\nCargo.toml\nREADME.md\nUSER_STORIES.md\npackage-lock.json\npackage.json\nsrc\n lib.rs\n util.rs\n"},"readme":{"kind":"string","value":"Nym.Near\n==============\n\nA name auction for Near.\n\nSee [User Stories](./USER_STORIES.md) for detailed interaction info.\n\n## Prerequisite\nEnsure `near-cli` is installed by running:\n\n```\nnear --version\n```\n\nIf needed, install `near-cli`:\n\n```\nnpm install near-cli -g\n```\n\n## Building this contract\nTo make the build process compatible with multiple operating systems, the build process exists as a script in `package.json`.\nThere are a number of special flags used to compile the smart contract into the wasm file.\nRun this command to build and place the wasm file in the `res` directory:\n```bash\nnpm run build\n```\n\n**Note**: Instead of `npm`, users of [yarn](https://yarnpkg.com) may run:\n```bash\nyarn build\n```\n\n## Using this contract\n\n### Quickest deploy\nBuild and deploy this smart contract to an development account. This development account will be created automatically and is not intended to be permanent. Please see the \"Standard deploy\" section for creating a more personalized account to deploy to.\n\n```bash\nnear dev-deploy --wasmFile res/nym_near.wasm --helperUrl https://near-contract-helper.onrender.com\n```\n\nBehind the scenes, this is creating an account and deploying a contract to it. On the console, notice a message like:\n\n>Done deploying to dev-1234567890123\n\nIn this instance, the account is `dev-1234567890123`. A file has been created containing the key to the account, located at `neardev/dev-account`. To make the next few steps easier, we're going to set an environment variable containing this development account id and use that when copy/pasting commands.\nRun this command to the environment variable:\n\n```bash\nsource neardev/dev-account.env\n```\n\nYou can tell if the environment variable is set correctly if your command line prints the account name after this command:\n```bash\necho $CONTRACT_NAME\n```\n\nThe next command will call the contract's `set_thing` method:\n\n```bash\nnear call $CONTRACT_NAME set_thing '{\"msg\": \"aloha!\"}' --accountId $CONTRACT_NAME\n```\n\nTo retrieve the message from the contract, call `get_thing` with the following:\n\n```bash\nnear view $CONTRACT_NAME get_thing '{\"account_id\": \"'$CONTRACT_NAME'\"}'\n```\n\n### Standard deploy\nIn this second option, the smart contract will get deployed to a specific account created with the NEAR Wallet.\n\nIf you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.nearprotocol.com).\n\nIn the project root, login with `near-cli` by following the instructions after this command:\n\n```\nnear login\n```\n\nDeploy the contract:\n\n```bash\nnear deploy --wasmFile res/nym_near.wasm --accountId YOUR_ACCOUNT_NAME\n```\n\n## Testing\nTo test run:\n```bash\ncargo test --package status-message -- --nocapture\n```\n\n## Cool Commands:\n\n```\n// create account for the contract\nnear create-account nym.t.testnet --masterAccount t.testnet --initialBalance 100\nnear create-account escrowbar.t.testnet --masterAccount t.testnet --initialBalance 100\nnear create-account auction.t.testnet --masterAccount t.testnet --initialBalance 100\n\n// no account creation, just use testnet autogen account\nNEAR_ENV=testnet near deploy --accountId t.testnet --wasmFile res/nym_near.wasm --initFunction new --initArgs '{\"escrow_account_id\":\"t.testnet\",\"escrow_public_key\":\"ed25519:4cKe5SWR4QTwc7MTLrzNuC633gLzFg9FgiygPVzKYvb1\"}'\n\nNEAR_ENV=testnet near call t.testnet create '{\"asset\": \"tc\", \"owner_beneficiary\": \"t.testnet\", \"auction_start_bid_amount\": 100, \"auction_close_block\": null}' --accountId t.testnet\n\n// deploy to created contract account\nnear deploy --wasmFile res/nym_near.wasm --accountId v0.nym.t.testnet --masterAccount nym.t.testnet\n\n// call function on deployed account, only call for things that change state\nnear call dev-1606630107890-6675680 create '{\"asset\": \"thank god its friday\"}' --accountId t.testnet\n\nnear call dev-1606630107890-6675680 create '{\"asset\": \"tc\", \"owner_beneficiary\": \"t.testnet\", \"auction_start_bid_amount\": 100, \"auction_close_block\": null}' --accountId t.testnet\n\n\"auction_close_block\": \"\", \n\n// view state via view function call with params\nnear view dev-1606630107890-6675680 get_auction_by_id '{\"id\":\"1234\"}' --accountId t.testnet\n\n// call more things with diff params #yay\nnear call dev-1606630107890-6675680 place_bid '{\"auction_id\": \"1234\"}' --accountId t.testnet\n\n// call more things with diff params #yay #youGetThePicture\nnear call dev-1606630107890-6675680 cancel_auction '{\"auction_id\": \"1234\"}' --accountId t.testnet\n```\n"}}},{"rowIdx":582,"cells":{"repoName":{"kind":"string","value":"mrlasdt_go-crypto-market-making"},"tree":{"kind":"string","value":"clock\n clock.go\ncommand\n start.go\nconfig\n config.go\nexchange\n exchange.go\n gateio.go\n order.go\n uniswap.go\ngateway\n .eslintrc.js\n Changelog.md\n README.md\n bin\n docker-start.sh\n conf\n avalanche.yml\n binance-smart-chain.yml\n cronos.yml\n database.yml\n defikingdoms.yml\n defira.yml\n ethereum-gas-station.yml\n ethereum.yml\n harmony.yml\n logging.yml\n mad_meerkat.yml\n near.yml\n openocean.yml\n pancakeswap.yml\n pangolin.yml\n perp.yml\n polygon.yml\n quickswap.yml\n ref.yml\n root.yml\n serum.yml\n server.yml\n solana.yml\n ssl.yml\n sushiswap.yml\n telemetry.yml\n traderjoe.yml\n uniswap.yml\n vvs.yml\n dist\n integration-test\n clob\n clob.controllers.test.js\n clob.routes.test.js\n connector\n serum\n reset.test.js\n serum.controllers.test.js\n serum.routes.test.js\n src\n amm\n amm.controllers.js\n amm.requests.js\n amm.routes.js\n amm.validators.js\n app.js\n chains\n avalanche\n avalanche.js\n avalanche.validators.js\n binance-smart-chain\n binance-smart-chain.js\n cronos\n cronos.js\n ethereum\n balancer\n balancer.config.js\n ethereum.config.js\n ethereum.controllers.js\n ethereum.js\n ethereum.requests.js\n ethereum.validators.js\n harmony\n harmony.config.js\n harmony.js\n harmony.validators.js\n near\n near.abi.json\n near.base.js\n near.config.js\n near.controllers.js\n near.js\n near.requests.js\n near.routes.js\n near.validators.js\n polygon\n polygon.js\n polygon.validators.js\n solana\n solana-middlewares.js\n solana.config.js\n solana.constants.js\n solana.controllers.js\n solana.js\n solana.requests.js\n solana.routes.js\n solana.validators.js\n clob\n clob.controllers.js\n clob.requests.js\n clob.routes.js\n connectors\n connectors.routes.js\n cronos-base\n cronos-base-uniswapish-connector.config.js\n cronos-base-uniswapish-connector.js\n defikingdoms\n defikingdoms.config.js\n defikingdoms.js\n defikingdoms_router_abi.json\n defira\n defira.config.js\n defira.js\n defira_v2_router_abi.json\n mad_meerkat\n abi.json\n mad_meerkat.config.js\n mad_meerkat.js\n openocean\n openocean.config.js\n openocean.js\n pancakeswap\n pancakeswap.config.js\n pancakeswap.js\n pancakeswap_router_abi.json\n pangolin\n IPangolinRouter.json\n pangolin.config.js\n pangolin.js\n perp\n perp.config.js\n perp.controllers.js\n perp.js\n quickswap\n quickswap.config.js\n quickswap.js\n ref\n ref.config.js\n ref.controllers.js\n ref.helper.js\n ref.js\n serum\n extensions\n json.js\n market.js\n serum.config.js\n serum.constants.js\n serum.controllers.js\n serum.convertors.js\n serum.helpers.js\n serum.js\n serum.middlewares.js\n serum.requests.js\n serum.routes.js\n serum.types.js\n serum.validators.js\n sushiswap\n sushiswap.config.js\n sushiswap.js\n sushiswap_router.json\n traderjoe\n IJoeRouter02.json\n traderjoe.config.js\n traderjoe.js\n uniswap\n uniswap.config.js\n uniswap.controllers.js\n uniswap.js\n uniswap.lp.helper.js\n uniswap.lp.interfaces.js\n uniswap.lp.js\n uniswap_v2_router_abi.json\n vvs\n abi.json\n vvs.config.js\n vvs.js\n evm\n evm.requests.js\n evm.routes.js\n https.js\n index.js\n network\n network.controllers.js\n network.requests.js\n network.routes.js\n paths.js\n services\n base.js\n common-interfaces.js\n config-manager-cert-passphrase.js\n config-manager-types.js\n config-manager-v2.js\n config-migration\n migrations.js\n config\n config.requests.js\n config.routes.js\n config.validators.js\n connection-manager.js\n error-handler.js\n ethereum-base.js\n ethereum.abi.json\n evm.nonce.js\n evm.tx-storage.js\n local-storage.js\n logger.js\n refcounting-closeable.js\n schema\n configuration-root-schema.json\n cronos-connector-schema.json\n database-schema.json\n defikingdoms-schema.json\n defira-schema.json\n ethereum-gas-station-schema.json\n ethereum-schema.json\n harmony-schema.json\n logging-schema.json\n openocean-schema.json\n pangolin-schema.json\n perp-schema.json\n quickswap-schema.json\n ref-schema.json\n serum-schema.json\n server-schema.json\n solana-schema.json\n ssl-schema.json\n sushiswap-schema.json\n telemetry-schema.json\n traderjoe-schema.json\n uniswap-schema.json\n swagger-manager.js\n telemetry-transport.js\n validators.js\n wallet\n wallet.controllers.js\n wallet.requests.js\n wallet.routes.js\n wallet.validators.js\n templates\n avalanche.yml\n binance-smart-chain.yml\n cronos.yml\n database.yml\n defikingdoms.yml\n defira.yml\n ethereum-gas-station.yml\n ethereum.yml\n harmony.yml\n logging.yml\n mad_meerkat.yml\n near.yml\n openocean.yml\n pancakeswap.yml\n pangolin.yml\n perp.yml\n polygon.yml\n quickswap.yml\n ref.yml\n root.yml\n serum.yml\n server.yml\n solana.yml\n ssl.yml\n sushiswap.yml\n telemetry.yml\n traderjoe.yml\n uniswap.yml\n vvs.yml\n test\n amm\n amm.validators.test.js\n app.test.js\n chains\n avalanche\n avalanche.routes.test.js\n avalanche.test.js\n avalanche.validators.test.js\n openocean\n openocean.routes.test.js\n openocean.test.js\n pangolin\n pangolin.routes.test.js\n pangolin.test.js\n traderjoe\n traderjoe.test.js\n binance-smart-chain\n binance-smart-chain.routes.test.js\n pancakeswap\n pancakeswap.routes.test.js\n pancakeswap.test.js\n cronos\n cronos.routes.test.js\n mad_meerkat\n mad-meerkat.routes.test.js\n mad-meerkat.test.js\n vvs\n vvs.routes.test.js\n vvs.test.js\n ethereum\n ethereum.controllers.test.js\n ethereum.routes.test.js\n ethereum.validators.test.js\n evm.nonce.test.js\n fixtures\n transaction-out-of-gas-receipt.json\n transaction-out-of-gas.json\n transaction-succesful-receipt.json\n transaction-succesful.json\n perp\n perp.routes.test.js\n perp.test.js\n sushiswap\n sushiswap.routes.test.js\n sushiswap.test.js\n uniswap\n uniswap.lp.routes.test.js\n uniswap.lp.test.js\n uniswap.routes.test.js\n uniswap.test.js\n harmony\n defikingdoms\n defikingdoms.routes.test.js\n defikingdoms.test.js\n defira\n defira.routes.test.js\n defira.test.js\n harmony.controllers.test.js\n harmony.routes.test.js\n harmony.test.js\n harmony.validators.test.js\n near\n fixtures\n getTokenList.json\n getTransaction.json\n near.controllers.test.js\n near.routes.test.js\n near.validators.test.js\n ref\n ref.route.test.js\n ref.test.js\n polygon\n polygon.test.js\n polygon.validators.test.js\n quickswap\n quickswap.route.test.js\n quickswap.test.js\n solana\n fixtures\n getOrCreateAssociatedTokenAccount.js\n getSolanaConfig.js\n getTokenAccount.js\n getTokenList.json\n getTransaction.json\n serum\n fixtures\n config.js\n helpers.js\n patches\n data.js\n patches.js\n serum.controllers.test.js\n serum.routes.test.js\n solana.controllers.test.js\n solana.routes.test.js\n solana.validators.test.js\n clob\n clob.controllers.test.js\n clob.routes.test.js\n config.util.js\n connectors\n connectors.routes.test.js\n evm.nonce.mock.js\n network\n network.routes.test.js\n services\n base.test.js\n config-manager-cert-passphrase.test.js\n config-manager-v2.test.js\n config-validators.test.js\n data\n config-manager-v2\n test1\n ethereum.yml\n invalid-defira.yml\n invalid-root-2.yml\n invalid-root-3.yml\n invalid-root-4.yml\n invalid-root-defira.yml\n invalid-root.yml\n invalid-ssl.yml\n root.yml\n root2.yml\n ssl.yml\n telemetry.yml\n error-handler.test.js\n evm.nonce.test.js\n evm.tx-storage.test.js\n local-storage.test.js\n logger.test.js\n patch.js\n patch.test.js\n refcounting-closeable.test.js\n swagger-manager.test.js\n validators.test.js\n wallet\n wallet.controllers.test.js\n wallet.routes.test.js\n wallet.validators.test.js\n setup.js\n teardown.js\n docs\n swagger\n amm-liquidity-routes.yml\n amm-routes.yml\n clob-routes.yml\n connectors-routes.yml\n definitions.yml\n evm-routes.yml\n main-routes.yml\n near-routes.yml\n network-routes.yml\n serum-routes.yml\n solana-routes.yml\n swagger.yml\n wallet-routes.yml\n testing.md\n hooks\n README.md\n integration-test\n clob\n clob.controllers.test.ts\n clob.routes.test.ts\n connector\n serum\n reset.test.ts\n serum.controllers.test.ts\n serum.routes.test.ts\n jest.config.js\n manual-tests\n curl.sh\n requests\n add_avalanche_key.json\n add_bsc_key.json\n add_cronos_key.json\n add_ethereum_key.json\n add_near_key.json\n avalanche_approve.json\n avalanche_nonce.json\n avalanche_traderjoe_allowances.json\n avalanche_traderjoe_trade.json\n bsc_approve.json\n bsc_balances.json\n bsc_nonce.json\n bsc_pancakeswap_trade.json\n bsc_sushiswap_trade.json\n clob_delete_orders.json\n clob_get_filled_orders.json\n clob_get_markets.json\n clob_get_open_orders.json\n clob_get_order_books.json\n clob_get_orders.json\n clob_get_root.json\n clob_get_tickers.json\n clob_post_orders.json\n clob_post_settle_funds.json\n config_update.json\n cronos_approve.json\n cronos_balances.json\n cronos_mmf_trade.json\n cronos_nonce.json\n cronos_vvs_trade.json\n eth_allowances.json\n eth_approve.json\n eth_approve_with_fees.json\n eth_approve_with_nonce.json\n eth_balances.json\n eth_nonce.json\n eth_perp_approve.json\n eth_poll.json\n eth_remove_allowance.json\n eth_uniswap_add_liquidity.json\n eth_uniswap_pool_price.json\n eth_uniswap_position.json\n eth_uniswap_price.json\n eth_uniswap_trade.json\n eth_uniswap_trade_with_fees.json\n harmony_dfk_trade.json\n harmony_testnet_defira_trade.json\n mmf_cronos_mainnet_allowance.json\n near_mainnet_ref_trade.json\n near_network_balances.json\n near_post_poll.json\n network_balances.json\n network_poll.json\n perp_position.json\n perp_prices.json\n perp_trade_open.json\n price_bsc_pancakeswap.json\n price_defira.json\n price_dfk.json\n price_mad_meerkat.json\n price_pangolin.json\n price_ref.json\n price_traderjoe.json\n price_uniswap.json\n price_vvs.json\n remove_avalanche_key.json\n remove_bsc_key.json\n remove_cronos_key.json\n remove_ethereum_key.json\n remove_near_key.json\n serum_delete_orders.json\n serum_get_filled_orders.json\n serum_get_markets.json\n serum_get_open_orders.json\n serum_get_order_books.json\n serum_get_orders.json\n serum_get_root.json\n serum_get_tickers.json\n serum_post_orders.json\n serum_post_settle_funds.json\n solana_get_balances.json\n solana_get_root.json\n solana_get_token.json\n solana_post_poll.json\n solana_post_token.json\n status_request.json\n nodemon.json\n package.json\n setup\n generate_conf.sh\n src\n @types\n buffer-layout.d.ts\n cycle.d.ts\n amm\n amm.controllers.ts\n amm.requests.ts\n amm.routes.ts\n amm.validators.ts\n app.ts\n chains\n avalanche\n avalanche.ts\n avalanche.validators.ts\n avalanche_tokens_fuji.json\n binance-smart-chain\n bep20_tokens_mainnet.json\n bep20_tokens_testnet.json\n binance-smart-chain.ts\n cronos\n cronos.ts\n mainnet_beta.json\n testnet.json\n ethereum\n balancer\n balancer.config.ts\n erc20_tokens_goerli.json\n erc20_tokens_kovan.json\n erc20_tokens_ropsten.json\n ethereum.config.ts\n ethereum.controllers.ts\n ethereum.requests.ts\n ethereum.ts\n ethereum.validators.ts\n harmony\n harmony.config.ts\n harmony.ts\n harmony.validators.ts\n harmony_tokens_defira.json\n harmony_tokens_defira_testnet.json\n harmony_tokens_sushiswap.json\n harmony_tokens_sushiswap_testnet.json\n near\n near.abi.json\n near.base.ts\n near.config.ts\n near.controllers.ts\n near.requests.ts\n near.routes.ts\n near.ts\n near.validators.ts\n polygon\n polygon.ts\n polygon.validators.ts\n polygon_tokens_mainnet.json\n polygon_tokens_mumbai.json\n solana\n solana-middlewares.ts\n solana.config.ts\n solana.constants.ts\n solana.controllers.ts\n solana.requests.ts\n solana.routes.ts\n solana.ts\n solana.validators.ts\n clob\n clob.controllers.ts\n clob.requests.ts\n clob.routes.ts\n connectors\n connectors.routes.ts\n cronos-base\n cronos-base-uniswapish-connector.config.ts\n cronos-base-uniswapish-connector.ts\n defikingdoms\n defikingdoms.config.ts\n defikingdoms.ts\n defikingdoms_router_abi.json\n defira\n defira.config.ts\n defira.ts\n defira_v2_router_abi.json\n mad_meerkat\n abi.json\n mad_meerkat.config.ts\n mad_meerkat.ts\n openocean\n openocean.config.ts\n openocean.ts\n pancakeswap\n pancakeswap.config.ts\n pancakeswap.ts\n pancakeswap_router_abi.json\n pangolin\n IPangolinRouter.json\n pangolin.config.ts\n pangolin.ts\n perp\n perp.config.ts\n perp.controllers.ts\n perp.ts\n quickswap\n quickswap.config.ts\n quickswap.ts\n ref\n ref.config.ts\n ref.controllers.ts\n ref.helper.ts\n ref.ts\n serum\n extensions\n json.ts\n market.ts\n serum.config.ts\n serum.constants.ts\n serum.controllers.ts\n serum.convertors.ts\n serum.helpers.ts\n serum.middlewares.ts\n serum.requests.ts\n serum.routes.ts\n serum.ts\n serum.types.ts\n serum.validators.ts\n sushiswap\n sushiswap.config.ts\n sushiswap.ts\n sushiswap_router.json\n traderjoe\n IJoeRouter02.json\n traderjoe.config.ts\n traderjoe.ts\n uniswap\n uniswap.config.ts\n uniswap.controllers.ts\n uniswap.lp.helper.ts\n uniswap.lp.interfaces.ts\n uniswap.lp.ts\n uniswap.ts\n uniswap_v2_router_abi.json\n vvs\n abi.json\n vvs.config.ts\n vvs.ts\n evm\n evm.requests.ts\n evm.routes.ts\n https.ts\n index.ts\n network\n network.controllers.ts\n network.requests.ts\n network.routes.ts\n paths.ts\n services\n base.ts\n common-interfaces.ts\n config-manager-cert-passphrase.ts\n config-manager-types.ts\n config-manager-v2.ts\n config-migration\n migrations.ts\n config\n config.requests.ts\n config.routes.ts\n config.validators.ts\n connection-manager.ts\n error-handler.ts\n ethereum-base.ts\n ethereum.abi.json\n evm.nonce.ts\n evm.tx-storage.ts\n local-storage.ts\n logger.ts\n refcounting-closeable.ts\n schema\n configuration-root-schema.json\n cronos-connector-schema.json\n database-schema.json\n defikingdoms-schema.json\n defira-schema.json\n ethereum-gas-station-schema.json\n ethereum-schema.json\n harmony-schema.json\n logging-schema.json\n openocean-schema.json\n pangolin-schema.json\n perp-schema.json\n quickswap-schema.json\n ref-schema.json\n serum-schema.json\n server-schema.json\n solana-schema.json\n ssl-schema.json\n sushiswap-schema.json\n telemetry-schema.json\n traderjoe-schema.json\n uniswap-schema.json\n swagger-manager.ts\n telemetry-transport.ts\n validators.ts\n wallet\n wallet.controllers.ts\n wallet.requests.ts\n wallet.routes.ts\n wallet.validators.ts\n templates\n avalanche.yml\n binance-smart-chain.yml\n cronos.yml\n database.yml\n defikingdoms.yml\n defira.yml\n ethereum-gas-station.yml\n ethereum.yml\n harmony.yml\n logging.yml\n mad_meerkat.yml\n near.yml\n openocean.yml\n pancakeswap.yml\n pangolin.yml\n perp.yml\n polygon.yml\n quickswap.yml\n ref.yml\n root.yml\n serum.yml\n server.yml\n solana.yml\n ssl.yml\n sushiswap.yml\n telemetry.yml\n traderjoe.yml\n uniswap.yml\n vvs.yml\n startup.sh\n test-scripts\n README.md\n ethereum.test.base.ts\n harmony.test.ts\n solana.test.ts\n test.base.ts\n uniswap.v2.test.ts\n test\n amm\n amm.validators.test.ts\n app.test.ts\n chains\n avalanche\n avalanche.routes.test.ts\n avalanche.test.ts\n avalanche.validators.test.ts\n openocean\n openocean.routes.test.ts\n openocean.test.ts\n pangolin\n pangolin.routes.test.ts\n pangolin.test.ts\n traderjoe\n traderjoe.test.ts\n binance-smart-chain\n binance-smart-chain.routes.test.ts\n pancakeswap\n pancakeswap.routes.test.ts\n pancakeswap.test.ts\n cronos\n cronos.routes.test.ts\n mad_meerkat\n mad-meerkat.routes.test.ts\n mad-meerkat.test.ts\n vvs\n vvs.routes.test.ts\n vvs.test.ts\n ethereum\n ethereum.controllers.test.ts\n ethereum.routes.test.ts\n ethereum.validators.test.ts\n evm.nonce.test.ts\n fixtures\n transaction-out-of-gas-receipt.json\n transaction-out-of-gas.json\n transaction-succesful-receipt.json\n transaction-succesful.json\n perp\n perp.routes.test.ts\n perp.test.ts\n sushiswap\n sushiswap.routes.test.ts\n sushiswap.test.ts\n uniswap\n uniswap.lp.routes.test.ts\n uniswap.lp.test.ts\n uniswap.routes.test.ts\n uniswap.test.ts\n harmony\n defikingdoms\n defikingdoms.routes.test.ts\n defikingdoms.test.ts\n defira\n defira.routes.test.ts\n defira.test.ts\n harmony.controllers.test.ts\n harmony.routes.test.ts\n harmony.test.ts\n harmony.validators.test.ts\n near\n fixtures\n getTokenList.json\n getTransaction.json\n near.controllers.test.ts\n near.routes.test.ts\n near.validators.test.ts\n ref\n ref.route.test.ts\n ref.test.ts\n polygon\n polygon.test.ts\n polygon.validators.test.ts\n quickswap\n quickswap.route.test.ts\n quickswap.test.ts\n solana\n fixtures\n getOrCreateAssociatedTokenAccount.ts\n getSolanaConfig.ts\n getTokenAccount.ts\n getTokenList.json\n getTransaction.json\n serum\n fixtures\n config.ts\n helpers.ts\n patches\n data.ts\n patches.ts\n serum.controllers.test.ts\n serum.routes.test.ts\n solana.controllers.test.ts\n solana.routes.test.ts\n solana.validators.test.ts\n clob\n clob.controllers.test.ts\n clob.routes.test.ts\n config.util.ts\n connectors\n connectors.routes.test.ts\n evm.nonce.mock.ts\n network\n network.routes.test.ts\n postman\n collections\n EthereumV2.postman_collection.json\n Openocean-GatewayV2.postman_collection.json\n Uniswap-GatewayV2.postman_collection.json\n enviroments\n GatewayV2.postman_environment.json\n services\n base.test.ts\n config-manager-cert-passphrase.test.ts\n config-manager-v2.test.ts\n config-validators.test.ts\n data\n config-manager-v2\n test1\n ethereum.yml\n invalid-defira.yml\n invalid-root-2.yml\n invalid-root-3.yml\n invalid-root-4.yml\n invalid-root-defira.yml\n invalid-root.yml\n invalid-ssl.yml\n root.yml\n root2.yml\n ssl.yml\n telemetry.yml\n error-handler.test.ts\n evm.nonce.test.ts\n evm.tx-storage.test.ts\n local-storage.test.ts\n logger.test.ts\n patch.test.ts\n patch.ts\n refcounting-closeable.test.ts\n swagger-manager.test.ts\n validators.test.ts\n wallet\n wallet.controllers.test.ts\n wallet.routes.test.ts\n wallet.validators.test.ts\n setup.ts\n setupTests.js\n teardown.ts\n tsconfig.json\n|\niterator\n iterator.go\nmain.go\nstrategy\n simplePmm.go\n strategy.go\n uniswapV3LP.go\nutils\n utils.go\n"},"readme":{"kind":"string","value":"\n\n# Hummingbot Gateway\n\n---\n\nHummingbot Gateway is a REST API that exposes connections to various blockchains (wallet, node & chain interaction) and decentralized exchanges (pricing, trading & liquidity provision). It is written in Typescript and takes advantage of existing blockchain and DEX SDKs. The advantage of using gateway is it provideds a programming language agnostic approach to interacting with blockchains and DEXs.\n\nGateway may be used alongside the main Hummingbot client to enable trading on DEXs, or as a standalone module by external developers.\n\n## Connectors\n\nThis is a list of DEX connections currently supported by Gateway.\n\n| Connector | Blockchain | Trading Interface |\n| ----------- | ------------------- | ----------------- |\n| UniswapV2 | Ethereum | AMM |\n| Sushiswap | Ethereum | AMM |\n| UniswapV3 | Ethereum | EVM_Range_AMM |\n| Pangolin | Avalanche | AMM |\n| PancakeSwap | Binance Smart Chain | AMM |\n| Traderjoe | Avalanche | AMM |\n| Quickswap | Polygon | AMM |\n| Perp | Ethereum | EVM_Perpetual |\n| Serum | Solana | CLOB |\n| Mad Meerkat | Cronos | AMM |\n| VVS | Cronos | AMM |\n\n## Contributing\n\nThere are a number of ways to contribute to gateway.\n\n- Add a new blockchain.\n\n- Add a new connector/DEX.\n\n- Fix a bug.\n\n- File an issue at [hummingbot issues](https://github.com/hummingbot/hummingbot/issues)\n\n- Make a PR for anything useful on [hummingbot](https://github.com/hummingbot/hummingbot/).\n\n- Vote on a snapshot proposal: [Hummingbot PRP](https://snapshot.org/#/hbot-prp.eth), [Hummingbot Foundation - HGP](https://snapshot.org/#/hbot.eth), [Hummingbot Improvement Proposals](https://snapshot.org/#/hbot-ip.eth).\n\n## Configuration\n\nBefore running gateway, you need to setup some configs. You can start by copying all of the yml files from [src/templates](./src/templates) to [conf](./conf). The format of this files are dictated by [src/services/config-manager-v2.ts](./src/services/config-manager-v2.ts) and the corresponding schema files in [src/services/schema](./src/services/schema) .\n\n### Useful configuration options\n\n- If you want to turn off `https`, set `unsafeDevModeWithHTTP` to `true` in [conf/server.yml](./conf/server.yml). \n\n- If you gateway to log to standard out, set `logToStdOut` to `true` in [conf/logging.yml](./conf/logging.yml).\n\n- Edit the path to the SSL files in [conf/ssl.yml](./conf/ssl.yml). This can be generated by hummingbot with `gateway generate-certs`. \n\nThe hummingbot client is also able to edit this config files.\n\n## Install and run locally\n\nCompile the Typescript code with `npm` or `yarn` .\n\n```bash\nyarn\nyarn build\nyarn dev --passphrase=<ssl-files-passphrase>\n# the passphrase can be anything if unsafeDevModeWithHTTP is true\n```\n\n## Documentation\n\nThe API is documented using swagger: [gateway swagger docs](./docs/swagger). You can run the gateway swagger UI by starting gateway and visiting [localhost:8080](localhost:8080).\n\nYou can follow details about [trading interfaces](https://hummingbot.notion.site/Gateway-v2-Trading-Interfaces-482e2684d48c450ebcfff5401ba806aa)\n\nAlso, we maintain docs on the official website about gateway [here](https://hummingbot.org/protocols/gateway/).\n\n### Files to read\n\nHere are some files we recommend you look at in order to get familiar with the gateway code base.\n\n- [src/services/ethereum-base.ts](./src/services/ethereum-base.ts) is a base class for EVM chains.\n\n- [src/connectors/uniswap/uniswap.ts](./src/connectors/uniswap/uniswap.ts) has functionality for interacting with Uniswap V2.\n\n- [src/services/validator.ts](./src/services/validator.ts) defines functions for validating request payloads.\n\n### Testing\n\nWhen making a PR, there are unit test coverage requirements. Look at our [github workflow](../.github/workflows/workflow.yml) for the exact definition. There are some more\n\n#### Unit tests\n\nRead this document for more details about how to write unit test in gateway: [How we write unit tests for gateway](./docs/testing.md).\n\nRun all unit tests.\n\n```bash\nyarn test:unit\n```\n\nRun an individual test file.\n\n```bash\nyarn jest test/app.test.ts\n```\n\n#### Manual tests\n\nWe have found it is useful to test individual endpoints with `curl` commands. We have a collection of prepared curl calls. POST bodies are stored in JSON files. Take a look at the [curl calls for gateway](./manual-tests/curl.sh). Note that some environment variables are expected.\n\n## Linting\n\nThis repo uses `eslint` and `prettier`. When you run `git commit` it will trigger the `pre-commit` hook. This will run `eslint` on the `src` and `test` directories.\n\nYou can lint before committing with:\n\n```bash\nyarn run lint\n```\n\nYou can run the prettifier before committing with:\n\n```bash\nyarn run prettier\n```\n# Docker Autobuild Hooks\n\nThis folder containers hooks for docker autobuild.\n\n[Hummingbot builds](https://hub.docker.com/r/coinalpha/hummingbot/builds)\n# gateway test scripts\n\nMake sure to properly setup your config files and add a wallet to use for testing.\nThen set the environment variable `ETH_PUBLIC_KEY` to an added wallet.\nStart a local instance of the gateway API with `yarn start`, and run the \ntest script with `yarn test:scripts`.\n"}}},{"rowIdx":583,"cells":{"repoName":{"kind":"string","value":"luciotato_simple-rust-parser"},"tree":{"kind":"string","value":".vscode\n tasks.json\nREADME.md\nbuild.js\npackage-lock.json\npackage.json\nres\n test\n expected\n staking-pool.js\n rust-samples\n declaration.rs\n outer-tests.rs\n test1-full.rs\n test1-start.rs\n staking-pool\n src\n lib.rs\nsrc\n index.ts\n lib\n Lexer\n Lexer.ts\n Parser\n ASTBase.ts\n CodeWriter.ts\n Grammar.ts\n Parser.ts\n Producer\n AssemblyScriptProducer.ts\n D3Visualization.ts\n create-contract-cli-producer.ts\n util\n ControlledError.ts\n String.extensions.ts\n UTF8FileReader.ts\n UTF8FileWriter.ts\n color.ts\n logger.ts\n mkPath.ts\n test\n expect.ts\n test.AssemblyScript.ts\n test.Tokenizer.ts\n test.ts\nSTART TESTS\nEND TESTS\ntsconfig.json\nz-old\n test_OLD\n Test.TokenizeDeclaration.ts\n UnitTest1.ts\n tests-ccc\n model\n hand-coded-tom\n .vscode\n tasks.json\n ContractAPI.ts\n package-lock.json\n package.json\n tom.ts\n tsconfig.json\n util\n CommandLineArgs.ts\n CommonCLIOptions.ts\n ShowHelpPage.ts\n SpawnNearCli.ts\n test.ts\n"},"readme":{"kind":"string","value":"# Simple Rust Parser\n\nThis a simple hand-coded PEG parser for a subset of Rust, \nit is aimed to parse the subset of Rust used for writing \nsmart contracts for the Near Blockchain\n"}}},{"rowIdx":584,"cells":{"repoName":{"kind":"string","value":"JoaquimLey_link3"},"tree":{"kind":"string","value":"client-web\n README.md\n package.json\n postcss.config.js\n public\n index.html\n manifest.json\n robots.txt\n src\n App.js\n App.test.js\n copy_icon.svg\n github_logo.svg\n index.css\n index.js\n link3_logo.svg\n near\n config.js\n near_logo.svg\n setupTests.js\n tailwind.config.js\ncontracts\n Cargo.toml\n build.sh\n src\n item.rs\n lib.rs\n link3.rs\n utils\n counter.rs\n keyvalue.rs\n simple_default.rs\n"},"readme":{"kind":"string","value":"# Getting Started with Create React App\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `npm start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in your browser.\n\nThe page will reload when you make changes.\\\nYou may also see any lint errors in the console.\n\n### `npm test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `npm run eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can't go back!**\n\nIf you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.\n\nYou don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n\n### Code Splitting\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)\n\n### Analyzing the Bundle Size\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)\n\n### Making a Progressive Web App\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)\n\n### Advanced Configuration\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)\n\n### Deployment\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)\n\n### `npm run build` fails to minify\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)\n"}}},{"rowIdx":585,"cells":{"repoName":{"kind":"string","value":"hermes1108_near-coinflip-frontend"},"tree":{"kind":"string","value":"README.md\npackage.json\npublic\n index.html\n manifest.json\n robots.txt\nsrc\n App.css\n App.js\n App.test.js\n common\n config.js\n components\n FundModal.js\n HelpModal.js\n index.css\n index.js\n logo.svg\n page\n Main.js\n coin.css\n reportWebVitals.js\n setupTests.js\n"},"readme":{"kind":"string","value":"# Getting Started with Create React App\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `npm start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in your browser.\n\nThe page will reload when you make changes.\\\nYou may also see any lint errors in the console.\n\n### `npm test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `npm run eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can't go back!**\n\nIf you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.\n\nYou don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n\n### Code Splitting\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)\n\n### Analyzing the Bundle Size\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)\n\n### Making a Progressive Web App\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)\n\n### Advanced Configuration\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)\n\n### Deployment\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)\n\n### `npm run build` fails to minify\n\nThis section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)\n"}}},{"rowIdx":586,"cells":{"repoName":{"kind":"string","value":"Markeljan_swapguard"},"tree":{"kind":"string","value":".vscode\n settings.json\nREADME.md\ndex-app\n README.md\n const\n details.ts\n next.config.js\n package-lock.json\n package.json\n pages\n api\n hello.ts\n public\n next.svg\n thirteen.svg\n vercel.svg\n styles\n Home.module.css\n globals.css\n tsconfig.json\ndex-contracts\n README.md\n deployArgs.json\n hardhat.config.js\n package-lock.json\n package.json\nfoundry\n README.md\n foundry.toml\n package.json\nscaffold-eth\n .github\n ISSUE_TEMPLATE\n bug_report.yml\n config.yml\n pull_request_template.md\n .lintstagedrc.js\n .yarnrc.yml\n CONTRIBUTING.md\n README.md\n package.json\n packages\n hardhat\n .eslintrc.json\n .prettierrc.json\n deploy\n 00_deployMultiDEX.ts\n 01_deployTokens.ts\n 02_deployWETH.ts\n 03_deployUSDC.ts\n 04_deployFrontRunner.ts\n 99_generateTsAbis.ts\n deployments\n coston2\n FrontRunner.json\n MultiDEX.json\n USDC.json\n WETH.json\n solcInputs\n 1a9cb6e99411acb453ab0d9acd1e67b6.json\n 2a3603bd4ff6f465642ba11cc0f67779.json\n 2cd8a4f954700d33a473d7e84335e86d.json\n 34763a34a83e96a47640037a4be290cf.json\n 64b969127ab1e88602aa4020bc65b903.json\n 6564edc1e5f1ca711141ab1ea88b125d.json\n 77908fc2fda08d3213ee986e8c5a838e.json\n 8959186d9735f863b166a2649432283f.json\n 8a59004299167595109b829221f6fa62.json\n 94039dc7aa9a1df2f66ae05811b96619.json\n a44cc90bef3c96c73078661dc7667072.json\n a58df7263434e503682954fc327092f3.json\n a77560ac51121517909662fcdc4730bf.json\n c3a38bb134f7e411fd5f53d24e29b457.json\n e452b631bbea39c41bc19985a7312220.json\n f9049ccea05241a3c7bb43802c5fffb6.json\n localhost\n MultiDEX.json\n solcInputs\n f4c33a2fbef6d9851d324a649fe9bb23.json\n hardhat.config.ts\n package.json\n scripts\n configureTokens.ts\n generateAccount.ts\n listAccount.ts\n tasks\n frontRunAttack.ts\n frontRunAttackSim.ts\n tsconfig.json\n nextjs\n .eslintrc.json\n .prettierrc.json\n components\n scaffold-eth\n Input\n index.ts\n utils.ts\n generated\n deployedContracts.ts\n hooks\n scaffold-eth\n index.ts\n useAccountBalance.ts\n useAnimationConfig.ts\n useAutoConnect.ts\n useBurnerWallet.ts\n useContractLogs.ts\n useDeployedContractInfo.ts\n useFetchBlocks.ts\n useNativeCurrencyPrice.ts\n useNetworkColor.ts\n useOutsideClick.ts\n useScaffoldContract.ts\n useScaffoldContractRead.ts\n useScaffoldContractWrite.ts\n useScaffoldEventHistory.ts\n useScaffoldEventSubscriber.ts\n next-env.d.ts\n next.config.js\n package.json\n postcss.config.js\n public\n flaredex.svg\n logo.svg\n manifest.json\n readme\n diagram.svg\n sponsors.svg\n swapguard.svg\n scaffold.config.ts\n services\n store\n store.ts\n web3\n wagmi-burner\n BurnerConnector.ts\n BurnerConnectorErrors.ts\n BurnerConnectorTypes.ts\n burnerWalletConfig.ts\n styles\n globals.css\n tailwind.config.js\n tsconfig.json\n types\n abitype\n abi.d.ts\n utils\n scaffold-eth\n block.ts\n common.ts\n contract.ts\n contractNames.ts\n decodeTxData.ts\n fetchPriceFromUniswap.ts\n index.ts\n networks.ts\n"},"readme":{"kind":"string","value":"# DEX contracts\n\n> **Warning:** This code is not audited. Use at your own risk.\n\nThis contracts in this repository can be used with the [DEX app repository](https://github.com/thirdweb-example/dex-app).\n\n## Compiling the contract\n\nUse the following command to compile the contract:\n\n```bash\nnpx thirdweb build\n```\n\n## Deploying the contract\n\nUse the following command to deploy the contract to any EVM chain:\n\n```bash\nnpx thirdweb deploy\n```\n\n## Conclusion\n\nIf you need support, feel free to join our [Discord server](https://discord.gg/thirdweb). For any feedback related to thirdweb, please leave them on our [feedback board](https://feedback.thirdweb.com).\n# DEX app\n\nCreate your own DEX for your ERC-20 token. Find the related contracts in the [dex-contracts repository](https://github.com/thirdweb-example/dex-contracts).\n\n## Installation\n\nAfter cloning this repository, install the dependencies using the following command:\n\n```bash\n# npm\nnpm install\n\n# yarn\nyarn install\n```\n\n## Adding details\n\nMake sure you deploy the contracts specified in the dex-contracts repository and add the contract details in the `const/details.ts` file.\n\n## Running the app\n\nUse the following command to start the development server:\n\n```bash\n# npm\nnpm run dev\n\n# yarn\nyarn dev\n```\n\n## Conclusion\n\nIf you need any support, feel free to join our [Discord server](https://discord.gg/thirdweb) and ask us. If you have any feedback related to thirdweb, please leave it on our [feedback board](https://feedback.thirdweb.com).\n\n# Price-Protected Trading on Flare Network - inspired by EIP-7265\n\n[Video Demo](https://www.youtube.com/watch?v=CiVqfb8Ow7U)\n\n[NEAR BOS Frontend](https://near.org/near/widget/ComponentDetailsPage?src=markeljan.near/widget/SwapGuard)\n\n## What is SwapGuard\n**SwapGuard** is a Smart Contract Module aimed at improving the UX and security of trading on DEXes, especially in terms of ensuring fair prices and preventing adverse trade conditions.\n\nTo demonstrate SwapGuard's functionality, we have built the:\n### First Price-Protected DEX on the Flare Network\n**Offering a price guarantee on all trades, powered by native price feeds on Flare Network.**\n\n## Eliminating Price Manipulations\n- **Slippage** -> _swap-guarded_\n- **Front Running** -> _swap-guarded_\n- **Low Liquidity** -> _swap-guarded_\n- **Oracle Manipulation** -> _swap-guarded_\n\n## How it Works\n\n\nUsers send transactions via a decentralized frontend built with NEAR BOS. The system checks prices between the oracle and the liquidity pool. If the price is good, the transaction is executed; otherwise, it's rejected.\n\n# NEAR BOS Component\n<img width=\"800\" alt=\"image\" src=\"https://github.com/Markeljan/swapguard/assets/12901349/fdd9a2b5-9099-4bcb-a745-005ad7659ff6\">\n\n## Credits to Flare Network\nBefore Flare Network's FTSO, gas-efficient circuit breakers were challenging. In relation to our work on EIP-7265 and implementations on other networks, circuit breakers usually had significant gas implications. Flare's native on-chain price feeds resolve this issue, making circuit breakers a prominent use case that highlights the USPs of Flare.\n\nsponsored tech stacK:\n\n\n## Foundry\n\n**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**\n\nFoundry consists of:\n\n- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).\n- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.\n- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.\n- **Chisel**: Fast, utilitarian, and verbose solidity REPL.\n\n## Documentation\n\nhttps://book.getfoundry.sh/\n\n## Usage\n\n### Build\n\n```shell\n$ forge build\n```\n\n### Test\n\n```shell\n$ forge test\n```\n\n### Format\n\n```shell\n$ forge fmt\n```\n\n### Gas Snapshots\n\n```shell\n$ forge snapshot\n```\n\n### Anvil\n\n```shell\n$ anvil\n```\n\n### Deploy\n\n```shell\n$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>\n```\n\n### Cast\n\n```shell\n$ cast <subcommand>\n```\n\n### Help\n\n```shell\n$ forge --help\n$ anvil --help\n$ cast --help\n```\n# 🏗 Scaffold-ETH 2\n\n🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.\n\n⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, and Typescript.\n\n- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it.\n- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.\n- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.\n\n## Contents\n\n- [Requirements](#requirements)\n- [Quickstart](#quickstart)\n- [Deploying your Smart Contracts to a Live Network](#deploying-your-smart-contracts-to-a-live-network)\n- [Deploying your NextJS App](#deploying-your-nextjs-app)\n- [Interacting with your Smart Contracts: SE-2 Custom Hooks](#interacting-with-your-smart-contracts-se-2-custom-hooks)\n- [Disabling Type & Linting Error Checks](#disabling-type-and-linting-error-checks)\n - [Disabling commit checks](#disabling-commit-checks)\n - [Deploying to Vercel without any checks](#deploying-to-vercel-without-any-checks)\n - [Disabling Github Workflow](#disabling-github-workflow)\n- [Contributing to Scaffold-ETH 2](#contributing-to-scaffold-eth-2)\n\n## Requirements\n\nBefore you begin, you need to install the following tools:\n\n- [Node (v18 LTS)](https://nodejs.org/en/download/)\n- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))\n- [Git](https://git-scm.com/downloads)\n\n## Quickstart\n\nTo get started with Scaffold-ETH 2, follow the steps below:\n\n1. Clone this repo & install dependencies\n\n```\ngit clone https://github.com/scaffold-eth/scaffold-eth-2.git\ncd scaffold-eth-2\nyarn install\n```\n\n2. Run a local network in the first terminal:\n\n```\nyarn chain\n```\n\nThis command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in `hardhat.config.ts`.\n\n3. On a second terminal, deploy the test contract:\n\n```\nyarn deploy\n```\n\nThis command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script.\n\n4. On a third terminal, start your NextJS app:\n\n```\nyarn start\n```\n\nVisit your app on: `http://localhost:3000`. You can interact with your smart contract using the contract component or the example ui in the frontend. You can tweak the app config in `packages/nextjs/scaffold.config.ts`.\n\nRun smart contract test with `yarn hardhat:test`\n\n- Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts`\n- Edit your frontend in `packages/nextjs/pages`\n- Edit your deployment scripts in `packages/hardhat/deploy`\n\n## Deploying your Smart Contracts to a Live Network\n\nOnce you are ready to deploy your smart contracts, there are a few things you need to adjust.\n\n1. Select the network\n\nBy default, `yarn deploy` will deploy the contract to the local network. You can change the defaultNetwork in `packages/hardhat/hardhat.config.ts.` You could also simply run `yarn deploy --network target_network` to deploy to another network.\n\nCheck the `hardhat.config.ts` for the networks that are pre-configured. You can also add other network settings to the `hardhat.config.ts file`. Here are the [Alchemy docs](https://docs.alchemy.com/docs/how-to-add-alchemy-rpc-endpoints-to-metamask) for information on specific networks.\n\nExample: To deploy the contract to the Sepolia network, run the command below:\n\n```\nyarn deploy --network sepolia\n```\n\n2. Generate a new account or add one to deploy the contract(s) from. Additionally you will need to add your Alchemy API key. Rename `.env.example` to `.env` and fill the required keys.\n\n```\nALCHEMY_API_KEY=\"\",\nDEPLOYER_PRIVATE_KEY=\"\"\n```\n\nThe deployer account is the account that will deploy your contracts. Additionally, the deployer account will be used to execute any function calls that are part of your deployment script.\n\nYou can generate a random account / private key with `yarn generate` or add the private key of your crypto wallet. `yarn generate` will create a random account and add the DEPLOYER_PRIVATE_KEY to the .env file. You can check the generated account with `yarn account`.\n\n3. Deploy your smart contract(s)\n\nRun the command below to deploy the smart contract to the target network. Make sure to have some funds in your deployer account to pay for the transaction.\n\n```\nyarn deploy --network network_name\n```\n\n4. Verify your smart contract\n\nYou can verify your smart contract on Etherscan by running:\n\n```\nyarn verify --network network_name\n```\n\n## Deploying your NextJS App\n\n**Hint**: We recommend connecting your GitHub repo to Vercel (through the Vercel UI) so it gets automatically deployed when pushing to `main`.\n\nIf you want to deploy directly from the CLI, run `yarn vercel` and follow the steps to deploy to Vercel. Once you log in (email, github, etc), the default options should work. It'll give you a public URL.\n\nIf you want to redeploy to the same production URL you can run `yarn vercel --prod`. If you omit the `--prod` flag it will deploy it to a preview/test URL.\n\n**Make sure your `packages/nextjs/scaffold.config.ts` file has the values you need.**\n\n## Interacting with your Smart Contracts: SE-2 Custom Hooks\n\nScaffold-ETH 2 provides a collection of custom React hooks designed to simplify interactions with your deployed smart contracts. These hooks are wrappers around `wagmi`, automatically loading the necessary contract ABI and address. They offer an easy-to-use interface for reading from, writing to, and monitoring events emitted by your smart contracts.\n\nTo help developers get started with smart contract interaction using Scaffold-ETH 2, we've provided the following custom hooks:\n\n- [useScaffoldContractRead](#usescaffoldcontractread): for reading public variables and getting data from read-only functions of your contract.\n- [useScaffoldContractWrite](#usescaffoldcontractwrite): for sending transactions to your contract to write data or perform an action.\n- [useScaffoldEventSubscriber](#usescaffoldeventsubscriber): for subscribing to your contract events and receiving real-time updates when events are emitted.\n- [useScaffoldEventHistory](#usescaffoldeventhistory): for retrieving historical event logs for your contract, providing past activity data.\n- [useDeployedContractInfo](#usedeployedcontractinfo): for fetching details from your contract, including the ABI and address.\n- [useScaffoldContract](#usescaffoldcontract): for obtaining a contract instance that lets you interact with the methods of your deployed smart contract.\n\nThese hooks offer a simplified and streamlined interface for interacting with your smart contracts. If you need to interact with external contracts, you can use `wagmi` directly, or add external contract data to your `deployedContracts.ts` file.\n\n### useScaffoldContractRead:\n\nUse this hook to read public variables and get data from read-only functions of your smart contract.\n\n```ts\nconst { data: totalCounter } = useScaffoldContractRead({\n contractName: \"YourContract\",\n functionName: \"getGreeting\",\n args: [\"ARGUMENTS IF THE FUNCTION ACCEPTS ANY\"],\n});\n```\n\nThis example retrieves the data returned by the `getGreeting` function of the `YourContract` smart contract. If the function accepts any arguments, they can be passed in the args array. The retrieved data is stored in the `data` property of the returned object.\n\n### useScaffoldContractWrite:\n\nUse this hook to send a transaction to your smart contract to write data or perform an action.\n\n```ts\nconst { writeAsync, isLoading, isMining } = useScaffoldContractWrite({\n contractName: \"YourContract\",\n functionName: \"setGreeting\",\n args: [\"The value to set\"],\n // For payable functions, expressed in ETH\n value: \"0.01\",\n // The number of block confirmations to wait for before considering transaction to be confirmed (default : 1).\n blockConfirmations: 1,\n // The callback function to execute when the transaction is confirmed.\n onBlockConfirmation: (txnReceipt) => {\n console.log(\"Transaction blockHash\", txnReceipt.blockHash);\n },\n});\n```\n\nTo send the transaction, you can call the `writeAsync` function returned by the hook. Here's an example usage:\n\n```ts\n<button className=\"btn btn-primary\" onClick={writeAsync}>\n Send TX\n</button>\n```\n\nThis example sends a transaction to the `YourContract` smart contract to call the `setGreeting` function with the arguments passed in `args`. The `writeAsync` function sends the transaction to the smart contract, and the `isLoading` and `isMining` properties indicate whether the transaction is currently being processed by the network.\n\n### useScaffoldEventSubscriber:\n\nUse this hook to subscribe to events emitted by your smart contract, and receive real-time updates when these events are emitted.\n\n```ts\nuseScaffoldEventSubscriber({\n contractName: \"YourContract\",\n eventName: \"GreetingChange\",\n // The listener function is called whenever a GreetingChange event is emitted by the contract.\n // It receives the parameters emitted by the event, for this example: GreetingChange(address greetingSetter, string newGreeting, bool premium, uint256 value);\n listener: (greetingSetter, newGreeting, premium, value) => {\n console.log(greetingSetter, newGreeting, premium, value);\n },\n});\n```\n\nThis example subscribes to the `GreetingChange` event emitted by the `YourContract` smart contract, and logs the parameters emitted by the event to the console whenever it is emitted. The `listener` function accepts the parameters emitted by the event, and can be customized according to your needs.\n\n### useScaffoldEventHistory:\n\nUse this hook to retrieve historical event logs for your smart contract, providing past activity data.\n\n```ts\nconst {\n data: events,\n isLoading: isLoadingEvents,\n error: errorReadingEvents,\n } = useScaffoldEventHistory({\n contractName: \"YourContract\",\n eventName: \"GreetingChange\",\n // Specify the starting block number from which to read events, this is a bigint.\n fromBlock: 31231n,\n blockData: true,\n // Apply filters to the event based on parameter names and values { [parameterName]: value },\n filters: { premium: true }\n // If set to true it will return the transaction data for each event (default: false),\n transactionData: true,\n // If set to true it will return the receipt data for each event (default: false),\n receiptData: true\n});\n```\n\nThis example retrieves the historical event logs for the `GreetingChange` event of the `YourContract` smart contract, starting from block number 31231 and filtering events where the premium parameter is true. The data property of the returned object contains an array of event objects, each containing the event parameters and (optionally) the block, transaction, and receipt data. The `isLoading` property indicates whether the event logs are currently being fetched, and the `error` property contains any error that occurred during the fetching process (if applicable).\n\n### useDeployedContractInfo:\n\nUse this hook to fetch details about a deployed smart contract, including the ABI and address.\n\n```ts\n// ContractName: name of the deployed contract\nconst { data: deployedContractData } = useDeployedContractInfo(contractName);\n```\n\nThis example retrieves the details of the deployed contract with the specified name and stores the details in the deployedContractData object.\n\n### useScaffoldContract:\n\nUse this hook to get your contract instance by providing the contract name. It enables you interact with your contract methods.\nFor reading data or sending transactions, it's recommended to use `useScaffoldContractRead` and `useScaffoldContractWrite`.\n\n```ts\nconst { data: yourContract } = useScaffoldContract({\n contractName: \"YourContract\",\n});\n// Returns the greeting and can be called in any function, unlike useScaffoldContractRead\nawait yourContract?.greeting();\n\n// Used to write to a contract and can be called in any function\nimport { useWalletClient } from \"wagmi\";\n\nconst { data: walletClient } = useWalletClient();\nconst { data: yourContract } = useScaffoldContract({\n contractName: \"YourContract\",\n walletClient,\n});\nconst setGreeting = async () => {\n // Call the method in any function\n await yourContract?.setGreeting(\"the greeting here\");\n};\n```\n\nThis example uses the `useScaffoldContract` hook to obtain a contract instance for the `YourContract` smart contract. The data property of the returned object contains the contract instance that can be used to call any of the smart contract methods.\n\n## Disabling type and linting error checks\n\n> **Hint**\n> Typescript helps you catch errors at compile time, which can save time and improve code quality, but can be challenging for those who are new to the language or who are used to the more dynamic nature of JavaScript. Below are the steps to disable type & lint check at different levels\n\n### Disabling commit checks\n\nWe run `pre-commit` [git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) which lints the staged files and don't let you commit if there is an linting error.\n\nTo disable this, go to `.husky/pre-commit` file and comment out `yarn lint-staged --verbose`\n\n```diff\n- yarn lint-staged --verbose\n+ # yarn lint-staged --verbose\n```\n\n### Deploying to Vercel without any checks\n\nBy default, Vercel runs types and lint checks before building your app. The deployment will fail if there are any types or lint errors.\n\nTo ignore these checks while deploying from the CLI, use:\n\n```shell\nyarn vercel:yolo\n```\n\nIf your repo is connected to Vercel, you can set `NEXT_PUBLIC_IGNORE_BUILD_ERROR` to `true` in a [environment variable](https://vercel.com/docs/concepts/projects/environment-variables).\n\n### Disabling Github Workflow\n\nWe have github workflow setup checkout `.github/workflows/lint.yaml` which runs types and lint error checks every time code is **pushed** to `main` branch or **pull request** is made to `main` branch\n\nTo disable it, **delete `.github` directory**\n\n## Contributing to Scaffold-ETH 2\n\nWe welcome contributions to Scaffold-ETH 2!\n\nPlease see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2.\n"}}},{"rowIdx":587,"cells":{"repoName":{"kind":"string","value":"ligebit_spring_near_guest_book"},"tree":{"kind":"string","value":".eslintrc.yml\n.github\n dependabot.yml\n workflows\n deploy.yml\n tests.yml\n.gitpod.yml\n.travis.yml\nREADME-Gitpod.md\nREADME.md\nas-pect.config.js\nasconfig.json\nassembly\n __tests__\n as-pect.d.ts\n guestbook.spec.ts\n as_types.d.ts\n main.ts\n model.ts\n tsconfig.json\nbabel.config.js\nneardev\n shared-test-staging\n test.near.json\n shared-test\n test.near.json\npackage.json\nsrc\n App.js\n config.js\n index.html\n index.js\n tests\n integration\n App-integration.test.js\n ui\n App-ui.test.js\n"},"readme":{"kind":"string","value":"Challenge #4\n\nhttps://ligebit.github.io/spring_near_guest_book/\n\nsub account contract - guest_book.near_spring.testnet\n"}}},{"rowIdx":588,"cells":{"repoName":{"kind":"string","value":"kuutamolabs_rapid-gossip-sync-server"},"tree":{"kind":"string","value":".github\n workflows\n build.yml\nCargo.toml\nLICENSE-APACHE.md\nLICENSE-MIT.md\nLICENSE.md\nREADME.md\ndocker-compose.yml\nsrc\n config.rs\n downloader.rs\n hex_utils.rs\n lib.rs\n lookup.rs\n main.rs\n persistence.rs\n serialization.rs\n snapshot.rs\n tests\n mod.rs\n tracking.rs\n types.rs\n verifier.rs\n"},"readme":{"kind":"string","value":"# rapid-gossip-sync-server\n\nThis is a server that connects to peers on the Lightning network and calculates compact rapid sync\ngossip data.\n\nThese are the components it's comprised of.\n\n## Modules\n\n### config\n\nA config file where the Postgres credentials and Lightning peers can be adjusted. Most adjustments\ncan be made by setting environment variables, whose usage is as follows:\n\n| Name | Default | Description |\n|:-------------------------------------------|:--------------------|:-----------------------------------------------------------------------------------------------------------|\n| RAPID_GOSSIP_SYNC_SERVER_DB_HOST | localhost | Domain of the Postgres database |\n| RAPID_GOSSIP_SYNC_SERVER_DB_USER | alice | Username to access Postgres |\n| RAPID_GOSSIP_SYNC_SERVER_DB_PASSWORD | _None_ | Password to access Postgres |\n| RAPID_GOSSIP_SYNC_SERVER_DB_NAME | ln_graph_sync | Name of the database to be used for gossip storage |\n| RAPID_GOSSIP_SYNC_SERVER_NETWORK | mainnet | Network to operate in. Possible values are mainnet, testnet, signet, regtest |\n| RAPID_GOSSIP_SYNC_SERVER_SNAPSHOT_INTERVAL | 10800 | The interval in seconds between snapshots |\n| BITCOIN_REST_DOMAIN | 127.0.0.1 | Domain of the [bitcoind REST server](https://github.com/bitcoin/bitcoin/blob/master/doc/REST-interface.md) |\n| BITCOIN_REST_PORT | 8332 | HTTP port of the bitcoind REST server |\n| BITCOIN_REST_PATH | /rest/ | Path infix to access the bitcoind REST endpoints |\n| LN_PEERS | _Wallet of Satoshi_ | Comma separated list of LN peers to use for retrieving gossip |\n\n### downloader\n\nThe module responsible for initiating the scraping of the network graph from its peers.\n\n### persistence\n\nThe module responsible for persisting all the downloaded graph data to Postgres.\n\n### snapshot\n\nThe snapshotting module is responsible for calculating and storing snapshots. It's started up\nas soon as the first full graph sync completes, and then keeps updating the snapshots at a\nconfigurable interval with a 3-hour-default.\n\n### lookup\n\nThe lookup module is responsible for fetching the latest data from the network graph and Postgres,\nand reconciling it into an actionable delta set that the server can return in a serialized format.\n\nIt works by collecting all the channels that are currently in the network graph, and gathering\nannouncements as well as updates for each of them. For the updates specifically, the last update\nseen prior to the given timestamp, the latest known updates, and, if necessary, all intermediate\nupdates are collected.\n\nThen, any channel that has only had an announcement but never an update is dropped. Additionally,\nevery channel whose first update was seen after the given timestamp is collected alongside its\nannouncement.\n\nFinally, all channel update transitions are evaluated and collected into either a full or an\nincremental update.\n\n## License\n\n[Apache 2.0](LICENSE-APACHE.md) or [MIT](LICENSE-MIT.md), [at your option](LICENSE.md).\n"}}},{"rowIdx":589,"cells":{"repoName":{"kind":"string","value":"gspindev_bcapps"},"tree":{"kind":"string","value":".gitpod.yml\nREADME.md\nnear-blockvote\n blockvote\n .gitpod.yml\n README.md\n babel.config.js\n contract\n Cargo.toml\n README.md\n as-pect.config.js\n asconfig.json\n assembly\n __tests__\n as-pect.d.ts\n main.spec.ts\n as_types.d.ts\n index.ts\n tsconfig.json\n compile.js\n package-lock.json\n package.json\n src\n lib.rs\n target\n .rustc_info.json\n debug\n .fingerprint\n Inflector-f35c64bdcc83a85c\n lib-inflector.json\n autocfg-5eed84e18ea4d38d\n lib-autocfg.json\n borsh-derive-761b64255590aa8b\n lib-borsh-derive.json\n borsh-derive-internal-a0b35acc7193a1d0\n lib-borsh-derive-internal.json\n borsh-schema-derive-internal-9f37d535db6c4ee3\n lib-borsh-schema-derive-internal.json\n byteorder-4e4f329b09aeb3fd\n build-script-build-script-build.json\n convert_case-04564bf453e861d8\n lib-convert_case.json\n derive_more-566efde9e14e316d\n lib-derive_more.json\n generic-array-bec72fe46df5bb50\n build-script-build-script-build.json\n hashbrown-42f79a9088e90730\n lib-hashbrown.json\n hashbrown-500377f64ca2c366\n run-build-script-build-script-build.json\n hashbrown-59f80045d7236bc4\n build-script-build-script-build.json\n indexmap-1f3eccbb1f1b3fcd\n build-script-build-script-build.json\n indexmap-5fbed610fb2dc724\n run-build-script-build-script-build.json\n indexmap-dc7cadd029b47868\n lib-indexmap.json\n itoa-63cf47e13d3db781\n lib-itoa.json\n memchr-67a2ff728556da01\n build-script-build-script-build.json\n near-rpc-error-core-2a45664b5ee46cf1\n lib-near-rpc-error-core.json\n near-rpc-error-macro-adaa389a95c4c64d\n lib-near-rpc-error-macro.json\n near-sdk-core-046688a20778ab0c\n lib-near-sdk-core.json\n near-sdk-macros-bf97191d7917f968\n lib-near-sdk-macros.json\n num-bigint-52ecb3e36d449c07\n build-script-build-script-build.json\n num-integer-71fdd49567fe1141\n build-script-build-script-build.json\n num-rational-caea7e28069930f5\n build-script-build-script-build.json\n num-traits-b7d192d6afcd3dde\n build-script-build-script-build.json\n proc-macro-crate-3bf1cd013445ff64\n lib-proc-macro-crate.json\n proc-macro2-2367cc8cea2612ce\n run-build-script-build-script-build.json\n proc-macro2-395b943ebbf040f9\n lib-proc-macro2.json\n proc-macro2-b648b70837f1c6f4\n build-script-build-script-build.json\n quote-54f9d5620c49c274\n lib-quote.json\n ryu-52f1bb91b4882a97\n build-script-build-script-build.json\n ryu-ce84462a99e7adbd\n run-build-script-build-script-build.json\n ryu-f8178accb5946406\n lib-ryu.json\n serde-36a08739de5d3f86\n lib-serde.json\n serde-473481d18b5ff63a\n build-script-build-script-build.json\n serde-835d15f265575fe4\n run-build-script-build-script-build.json\n serde_derive-1e873dceb097610e\n lib-serde_derive.json\n serde_derive-2086cae8fa2c1432\n build-script-build-script-build.json\n serde_derive-bfa500c2eadb07be\n run-build-script-build-script-build.json\n serde_json-2c194e4afdebdac8\n run-build-script-build-script-build.json\n serde_json-4317fae4e2dcf266\n lib-serde_json.json\n serde_json-a63a4500f066a2d2\n build-script-build-script-build.json\n syn-56a5bf88b05722f8\n run-build-script-build-script-build.json\n syn-7c765a4c08ca1842\n build-script-build-script-build.json\n syn-c9ee3dc821cbeb4b\n lib-syn.json\n toml-bd2b444908e77606\n lib-toml.json\n typenum-1c3be606d652c4ef\n build-script-build-script-main.json\n unicode-xid-bee6a97a0e141568\n lib-unicode-xid.json\n version_check-255985b2dd15b66b\n lib-version_check.json\n wee_alloc-e93d2ce325a73164\n build-script-build-script-build.json\n release\n .fingerprint\n Inflector-b1f6533151e7be62\n lib-inflector.json\n autocfg-735fbe8c5dbf71b9\n lib-autocfg.json\n borsh-derive-7d59e150cdb518c0\n lib-borsh-derive.json\n borsh-derive-internal-2d78bb3d30492957\n lib-borsh-derive-internal.json\n borsh-schema-derive-internal-85e7e315ba312ee7\n lib-borsh-schema-derive-internal.json\n byteorder-81302f6bfc5eb31f\n build-script-build-script-build.json\n convert_case-d9acb4e6c727fc39\n lib-convert_case.json\n derive_more-8d1bb25cd5020356\n lib-derive_more.json\n generic-array-d6c13f53da57eaab\n build-script-build-script-build.json\n hashbrown-07494e18ba19bf78\n run-build-script-build-script-build.json\n hashbrown-83b09df10dd1e41a\n build-script-build-script-build.json\n hashbrown-d7a8c4c4bbc55cd6\n lib-hashbrown.json\n indexmap-777ecb07eb7c653b\n build-script-build-script-build.json\n indexmap-c1b64f93eeed18e9\n lib-indexmap.json\n indexmap-fdbd2f59d739307d\n run-build-script-build-script-build.json\n itoa-bb11e9a682f4a0a3\n lib-itoa.json\n memchr-59f60882f3a6fdc4\n build-script-build-script-build.json\n near-rpc-error-core-87cd92434b55bc20\n lib-near-rpc-error-core.json\n near-rpc-error-macro-988344ce9064fcf8\n lib-near-rpc-error-macro.json\n near-sdk-core-2289a4a8c4b53ccd\n lib-near-sdk-core.json\n near-sdk-macros-c0403bcb04e8a0ea\n lib-near-sdk-macros.json\n num-bigint-74134c594c8b09e4\n build-script-build-script-build.json\n num-integer-982480eb0675b6e4\n build-script-build-script-build.json\n num-rational-ee02237c4a087c84\n build-script-build-script-build.json\n num-traits-9155197deb68bde0\n build-script-build-script-build.json\n proc-macro-crate-e11d07896b88a341\n lib-proc-macro-crate.json\n proc-macro2-4a41766285ae3b71\n lib-proc-macro2.json\n proc-macro2-9508761ff3b2ceb3\n run-build-script-build-script-build.json\n proc-macro2-dff7675cc3d539cf\n build-script-build-script-build.json\n quote-af2ffbfaeb05cf39\n lib-quote.json\n ryu-03d8d14e187b80dd\n build-script-build-script-build.json\n ryu-8aabbea4a072ce32\n run-build-script-build-script-build.json\n ryu-b58a78f25485d0d7\n lib-ryu.json\n serde-43577858555c1f0e\n lib-serde.json\n serde-d041d925dd72a9a7\n build-script-build-script-build.json\n serde-f0856918557b9658\n run-build-script-build-script-build.json\n serde_derive-2fda46d22992ac7e\n run-build-script-build-script-build.json\n serde_derive-34c1264feee50417\n lib-serde_derive.json\n serde_derive-ec64f90e16c9291e\n build-script-build-script-build.json\n serde_json-314108b27f235f7e\n build-script-build-script-build.json\n serde_json-d24cdaf20879683a\n lib-serde_json.json\n serde_json-d2ee8bb4d740eab8\n run-build-script-build-script-build.json\n syn-54daadb1bc6d3c9c\n lib-syn.json\n syn-5eff70ac5a70f6e0\n run-build-script-build-script-build.json\n syn-e12e1ce835e719c1\n build-script-build-script-build.json\n toml-832b9f05674868c2\n lib-toml.json\n typenum-979d1ff71f05660b\n build-script-build-script-main.json\n unicode-xid-2b21b505d13ab61a\n lib-unicode-xid.json\n version_check-e88a35665327f85d\n lib-version_check.json\n wee_alloc-7ac7d6f4e423032d\n build-script-build-script-build.json\n wasm32-unknown-unknown\n debug\n .fingerprint\n ahash-eb636ec8915dddf7\n lib-ahash.json\n aho-corasick-a71edad06bb68cab\n lib-aho_corasick.json\n base64-0ae58e1dbffe7e84\n lib-base64.json\n block-buffer-20af8d642b837847\n lib-block-buffer.json\n block-buffer-85b17d9b8595e159\n lib-block-buffer.json\n block-padding-095fc83b1607738a\n lib-block-padding.json\n borsh-bf7950abe3f09d4c\n lib-borsh.json\n bs58-286532934081eba1\n lib-bs58.json\n byte-tools-b7ac364c6d558430\n lib-byte-tools.json\n byteorder-0cd1ed356486674f\n lib-byteorder.json\n byteorder-f5dc4b4e48bded04\n run-build-script-build-script-build.json\n cfg-if-4d8a2758c80889c0\n lib-cfg-if.json\n cfg-if-a77a3c4e042d055d\n lib-cfg-if.json\n digest-72529d28ecf61488\n lib-digest.json\n digest-d4124ab6c18e79e5\n lib-digest.json\n generic-array-0ecce5cce49dcea1\n run-build-script-build-script-build.json\n generic-array-a51a241793992f40\n lib-generic_array.json\n generic-array-f88c74110034607c\n lib-generic_array.json\n greeter-98ace302c5fafa12\n lib-greeter.json\n hashbrown-88c4fd68d369e204\n lib-hashbrown.json\n hashbrown-c79eeed063cebff2\n lib-hashbrown.json\n hashbrown-d08c50da5660759f\n run-build-script-build-script-build.json\n hex-ed3e76e456925cba\n lib-hex.json\n indexmap-5c193501167d8447\n run-build-script-build-script-build.json\n indexmap-b28a5ce6ad124174\n lib-indexmap.json\n itoa-8131ef3e89947368\n lib-itoa.json\n keccak-fec8796739ce5fde\n lib-keccak.json\n lazy_static-4d5361ccf5b352f5\n lib-lazy_static.json\n memchr-25b196f1bd4b2ecc\n lib-memchr.json\n memchr-d7d50b3eb5e79daf\n run-build-script-build-script-build.json\n memory_units-27c0630f88317c76\n lib-memory_units.json\n near-primitives-core-1dbb5cc6733d750e\n lib-near-primitives-core.json\n near-runtime-utils-2fc656fcfaaacd29\n lib-near-runtime-utils.json\n near-sdk-ee3ca4da10262bbf\n lib-near-sdk.json\n near-vm-errors-979533521df46ffd\n lib-near-vm-errors.json\n near-vm-logic-4713d4cfd3563cc5\n lib-near-vm-logic.json\n num-bigint-a7776bc10849fa10\n lib-num-bigint.json\n num-bigint-cf5799adc943a33e\n run-build-script-build-script-build.json\n num-integer-1354f87f88c7c4b3\n lib-num-integer.json\n num-integer-c1d009c0dcda2b1a\n run-build-script-build-script-build.json\n num-rational-8a750fca4189c112\n run-build-script-build-script-build.json\n num-rational-9191d276205b351e\n lib-num-rational.json\n num-traits-2fa84436ba59c6a5\n lib-num-traits.json\n num-traits-b827cec4781ff7ef\n run-build-script-build-script-build.json\n opaque-debug-9a055071732a2e05\n lib-opaque-debug.json\n opaque-debug-ce59ec0a8ef85c91\n lib-opaque-debug.json\n regex-180ae6db84ef7c43\n lib-regex.json\n regex-syntax-64d72df1a7a24eed\n lib-regex-syntax.json\n ryu-cee8a9e3ef551249\n run-build-script-build-script-build.json\n ryu-f5f5279d17e4558f\n lib-ryu.json\n serde-454350dad00c836f\n lib-serde.json\n serde-9c4e68c7bafb97ab\n run-build-script-build-script-build.json\n serde_json-89e9633a411c631e\n lib-serde_json.json\n serde_json-99a433b6f05242fb\n run-build-script-build-script-build.json\n sha2-f58f5f9043003f37\n lib-sha2.json\n sha3-e89a3e3ea208ff02\n lib-sha3.json\n typenum-5bdf061afe46b05e\n run-build-script-build-script-main.json\n typenum-5eb09d9567c7402c\n lib-typenum.json\n wee_alloc-87427b00e2478ff4\n run-build-script-build-script-build.json\n wee_alloc-adb071298af20a95\n lib-wee_alloc.json\n build\n num-bigint-cf5799adc943a33e\n out\n radix_bases.rs\n typenum-5bdf061afe46b05e\n out\n consts.rs\n op.rs\n tests.rs\n wee_alloc-87427b00e2478ff4\n out\n wee_alloc_static_array_backend_size_bytes.txt\n release\n .fingerprint\n ahash-5733d2af5ab642f9\n lib-ahash.json\n aho-corasick-358cd9fc49fc208f\n lib-aho_corasick.json\n base64-0ed85d98192b35cb\n lib-base64.json\n block-buffer-1e4e2337592206e5\n lib-block-buffer.json\n block-buffer-c54763f257b15dd1\n lib-block-buffer.json\n block-padding-c555c563296295f4\n lib-block-padding.json\n borsh-beb3e822996c2cb4\n lib-borsh.json\n bs58-41d69aa5ea2113ca\n lib-bs58.json\n byte-tools-fb87ed39c08375ce\n lib-byte-tools.json\n byteorder-0c3b7b13740da921\n lib-byteorder.json\n byteorder-405f574730de3eef\n run-build-script-build-script-build.json\n cfg-if-b071a0b2275e82e2\n lib-cfg-if.json\n cfg-if-d5346bc0bf7330e8\n lib-cfg-if.json\n digest-0d4237bf4d9c1a6a\n lib-digest.json\n digest-adac54607d80ee38\n lib-digest.json\n generic-array-217ce918508d02cd\n run-build-script-build-script-build.json\n generic-array-e67b0eb4308d514e\n lib-generic_array.json\n generic-array-f16946a2302dd633\n lib-generic_array.json\n greeter-98ace302c5fafa12\n lib-greeter.json\n hashbrown-2ec52ed5ef7e8301\n run-build-script-build-script-build.json\n hashbrown-8c8841b45faaaabd\n lib-hashbrown.json\n hashbrown-ae7cd6c71d752e9a\n lib-hashbrown.json\n hex-7df3a25827098668\n lib-hex.json\n indexmap-499bc4cee6a96e5a\n lib-indexmap.json\n indexmap-cb04952586968012\n run-build-script-build-script-build.json\n itoa-809e1c13e2b226d3\n lib-itoa.json\n keccak-8f1f086e7e9699d2\n lib-keccak.json\n lazy_static-972e121ee292811f\n lib-lazy_static.json\n memchr-137fa0863f905d2c\n run-build-script-build-script-build.json\n memchr-e48956fbf149470d\n lib-memchr.json\n memory_units-6d9926a0d4bb6989\n lib-memory_units.json\n near-primitives-core-c1d94f159e4a2fcc\n lib-near-primitives-core.json\n near-runtime-utils-a3cb73bd60125da8\n lib-near-runtime-utils.json\n near-sdk-425250cb7ccbf675\n lib-near-sdk.json\n near-vm-errors-8abc13bf4c874e4c\n lib-near-vm-errors.json\n near-vm-logic-27a1fbe8540f5631\n lib-near-vm-logic.json\n num-bigint-5f3184d31ccdc4aa\n lib-num-bigint.json\n num-bigint-edd88df40ad0adeb\n run-build-script-build-script-build.json\n num-integer-3caf5a2e1cd3ffa6\n run-build-script-build-script-build.json\n num-integer-80774b99740e0f81\n lib-num-integer.json\n num-rational-461cc94cc1251d94\n run-build-script-build-script-build.json\n num-rational-9439f578daeff963\n lib-num-rational.json\n num-traits-542afd3e0b9f4731\n run-build-script-build-script-build.json\n num-traits-d764c2a26c748628\n lib-num-traits.json\n opaque-debug-e7c6e45d0f6dbcbc\n lib-opaque-debug.json\n opaque-debug-fbd12b4a5adf74d4\n lib-opaque-debug.json\n regex-c45e85a87d9d3aa2\n lib-regex.json\n regex-syntax-4308c62ce412d750\n lib-regex-syntax.json\n ryu-17d9881e571cdd4b\n lib-ryu.json\n ryu-6c0eafb381d8ef83\n run-build-script-build-script-build.json\n serde-8cfb315b6ee116ce\n lib-serde.json\n serde-a8f4a3c392c64d21\n run-build-script-build-script-build.json\n serde_json-c74861dd6cf40b64\n run-build-script-build-script-build.json\n serde_json-dd836d1a69b1c32b\n lib-serde_json.json\n sha2-e06d4e2ca3f7096b\n lib-sha2.json\n sha3-7e8ddc190e555192\n lib-sha3.json\n typenum-4acd3ba97586d824\n lib-typenum.json\n typenum-55ff30b9565f0355\n run-build-script-build-script-main.json\n wee_alloc-2b2eac064dc92512\n run-build-script-build-script-build.json\n wee_alloc-c61199675b501834\n lib-wee_alloc.json\n build\n num-bigint-edd88df40ad0adeb\n out\n radix_bases.rs\n typenum-55ff30b9565f0355\n out\n consts.rs\n op.rs\n tests.rs\n wee_alloc-2b2eac064dc92512\n out\n wee_alloc_static_array_backend_size_bytes.txt\n package.json\n src\n App.js\n Home.js\n __mocks__\n fileMock.js\n assets\n logo-black.svg\n logo-white.svg\n components\n NewPoll.js\n PollingStation.js\n config.js\n global.css\n index.html\n index.js\n jest.init.js\n main.test.js\n utils.js\n wallet\n login\n index.html\npackage-lock.json\npackage.json\n"},"readme":{"kind":"string","value":"blockvote\n==================\n\nThis [React] app was initialized with [create-near-app]\n\nQuick Start\n===========\n\nTo run this project locally:\n\n1. Prerequisites: Make sure you've installed [Node.js] ≥ 12\n2. Install dependencies: `yarn install`\n3. Run the local development server: `yarn dev` (see `package.json` for a\n full list of `scripts` you can run with `yarn`)\n\nNow you'll have a local development environment backed by the NEAR TestNet!\n\nGo ahead and play with the app and the code. As you make code changes, the app will automatically reload.\n\nExploring The Code\n==================\n\n1. The \"backend\" code lives in the `/contract` folder. See the README there for\n more info.\n2. The frontend code lives in the `/src` folder. `/src/index.html` is a great\n place to start exploring. Note that it loads in `/src/index.js`, where you\n can learn how the frontend connects to the NEAR blockchain.\n3. Tests: there are different kinds of tests for the frontend and the smart\n contract. See `contract/README` for info about how it's tested. The frontend\n code gets tested with [jest]. You can run both of these at once with `yarn\n run test`.\n\nDeploy\n======\n\nEvery smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `yarn dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how.\n\nStep 0: Install near-cli (optional)\n-------------------------------------\n\n[near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `yarn install`, but for best ergonomics you may want to install it globally:\n\n yarn install --global near-cli\n\nOr, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`\n\nEnsure that it's installed with `near --version` (or `npx near --version`)\n\nStep 1: Create an account for the contract\n------------------------------------------\n\nEach account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `blockvote.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `blockvote.your-name.testnet`:\n\n1. Authorize NEAR CLI, following the commands it gives you:\n\n near login\n\n2. Create a subaccount (replace `YOUR-NAME` below with your actual account name):\n\n near create-account blockvote.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet\n\nStep 2: set contract name in code\n---------------------------------\n\nModify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.\n\n const CONTRACT_NAME = process.env.CONTRACT_NAME || 'blockvote.YOUR-NAME.testnet'\n\nStep 3: deploy!\n---------------\n\nOne command:\n\n yarn deploy\n\nAs you can see in `package.json`, this does two things:\n\n1. builds & deploys smart contract to NEAR TestNet\n2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere.\n\nTroubleshooting\n===============\n\nOn Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details.\n\n [React]: https://reactjs.org/\n [create-near-app]: https://github.com/near/create-near-app\n [Node.js]: https://nodejs.org/en/download/package-manager/\n [jest]: https://jestjs.io/\n [NEAR accounts]: https://docs.near.org/docs/concepts/account\n [NEAR Wallet]: https://wallet.testnet.near.org/\n [near-cli]: https://github.com/near/near-cli\n [gh-pages]: https://github.com/tschaub/gh-pages\nblockvote Smart Contract\n==================\n\nA [smart contract] written in [Rust] for an app initialized with [create-near-app]\n\nQuick Start\n===========\n\nBefore you compile this code, you will need to install Rust with [correct target]\n\nExploring The Code\n==================\n\n1. The main smart contract code lives in `src/lib.rs`. You can compile it with\n the `./compile` script.\n2. Tests: You can run smart contract tests with the `./test` script. This runs\n standard Rust tests using [cargo] with a `--nocapture` flag so that you\n can see any debug info you print to the console.\n\n [smart contract]: https://docs.near.org/docs/develop/contracts/overview\n [Rust]: https://www.rust-lang.org/\n [create-near-app]: https://github.com/near/create-near-app\n [correct target]: https://github.com/near/near-sdk-rs#pre-requisites\n [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html\n# bcapps\n"}}},{"rowIdx":590,"cells":{"repoName":{"kind":"string","value":"Lightency_nearcon-hackathon-lightency"},"tree":{"kind":"string","value":".gitpod.yml\nREADME.md\ncontract\n Cargo.toml\n README.md\n neardev\n dev-account.env\n src\n lib.rs\ndao_contract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\nenergy_pool_contract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n neardev\n dev-account.env\n src\n lib.rs\nfrontend\n App.js\n Routes.js\n assets\n css\n global.css\n img\n index.js\n logo-black.svg\n logo-white.svg\n swaps\n Etoro_logo.svg\n components\n dao\n createProposal.js\n dashboards.js\n proposals.js\n governance\n charts\n chart1.js\n forms\n createDao.js\n tables\n daoList.js\n layouts\n Reusables\n LineChart.js\n layout.js\n styles.js\n shared\n Clock\n Clock.js\n Loading\n loader2.js\n loading.js\n styles.js\n Navbar\n navbar.js\n style.js\n Sidebar\n sidebar.js\n styles.js\n config.js\n dist\n Etoro_logo.ba873066.svg\n auto.0965e03f.js\n index.1afa09c0.css\n index.html\n primeicons.cdbe9e7f.svg\n index.html\n index.js\n near-api.js\n near-config.js\n package-lock.json\n package.json\n pages\n BondPage.js\n DaoPage.js\n GovernancePage.js\n HomePage.js\n OnDevelopmentModPage.js\n StakePage.js\n StakingPoolPage.js\n SwapPage.js\n VotingPage.js\n styles\n globalStyles.js\n theme.js\n variables.js\n ui-components.js\n utils.js\n utils\n timeConverter.js\nft\n Cargo.toml\n build.sh\n src\n lib.rs\nfundmanager\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\nintegration-tests\n Cargo.toml\n src\n tests.rs\npackage-lock.json\npackage.json\nrewarder\n .gitpod.yml\n README.md\n contract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\n integration-tests\n Cargo.toml\n src\n tests.rs\n package-lock.json\n package.json\nrewardpoolcontract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\nstaking\n .gitpod.yml\n README.md\n contract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\n integration-tests\n Cargo.toml\n src\n tests.rs\n package-lock.json\n package.json\nstakingpool\n .gitpod.yml\n README.md\n contract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\n integration-tests\n Cargo.toml\n src\n tests.rs\n package-lock.json\n package.json\ntreasury\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n lib.rs\n"},"readme":{"kind":"string","value":"# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\nnear-blank-project\n==================\n\nThis app was initialized with [create-near-app]\n\nQuick Start\n===========\n\nIf you haven't installed dependencies during setup:\n\n npm install\n\nBuild and deploy your contract to TestNet with a temporary dev account:\n\n npm run deploy\n\nTest your contract:\n\n npm test\n\nIf you have a frontend, run `npm start`. This will run a dev server.\n\nExploring The Code\n==================\n\n1. The smart-contract code lives in the `/contract` folder. See the README there for\n more info. In blockchain apps the smart contract is the \"backend\" of your app.\n2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great\n place to start exploring. Note that it loads in `/frontend/index.js`,\n this is your entrypoint to learn how the frontend connects to the NEAR blockchain.\n3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory.\n\nDeploy\n======\n\nEvery smart contract in NEAR has its [own associated account][NEAR accounts]. \nWhen you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account.\nWhen you're ready to make it permanent, here's how:\n\nStep 0: Install near-cli (optional)\n-------------------------------------\n\n[near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally:\n\n npm install --global near-cli\n\nOr, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`\n\nEnsure that it's installed with `near --version` (or `npx near --version`)\n\nStep 1: Create an account for the contract\n------------------------------------------\n\nEach account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`:\n\n1. Authorize NEAR CLI, following the commands it gives you:\n\n near login\n\n2. Create a subaccount (replace `YOUR-NAME` below with your actual account name):\n\n near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet\n\nStep 2: deploy the contract\n---------------------------\n\nUse the CLI to deploy the contract to TestNet with your account ID.\nReplace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory.\n\n near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE\n\nStep 3: set contract name in your frontend code\n-----------------------------------------------\n\nModify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.\n\n const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'\n\nTroubleshooting\n===============\n\nOn Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details.\n\n [create-near-app]: https://github.com/near/create-near-app\n [Node.js]: https://nodejs.org/en/download/package-manager/\n [jest]: https://jestjs.io/\n [NEAR accounts]: https://docs.near.org/concepts/basics/account\n [NEAR Wallet]: https://wallet.testnet.near.org/\n [near-cli]: https://github.com/near/near-cli\n [gh-pages]: https://github.com/tschaub/gh-pages\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\nnear-blank-project\n==================\n\nThis app was initialized with [create-near-app]\n\nQuick Start\n===========\n\nIf you haven't installed dependencies during setup:\n\n npm run deps-install\n\nBuild and deploy your contract to TestNet with a temporary dev account:\n\n npm run deploy\n\nTest your contract:\n\n npm test\n\nIf you have a frontend, run `npm start`. This will run a dev server.\n\nExploring The Code\n==================\n\n1. The smart-contract code lives in the `/contract` folder. See the README there for\n more info. In blockchain apps the smart contract is the \"backend\" of your app.\n2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great\n place to start exploring. Note that it loads in `/frontend/index.js`,\n this is your entrypoint to learn how the frontend connects to the NEAR blockchain.\n3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory.\n\nDeploy\n======\n\nEvery smart contract in NEAR has its [own associated account][NEAR accounts]. \nWhen you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account.\nWhen you're ready to make it permanent, here's how:\n\nStep 0: Install near-cli (optional)\n-------------------------------------\n\n[near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally:\n\n npm install --global near-cli\n\nOr, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`\n\nEnsure that it's installed with `near --version` (or `npx near --version`)\n\nStep 1: Create an account for the contract\n------------------------------------------\n\nEach account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`:\n\n1. Authorize NEAR CLI, following the commands it gives you:\n\n near login\n\n2. Create a subaccount (replace `YOUR-NAME` below with your actual account name):\n\n near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet\n\nStep 2: deploy the contract\n---------------------------\n\nUse the CLI to deploy the contract to TestNet with your account ID.\nReplace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory.\n\n near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE\n\nStep 3: set contract name in your frontend code\n-----------------------------------------------\n\nModify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.\n\n const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'\n\nTroubleshooting\n===============\n\nOn Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details.\n\n [create-near-app]: https://github.com/near/create-near-app\n [Node.js]: https://nodejs.org/en/download/package-manager/\n [jest]: https://jestjs.io/\n [NEAR accounts]: https://docs.near.org/concepts/basics/account\n [NEAR Wallet]: https://wallet.testnet.near.org/\n [near-cli]: https://github.com/near/near-cli\n [gh-pages]: https://github.com/tschaub/gh-pages\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\nnear-blank-project\n==================\n\nThis app was initialized with [create-near-app]\n\nQuick Start\n===========\n\nIf you haven't installed dependencies during setup:\n\n npm install\n\nBuild and deploy your contract to TestNet with a temporary dev account:\n\n npm run deploy\n\nTest your contract:\n\n npm test\n\nIf you have a frontend, run `npm start`. This will run a dev server.\n\nExploring The Code\n==================\n\n1. The smart-contract code lives in the `/contract` folder. See the README there for\n more info. In blockchain apps the smart contract is the \"backend\" of your app.\n2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great\n place to start exploring. Note that it loads in `/frontend/index.js`,\n this is your entrypoint to learn how the frontend connects to the NEAR blockchain.\n3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory.\n\nDeploy\n======\n\nEvery smart contract in NEAR has its [own associated account][NEAR accounts]. \nWhen you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account.\nWhen you're ready to make it permanent, here's how:\n\nStep 0: Install near-cli (optional)\n-------------------------------------\n\n[near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally:\n\n npm install --global near-cli\n\nOr, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`\n\nEnsure that it's installed with `near --version` (or `npx near --version`)\n\nStep 1: Create an account for the contract\n------------------------------------------\n\nEach account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`:\n\n1. Authorize NEAR CLI, following the commands it gives you:\n\n near login\n\n2. Create a subaccount (replace `YOUR-NAME` below with your actual account name):\n\n near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet\n\nStep 2: deploy the contract\n---------------------------\n\nUse the CLI to deploy the contract to TestNet with your account ID.\nReplace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory.\n\n near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE\n\nStep 3: set contract name in your frontend code\n-----------------------------------------------\n\nModify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.\n\n const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'\n\nTroubleshooting\n===============\n\nOn Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details.\n\n [create-near-app]: https://github.com/near/create-near-app\n [Node.js]: https://nodejs.org/en/download/package-manager/\n [jest]: https://jestjs.io/\n [NEAR accounts]: https://docs.near.org/concepts/basics/account\n [NEAR Wallet]: https://wallet.testnet.near.org/\n [near-cli]: https://github.com/near/near-cli\n [gh-pages]: https://github.com/tschaub/gh-pages\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\nHello NEAR!\n=================================\n\nA [smart contract] written in [Rust] for an app initialized with [create-near-app]\n\nQuick Start\n===========\n\nBefore you compile this code, you will need to install Rust with [correct target]\n\nExploring The Code\n==================\n\n1. The main smart contract code lives in `src/lib.rs`.\n2. There are two functions to the smart contract: `get_greeting` and `set_greeting`.\n3. Tests: You can run smart contract tests with the `cargo test`.\n\n [smart contract]: https://docs.near.org/develop/welcome\n [Rust]: https://www.rust-lang.org/\n [create-near-app]: https://github.com/near/create-near-app\n [correct target]: https://docs.near.org/develop/prerequisites#rust-and-wasm\n [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html\nnear-blank-project\n==================\n\nThis app was initialized with [create-near-app]\n\nQuick Start\n===========\n\nIf you haven't installed dependencies during setup:\n\n npm install\n\nBuild and deploy your contract to TestNet with a temporary dev account:\n\n npm run deploy\n\nTest your contract:\n\n npm test\n\nIf you have a frontend, run `npm start`. This will run a dev server.\n\nExploring The Code\n==================\n\n1. The smart-contract code lives in the `/contract` folder. See the README there for\n more info. In blockchain apps the smart contract is the \"backend\" of your app.\n2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great\n place to start exploring. Note that it loads in `/frontend/index.js`,\n this is your entrypoint to learn how the frontend connects to the NEAR blockchain.\n3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory.\n\nDeploy\n======\n\nEvery smart contract in NEAR has its [own associated account][NEAR accounts]. \nWhen you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account.\nWhen you're ready to make it permanent, here's how:\n\nStep 0: Install near-cli (optional)\n-------------------------------------\n\n[near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally:\n\n npm install --global near-cli\n\nOr, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`\n\nEnsure that it's installed with `near --version` (or `npx near --version`)\n\nStep 1: Create an account for the contract\n------------------------------------------\n\nEach account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`:\n\n1. Authorize NEAR CLI, following the commands it gives you:\n\n near login\n\n2. Create a subaccount (replace `YOUR-NAME` below with your actual account name):\n\n near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet\n\nStep 2: deploy the contract\n---------------------------\n\nUse the CLI to deploy the contract to TestNet with your account ID.\nReplace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory.\n\n near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE\n\nStep 3: set contract name in your frontend code\n-----------------------------------------------\n\nModify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.\n\n const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'\n\nTroubleshooting\n===============\n\nOn Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details.\n\n [create-near-app]: https://github.com/near/create-near-app\n [Node.js]: https://nodejs.org/en/download/package-manager/\n [jest]: https://jestjs.io/\n [NEAR accounts]: https://docs.near.org/concepts/basics/account\n [NEAR Wallet]: https://wallet.testnet.near.org/\n [near-cli]: https://github.com/near/near-cli\n [gh-pages]: https://github.com/tschaub/gh-pages\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\n# Hello NEAR Contract\n\nThe smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.\n\n```rust\nconst DEFAULT_GREETING: &str = \"Hello\";\n\n#[near_bindgen]\n#[derive(BorshDeserialize, BorshSerialize)]\npub struct Contract {\n greeting: String,\n}\n\nimpl Default for Contract {\n fn default() -> Self {\n Self{greeting: DEFAULT_GREETING.to_string()}\n }\n}\n\n#[near_bindgen]\nimpl Contract {\n // Public: Returns the stored greeting, defaulting to 'Hello'\n pub fn get_greeting(&self) -> String {\n return self.greeting.clone();\n }\n\n // Public: Takes a greeting, such as 'howdy', and records it\n pub fn set_greeting(&mut self, greeting: String) {\n // Record a log permanently to the blockchain!\n log!(\"Saving greeting {}\", greeting);\n self.greeting = greeting;\n }\n}\n```\n\n<br />\n\n# Quickstart\n\n1. Make sure you have installed [rust](https://rust.org/).\n2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup)\n\n<br />\n\n## 1. Build and Deploy the Contract\nYou can automatically compile and deploy the contract in the NEAR testnet by running:\n\n```bash\n./deploy.sh\n```\n\nOnce finished, check the `neardev/dev-account` file to find the address in which the contract was deployed:\n\n```bash\ncat ./neardev/dev-account\n# e.g. dev-1659899566943-21539992274727\n```\n\n<br />\n\n## 2. Retrieve the Greeting\n\n`get_greeting` is a read-only method (aka `view` method).\n\n`View` methods can be called for **free** by anyone, even people **without a NEAR account**!\n\n```bash\n# Use near-cli to get the greeting\nnear view <dev-account> get_greeting\n```\n\n<br />\n\n## 3. Store a New Greeting\n`set_greeting` changes the contract's state, for which it is a `change` method.\n\n`Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction.\n\n```bash\n# Use near-cli to set a new greeting\nnear call <dev-account> set_greeting '{\"greeting\":\"howdy\"}' --accountId <dev-account>\n```\n\n**Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using:\n\n```bash\n# Use near-cli to login your NEAR account\nnear login\n```\n\nand then use the logged account to sign the transaction: `--accountId <your-account>`.\n"}}},{"rowIdx":591,"cells":{"repoName":{"kind":"string","value":"pantemon_question"},"tree":{"kind":"string","value":"README.md\ncontract\n Cargo.toml\n README.md\n rustfmt.toml\n scripts\n build.sh\n deploy.sh\n dev-deploy.sh\n init-args.js\n src\n contract.rs\n lib.rs\n utils.rs\n"},"readme":{"kind":"string","value":"# NEAR Smart Contract Rust Template\n\nProject structure for writing smart contracts in Rust for NEAR Protocol\n\n# Required Software\n\n- Rust 1.58 + cargo\n- Node.js\n- NEAR CLI 3.1\n\n# Authors\n\n- Jacob Lindahl <jacob@near.foundation> [@sudo_build](https://twitter.com/sudo_build)\n# question\n"}}},{"rowIdx":592,"cells":{"repoName":{"kind":"string","value":"marco-sundsk_senderwallet-registrar"},"tree":{"kind":"string","value":"README.md\ncontracts\n Cargo.toml\n README.md\n __tests__\n sw-registrar\n helper.ts\n operator.ava.ts\n owner.ava.ts\n package-lock.json\n package.json\n sw-registrar\n Cargo.toml\n build_local.sh\n src\n lib.rs\n owner.rs\n user_info.rs\n utils.rs\n views.rs\n tsconfig.json\n"},"readme":{"kind":"string","value":"# Registrar Contract for Sender Wallet\nAn upgradable IMS contract for Sender-Wallet user management.\n\n## Description\n* Everyone can check a given user's information. \n* Operators can do all above and can add user information. \n* Owner can do all above and can upgrade the contract and management Operators.\n\n### For Everyone\n```rust\npub struct ContractMetadata {\n pub version: String,\n /// the owner of the contract, normally a DAO\n pub owner_id: AccountId,\n /// those operators's near accounts\n pub operators: Vec<AccountId>,\n /// how many users currently managed\n pub user_count: U64,\n}\n/// get contract basic info\npub fn metadata(&self) -> ContractMetadata;\n\npub struct HumanReadableUserInfo {\n // user NEAR Account, the key to find a user\n pub account_id: AccountId,\n // user nick name on SenderWallet side\n pub user_name: String,\n // Timestamp (secs) that adding this user\n pub register_at: u32,\n}\n\n/// Check a given user's UserInfo\npub fn get_user_info(&self, account_id: ValidAccountId) -> Option<HumanReadableUserInfo>;\n```\n\n### For Operators\n```rust\n#[payable]\npub fn register_new_user(&mut self, accound_id: ValidAccountId, user_name: String);\n```\n\n### For Owner\n```rust\npub fn set_owner(&mut self, owner_id: ValidAccountId);\npub fn extend_operators(&mut self, operators: Vec<ValidAccountId>);\npub fn remove_operators(&mut self, operators: Vec<ValidAccountId>);\n```\n\n## Build\n1. Install `rustup` via [https://rustup.rs/](https://rustup.rs/)\n2. Run the following:\n ```bash\n rustup default stable\n rustup target add wasm32-unknown-unknown\n ```\n3. Build:\n ```bash\n cd sw-registrar\n ./build_local.sh\n ```\n4. Test:\n ```bash\n cd sw-registrar\n cargo test\n ```\n\n## Deploying to Testnet\nTo deploy to TestNet, you can use next command:\n```bash\nnpm install -g near-cli\nnear dev-deploy res/sw_registrar_local.wasm\n```\nThis will output on the contract ID it deployed.\n# senderwallet-registrar\nSenderWallet User Registrar Contract\n\n## Build\nIn `contracts` Dir: \n- Build all artifacts: `make`\n\n## Test\nIn `contracts` Dir: \n- Run all tests: `make test`\n- Run with some flags:\n - Run specific test file: `TEST_FILE={filename} make test`\n - Print contract logs: `LOGS=1 make test`\n"}}},{"rowIdx":593,"cells":{"repoName":{"kind":"string","value":"near_near-indexer-events"},"tree":{"kind":"string","value":"Cargo.toml\nREADME.md\nmigrations\n 20220712171424_initial.sql\nsrc\n configs.rs\n db_adapters\n coin\n legacy\n DOC.md\n aurora.rs\n mod.rs\n rainbow_bridge.rs\n skyward.rs\n tkn_near.rs\n wentokensir.rs\n wrap_near.rs\n mod.rs\n nep141_events.rs\n event_types.rs\n events.rs\n mod.rs\n nft\n mod.rs\n nep171_events.rs\n numeric_types.rs\n lib.rs\n main.rs\n metrics.rs\n models\n coin_events.rs\n contracts.rs\n mod.rs\n nft_events.rs\n"},"readme":{"kind":"string","value":"# Indexer Events\n\nAsync Postgres-compatible solution to load the data from NEAR blockchain.\nBased on [NEAR Lake Framework](https://github.com/near/near-lake-framework-rs).\n\nSee [Indexer Base](https://github.com/near/near-indexer-base#indexer-base) docs for all the explanations, installation guide, etc.\n\nThis solution collects balance-changing events about FTs, NFTs, etc.\n\n- We can index the blockchain from any point of time. The code does not check if all the previous history is collected.\n- Potentially, some events may be skipped.\n- We do not check the correctness of collected events, it should be done separately.\n- We can re-run infinite number of indexers writing at the same DB, they may index same or different parts of the blockchain. It should not break the flow.\n\n### Why existing `assets__*` tables are not enough?\n\n`assets__non_fungible_token_events`, `assets__fungible_token_events` do not have the sorting column.\nIn the current solution, we've added artificial `event_index` column.\n\nThe new `coin_events` table stores the data in the format of affected/involved account_id, that simplifies filtering by affected `account_id`. \n`coin_events` still does not have `absolute_value` column, so you have to collect it from RPC if needed.\n\n### What if my contract does not produce events?\n\nPlease go and update your contract with our new [SDK](https://github.com/near/near-sdk-rs).\n\nIf it's important for you to collect all the previous history as well, you need to make the contribution and implement your own legacy handler. \nYou can use [existing handlers](src/db_adapters/coin/legacy) as the example, [wrap_near](src/db_adapters/coin/legacy/wrap_near.rs) may be a good starting point.\n\n### My contract produces events/there's a custom legacy logic for my contract, but the Enhanced API still ignores me. Why?\n\nIt means that we've found inconsistency in the data you provided with the data we've queried by RPC. \nTo be more clear, we collected all the logs/performed all the legacy logic, we know all the changed balances for all the active users at the end of the block.\nAfter that, we ask the RPC to provide all the needed balances.\nThe numbers should be the same.\nIf they are not the same, it means the data is inconsistent.\n\nWhen we meet the inconsistency, we mark such contract as \"non-trusted\". \nIf you want to fix this, you need to write/edit [legacy handler](src/db_adapters/coin/legacy/DOC.md) for your contract.\n\n### Contribution Guide\n\nPlease refer to this [guide](https://github.com/near/near-indexer-for-explorer/blob/master/CONTRIBUTING.md) before submitting PRs to this repo\n"}}},{"rowIdx":594,"cells":{"repoName":{"kind":"string","value":"PrimeLabCore_tenk-frontend-template"},"tree":{"kind":"string","value":"README.md\npackage.json\npublic\n index.html\nsrc\n Contexts\n BuyContext\n BuyContext.js\n index.js\n Main.js\n assets\n images\n copy-icon.svg\n faq-ellipse-left.svg\n faq-ellipse-right.svg\n faq-kat.svg\n footer-near-logo.svg\n generate.svg\n hero-big-cat.svg\n hero-cloud1.svg\n hero-cloud2.svg\n hero-cloud3.svg\n hero-ellipse.svg\n leran-background-circle.svg\n leran-background-ellipse.svg\n link-drop-background.svg\n nearkat-item-clothes.svg\n nearkat-item-hat.svg\n nearkat-item-palette.svg\n nearkat-logo.svg\n nfts-kat1.svg\n nfts-kat2.svg\n nfts-kat3.svg\n nfts-kat4.svg\n rarity-background-gradient.svg\n rarity-common.svg\n rarity-kat1.svg\n rarity-kat2.svg\n rarity-kat3.svg\n rarity-kat4.svg\n rarity-rare.svg\n rarity-rate-kat1.svg\n rarity-rate-kat2.svg\n rarity-rate-kat3.svg\n rarity-rate-kat4.svg\n rarity-super-rare.svg\n rarity-uncommon.svg\n rarity-very-rare.svg\n reveal.svg\n roadmap-background-clouds.svg\n roadmap-ellipse-left.svg\n roadmap-ellipse-right.svg\n share-social\n discord.svg\n email.svg\n facebook.svg\n instagram.svg\n linkedin.svg\n telegram.svg\n twitter.svg\n wechat.svg\n social-face.svg\n social-mintbase.svg\n social-twitter.svg\n sold-out-kat.svg\n components\n Buy\n BuyMore\n index.js\n index.js\n BuyMoreBtn\n index.js\n ConnectWalletBtn\n index.js\n FAQ\n index.js\n Generate\n index.js\n GenerateCountBtn\n index.js\n Hero\n index.js\n Learn\n index.js\n Loader\n Loader.js\n index.js\n Navigation\n Navigation.js\n index.js\n NearkatsList\n index.js\n NftItem\n NftItem.js\n index.js\n NftItemInfo\n NftItemInfo.js\n index.js\n NftList\n NftList.js\n index.js\n NumberOfBuy\n index.js\n Price\n index.js\n Rarity\n index.js\n rarityData.js\n RateList\n index.js\n RenderRoutes\n RenderRoutes.js\n RouteWithSubRoutes\n RouteWithSubRoutes.js\n index.js\n index.js\n Roadmap\n index.js\n ScrollToTop\n index.js\n ShareSocialLinks\n index.js\n SocialLinks\n index.js\n config.js\n hooks\n useCopyToClipboard.js\n index.js\n layouts\n Footer\n Footer.js\n index.js\n Header\n Header.js\n index.js\n Layout\n Layout.js\n index.js\n pages\n Home\n Home.js\n index.js\n LinkDrop\n LinkDrop.js\n SaveBtn\n index.js\n ShareableCircle\n index.js\n ShareableInput\n index.js\n ShareableLink\n index.js\n index.js\n MyNFTS\n MyNFTS.js\n dataNfts.js\n index.js\n NoNfts\n index.js\n Reveal\n dataReveal.js\n index.js\n routes.js\n setupTests.js\n state\n app.js\n near.js\n utils\n near-utils.js\n state-utils.js\n"},"readme":{"kind":"string","value":"# Simple React App template\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n"}}},{"rowIdx":595,"cells":{"repoName":{"kind":"string","value":"ngocquang_near-tutorial-1"},"tree":{"kind":"string","value":"README.md\ncontract\n Cargo.toml\n src\n lib.rs\npackage.json\n"},"readme":{"kind":"string","value":"near-tutorial-1\n\nnear deploy --wasm-file out/main.wasm --account-id contract1.chihiro.testnet --master-account chihiro.testnet\n\nnear create-account contract1.chihiro.testnet --masterAccount chihiro.testnet\n"}}},{"rowIdx":596,"cells":{"repoName":{"kind":"string","value":"hermes1108_near-mr-giggles-nft-smart-contract"},"tree":{"kind":"string","value":"Cargo.toml\nREADME.md\nbuild.sh\nneardev\n dev-account.env\nsrc\n approval.rs\n enumeration.rs\n events.rs\n internal.rs\n lib.rs\n metadata.rs\n mint.rs\n nft_core.rs\n royalty.rs\n util.rs\n"},"readme":{"kind":"string","value":"# TBD\n"}}},{"rowIdx":597,"cells":{"repoName":{"kind":"string","value":"gyan0890_NEAR-Quest4-Auction"},"tree":{"kind":"string","value":"README.md\nas-pect.config.js\nasconfig.json\npackage.json\nscripts\n 1.dev-deploy.sh\n 2.use-contract.sh\n 3.cleanup.sh\n README.md\nsrc\n as_types.d.ts\n simple\n __tests__\n as-pect.d.ts\n index.unit.spec.ts\n asconfig.json\n assembly\n index.ts\n singleton\n __tests__\n as-pect.d.ts\n index.unit.spec.ts\n asconfig.json\n assembly\n index.ts\n tsconfig.json\n utils.ts\n"},"readme":{"kind":"string","value":"# `near-sdk-as` Starter Kit\n\nThis is a good project to use as a starting point for your AssemblyScript project.\n\n## Samples\n\nThis repository includes a complete project structure for AssemblyScript contracts targeting the NEAR platform.\n\nThe example here is very basic. It's a simple contract demonstrating the following concepts:\n- a single contract\n- the difference between `view` vs. `change` methods\n- basic contract storage\n\nThere are 2 AssemblyScript contracts in this project, each in their own folder:\n\n- **simple** in the `src/simple` folder\n- **singleton** in the `src/singleton` folder\n\n### Simple\n\nWe say that an AssemblyScript contract is written in the \"simple style\" when the `index.ts` file (the contract entry point) includes a series of exported functions.\n\nIn this case, all exported functions become public contract methods.\n\n```ts\n// return the string 'hello world'\nexport function helloWorld(): string {}\n\n// read the given key from account (contract) storage\nexport function read(key: string): string {}\n\n// write the given value at the given key to account (contract) storage\nexport function write(key: string, value: string): string {}\n\n// private helper method used by read() and write() above\nprivate storageReport(): string {}\n```\n\n### Singleton\n\nWe say that an AssemblyScript contract is written in the \"singleton style\" when the `index.ts` file (the contract entry point) has a single exported class (the name of the class doesn't matter) that is decorated with `@nearBindgen`.\n\nIn this case, all methods on the class become public contract methods unless marked `private`. Also, all instance variables are stored as a serialized instance of the class under a special storage key named `STATE`. AssemblyScript uses JSON for storage serialization (as opposed to Rust contracts which use a custom binary serialization format called borsh).\n\n```ts\n@nearBindgen\nexport class Contract {\n\n // return the string 'hello world'\n helloWorld(): string {}\n\n // read the given key from account (contract) storage\n read(key: string): string {}\n\n // write the given value at the given key to account (contract) storage\n @mutateState()\n write(key: string, value: string): string {}\n\n // private helper method used by read() and write() above\n private storageReport(): string {}\n}\n```\n\n## Usage\n\n### Getting started\n\n(see below for video recordings of each of the following steps)\n\n1. clone this repo to a local folder\n2. run `yarn`\n3. run `./scripts/1.dev-deploy.sh`\n3. run `./scripts/2.use-contract.sh`\n4. run `./scripts/2.use-contract.sh` (yes, run it to see changes)\n5. run `./scripts/3.cleanup.sh`\n\n### Videos\n\n**`1.dev-deploy.sh`**\n\nThis video shows the build and deployment of the contract.\n\n[](https://asciinema.org/a/409575)\n\n**`2.use-contract.sh`**\n\nThis video shows contract methods being called. You should run the script twice to see the effect it has on contract state.\n\n[](https://asciinema.org/a/409577)\n\n**`3.cleanup.sh`**\n\nThis video shows the cleanup script running. Make sure you add the `BENEFICIARY` environment variable. The script will remind you if you forget.\n\n```sh\nexport BENEFICIARY=<your-account-here> # this account receives contract account balance\n```\n\n[](https://asciinema.org/a/409580)\n\n### Other documentation\n\n- See `./scripts/README.md` for documentation about the scripts\n- Watch this video where Willem Wyndham walks us through refactoring a simple example of a NEAR smart contract written in AssemblyScript\n\n https://youtu.be/QP7aveSqRPo\n\n ```\n There are 2 \"styles\" of implementing AssemblyScript NEAR contracts:\n - the contract interface can either be a collection of exported functions\n - or the contract interface can be the methods of a an exported class\n\n We call the second style \"Singleton\" because there is only one instance of the class which is serialized to the blockchain storage. Rust contracts written for NEAR do this by default with the contract struct.\n\n 0:00 noise (to cut)\n 0:10 Welcome\n 0:59 Create project starting with \"npm init\"\n 2:20 Customize the project for AssemblyScript development\n 9:25 Import the Counter example and get unit tests passing\n 18:30 Adapt the Counter example to a Singleton style contract\n 21:49 Refactoring unit tests to access the new methods\n 24:45 Review and summary\n ```\n\n## The file system\n\n```sh\n├── README.md # this file\n├── as-pect.config.js # configuration for as-pect (AssemblyScript unit testing)\n├── asconfig.json # configuration for AssemblyScript compiler (supports multiple contracts)\n├── package.json # NodeJS project manifest\n├── scripts\n│ ├── 1.dev-deploy.sh # helper: build and deploy contracts\n│ ├── 2.use-contract.sh # helper: call methods on ContractPromise\n│ ├── 3.cleanup.sh # helper: delete build and deploy artifacts\n│ └── README.md # documentation for helper scripts\n├── src\n│ ├── as_types.d.ts # AssemblyScript headers for type hints\n│ ├── simple # Contract 1: \"Simple example\"\n│ │ ├── __tests__\n│ │ │ ├── as-pect.d.ts # as-pect unit testing headers for type hints\n│ │ │ └── index.unit.spec.ts # unit tests for contract 1\n│ │ ├── asconfig.json # configuration for AssemblyScript compiler (one per contract)\n│ │ └── assembly\n│ │ └── index.ts # contract code for contract 1\n│ ├── singleton # Contract 2: \"Singleton-style example\"\n│ │ ├── __tests__\n│ │ │ ├── as-pect.d.ts # as-pect unit testing headers for type hints\n│ │ │ └── index.unit.spec.ts # unit tests for contract 2\n│ │ ├── asconfig.json # configuration for AssemblyScript compiler (one per contract)\n│ │ └── assembly\n│ │ └── index.ts # contract code for contract 2\n│ ├── tsconfig.json # Typescript configuration\n│ └── utils.ts # common contract utility functions\n└── yarn.lock # project manifest version lock\n```\n\nYou may clone this repo to get started OR create everything from scratch.\n\nPlease note that, in order to create the AssemblyScript and tests folder structure, you may use the command `asp --init` which will create the following folders and files:\n\n```\n./assembly/\n./assembly/tests/\n./assembly/tests/example.spec.ts\n./assembly/tests/as-pect.d.ts\n```\n## Setting up your terminal\n\nThe scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project.\n\nIt uses the following setup:\n\n```sh\n# set your terminal up to have 2 windows, A and B like this:\n┌─────────────────────────────────┬─────────────────────────────────┐\n│ │ │\n│ │ │\n│ A │ B │\n│ │ │\n│ │ │\n└─────────────────────────────────┴─────────────────────────────────┘\n```\n\n### Terminal **A**\n\n*This window is used to compile, deploy and control the contract*\n- Environment\n ```sh\n export CONTRACT= # depends on deployment\n export OWNER= # any account you control\n\n # for example\n # export CONTRACT=dev-1615190770786-2702449\n # export OWNER=sherif.testnet\n ```\n\n- Commands\n\n _helper scripts_\n ```sh\n 1.dev-deploy.sh # helper: build and deploy contracts\n 2.use-contract.sh # helper: call methods on ContractPromise\n 3.cleanup.sh # helper: delete build and deploy artifacts\n ```\n\n### Terminal **B**\n\n*This window is used to render the contract account storage*\n- Environment\n ```sh\n export CONTRACT= # depends on deployment\n\n # for example\n # export CONTRACT=dev-1615190770786-2702449\n ```\n\n- Commands\n ```sh\n # monitor contract storage using near-account-utils\n # https://github.com/near-examples/near-account-utils\n watch -d -n 1 yarn storage $CONTRACT\n ```\n---\n\n## OS Support\n\n### Linux\n\n- The `watch` command is supported natively on Linux\n- To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com)\n\n### MacOS\n\n- Consider `brew info visionmedia-watch` (or `brew install watch`)\n\n### Windows\n\n- Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068)\n"}}},{"rowIdx":598,"cells":{"repoName":{"kind":"string","value":"hrs025_Car-Marktplace"},"tree":{"kind":"string","value":"README.md\nas-pect.config.js\nasconfig.json\npackage.json\nscripts\n 1.init.sh\n 2.run.sh\nsrc\n as-pect.d.ts\n as_types.d.ts\n sample\n __tests__\n index.unit.spec.ts\n asconfig.json\n assembly\n as_types.d.ts\n index.ts\n model.ts\n tsconfig.json\n utils.ts\n tsconfig.json\n utils.ts\n"},"readme":{"kind":"string","value":"# Near-Car\n# Near-Car\n"}}},{"rowIdx":599,"cells":{"repoName":{"kind":"string","value":"laitsky_tamagotchi-on-near"},"tree":{"kind":"string","value":"README.md\nclient\n README.md\n package.json\n public\n index.html\n manifest.json\n robots.txt\n src\n App.js\n App.test.js\n components\n Game.js\n HowToPlay.js\n MintNFT.js\n Navbar.js\n Play.js\n RenderNotConnected.js\n config.js\n index.css\n index.js\n logo.svg\n reportWebVitals.js\n serviceWorker.js\n setupTests.js\n test-utils.js\n theme.js\n utils.js\ncontract\n .idea\n codeStyles\n codeStyleConfig.xml\n modules.xml\n vcs.xml\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n external.rs\n lib.rs\n test.sh\nnft-contract\n Cargo.toml\n README.md\n build.sh\n deploy.sh\n src\n approval.rs\n enumeration.rs\n events.rs\n internal.rs\n lib.rs\n metadata.rs\n mint.rs\n nft_core.rs\n royalty.rs\n"},"readme":{"kind":"string","value":"This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `npm start`\n\nRuns the app in the development mode.<br />\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.<br />\nYou will also see any lint errors in the console.\n\n### `npm test`\n\nLaunches the test runner in the interactive watch mode.<br />\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder.<br />\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.<br />\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `npm run eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can’t go back!**\n\nIf you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.\n\nYou don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n\n### Code Splitting\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting\n\n### Analyzing the Bundle Size\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size\n\n### Making a Progressive Web App\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app\n\n### Advanced Configuration\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration\n\n### Deployment\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/deployment\n\n### `npm run build` fails to minify\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify\nnft-mint-frontend Smart Contract\n==================\n\nA [smart contract] written in [Rust] for an app initialized with [create-near-app]\n\nQuick Start\n===========\n\nBefore you compile this code, you will need to install Rust with [correct target]\n\nExploring The Code\n==================\n\n1. The main smart contract code lives in `src/lib.rs`. You can compile it with\n the `./compile` script.\n2. Tests: You can run smart contract tests with the `./test` script. This runs\n standard Rust tests using [cargo] with a `--nocapture` flag so that you\n can see any debug info you print to the console.\n\n [smart contract]: https://docs.near.org/docs/develop/contracts/overview\n [Rust]: https://www.rust-lang.org/\n [create-near-app]: https://github.com/near/create-near-app\n [correct target]: https://github.com/near/near-sdk-rs#pre-requisites\n [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html\n# Tamagotchi on NEAR\n\n[Deployed app (testnet)](tamagotchi-on-near.vercel.app)\n\nSimple Tamagotchi clone made fully on-chain with NEAR and Rust.\n\nThis repository serves 3 main folders:\n- `client`: Where the frontend code is written — basically the program where the user will interact with. Made using React and Chakra.\n- `contract`: Where the smart contract is written. Made using NEAR SDK and Rust. This folder contains the business logic of the game that meets the game spec (written in the next section) such as feeding and playing.\n- `nft-contract`: The repo to integrate the game with NEP-171 NFT standards so every character is a non-fungible where every account ID has different NFT. Not written from scratch due to the nature of complexities of NFT standards from NEAR itself (still ongoing development to simplify the whole process). It was taken from NEAR NFT contract templates.\n\n# Game Specification\n\n## Tamagotchi character\nEach tamagotchi is an unique NFT based on NEP-171 NFT standards, hence, tradable.\n\n## Feed and hungry mechanics\nThe player can give food to the tamagotchi. There are two types of food:\n1. Meal — fills hungry hearts, adds 1 to tamagotchi weight\n2. Snack — fills one hungry heart, adds 2 to the tamagotchi weight\n\nOverfeeding will make tamagotchi sick\n\n## Play mechanics\nThe player can play with the tamagotchi. The gameplay is simple, the player has to guess where the tamagotchi will be facing. The options are : left, right. If the player guess is correct, then the player wins.\n\nPlaying the game will reduce tamagotchi weight and hungry meter by 1\n\nWinning the game will increase tamagotchi happy heart by 1\n\n## Medicine\nIf tamagotchi is sick, giving medicine will cure it. A sick tamagotchi cannot be fed or played.\n\n## Sickness\nThe tamagotchi will be sick if giving tamagotchi too manys nacks after the hungry meter is 4.\n\nIf tamagotchi get sick, decrease the happiness meter by 3.\n\n# Screenshots\n\nWelcome page:\n\n[](https://postimg.cc/cts5FLbb)\n\nMint page (if user has yet to mint the NFT tamagotchi character):\n\n[](https://postimg.cc/JtPT1mgR)\n\nPlay page:\n\n[](https://postimg.cc/0r2fXFNF)\n# Rust Smart Contract Template\n\n## Getting started\n\nTo get started with this template:\n\n1. Click the \"Use this template\" button to create a new repo based on this template\n2. Update line 2 of `Cargo.toml` with your project name\n3. Update line 4 of `Cargo.toml` with your project author names\n4. Set up the [prerequisites](https://github.com/near/near-sdk-rs#pre-requisites)\n5. Begin writing your smart contract in `src/lib.rs`\n6. Test the contract \n\n `cargo test -- --nocapture`\n\n8. Build the contract\n\n `RUSTFLAGS='-C link-arg=-s' cargo build --target wasm32-unknown-unknown --release`\n\n**Get more info at:**\n\n* [Rust Smart Contract Quick Start](https://docs.near.org/docs/develop/contracts/rust/intro)\n* [Rust SDK Book](https://www.near-sdk.io/)\n"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":5,"numItemsPerPage":100,"numTotalItems":2863,"offset":500,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sInJlcG9JZHMiOlsiNjY0ZjcyN2FhYzExZDI3MTU4YjczNzZmIl0sImlhdCI6MTc5MzM1NzIxMCwianRpIjoiZTVjZjMxYjItNjRjNi00ZTFlLWJkYjQtZjRhYThlMGY3OGY2Iiwic3ViIjoiL2RhdGFzZXRzL2pjYXJib25uZWxsL3N0cnVjdFR1bmluZ05FQVIiLCJleHAiOjE3OTMzNjA4MTAsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.5Ok_ga8Crz2hlpIgI3kGSB_60ckrqmz4ViAH6XU4rcIZEpQAZ-j-Ey86iCdjxceegE97ivJSP-jp-rnXmJHfDQ","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":2863,"numBytesParquet":54906025},{"config":"default","split":"val","numRows":319,"numBytesParquet":7435508}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
repoName stringlengths 7 77 | tree stringlengths 0 2.85M | readme stringlengths 0 4.9M |
|---|---|---|
NEAR-Edu_portal | .eslintrc.js
README.md
components
header.module.css
helpers
airtable.ts
countries.ts
email.ts
migrateFromAirtable.ts
near.ts
nextAuthEmailProvider.ts
paths.ts
profile.ts
registrations.ts
session.ts
statusCodes.ts
string.ts
time.ts
timeZones.ts
types.ts
... | # Overview
This project is a work in progress.
The aim has been for this portal to replace this Airtable form: https://airtable.com/shrr8CbYRDHflkgI9 which saves to https://airtable.com/appncY8IjPHkOVapz/tblFBQY4popYmxfkh/viwgxFeJIGB50pkvj?blocks=hide
## Why?
- to improve student experience
- to clean up our data (... |
openwebbuild_near-contract-registry | README.md
|
| # NEAR Contract Registry
## Why Contract Registry?
1. **Improve contract metadata discoverability.** It's frequently asked by developers about where to find the mainnet/testnet contract accounts, DApp URLs and source code of the smart contracts on NEAR. To make the contract metadata more discoverable, we created this... |
itsdivgithub_ZDeFiSwap-Near | README.md
zswap-contracts-main
Cargo.toml
README.md
build.sh
deploy.sh
factory
Cargo.toml
src
dev.rs
error.rs
ft_storage.rs
lib.rs
pool.rs
integration-tests
Cargo.toml
tests
burn.rs
... | # ZSwap
## Step 0: Create a new account
0. Install near-cli
```sh
$ npm install --global near-cli
```
1. Create a new account on [MyNearWallet testnet](https://testnet.mynearwallet.com/)
2. Authorize NEAR CLI, following the commands it gives you:
```sh
# login to zswap.testnet account
$ near login --walletUrl htt... |
guille-near_mintickt | .env
README.md
babel.config.js
changelog.md
package.json
public
index.html
themes
dark
theme.css
light
theme.css
webflow.js
src
Routes.js
assets
backgrounds
border-gradient-btn-small.svg
border-gradient-menu-small.svg
... | # Mintickt
Front end for Mintickt
|
near-examples_NFT-Examples | NFT-example
.github
dependabot.yml
scripts
readme-quick-deploy.sh
workflows
readme-ci.yml
tests.yml
.gitpod.yml
Cargo.toml
README-Windows.md
README.md
integration-tests
rs
Cargo.toml
src
t... | # TBD
# TBD
Non-fungible Token (NFT)
===================
>**Note**: If you'd like to learn how to create an NFT contract from scratch that explores every aspect of the [NEP-171](https://github.com/near/NEPs/blob/master/neps/nep-0171.md) standard including an NFT marketplace, check out the NFT [Zero to Hero Tutorial](h... |
near_boilerplate-template-keypom | .github
ISSUE_TEMPLATE
01_BUG_REPORT.md
02_FEATURE_REQUEST.md
03_CODEBASE_IMPROVEMENT.md
04_SUPPORT_QUESTION.md
BOUNTY.yml
config.yml
PULL_REQUEST_TEMPLATE.md
labels.yml
workflows
codeql.yml
deploy-to-console.yml
labels.yml
... | <h1 align="center">
<a href="https://github.com/near/boilerplate-template-keypom">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/near/boilerplate-template-keypom/main/docs/images/pagoda_logo_light.png">
<source media="(prefers-color-scheme: light)" sr... |
mrtlive_NCD-Bookshop-Example | README.md
asconfig.json
assembly
as_typed.d.ts
index.ts
model.ts
tsconfig.json
index.html
neardev
dev-account.env
node_modules
.bin
sha.js
@as-covers
assembly
CONTRIBUTING.md
README.md
index.ts
package.json
tsconfig.... | # require-main-filename
[](https://travis-ci.org/yargs/require-main-filename)
[](https://coveralls.io/r/yargs/require-main-filename?branch=master)
[.
|
evolution001_Near-Project | README.md
as-pect.config.js
asconfig.json
package.json
scripts
1.dev-deploy.sh
2.use-contract.sh
3.cleanup.sh
README.md
src
as_types.d.ts
simple
__tests__
as-pect.d.ts
index.unit.spec.ts
asconfig.json
assembly
index.ts
singleton
... | ## Setting up your terminal
The scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project.
It uses the following setup:
```sh
# set your terminal up to have 2 windows, A and B like this:
┌─────────────────────────────────┬─────────────────────────────────┐
│ ... |
Peersyst_Landstead | .idea
workspace.xml
README.md
build
css
bootstrap.min.css
font-awesome.min.css
fonts
fontawesome-webfont.svg
nano.css
ngToast.min.css
start.html
tests
start.html
tests.js
vendors
FileSaver.min.js
bitcoinjs-min.js
... | # LANDSTEAD #
## Land And Immovable Property Ownership Register ##
Implementation of a Proof of Concept (POC) of an ownership register or cadastral system to prove the viability and usability of blockchain technologym for such a system in real life situations. The system is based on unique identifications and immutable... |
kmiyachi_NearCertification | Cargo.toml
README.md
build.sh
deploy.sh
dev-deploy.sh
init-args.js
rustfmt.toml
src
contract.rs
lib.rs
utils.rs
| # NEAR Smart Contract Rust Template
Project structure for writing smart contracts in Rust for NEAR Protocol
# Required Software
- Rust 1.58 + cargo
- Node.js
- NEAR CLI 3.1
# Authors
- Jacob Lindahl <jacob@near.foundation> [@sudo_build](https://twitter.com/sudo_build)
|
PotLock_sui-contracts | .github
ISSUE_TEMPLATE
BOUNTY.yml
README.md
| # sui-contracts
PotLock on Sui, built on move smart contracts
|
oleksanderkorn_nearvember-challenge-6 | .eslintrc.yml
.gitpod.yml
README.md
babel.config.js
package.json
src
App.js
__mocks__
fileMock.js
assets
logo-black.svg
logo-white.svg
config.js
global.css
index.html
index.js
jest.init.js
main.test.js
utils.js
wallet
login
index.ht... | # nearvember-challenge-6
This [React] app was initialized with [create-near-app]
# Quick Start
To run this project locally:
1. Prerequisites: Make sure you've installed [Node.js] ≥ 12
2. Install dependencies: `yarn install`
3. Run the local development server: `yarn dev` (see `package.json` for a
full list of `s... |
Kuro-Bryan_Biblioteca_Gamer | README.md
contract
README.md
babel.config.json
build.sh
deploy.sh
package-lock.json
package.json
src
contract.ts
model.ts
tsconfig.json
frontend
App.js
index.html
index.js
near-interface.js
near-wallet.js
package-lock.json
package.json
star... | # Contrato Biblioteca gamer
El contrato inteligente guarda datos de los juegos brindados por el usuario.
<br />
# Inicio Rapido
1. Asegurate de tener instalado [node.js](https://nodejs.org/en/download/package-manager/) >= 16.
2. Installar [`NEAR CLI`](https://github.com/near/near-cli#setup)
<br />
## 1. Construir... |
amusnation_nearmint | .env
README.md
package.json
public
index.html
manifest.json
robots.txt
src
App.js
index.js
near-interface.js
near-wallet.js
| # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view... |
Learn-NEAR_NCD.L1.sample--promises | .gitpod.yml
README.md
babel.config.js
contract
README.md
as-pect.config.js
asconfig.json
assembly
__tests__
as-pect.d.ts
main.spec.ts
as_types.d.ts
index.ts
model.ts
tsconfig.json
compile.js
package-lock.json
package.json
copy-d... | promises Smart Contract
==================
A [smart contract] written in [AssemblyScript] for an app initialized with [create-near-app]
Quick Start
===========
Before you compile this code, you will need to install [Node.js] ≥ 12
Exploring The Code
==================
1. The main smart contract code lives in `assem... |
near-examples_indexer-tx-watcher-example-lake | Cargo.toml
README.md
src
configs.rs
main.rs
| Indexer that catches txs for specific contract(s)
=================================================
**This project is a copy of https://github.com/near-examples/indexer-tx-watcher-example but is migrated to [NEAR Lake Framework](https://github.com/near/near-lake-framework). We keep them both separately as they show di... |
kherld-hussein_near_ticket | .github
workflows
codeql-analysis.yml
Cargo.toml
README.md
SECURITY.md
|
build.sh
deploy.sh
dev-deploy.sh
init-args.js
rustfmt.toml
src
lib.rs
| # NEAR Smart Event RSVP Contract
RSVP just got easy...
Create or get ticket to any event
Project structure for writing smart contracts in Rust for NEAR Protocol
# Required Software
- Rust 1.58 + cargo
- Node.js
- NEAR CLI 3.1
# Author
- Khalid Hussein <kherld11@gmail.com> [@kherldhussein](https://twitter.com/kh... |
Learn-NEAR_starter--vue-and-tailwind | .eslintrc.js
README.md
babel.config.js
package.json
postcss.config.js
public
index.html
src
main.js
tailwind.config.js
| # vue-3 + tailwindui
## Project setup
```
yarn install
```
### Compiles and hot-reloads for development
```
yarn serve
```
### Compiles and minifies for production
```
yarn build
```
### Lints and fixes files
```
yarn lint
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/)... |
kimchi9199_blockchain-homework | .gitpod.yml
README.md
contract
Cargo.toml
README.md
neardev
dev-account.env
src
lib.rs
target
.rustc_info.json
release
.fingerprint
Inflector-34b3ed2ea6d72e66
lib-inflector.json
ahash-c6faee060863811c
... | # blockchain-homework
Hello NEAR!
=================================
A [smart contract] written in [Rust] for an app initialized with [create-near-app]
Quick Start
===========
Before you compile this code, you will need to install Rust with [correct target]
Exploring The Code
==================
1. The main smart co... |
nhtera_near-simple-vote | .gitpod.yml
.postcssrc.json
Notes.txt
README.md
babel.config.json
contract
Cargo.toml
README.md
compile.js
src
lib.rs
package.json
src
App.js
__mocks__
fileMock.js
assets
logo-black.svg
logo-white.svg
config.js
global.css
index.html
index.js
... | near-simple-vote
==================
This [React] app was initialized with [create-near-app]
Quick Start
===========
To run this project locally:
1. Prerequisites: Make sure you've installed [Node.js] ≥ 12
2. Install dependencies: `yarn install`
3. Run the local development server: `yarn dev` (see `package.json` for... |
mattlockyer_dolla | .eslintrc.js
README.md
contract
Cargo.toml
build.sh
src
lib.rs
deploy
mainnet.js
testnet.js
package.json
src
App.js
Bill.js
Bills.js
Capture.js
HelloMessage.js
Printer.js
index.html
index.js
state
app.js
near.js
utils
state.js
t... | # Dolla
> Cash rules everything around me, C.R.E.A.M., get the money, dollar dollar bill, y'all
NEAR Money Printer Go Brrr!
Print YUUUGE amounts of "NEAR CASH" bills and drop that STIMI!
Receivers can claim to an existing account or use funds to set up a brand new NEAR Account!
# React 17, Parcel with useContext a... |
gescobar129_project_relik | .gitpod.yml
License.md
Project Relik
Assets
Input Controls
Character Controls.cs
Pixel UI
Scripts
CardProfile.cs
Editor
CreateBaseMenu.cs
CreateExtrasMenu.cs
CreateRoundedMenu.cs
... | # Hello NEAR Contract
The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.
```ts
@NearBindgen({})
class HelloNear {
greeting: string = "Hello";
@view // This method is read-only and can be called for free
get_greeting(): string {
return this.greeting;
}
... |
LanNhi1997_contact-card | .gitpod.yml
README.md
babel.config.js
contract
Cargo.toml
src
lib.rs
package.json
src
App.js
__mocks__
fileMock.js
assets
logo-black.svg
logo-white.svg
config.js
global.css
index.html
index.js
jest.init.js
main.test.js
utils.js
wallet
... | contact-card
==================
This [React] app was initialized with [create-near-app]
Quick Start
===========
To run this project locally:
1. Prerequisites: Make sure you've installed [Node.js] ≥ 12
2. Install dependencies: `yarn install`
3. Run the local development server: `yarn dev` (see `package.json` for a
... |
metaseed-project_template-contracts | GameManager
Cargo.toml
Readme.md
src
lib.rs
Readme.md
Registry
Cargo.toml
README.md
instruction.md
src
lib.rs
SimpleFT
Cargo.toml
README.md
build.bat
build.sh
ft
Cargo.toml
src
lib.rs
rustfmt.toml
test-contract-defi
... | # Folder that contains wasm files
Fungible Token (FT)
===================
Example implementation of a [Fungible Token] contract which uses [near-contract-standards] and [simulation] tests. This is a contract-only example.
[Fungible Token]: https://nomicon.io/Standards/FungibleToken/Core.html
[near-contract-standa... |
near_near-account-id-rs | .github
workflows
ci.yml
dep-reqs.yml
release-plz.yml
CHANGELOG.md
Cargo.toml
README.md
fuzz
Cargo.toml
README.md
fuzz_targets
borsh.rs
serde.rs
src
account_id.rs
account_id_ref.rs
borsh.rs
errors.rs
lib.rs
serde.rs
test_data.rs
val... | ## Fuzzing `near-account-id`
### Setup
First, ensure [`cargo-fuzz`](https://github.com/rust-fuzz/cargo-fuzz) is installed:
```console
cargo install cargo-fuzz
```
### Execution
Finally, there are two fuzzing targets available: one for [`serde`](https://github.com/serde-rs/serde) and another for [`borsh`](https://g... |
humanman_tic-tac-toe-contract | README.md
as-pect.config.js
asconfig.json
assembly
__tests__
as-pect.d.ts
main.spec.ts
as_types.d.ts
main.ts
model.ts
tsconfig.json
package.json
script.sh
src
index.js
| # Tic-Tac-Toe as a NEAR contract
Video demo: [here](https://drive.google.com/file/d/1L0licLk5sSTQ21iwIp3QHHPRhX8hhfC3/view)
Figma wireframes: [here](https://www.figma.com/file/reMNlA1lKaM1hFthWbwvrP/Untitled?node-id=3%3A117)
## Install dependencies
```
yarn
```
## Build and Deploy the contract
```
npx asb
near dev-... |
gacarg_ttt | Cargo.toml
README.md
build.sh
neardev
dev-account.env
src
lib.rs
target
.rustc_info.json
debug
.fingerprint
Inflector-ddc8cd320e9ecbdc
lib-inflector.json
ahash-4793548205fc6e16
lib-ahash.json
... | # ttt
Unfinished Tic tac toe with save in Near
|
idea404_xcc-view-test | .github
workflows
tests.yml
README.md
contract
index.js
package-lock.json
package.json
test
main.ava.js
| # NEAR Cross Contract Calls with View or Change Methods
This repo shows how cross contract calls behave when placed within view or change methods. Specifically, with the current syntax for [NEAR SDK JS](https://github.com/near/near-sdk-js), every cross contract call becomes a function call. Function calls can not be c... |
microchipgnu_bonsai | .devcontainer
devcontainer.json
.eslintrc.json
.github
workflows
promote-develop-to-main.yml
.idea
jsLibraryMappings.xml
modules.xml
prettier.xml
vcs.xml
README.md
next.config.js
package.json
public
llm-functions-data
generate-bos-widget
code
promp... | # NEAR Discovery (BOS)
## Setup & Development
Initialize repo:
```
pnpm i
```
Start development version:
```
pnpm dev
```
## Local Component Development
1. Run an instance of a component server like [near/bos-loader](https://github.com/near/bos-loader) which serves component code in the following format
```j... |
near-examples_collection-examples-rs | .eslintrc.yml
README.md
getData.js
package.json
results
example-results
get-data
get_lookup_map_results.js
get_tree_map_results.js
get_unordered_map_results.js
index.html
set-data
add_lookup_map_results.js
add_tree_map_results.j... | # NEAR Rust Collection Examples using `near-sdk-rs`
This repository serves to demonstrate differences in gas consumption when storing or retrieving data from the NEAR blockchain using [Rust](https://www.rust-lang.org/) collection methods found in [`near-sdk-rs`](https://github.com/near/near-sdk-rs).
After running `se... |
letangphuquy_ltpq-hi-near | Cargo.toml
Makefile.toml
rust-toolchain.toml
rustfmt.toml
src
lib.rs
| |
near-x_near-developers | README.md
| # near-developers
Welcome to the NEAR Developer Community
|
Laser420_DAO_Managed_Vault | .github
workflows
test.yml
README.md
broadcast
DeployGnosisChiado.s.sol
100
run-1687707807.json
run-1687707814.json
run-latest.json
10200
run-1687676494.json
run-1687676751.json
run-1687678043.json
run-16... | <br />
<div align="center">
<img src="https://static.sismo.io/readme/top-main.png" alt="Logo" width="150" height="150" style="borderRadius: 20px">
<h3 align="center">
Sismo Connect
</h3>
<p align="center">
Made by <a href="https://docs.sismo.io/" target="_blank">Sismo</a>
</p>
<p align="center"... |
GiselleNessi_crea | .github
workflows
tests.yml
.gitpod.yml
README.md
contract
Cargo.toml
README.md
build.sh
deploy.sh
src
lib.rs
target
.rustc_info.json
release
.fingerprint
Inflector-10c620bdb7f37e48
lib-inflector.json
... | # Count on NEAR 🧮
[](https://docs.near.org/tutorials/welcome)
[](https://gitpod.io/#/https://github.com/near-examples/counter-rust)
[](https://docs.near.or... |
near_wasmer | .cargo
config.toml
.github
ISSUE_TEMPLATE
---bug-report.md
---feature-request.md
--question.md
BOUNTY.yml
codecov.yml
pull_request_template.md
stale.yml
.tarpaulin.toml
ATTRIBUTIONS.md
LLVM Exceptions to the Apache 2.0 License
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUT... | <div align="center">
<a href="https://wasmer.io" target="_blank" rel="noopener noreferrer">
<img width="300" src="https://raw.githubusercontent.com/wasmerio/wasmer/master/assets/logo.png" alt="Wasmer logo">
</a>
<p>
<a href="https://github.com/wasmerio/wasmer/actions?query=workflow%3Abuild">
<img s... |
frol_block-and-wine-web4-demo | Cargo.toml
README.md
src
index.html
lib.rs
| Web4 Demo on NEAR protocol for Block & Wine Community
=====================================================
[Web4](https://web4.near.page) is a gateway to the smart contracts deployed to NEAR protocol.
This demo just shows [blockandwine.com](https://blockandwine.com) landing page that lives on NEAR chain, and thus an... |
gpteth_- | ArtifyNet
NodeJsServer
src
controllers
ArtworkController.js
AuctionController.js
UserController.js
routes
artworkRoutes.js
auctionRoutes.js
userRoutes.js
server.js
ReactWeb... | # CryptoKingdom MMORPG
CryptoKingdom is a blockchain-based Massively Multiplayer Online Role-Playing Game (MMORPG) where players can explore virtual worlds, own land, build kingdoms, engage in battles, and trade while earning cryptocurrency.
## Project Structure
The project consists of three main components:
1. **E... |
near-ndc_wasm-arithmetic-exception | Cargo.toml
README.md
src
lib.rs
| # wasm-arithmetic-exception
Minimum code to exploit wasm arithmetic exception in the NEAR Core Runtime.
Issue: https://github.com/near/nearcore/issues/9393
|
jayden-dang_smart-contract-vugomars-near | Cargo.toml
build.sh
deploy.sh
src
lib.rs
| |
itissandeep98_mazout | .eslintrc.json
.github
workflows
main.yml
README.md
config
constants.js
supabase.js
layer0.config.js
layout
LayoutWrapper.js
Meta.js
next.config.js
package.json
pages
_app.js
api
hello.js
home.js
index.js
sitemap.xml.js
postcss.config.js
public
Plug.svg
ca... | # POC for Electric Vehicle Charging station
## Tablet Views
 {
// Get who is calling the method and how much $NEAR they attached
let donor = near.predecessorAccountId();
let donationAmount: bigint = near.attachedDeposit() as bigint;
let donatedSoFa... |
NEARBuilders_CommunityGroups | README.md
|
SUMMARY.md
about
DAO.md
NFT.md
Wallet.md
| # Community Groups
## Quickstart
{% content-ref url="https://app.gitbook.com/o/wxNIOkA8NaT6omjLbqYh/s/eYMvXqEeHTuMsh7JRboR/" %}
[Start Here](https://app.gitbook.com/o/wxNIOkA8NaT6omjLbqYh/s/eYMvXqEeHTuMsh7JRboR/)
{% endcontent-ref %}
{% content-ref url="https://app.gitbook.com/o/wxNIOkA8NaT6omjLbqYh/s/paqK4UTfbHO8Ts... |
johnedvard_NCD-I | README.md
as-pect.config.js
asconfig.json
package-lock.json
package.json
scripts
1.dev-deploy.sh
2.use-contract.sh
3.cleanup.sh
README.md
src
as_types.d.ts
singleton
__tests__
as-pect.d.ts
index.unit.spec.ts
asconfig.json
assembly
game.... | ## Summary
This is a project for NEAR certified program level 1. This project was cloned from the starter template, [starter--near-sdk-as](https://github.com/Learn-NEAR/starter--near-sdk-as)
This project is based on the Japanese game, [Shiritori Game](https://en.wikipedia.org/wiki/Shiritori), where you have to write ... |
GigameshGarages_VajraNet | .buildkite
contracts-eth.yml
contracts-near.yml
npm-package.yml
pipeline.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
MIGRATION.md
README.md
SPEC.md
cli
commands
clean.js
danger-deploy-myerc20.js
danger-submit-invalid-near-block.js
eth-dump.js
near-dump... | # NearBridge
TruffleFramework template with travis-ci.org and coveralls.io configured
[](https://travis-ci.org/nearprotocol/bridge)
[](https://co... |
Learn-NEAR-Hispano_NCD2--CodingHope | .cache
00
c62409ca3d86638b58edc3bca7c937.json
01
cb1e1cc5f502bc59e2ff7c009a6cff.json
02
960fe6f943f643207e5758e927c5b6.json
9e41a704a7ebc97c68c5f4606bac50.json
03
1d87e942581dd7e561b25b0f2147aa.json
3f6e2cef26ee95ce0d8ce1ac0f1568.json
04
906dcc... | # cross-spawn
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-d... |
esaminu_test-rs-boilerplate-8 | .eslintrc.yml
.github
ISSUE_TEMPLATE
01_BUG_REPORT.md
02_FEATURE_REQUEST.md
03_CODEBASE_IMPROVEMENT.md
04_SUPPORT_QUESTION.md
config.yml
PULL_REQUEST_TEMPLATE.md
labels.yml
workflows
codeql.yml
deploy-to-console.yml
labels.yml
lock.... | <h1 align="center">
<a href="https://github.com/near/boilerplate-template-rs">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_light.png">
<source media="(prefers-color-scheme: light)" srcset="ht... |
meghaa105_near-stackoverflow-64378144 | Cargo.toml
build.sh
src
lib.rs
| |
PotLock_next-app | .github
ISSUE_TEMPLATE
bug_report.md
enhancement.md
feature_request.md
README.md
| # next-app
NextJS application built for PotLock (on NEAR)
|
IgnacioMolinaPortoles_NCD--Memonear | README.md
as-pect.config.js
asconfig.json
package.json
src
as_types.d.ts
singleton
__tests__
as-pect.d.ts
index.unit.spec.ts
asconfig.json
assembly
index.ts
models.ts
tsconfig.json
utils.ts
| # NCD Project Memonear
🎬 [Loom demo](https://www.loom.com/share/6f72b278a5fa4dbe8ba460a530bb06a7)
🎨 [Figma design](https://www.figma.com/file/CysKjUzYeDr2qUTBw5UohU/Memonear?node-id=0%3A1)
## Install dependencies
```
yarn
```
## Build and Deploy the contract
```
yarn build
near dev-deploy ./build/debug/singleto... |
JIC1816_Car-Near-Me | README.md
as-pect.config.js
asconfig.json
neardev
dev-account.env
node_modules
.bin
sha.js
.package-lock.json
@as-covers
assembly
CONTRIBUTING.md
README.md
index.ts
package.json
tsconfig.json
core
CONTRIBUTIN... | # ci-info
Get details about the current Continuous Integration environment.
Please [open an
issue](https://github.com/watson/ci-info/issues/new?template=ci-server-not-detected.md)
if your CI server isn't properly detected :)
[](https://www.npmjs.com/package/ci-info)
[!... |
khanhhuy-bkdn_even-odd-rust | Cargo.toml
build.sh
flags.sh
src
lib.rs
test.sh
tests
sim
first_tests.rs
main.rs
utils.rs
| |
jasperdg_near-collection-behaviour | Cargo.toml
scripts
build.sh
create_account.sh
delete.sh
deploy.sh
test.sh
src
lib.rs
| |
K-dizzled_lab1-k-dizzled-sokoban-rust | Cargo.toml
build.sh
neardev
dev-account.env
rust_near_sokoban
Cargo.toml
src
auxiliary.rs
board.rs
lib.rs
sb_token
Cargo.toml
src
lib.rs
| |
HoBocPhat_voting_app | contract
Cargo.toml
README.md
build.js
src
lib.rs
package.json
src
assets
gray_near_logo.svg
near.svg
config.js
index.html
main.js
wallet
login
index.html
| # Voting App
Allow voting upon a specific item on NEAR.
## Testing
To test run:
```bash
cargo test --package voting-app -- --nocapture
```
|
near-mezze_NCD--reading-library | README.md
as-pect.config.js
asconfig.json
package-lock.json
package.json
scripts
1.dev-deploy.sh
2.use-contract.sh
3.cleanup.sh
README.md
src
as_types.d.ts
library
__test__
as-pect.d.ts
index.unit.spec.ts
asconfig.json
assembly
index.ts... | 📑 Exploring the NEAR library smart contract methods
==================
The following commands allow you to interact with the smart contract methods using the NEAR CLI (for this you need to have a provisional smart contract deployed).
Information: the command for rate will require especific data (AccountId, Rate)
... |
near-everything_gigs-board | .vscode
settings.json
NOTES.txt
README.md
firebase.json
package.json
public
index.html
manifest.json
robots.txt
src
App.css
hooks
useTypedNavigator.ts
index.css
logo.svg
react-app-env.d.ts
routes
NavigationProps.ts
services
addCard.ts
deleteCar... | # Gigs Board
Just a simple react app with [react-trello](https://github.com/rcdexta/react-trello), served from the [Gig.Board Widget](https://near.org/near/widget/ComponentDetailsPage?src=efiz.near/widget/Gigs.Board), hooked up via [near-social-bridge](https://github.com/wpdas/near-social-bridge);
```json
"scripts": ... |
lunafromthemoon_almostThere | .cache
01
52781c4b348f711d27b03d2292bcd9.json
9dc95d0576f2bd87633c777953be1b.json
9e133f0b6efb58d1119d6741ecc338.json
02
972b2e56e14bedb928b0e2102dd45b.json
04
7bd5fb3115f10649d6a476076c8b61.json
07
e97d301dc9c94c56ca437e8a2ab9c3.json
09
948310... | # function-bind
<!--
[![build status][travis-svg]][travis-url]
[![NPM version][npm-badge-svg]][npm-url]
[![Coverage Status][5]][6]
[![gemnasium Dependency Status][7]][8]
[![Dependency status][deps-svg]][deps-url]
[![Dev Dependency status][dev-deps-svg]][dev-deps-url]
-->
<!-- [**.
>
> The JavaScript runtime has not been fully audited. For creating smart contracts that hold value please use [`near-sdk-rs`](https://github.com/near/near-sdk-rs).
>
> Help contribute!
>
> - [Report issues you enco... |
mehmetlevent_near_todo-crud | README.md
asconfig.json
assembly
as_types.d.ts
index.ts
model.ts
tsconfig.json
index.html
package.json
tests
index.js
| # near_todo-crud
patika.dev
|
gnoblin_roketo-hackathon-deblockle | Assets
DampedSpringMotionCopier
Code
DampedSpringMotionCopier.Utils.cs
DampedSpringMotionCopier.cs
TooltipAttribute.cs
Docs
Html
DampedSpringMotionCopier.html
Scripts
ActionProcessors
CubeAction.cs
Di... | # roketo-hackathon-deblockle
Unity3d webgl client for Deblockle game
(based on awesome https://github.com/uz0/lab2-vdikan-near-deblockle smart-contracts)
Video (showing the fresh version of the gameplay):
https://user-images.githubusercontent.com/639995/188195681-000b0e63-94b3-4222-aa54-0778eac70a67.mp4
Presentati... |
near_near-abi-client-rs | .github
workflows
release-plz.yml
test.yml
CHANGELOG.md
Cargo.toml
README.md
examples
delegator-generation
Cargo.toml
build.rs
src
adder.json
lib.rs
tests
mod.rs
delegator-macro
Cargo.toml
src
add... | <!-- markdownlint-disable MD014 -->
<div align="center">
<h1><code>near-abi-client-rs</code></h1>
<p>
<strong>Library to generate Rust client code with <a href="https://github.com/near/workspaces-rs">workspaces-rs</a> from <a href="https://github.com/near/abi">ABI schemas</a> on NEAR</strong>
</p>
<p>
... |
mmurat_new_simple | README.md
asconfig.json
assembly
index.ts
tsconfig.json
index.js
package.json
tests
index.js
| |
hdriqi_piece-app | README.md
babel.config.js
package.json
postcss.config.js
src
App.js
assets
how-it-works.svg
components
Activity.js
Footer.js
ImgCrop.js
Loading.js
Nav.js
ProfileCard.js
config.js
index.html
index.js
near.js
pages
Explore.js
... | Piece Interface
==================
The interface for Piece Protocol, An incentivized protocol both for creators and supporters. Piece Protocol is built on top of NEAR blockchain and Sia decentralized storage.
[Try Piece on Sia](https://siasky.net/_AUBQQJF4mYSB2iqUx30ZA6U4iAMmezZDFeVMERZXXAXZQ)
Video Demo
==========... |
Mrquinnd_nfnft | 401.html
README.md
backup.html
counter.html
css
normalize.css
spamnft.webflow.css
webflow.css
div.css
documents
angry_face.json
idx.html
imageClick.js
images
elon.json
index.html
js
webflow.js
| # nfnft - non-functional-non-fungible-token
Counter component using JS + Jquery to perform asynchronous updates of an NFT infection counter.
|
lawcia_near-sweet-nfts | README.md
contract
Cargo.toml
README.md
build.sh
src
approval.rs
enumeration.rs
internal.rs
lib.rs
metadata.rs
mint.rs
nft_core.rs
royalty.rs
frontend
README.md
package.json
public
index.html
manifest.json
... | # RUST Contract
## Scripts
Assumes you have a bash terminal
- Build the contract `sh build.sh` or `bash build.sh`
# NEAR Sweet NFTs
Challenge 2: NEAR NFT Smart Contract
This website is a gallery for the Sweet NFTs on NEAR.
Hosted on Netlify: https://sweet-nfts-testnet-near.netlify.app/
Users can login using their... |
near_jsonrpc-benchmark | .github
ISSUE_TEMPLATE
BOUNTY.yml
README.md
benchmark.yml
run.sh
view_access_key_list.yml
view_account.yml
view_call.yml
view_state.yml
| # NEAR JSON RPC benchmark
## Install [`drill`](https://github.com/fcsonline/drill) with dependencies and run the benchmark
* Install [`cargo`](https://doc.rust-lang.org/cargo/getting-started/installation.html)
```bash
$ curl https://sh.rustup.rs -sSf | sh
$ source $HOME/.cargo/env
```
* Install depe... |
mhassanist_nftizer-nft-minter-smart-contract-near-protocol | Cargo.toml
README.md
src
lib.rs
| # NFTizer | NFT Minter on NEAR Protocol
This is a ready-to-use smart contract for minting NFTs on NEAR blockchain. Below is hwo you may use it. I'm assuming you already familiar with NEAR and have installed Rust blockchain and near-cli.
## Smart Contract Sample Usage
### Build
```
env 'RUSTFLAGS=-C link-arg=-s' car... |
midou10_Near_Token_Contract | .gitpod.yml
README.md
as-pect.config.js
asconfig.js
assembly
__tests__
as-pect.d.ts
context.json
main.spec.ts
as_types.d.ts
main.ts
model.ts
tsconfig.json
babel.config.json
dist
gray_near_logo.f4fe4645.svg
index.html
logo.b37d81ec.svg
near.45fb95a6.svg
src... | ## Near decentralized app: token delegation app
### Requirements
##### IMPORTANT: Make sure you have the latest version of NEAR Shell and Node Version > 10.x
1. [Node.js](https://nodejs.org/en/download/package-manager/)
2. (optional) near-shell
```
npm i -g near-shell
```
### To run on NEAR testnet
```bash
npm ins... |
happy-zhangbo_near-status-one | .github
dependabot.yml
workflows
tests.yml
.gitpod.yml
.travis.yml
Cargo.toml
README-Gitpod.md
README-Windows.md
README.md
borsh.js
frontend
App.js
config.js
index.html
index.js
integration-tests
rs
Cargo.toml
src
tests.rs
ts
main.ava.ts
packag... | Status Message
==============
[](https://gitpod.io/#https://github.com/near-examples/rust-status-message)
<!-- MAGIC COMMENT: DO NOT DELETE! Everything above this line is hidden on NEAR Examples page -->
This smart contract saves and records the status me... |
NEAR-BRASIL_ref | .vscode
launch.json
README.md
backend
.eslintrc.js
docker-compose.db.yml
docker-compose.migrate.yml
docker-compose.studio.yml
docker-compose.yml
near_cli_examples
croncat.sh
ref-finance.sh
nest-cli.json
package-lock.json
package.json
prisma
migrations
... | # Overview
Ref Status Explorer and Community Application
The application runs at https://ref.nearchaintools.com and is connected to NEAR blockchain mainnet data.
Project page with the To-Do section and collected feedback from the community could be found [here](https://imiroslav.notion.site/NearTools-com-for-Ref-Finan... |
haardikk21_learnweb3-junior-ceramic | .eslintrc.json
README.md
next.config.js
package-lock.json
package.json
pages
_app.js
api
hello.js
index.js
public
vercel.svg
styles
Home.module.css
globals.css
| # Ceramic
Ceramic is a decentralized data network, that allows for building composable Web3 applications. Since Ceramic decentralizes application databases, application developers can reuse data across applications and make them automatically interoperable.
In the course of this... |
ketyung_tm_collections_contract | Cargo.toml
LICENSE.md
build.sh
readme.md
src
collections_manage.rs
collections_view.rs
ext.rs
lib.rs
tests.rs
ticket_mint.rs
term_tests1.txt
| |
lflozano_NCD---Near | .idea
misc.xml
modules.xml
vcs.xml
README.md
as-pect.config.js
asconfig.json
package-lock.json
package.json
src
as_types.d.ts
contrato
__tests__
as-pect.d.ts
index.unit.spec.ts
asconfig.json
assembly
index.ts
model.ts
tsconf... | ```sh
npm install
```
ó
```sh
yarn install
```
Una vez hecho esto, podemos compilar el código.
```sh
npm run build
```
ó
```sh
yarn build
```
El contrato compilado en WebAssembly se guarda en la carpeta `/build/release/`. Ahora solo es necesario desplegarlo en una cuenta de desarrollo.
```sh
near dev-deploy bui... |
NEARBuilders_Wallets | features.md
|
| |
pseudo-exchange_nym-spec | .travis.yml
Cargo.toml
README.md
USER_STORIES.md
package-lock.json
package.json
src
lib.rs
util.rs
| Nym.Near
==============
A name auction for Near.
See [User Stories](./USER_STORIES.md) for detailed interaction info.
## Prerequisite
Ensure `near-cli` is installed by running:
```
near --version
```
If needed, install `near-cli`:
```
npm install near-cli -g
```
## Building this contract
To make the build proces... |
mrlasdt_go-crypto-market-making | clock
clock.go
command
start.go
config
config.go
exchange
exchange.go
gateio.go
order.go
uniswap.go
gateway
.eslintrc.js
Changelog.md
README.md
bin
docker-start.sh
conf
avalanche.yml
binance-smart-chain.yml
cronos.yml
database.yml
... | 
# Hummingbot Gateway
---
Hummingbot Gateway is a REST API that exposes connections to various blockchains (wallet, node & chain interaction) and decentralized exchanges (pricing, trading & liquidity provision). It is written in Typescript and takes adva... |
luciotato_simple-rust-parser | .vscode
tasks.json
README.md
build.js
package-lock.json
package.json
res
test
expected
staking-pool.js
rust-samples
declaration.rs
outer-tests.rs
test1-full.rs
test1-start.rs
staking-pool
src
lib.rs
s... | # Simple Rust Parser
This a simple hand-coded PEG parser for a subset of Rust,
it is aimed to parse the subset of Rust used for writing
smart contracts for the Near Blockchain
|
JoaquimLey_link3 | client-web
README.md
package.json
postcss.config.js
public
index.html
manifest.json
robots.txt
src
App.js
App.test.js
copy_icon.svg
github_logo.svg
index.css
index.js
link3_logo.svg
near
config.js
... | # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view... |
hermes1108_near-coinflip-frontend | README.md
package.json
public
index.html
manifest.json
robots.txt
src
App.css
App.js
App.test.js
common
config.js
components
FundModal.js
HelpModal.js
index.css
index.js
logo.svg
page
Main.js
coin.css
reportWebVitals.js
setu... | # Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view... |
Markeljan_swapguard | .vscode
settings.json
README.md
dex-app
README.md
const
details.ts
next.config.js
package-lock.json
package.json
pages
api
hello.ts
public
next.svg
thirteen.svg
vercel.svg
styles
Home.module.css
globals.css
tscon... | # DEX contracts
> **Warning:** This code is not audited. Use at your own risk.
This contracts in this repository can be used with the [DEX app repository](https://github.com/thirdweb-example/dex-app).
## Compiling the contract
Use the following command to compile the contract:
```bash
npx thirdweb build
```
## De... |
ligebit_spring_near_guest_book | .eslintrc.yml
.github
dependabot.yml
workflows
deploy.yml
tests.yml
.gitpod.yml
.travis.yml
README-Gitpod.md
README.md
as-pect.config.js
asconfig.json
assembly
__tests__
as-pect.d.ts
guestbook.spec.ts
as_types.d.ts
main.ts
model.ts
tsconfig.json
babel.config.j... | Challenge #4
https://ligebit.github.io/spring_near_guest_book/
sub account contract - guest_book.near_spring.testnet
|
kuutamolabs_rapid-gossip-sync-server | .github
workflows
build.yml
Cargo.toml
LICENSE-APACHE.md
LICENSE-MIT.md
LICENSE.md
README.md
docker-compose.yml
src
config.rs
downloader.rs
hex_utils.rs
lib.rs
lookup.rs
main.rs
persistence.rs
serialization.rs
snapshot.rs
tests
mod.rs
tracking.rs
types... | # rapid-gossip-sync-server
This is a server that connects to peers on the Lightning network and calculates compact rapid sync
gossip data.
These are the components it's comprised of.
## Modules
### config
A config file where the Postgres credentials and Lightning peers can be adjusted. Most adjustments
can be made... |
gspindev_bcapps | .gitpod.yml
README.md
near-blockvote
blockvote
.gitpod.yml
README.md
babel.config.js
contract
Cargo.toml
README.md
as-pect.config.js
asconfig.json
assembly
__tests__
as-pect.d.ts
... | blockvote
==================
This [React] app was initialized with [create-near-app]
Quick Start
===========
To run this project locally:
1. Prerequisites: Make sure you've installed [Node.js] ≥ 12
2. Install dependencies: `yarn install`
3. Run the local development server: `yarn dev` (see `package.json` for a
f... |
Lightency_nearcon-hackathon-lightency | .gitpod.yml
README.md
contract
Cargo.toml
README.md
neardev
dev-account.env
src
lib.rs
dao_contract
Cargo.toml
README.md
build.sh
deploy.sh
src
lib.rs
energy_pool_contract
Cargo.toml
README.md
build.sh
deploy.sh
neardev
dev-account.... | # Hello NEAR Contract
The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network.
```rust
const DEFAULT_GREETING: &str = "Hello";
#[near_bindgen]
#[derive(BorshDeserialize, BorshSerialize)]
pub struct Contract {
greeting: String,
}
impl Default for Contract {
fn d... |
pantemon_question | README.md
contract
Cargo.toml
README.md
rustfmt.toml
scripts
build.sh
deploy.sh
dev-deploy.sh
init-args.js
src
contract.rs
lib.rs
utils.rs
| # NEAR Smart Contract Rust Template
Project structure for writing smart contracts in Rust for NEAR Protocol
# Required Software
- Rust 1.58 + cargo
- Node.js
- NEAR CLI 3.1
# Authors
- Jacob Lindahl <jacob@near.foundation> [@sudo_build](https://twitter.com/sudo_build)
# question
|
marco-sundsk_senderwallet-registrar | README.md
contracts
Cargo.toml
README.md
__tests__
sw-registrar
helper.ts
operator.ava.ts
owner.ava.ts
package-lock.json
package.json
sw-registrar
Cargo.toml
build_local.sh
src
lib.rs
owner.rs
... | # Registrar Contract for Sender Wallet
An upgradable IMS contract for Sender-Wallet user management.
## Description
* Everyone can check a given user's information.
* Operators can do all above and can add user information.
* Owner can do all above and can upgrade the contract and management Operators.
### For Ev... |
near_near-indexer-events | Cargo.toml
README.md
migrations
20220712171424_initial.sql
src
configs.rs
db_adapters
coin
legacy
DOC.md
aurora.rs
mod.rs
rainbow_bridge.rs
skyward.rs
tkn_near.rs
wentokensir.r... | # Indexer Events
Async Postgres-compatible solution to load the data from NEAR blockchain.
Based on [NEAR Lake Framework](https://github.com/near/near-lake-framework-rs).
See [Indexer Base](https://github.com/near/near-indexer-base#indexer-base) docs for all the explanations, installation guide, etc.
This solution c... |
PrimeLabCore_tenk-frontend-template | README.md
package.json
public
index.html
src
Contexts
BuyContext
BuyContext.js
index.js
Main.js
assets
images
copy-icon.svg
faq-ellipse-left.svg
faq-ellipse-right.svg
faq-kat.svg
footer-near-logo.svg
... | # Simple React App template
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the ... |
ngocquang_near-tutorial-1 | README.md
contract
Cargo.toml
src
lib.rs
package.json
| near-tutorial-1
near deploy --wasm-file out/main.wasm --account-id contract1.chihiro.testnet --master-account chihiro.testnet
near create-account contract1.chihiro.testnet --masterAccount chihiro.testnet
|
hermes1108_near-mr-giggles-nft-smart-contract | Cargo.toml
README.md
build.sh
neardev
dev-account.env
src
approval.rs
enumeration.rs
events.rs
internal.rs
lib.rs
metadata.rs
mint.rs
nft_core.rs
royalty.rs
util.rs
| # TBD
|
gyan0890_NEAR-Quest4-Auction | README.md
as-pect.config.js
asconfig.json
package.json
scripts
1.dev-deploy.sh
2.use-contract.sh
3.cleanup.sh
README.md
src
as_types.d.ts
simple
__tests__
as-pect.d.ts
index.unit.spec.ts
asconfig.json
assembly
index.ts
singleton
... | # `near-sdk-as` Starter Kit
This is a good project to use as a starting point for your AssemblyScript project.
## Samples
This repository includes a complete project structure for AssemblyScript contracts targeting the NEAR platform.
The example here is very basic. It's a simple contract demonstrating the followin... |
hrs025_Car-Marktplace | README.md
as-pect.config.js
asconfig.json
package.json
scripts
1.init.sh
2.run.sh
src
as-pect.d.ts
as_types.d.ts
sample
__tests__
index.unit.spec.ts
asconfig.json
assembly
as_types.d.ts
index.ts
model.ts
tsconfig.jso... | # Near-Car
# Near-Car
|
laitsky_tamagotchi-on-near | README.md
client
README.md
package.json
public
index.html
manifest.json
robots.txt
src
App.js
App.test.js
components
Game.js
HowToPlay.js
MintNFT.js
Navbar.js
Play.js
RenderNotConnecte... | This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will r... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.