PC) have this type.\n\n### .transfer(length, callback(error, data))\nPerform a transfer to read data from the endpoint.\n\nIf length is greater than maxPacketSize, libusb will automatically split the transfer in multiple packets, and you will receive one callback with all data once all packets are complete.\n\n`this` in the callback is the InEndpoint object.\n\n### .startPoll(nTransfers=3, transferSize=maxPacketSize)\nStart polling the endpoint.\n\nThe library will keep `nTransfers` transfers of size `transferSize` pending in\nthe kernel at all times to ensure continuous data flow. This is handled by the\nlibusb event thread, so it continues even if the Node v8 thread is busy. The\n`data` and `error` events are emitted as transfers complete.\n\n### .stopPoll(cb)\nStop polling.\n\nFurther data may still be received. The `end` event is emitted and the callback\nis called once all transfers have completed or canceled.\n\n### Event: data(data : Buffer)\nEmitted with data received by the polling transfers\n\n### Event: error(error)\nEmitted when polling encounters an error. All in flight transfers will be automatically canceled and no further polling will be done. You have to wait for the `end` event before you can start polling again.\n\n### Event: end\nEmitted when polling has been canceled\n\nOutEndpoint\n-----------\n\nEndpoints in the OUT direction (PC->device) have this type.\n\n### .transfer(data, callback(error))\nPerform a transfer to write `data` to the endpoint.\n\nIf length is greater than maxPacketSize, libusb will automatically split the transfer in multiple packets, and you will receive one callback once all packets are complete.\n\n`this` in the callback is the OutEndpoint object.\n\n### Event: error(error)\nEmitted when the stream encounters an error.\n\n### Event: end\nEmitted when the stream has been stopped and all pending requests have been completed.\n\nUsbDetection\n------------\n\n### usb.on('attach', function(device) { ... });\nAttaches a callback to plugging in a `device`.\n\n### usb.on('detach', function(device) { ... });\nAttaches a callback to unplugging a `device`.\n\n### usb.refHotplugEvents();\nRestore (re-reference) the hotplug events unreferenced by `unrefHotplugEvents()`\n\n### usb.unrefHotplugEvents();\nListening to events will prevent the process to exit. By calling this function, hotplug events will be unreferenced by the event loop, allowing the process to exit even when listening for the `attach` and `detach` events.\n\nDevelopment and testing\n=======================\n\nTo build from git:\n\n\tgit clone --recursive https://github.com/node-usb/node-usb.git\n\tcd node-usb\n\tnpm install\n\nTo execute the unit tests, [CoffeeScript](http://coffeescript.org) is required. Run\n\n\tnpm test\n\nSome tests require an [attached STM32F103 Microprocessor USB device with specific firmware](https://github.com/thegecko/node-usb-test-firmware).\n\n\tnpm run --silent full-test\n\tnpm run --silent valgrind\n\nLimitations\n===========\n\nDoes not support:\n\n - Configurations other than the default one\n - Isochronous transfers\n\nLicense\n=======\n\nMIT\n\nNote that the compiled Node extension includes Libusb, and is thus subject to the LGPL.\n# estree-walker\n\nSimple utility for walking an [ESTree](https://github.com/estree/estree)-compliant AST, such as one generated by [acorn](https://github.com/marijnh/acorn).\n\n## Installation\n\n```bash\nnpm i estree-walker\n```\n\n## Usage\n\n```js\nvar walk = require( 'estree-walker' ).walk;\nvar acorn = require( 'acorn' );\n\nast = acorn.parse( sourceCode, options ); // https://github.com/acornjs/acorn\n\nwalk( ast, {\n enter: function ( node, parent, prop, index ) {\n // some code happens\n },\n leave: function ( node, parent, prop, index ) {\n \t// some code happens\n }\n});\n```\n\nInside the `enter` function, calling `this.skip()` will prevent the node's children being walked, or the `leave` function (which is optional) being called.\n\nCall `this.replace(new_node)` in either `enter` or `leave` to replace the current node with a new one.\n\nCall `this.remove()` in either `enter` or `leave` to remove the current node.\n\n## Why not use estraverse?\n\nThe ESTree spec is evolving to accommodate ES6/7. I've had a couple of experiences where [estraverse](https://github.com/estools/estraverse) was unable to handle an AST generated by recent versions of acorn, because it hard-codes visitor keys.\n\nestree-walker, by contrast, simply enumerates a node's properties to find child nodes (and child lists of nodes), and is therefore resistant to spec changes. It's also much smaller. (The performance, if you're wondering, is basically identical.)\n\nNone of which should be taken as criticism of estraverse, which has more features and has been battle-tested in many more situations, and for which I'm very grateful.\n\n## License\n\nMIT\n# near-api-js\n\n[](https://travis-ci.com/near/near-api-js)\n[](https://gitpod.io/#https://github.com/near/near-api-js) \n\nA JavaScript/TypeScript library for development of DApps on the NEAR platform\n\n# Documentation\n\n[Read the TypeDoc API documentation](https://near.github.io/near-api-js/)\n\n---\n\n# Examples\n\n## [Quick Reference](https://github.com/near/near-api-js/blob/master/examples/quick-reference.md)\n_(Cheat sheet / quick reference)_\n\n## [Cookbook](https://github.com/near/near-api-js/blob/master/examples/cookbook/README.md)\n_(Common use cases / more complex examples)_\n\n---\n\n# Contribute to this library\n\n1. Install dependencies\n\n yarn\n\n2. Run continuous build with:\n\n yarn build -- -w\n\n# Publish\n\nPrepare `dist` version by running:\n\n yarn dist\n\nWhen publishing to npm use [np](https://github.com/sindresorhus/np).\n\n---\n\n# Integration Test\n\nStart the node by following instructions from [nearcore](https://github.com/nearprotocol/nearcore), then\n\n yarn test\n\nTests use sample contract from `near-hello` npm package, see https://github.com/nearprotocol/near-hello\n\n# Update error schema\n\nFollow next steps:\n\n1. [Change hash for the commit with errors in the nearcore](https://github.com/near/near-api-js/blob/master/gen_error_types.js#L7-L9)\n2. Fetch new schema: `node fetch_error_schema.js`\n3. `yarn build` to update `lib/**.js` files\n\n# License\n\nThis repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).\nSee [LICENSE](LICENSE) and [LICENSE-APACHE](LICENSE-APACHE) for details.\n# end-of-stream\n\nA node module that calls a callback when a readable/writable/duplex stream has completed or failed.\n\n\tnpm install end-of-stream\n\n[](https://travis-ci.org/mafintosh/end-of-stream)\n\n## Usage\n\nSimply pass a stream and a callback to the `eos`.\nBoth legacy streams, streams2 and stream3 are supported.\n\n``` js\nvar eos = require('end-of-stream');\n\neos(readableStream, function(err) {\n // this will be set to the stream instance\n\tif (err) return console.log('stream had an error or closed early');\n\tconsole.log('stream has ended', this === readableStream);\n});\n\neos(writableStream, function(err) {\n\tif (err) return console.log('stream had an error or closed early');\n\tconsole.log('stream has finished', this === writableStream);\n});\n\neos(duplexStream, function(err) {\n\tif (err) return console.log('stream had an error or closed early');\n\tconsole.log('stream has ended and finished', this === duplexStream);\n});\n\neos(duplexStream, {readable:false}, function(err) {\n\tif (err) return console.log('stream had an error or closed early');\n\tconsole.log('stream has finished but might still be readable');\n});\n\neos(duplexStream, {writable:false}, function(err) {\n\tif (err) return console.log('stream had an error or closed early');\n\tconsole.log('stream has ended but might still be writable');\n});\n\neos(readableStream, {error:false}, function(err) {\n\t// do not treat emit('error', err) as a end-of-stream\n});\n```\n\n## License\n\nMIT\n\n## Related\n\n`end-of-stream` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one.\n# fast-glob\n\n> It's a very fast and efficient [glob][glob_definition] library for [Node.js][node_js].\n\nThis package provides methods for traversing the file system and returning pathnames that matched a defined set of a specified pattern according to the rules used by the Unix Bash shell with some simplifications, meanwhile results are returned in **arbitrary order**. Quick, simple, effective.\n\n## Table of Contents\n\n }]\n```\n\nThe object has the following fields:\n\n* name (`string`) — the last part of the path (basename)\n* path (`string`) — full path relative to the pattern base directory\n* dirent ([`fs.Dirent`][node_js_fs_class_fs_dirent]) — instance of `fs.Dirent`\n\n> :book: An object is an internal representation of entry, so getting it does not affect performance.\n\n#### onlyDirectories\n\n* Type: `boolean`\n* Default: `false`\n\nReturn only directories.\n\n```js\nfg.sync('*', { onlyDirectories: false }); // ['index.js', 'src']\nfg.sync('*', { onlyDirectories: true }); // ['src']\n```\n\n> :book: If `true`, the [`onlyFiles`](#onlyfiles) option is automatically `false`.\n\n#### onlyFiles\n\n* Type: `boolean`\n* Default: `true`\n\nReturn only files.\n\n```js\nfg.sync('*', { onlyFiles: false }); // ['index.js', 'src']\nfg.sync('*', { onlyFiles: true }); // ['index.js']\n```\n\n#### stats\n\n* Type: `boolean`\n* Default: `false`\n\nEnables an [object mode](#objectmode) with an additional field:\n\n* stats ([`fs.Stats`][node_js_fs_class_fs_stats]) — instance of `fs.Stats`\n\n```js\nfg.sync('*', { stats: false }); // ['src/index.js']\nfg.sync('*', { stats: true }); // [{ name: 'index.js', path: 'src/index.js', dirent: , stats: }]\n```\n\n> :book: Returns `fs.stat` instead of `fs.lstat` for symbolic links when the [`followSymbolicLinks`](#followsymboliclinks) option is specified.\n>\n> :warning: Unlike [object mode](#objectmode) this mode requires additional calls to the file system. On average, this mode is slower at least twice. See [old and modern mode](#old-and-modern-mode) for more details.\n\n#### unique\n\n* Type: `boolean`\n* Default: `true`\n\nEnsures that the returned entries are unique.\n\n```js\nfg.sync(['*.json', 'package.json'], { unique: false }); // ['package.json', 'package.json']\nfg.sync(['*.json', 'package.json'], { unique: true }); // ['package.json']\n```\n\nIf `true` and similar entries are found, the result is the first found.\n\n### Matching control\n\n#### braceExpansion\n\n* Type: `boolean`\n* Default: `true`\n\nEnables Bash-like brace expansion.\n\n> :1234: [Syntax description][bash_hackers_syntax_expansion_brace] or more [detailed description][micromatch_braces].\n\n```js\ndir/\n├── abd\n├── acd\n└── a{b,c}d\n```\n\n```js\nfg.sync('a{b,c}d', { braceExpansion: false }); // ['a{b,c}d']\nfg.sync('a{b,c}d', { braceExpansion: true }); // ['abd', 'acd']\n```\n\n#### caseSensitiveMatch\n\n* Type: `boolean`\n* Default: `true`\n\nEnables a [case-sensitive][wikipedia_case_sensitivity] mode for matching files.\n\n```js\ndir/\n├── file.txt\n└── File.txt\n```\n\n```js\nfg.sync('file.txt', { caseSensitiveMatch: false }); // ['file.txt', 'File.txt']\nfg.sync('file.txt', { caseSensitiveMatch: true }); // ['file.txt']\n```\n\n#### dot\n\n* Type: `boolean`\n* Default: `false`\n\nAllow patterns to match entries that begin with a period (`.`).\n\n> :book: Note that an explicit dot in a portion of the pattern will always match dot files.\n\n```js\ndir/\n├── .editorconfig\n└── package.json\n```\n\n```js\nfg.sync('*', { dot: false }); // ['package.json']\nfg.sync('*', { dot: true }); // ['.editorconfig', 'package.json']\n```\n\n#### extglob\n\n* Type: `boolean`\n* Default: `true`\n\nEnables Bash-like `extglob` functionality.\n\n> :1234: [Syntax description][micromatch_extglobs].\n\n```js\ndir/\n├── README.md\n└── package.json\n```\n\n```js\nfg.sync('*.+(json|md)', { extglob: false }); // []\nfg.sync('*.+(json|md)', { extglob: true }); // ['README.md', 'package.json']\n```\n\n#### globstar\n\n* Type: `boolean`\n* Default: `true`\n\nEnables recursively repeats a pattern containing `**`. If `false`, `**` behaves exactly like `*`.\n\n```js\ndir/\n└── a\n └── b\n```\n\n```js\nfg.sync('**', { onlyFiles: false, globstar: false }); // ['a']\nfg.sync('**', { onlyFiles: false, globstar: true }); // ['a', 'a/b']\n```\n\n#### baseNameMatch\n\n* Type: `boolean`\n* Default: `false`\n\nIf set to `true`, then patterns without slashes will be matched against the basename of the path if it contains slashes.\n\n```js\ndir/\n└── one/\n └── file.md\n```\n\n```js\nfg.sync('*.md', { baseNameMatch: false }); // []\nfg.sync('*.md', { baseNameMatch: true }); // ['one/file.md']\n```\n\n## FAQ\n\n## What is a static or dynamic pattern?\n\nAll patterns can be divided into two types:\n\n* **static**. A pattern is considered static if it can be used to get an entry on the file system without using matching mechanisms. For example, the `file.js` pattern is a static pattern because we can just verify that it exists on the file system.\n* **dynamic**. A pattern is considered dynamic if it cannot be used directly to find occurrences without using a matching mechanisms. For example, the `*` pattern is a dynamic pattern because we cannot use this pattern directly.\n\nA pattern is considered dynamic if it contains the following characters (`…` — any characters or their absence) or options:\n\n* The [`caseSensitiveMatch`](#casesensitivematch) option is disabled\n* `\\\\` (the escape character)\n* `*`, `?`, `!` (at the beginning of line)\n* `[…]`\n* `(…|…)`\n* `@(…)`, `!(…)`, `*(…)`, `?(…)`, `+(…)` (respects the [`extglob`](#extglob) option)\n* `{…,…}`, `{…..…}` (respects the [`braceExpansion`](#braceexpansion) option)\n\n## How to write patterns on Windows?\n\nAlways use forward-slashes in glob expressions (patterns and [`ignore`](#ignore) option). Use backslashes for escaping characters. With the [`cwd`](#cwd) option use a convenient format.\n\n**Bad**\n\n```ts\n[\n\t'directory\\\\*',\n\tpath.join(process.cwd(), '**')\n]\n```\n\n**Good**\n\n```ts\n[\n\t'directory/*',\n\tpath.join(process.cwd(), '**').replace(/\\\\/g, '/')\n]\n```\n\n> :book: Use the [`normalize-path`][npm_normalize_path] or the [`unixify`][npm_unixify] package to convert Windows-style path to a Unix-style path.\n\nRead more about [matching with backslashes][micromatch_backslashes].\n\n## Why are parentheses match wrong?\n\n```js\ndir/\n└── (special-*file).txt\n```\n\n```js\nfg.sync(['(special-*file).txt']) // []\n```\n\nRefers to Bash. You need to escape special characters:\n\n```js\nfg.sync(['\\\\(special-*file\\\\).txt']) // ['(special-*file).txt']\n```\n\nRead more about [matching special characters as literals][picomatch_matching_special_characters_as_literals].\n\n## How to exclude directory from reading?\n\nYou can use a negative pattern like this: `!**/node_modules` or `!**/node_modules/**`. Also you can use [`ignore`](#ignore) option. Just look at the example below.\n\n```js\nfirst/\n├── file.md\n└── second/\n └── file.txt\n```\n\nIf you don't want to read the `second` directory, you must write the following pattern: `!**/second` or `!**/second/**`.\n\n```js\nfg.sync(['**/*.md', '!**/second']); // ['first/file.md']\nfg.sync(['**/*.md'], { ignore: ['**/second/**'] }); // ['first/file.md']\n```\n\n> :warning: When you write `!**/second/**/*` it means that the directory will be **read**, but all the entries will not be included in the results.\n\nYou have to understand that if you write the pattern to exclude directories, then the directory will not be read under any circumstances.\n\n## How to use UNC path?\n\nYou cannot use [Uniform Naming Convention (UNC)][unc_path] paths as patterns (due to syntax), but you can use them as [`cwd`](#cwd) directory.\n\n```ts\nfg.sync('*', { cwd: '\\\\\\\\?\\\\C:\\\\Python27' /* or //?/C:/Python27 */ });\nfg.sync('Python27/*', { cwd: '\\\\\\\\?\\\\C:\\\\' /* or //?/C:/ */ });\n```\n\n## Compatible with `node-glob`?\n\n| node-glob | fast-glob |\n| :----------: | :-------: |\n| `cwd` | [`cwd`](#cwd) |\n| `root` | – |\n| `dot` | [`dot`](#dot) |\n| `nomount` | – |\n| `mark` | [`markDirectories`](#markdirectories) |\n| `nosort` | – |\n| `nounique` | [`unique`](#unique) |\n| `nobrace` | [`braceExpansion`](#braceexpansion) |\n| `noglobstar` | [`globstar`](#globstar) |\n| `noext` | [`extglob`](#extglob) |\n| `nocase` | [`caseSensitiveMatch`](#casesensitivematch) |\n| `matchBase` | [`baseNameMatch`](#basenamematch) |\n| `nodir` | [`onlyFiles`](#onlyfiles) |\n| `ignore` | [`ignore`](#ignore) |\n| `follow` | [`followSymbolicLinks`](#followsymboliclinks) |\n| `realpath` | – |\n| `absolute` | [`absolute`](#absolute) |\n\n## Benchmarks\n\n### Server\n\nLink: [Vultr Bare Metal][vultr_pricing_baremetal]\n\n* Processor: E3-1270v6 (8 CPU)\n* RAM: 32GB\n* Disk: SSD ([Intel DC S3520 SSDSC2BB240G7][intel_ssd])\n\nYou can see results [here][github_gist_benchmark_server] for latest release.\n\n### Nettop\n\nLink: [Zotac bi323][zotac_bi323]\n\n* Processor: Intel N3150 (4 CPU)\n* RAM: 8GB\n* Disk: SSD ([Silicon Power SP060GBSS3S55S25][silicon_power_ssd])\n\nYou can see results [here][github_gist_benchmark_nettop] for latest release.\n\n## Changelog\n\nSee the [Releases section of our GitHub project][github_releases] for changelog for each release version.\n\n## License\n\nThis software is released under the terms of the MIT license.\n\n[bash_hackers_syntax_expansion_brace]: https://wiki.bash-hackers.org/syntax/expansion/brace\n[github_gist_benchmark_nettop]: https://gist.github.com/mrmlnc/f06246b197f53c356895fa35355a367c#file-fg-benchmark-nettop-product-txt\n[github_gist_benchmark_server]: https://gist.github.com/mrmlnc/f06246b197f53c356895fa35355a367c#file-fg-benchmark-server-product-txt\n[github_releases]: https://github.com/mrmlnc/fast-glob/releases\n[glob_definition]: https://en.wikipedia.org/wiki/Glob_(programming)\n[glob_linux_man]: http://man7.org/linux/man-pages/man3/glob.3.html\n[intel_ssd]: https://ark.intel.com/content/www/us/en/ark/products/93012/intel-ssd-dc-s3520-series-240gb-2-5in-sata-6gb-s-3d1-mlc.html\n[micromatch_backslashes]: https://github.com/micromatch/micromatch#backslashes\n[micromatch_braces]: https://github.com/micromatch/braces\n[micromatch_extended_globbing]: https://github.com/micromatch/micromatch#extended-globbing\n[micromatch_extglobs]: https://github.com/micromatch/micromatch#extglobs\n[micromatch_regex_character_classes]: https://github.com/micromatch/micromatch#regex-character-classes\n[micromatch]: https://github.com/micromatch/micromatch\n[node_js_fs_class_fs_dirent]: https://nodejs.org/api/fs.html#fs_class_fs_dirent\n[node_js_fs_class_fs_stats]: https://nodejs.org/api/fs.html#fs_class_fs_stats\n[node_js_stream_readable_streams]: https://nodejs.org/api/stream.html#stream_readable_streams\n[node_js]: https://nodejs.org/en\n[nodelib_fs_scandir_old_and_modern_modern]: https://github.com/nodelib/nodelib/blob/master/packages/fs/fs.scandir/README.md#old-and-modern-mode\n[npm_normalize_path]: https://www.npmjs.com/package/normalize-path\n[npm_unixify]: https://www.npmjs.com/package/unixify\n[paypal_mrmlnc]:https://paypal.me/mrmlnc\n[picomatch_matching_behavior]: https://github.com/micromatch/picomatch#matching-behavior-vs-bash\n[picomatch_matching_special_characters_as_literals]: https://github.com/micromatch/picomatch#matching-special-characters-as-literals\n[picomatch_posix_brackets]: https://github.com/micromatch/picomatch#posix-brackets\n[regular_expressions_brackets]: https://www.regular-expressions.info/brackets.html\n[silicon_power_ssd]: https://www.silicon-power.com/web/product-1\n[unc_path]: https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-dtyp/62e862f4-2a51-452e-8eeb-dc4ff5ee33cc\n[vultr_pricing_baremetal]: https://www.vultr.com/pricing/baremetal\n[wikipedia_case_sensitivity]: https://en.wikipedia.org/wiki/Case_sensitivity\n[zotac_bi323]: https://www.zotac.com/ee/product/mini_pcs/zbox-bi323\n# Tools\n\n## clang-format\n\nThe clang-format checking tools is designed to check changed lines of code compared to given git-refs.\n\n## Migration Script\n\nThe migration tool is designed to reduce repetitive work in the migration process. However, the script is not aiming to convert every thing for you. There are usually some small fixes and major reconstruction required.\n\n### How To Use\n\nTo run the conversion script, first make sure you have the latest `node-addon-api` in your `node_modules` directory.\n```\nnpm install node-addon-api\n```\n\nThen run the script passing your project directory\n```\nnode ./node_modules/node-addon-api/tools/conversion.js ./\n```\n\nAfter finish, recompile and debug things that are missed by the script.\n\n### Quick Fixes\nHere is the list of things that can be fixed easily.\n 1. Change your methods' return value to void if it doesn't return value to JavaScript.\n 2. Use `.` to access attribute or to invoke member function in Napi::Object instead of `->`.\n 3. `Napi::New(env, value);` to `Napi::[Type]::New(env, value);\n\n### Major Reconstructions\nThe implementation of `Napi::ObjectWrap` is significantly different from NAN's. `Napi::ObjectWrap` takes a pointer to the wrapped object and creates a reference to the wrapped object inside ObjectWrap constructor. `Napi::ObjectWrap` also associates wrapped object's instance methods to Javascript module instead of static methods like NAN.\n\nSo if you use Nan::ObjectWrap in your module, you will need to execute the following steps.\n\n 1. Convert your [ClassName]::New function to a constructor function that takes a `Napi::CallbackInfo`. Declare it as\n```\n[ClassName](const Napi::CallbackInfo& info);\n```\nand define it as\n```\n[ClassName]::[ClassName](const Napi::CallbackInfo& info) : Napi::ObjectWrap<[ClassName]>(info){\n ...\n}\n```\nThis way, the `Napi::ObjectWrap` constructor will be invoked after the object has been instantiated and `Napi::ObjectWrap` can use the `this` pointer to create a reference to the wrapped object.\n\n 2. Move your original constructor code into the new constructor. Delete your original constructor.\n 3. In your class initialization function, associate native methods in the following way.\n```\nNapi::FunctionReference constructor;\n\nvoid [ClassName]::Init(Napi::Env env, Napi::Object exports, Napi::Object module) {\n Napi::HandleScope scope(env);\n Napi::Function ctor = DefineClass(env, \"Canvas\", {\n InstanceMethod<&[ClassName]::Func1>(\"Func1\"),\n InstanceMethod<&[ClassName]::Func2>(\"Func2\"),\n InstanceAccessor<&[ClassName]::ValueGetter>(\"Value\"),\n StaticMethod<&[ClassName]::StaticMethod>(\"MethodName\"),\n InstanceValue(\"Value\", Napi::[Type]::New(env, value)),\n });\n\n constructor = Napi::Persistent(ctor);\n constructor .SuppressDestruct();\n exports.Set(\"[ClassName]\", ctor);\n}\n```\n 4. In function where you need to Unwrap the ObjectWrap in NAN like `[ClassName]* native = Nan::ObjectWrap::Unwrap<[ClassName]>(info.This());`, use `this` pointer directly as the unwrapped object as each ObjectWrap instance is associated with a unique object instance.\n\nIf you still find issues after following this guide, please leave us an issue describing your problem and we will try to resolve it.\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. (/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# 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# cliui\n\n\n[](https://www.npmjs.com/package/cliui)\n[](https://conventionalcommits.org)\n\n\neasily create complex multi-column command-line-interfaces.\n\n## Example\n\n```js\nconst ui = require('cliui')()\n\nui.div('Usage: $0 [command] [options]')\n\nui.div({\n text: 'Options:',\n padding: [2, 0, 1, 0]\n})\n\nui.div(\n {\n text: \"-f, --file\",\n width: 20,\n padding: [0, 4, 0, 4]\n },\n {\n text: \"the file to load.\" +\n chalk.green(\"(if this description is long it wraps).\")\n ,\n width: 20\n },\n {\n text: chalk.red(\"[required]\"),\n align: 'right'\n }\n)\n\nconsole.log(ui.toString())\n```\n\n## Deno/ESM Support\n\nAs of `v7` `cliui` supports [Deno](https://github.com/denoland/deno) and\n[ESM](https://nodejs.org/api/esm.html#esm_ecmascript_modules):\n\n```typescript\nimport cliui from \"https://deno.land/x/cliui/deno.ts\";\n\nconst ui = cliui({})\n\nui.div('Usage: $0 [command] [options]')\n\nui.div({\n text: 'Options:',\n padding: [2, 0, 1, 0]\n})\n\nui.div({\n text: \"-f, --file\",\n width: 20,\n padding: [0, 4, 0, 4]\n})\n\nconsole.log(ui.toString())\n```\n\n![](\"screenshot.png\")
\n\n## Layout DSL\n\ncliui exposes a simple layout DSL:\n\nIf you create a single `ui.div`, passing a string rather than an\nobject:\n\n* `\\n`: characters will be interpreted as new rows.\n* `\\t`: characters will be interpreted as new columns.\n* `\\s`: characters will be interpreted as padding.\n\n**as an example...**\n\n```js\nvar ui = require('./')({\n width: 60\n})\n\nui.div(\n 'Usage: node ./bin/foo.js\\n' +\n ' \\t provide a regex\\n' +\n ' \\t provide a glob\\t [required]'\n)\n\nconsole.log(ui.toString())\n```\n\n**will output:**\n\n```shell\nUsage: node ./bin/foo.js\n provide a regex\n provide a glob [required]\n```\n\n## Methods\n\n```js\ncliui = require('cliui')\n```\n\n### cliui({width: integer})\n\nSpecify the maximum width of the UI being generated.\nIf no width is provided, cliui will try to get the current window's width and use it, and if that doesn't work, width will be set to `80`.\n\n### cliui({wrap: boolean})\n\nEnable or disable the wrapping of text in a column.\n\n### cliui.div(column, column, column)\n\nCreate a row with any number of columns, a column\ncan either be a string, or an object with the following\noptions:\n\n* **text:** some text to place in the column.\n* **width:** the width of a column.\n* **align:** alignment, `right` or `center`.\n* **padding:** `[top, right, bottom, left]`.\n* **border:** should a border be placed around the div?\n\n### cliui.span(column, column, column)\n\nSimilar to `div`, except the next row will be appended without\na new line being created.\n\n### cliui.resetOutput()\n\nResets the UI elements of the current cliui instance, maintaining the values\nset for `width` and `wrap`.\n# balanced-match\n\nMatch balanced string pairs, like `{` and `}` or `` and ``. 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: `[ , ]`.\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## Security contact information\n\nTo report a security vulnerability, please use the\n[Tidelift security contact](https://tidelift.com/security).\nTidelift will coordinate the fix and disclosure.\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
_(e.g. `appname_foo__bar__baz` => `foo.bar.baz`)_\n * if you passed an option `--config file` then from that file\n * a local `.${appname}rc` or the first found looking in `./ ../ ../../ ../../../` etc.\n * `$HOME/.${appname}rc`\n * `$HOME/.${appname}/config`\n * `$HOME/.config/${appname}`\n * `$HOME/.config/${appname}/config`\n * `/etc/${appname}rc`\n * `/etc/${appname}/config`\n * the defaults object you passed in.\n\nAll configuration sources that were found will be flattened into one object,\nso that sources **earlier** in this list override later ones.\n\n## Configuration File Formats\n\nConfiguration files (e.g. `.appnamerc`) may be in either [json](http://json.org/example) or [ini](http://en.wikipedia.org/wiki/INI_file) format. **No** file extension (`.json` or `.ini`) should be used. The example configurations below are equivalent:\n\n#### Formatted as `ini`\n\n```\n; You can include comments in `ini` format if you want.\n\ndependsOn=0.10.0\n\n; `rc` has built-in support for ini sections, see?\n\n[commands]\n www = ./commands/www\n console = ./commands/repl\n\n; You can even do nested sections\n\n[generators.options]\n engine = ejs\n\n[generators.modules]\n new = generate-new\n engine = generate-backend\n\n```\n\n#### Formatted as `json`\n\n```javascript\n{\n // You can even comment your JSON, if you want\n \"dependsOn\": \"0.10.0\",\n \"commands\": {\n \"www\": \"./commands/www\",\n \"console\": \"./commands/repl\"\n },\n \"generators\": {\n \"options\": {\n \"engine\": \"ejs\"\n },\n \"modules\": {\n \"new\": \"generate-new\",\n \"backend\": \"generate-backend\"\n }\n }\n}\n```\n\nComments are stripped from JSON config via [strip-json-comments](https://github.com/sindresorhus/strip-json-comments).\n\n> Since ini, and env variables do not have a standard for types, your application needs be prepared for strings.\n\nTo ensure that string representations of booleans and numbers are always converted into their proper types (especially useful if you intend to do strict `===` comparisons), consider using a module such as [parse-strings-in-object](https://github.com/anselanza/parse-strings-in-object) to wrap the config object returned from rc.\n\n## Simple example demonstrating precedence\nAssume you have an application like this (notice the hard-coded defaults passed to rc):\n```\nconst conf = require('rc')('myapp', {\n port: 12345,\n mode: 'test'\n});\n\nconsole.log(JSON.stringify(conf, null, 2));\n```\nYou also have a file `config.json`, with these contents:\n```\n{\n \"port\": 9000,\n \"foo\": \"from config json\",\n \"something\": \"else\"\n}\n```\nAnd a file `.myapprc` in the same folder, with these contents:\n```\n{\n \"port\": \"3001\",\n \"foo\": \"bar\"\n}\n```\nHere is the expected output from various commands:\n\n`node .`\n```\n{\n \"port\": \"3001\",\n \"mode\": \"test\",\n \"foo\": \"bar\",\n \"_\": [],\n \"configs\": [\n \"/Users/stephen/repos/conftest/.myapprc\"\n ],\n \"config\": \"/Users/stephen/repos/conftest/.myapprc\"\n}\n```\n*Default `mode` from hard-coded object is retained, but port is overridden by `.myapprc` file (automatically found based on appname match), and `foo` is added.*\n\n`node . --foo baz`\n```\n{\n \"port\": \"3001\",\n \"mode\": \"test\",\n \"foo\": \"baz\",\n \"_\": [],\n \"configs\": [\n \"/Users/stephen/repos/conftest/.myapprc\"\n ],\n \"config\": \"/Users/stephen/repos/conftest/.myapprc\"\n}\n```\n*Same result as above but `foo` is overridden because command-line arguments take precedence over `.myapprc` file.*\n\n`node . --foo barbar --config config.json`\n```\n{\n \"port\": 9000,\n \"mode\": \"test\",\n \"foo\": \"barbar\",\n \"something\": \"else\",\n \"_\": [],\n \"config\": \"config.json\",\n \"configs\": [\n \"/Users/stephen/repos/conftest/.myapprc\",\n \"config.json\"\n ]\n}\n```\n*Now the `port` comes from the `config.json` file specified (overriding the value from `.myapprc`), and `foo` value is overriden by command-line despite also being specified in the `config.json` file.*\n \n\n## Advanced Usage\n\n#### Pass in your own `argv`\n\nYou may pass in your own `argv` as the third argument to `rc`. This is in case you want to [use your own command-line opts parser](https://github.com/dominictarr/rc/pull/12).\n\n```javascript\nrequire('rc')(appname, defaults, customArgvParser);\n```\n\n## Pass in your own parser\n\nIf you have a special need to use a non-standard parser,\nyou can do so by passing in the parser as the 4th argument.\n(leave the 3rd as null to get the default args parser)\n\n```javascript\nrequire('rc')(appname, defaults, null, parser);\n```\n\nThis may also be used to force a more strict format,\nsuch as strict, valid JSON only.\n\n## Note on Performance\n\n`rc` is running `fs.statSync`-- so make sure you don't use it in a hot code path (e.g. a request handler) \n\n## License\n\nMulti-licensed under the two-clause BSD License, MIT License, or Apache License, version 2.0\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# 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][ci-image]][ci-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n\nThis is a large database of mime types and information about them.\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```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-types.json` or\n`src/custom-suffix.json`.\n\nThe `src/custom-types.json` file is a JSON object with the MIME type as the\nkeys and 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[ci-image]: https://badgen.net/github/checks/jshttp/mime-db/master?label=ci\n[ci-url]: https://github.com/jshttp/mime-db/actions?query=workflow%3Aci\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#![\"RxJS](\"docs_app/assets/Rx_Logo_S.png\")
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# node-gyp-build\n\n> Build tool and bindings loader for [`node-gyp`][node-gyp] that supports prebuilds.\n\n```\nnpm install node-gyp-build\n```\n\n[](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml)\n\nUse together with [`prebuildify`][prebuildify] to easily support prebuilds for your native modules.\n\n## Usage\n\n> **Note.** Prebuild names have changed in [`prebuildify@3`][prebuildify] and `node-gyp-build@4`. Please see the documentation below.\n\n`node-gyp-build` works similar to [`node-gyp build`][node-gyp] except that it will check if a build or prebuild is present before rebuilding your project.\n\nIt's main intended use is as an npm install script and bindings loader for native modules that bundle prebuilds using [`prebuildify`][prebuildify].\n\nFirst add `node-gyp-build` as an install script to your native project\n\n``` js\n{\n ...\n \"scripts\": {\n \"install\": \"node-gyp-build\"\n }\n}\n```\n\nThen in your `index.js`, instead of using the [`bindings`](https://www.npmjs.com/package/bindings) module use `node-gyp-build` to load your binding.\n\n``` js\nvar binding = require('node-gyp-build')(__dirname)\n```\n\nIf you do these two things and bundle prebuilds with [`prebuildify`][prebuildify] your native module will work for most platforms\nwithout having to compile on install time AND will work in both node and electron without the need to recompile between usage.\n\nUsers can override `node-gyp-build` and force compiling by doing `npm install --build-from-source`.\n\nPrebuilds will be attempted loaded from `MODULE_PATH/prebuilds/...` and then next `EXEC_PATH/prebuilds/...` (the latter allowing use with `zeit/pkg`)\n\n## Supported prebuild names\n\nIf so desired you can bundle more specific flavors, for example `musl` builds to support Alpine, or targeting a numbered ARM architecture version.\n\nThese prebuilds can be bundled in addition to generic prebuilds; `node-gyp-build` will try to find the most specific flavor first. Prebuild filenames are composed of _tags_. The runtime tag takes precedence, as does an `abi` tag over `napi`. For more details on tags, please see [`prebuildify`][prebuildify].\n\nValues for the `libc` and `armv` tags are auto-detected but can be overridden through the `LIBC` and `ARM_VERSION` environment variables, respectively.\n\n## License\n\nMIT\n\n[prebuildify]: https://github.com/prebuild/prebuildify\n[node-gyp]: https://www.npmjs.com/package/node-gyp\n# NEAR CLI (command line interface)\n\n[](https://gitpod.io/#https://github.com/near/near-cli)\n\nNEAR CLI is a Node.js application that relies on [`near-api-js`](https://github.com/near/near-api-js) to connect to and interact with the NEAR blockchain. Create accounts, access keys, sign & send transactions with this versatile command line interface tool.\n\n**Note:** Node.js version 10+ is required to run NEAR CLI.\n\n## Release notes\n\n**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**\n\n## Overview\n\n_Click on a command for more information and examples._\n\n| Command | Description |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| **ACCESS KEYS** | |\n| [`near login`](#near-login) | stores a full access key locally using [NEAR Wallet](https://wallet.testnet.near.org/) |\n| [`near keys`](#near-keys) | displays all access keys and their details for a given account |\n| [`near generate-key`](#near-generate-key) | generates a local key pair **or** shows public key & [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts) |\n| [`near add-key`](#near-add-key) | adds a new access key to an account |\n| [`near delete-key`](#near-delete-key) | deletes an access key from an account |\n| **ACCOUNTS** | |\n| [`near create-account`](#near-create-account) | creates an account |\n| [`near state`](#near-state) | shows general details of an account |\n| [`near keys`](#near-keys) | displays all access keys for a given account |\n| [`near send`](#near-send) | sends tokens from one account to another |\n| [`near delete`](#near-delete) | deletes an account and transfers remaining balance to a beneficiary account |\n| **CONTRACTS** | |\n| [`near deploy`](#near-deploy) | deploys a smart contract to the NEAR blockchain |\n| [`near dev-deploy`](#near-dev-deploy) | creates a development account and deploys a contract to it _(`testnet` only)_ |\n| [`near call`](#near-call) | makes a contract call which can invoke `change` _or_ `view` methods |\n| [`near view`](#near-view) | makes a contract call which can **only** invoke a `view` method |\n| **TRANSACTIONS** | |\n| [`near tx-status`](#near-tx-status) | queries a transaction's status by `txHash` |\n| **VALIDATORS** | |\n| [`near validators current`](#near-validators-current) | displays current [epoch](http://docs.near.org/docs/concepts/epoch) validator pool details |\n| [`near validators next`](#near-validators-next) | displays validator details for the next [epoch](http://docs.near.org/docs/concepts/epoch) |\n| [`near proposals`](#near-proposals) | displays validator proposals for the [epoch](http://docs.near.org/docs/concepts/epoch) _after_ next |\n| **JS-SDK** | |\n| [`near js`](#near-js) | Work with JS contract enclave |\n| **REPL** | |\n| [`near repl`](#near-repl) | launches an interactive connection to the NEAR blockchain ([REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop)) |\n| | can also run a JS/TS file which exports an async main function that takes a [context](./context/index.d.ts) object |\n\n[ [**OPTIONS**](#options) ]\n\n> For EVM support see [Project Aurora's](https://aurora.dev) [`aurora-cli`](https://github.com/aurora-is-near/aurora-cli).\n\n---\n\n## Setup\n\n### Installation\n\n> Make sure you have a current version of `npm` and `NodeJS` installed.\n\n#### Mac and Linux\n\n1. Install `npm` and `node` using a package manager like `nvm` as sometimes there are issues using Ledger due to how OS X handles node packages related to USB devices. [[click here]](https://nodejs.org/en/download/package-manager/)\n2. Ensure you have installed Node version 12 or above.\n3. Install `near-cli` globally by running:\n\n```bash\nnpm install -g near-cli\n```\n\n#### Windows\n\n> For Windows users, we recommend using Windows Subsystem for Linux (`WSL`).\n\n1. Install `WSL` [[click here]](https://docs.microsoft.com/en-us/windows/wsl/install-manual#downloading-distros)\n2. Install `npm` [[click here]](https://www.npmjs.com/get-npm)\n3. Install ` Node.js` [ [ click here ]](https://nodejs.org/en/download/package-manager/)\n4. Change `npm` default directory [ [ click here ] ](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally#manually-change-npms-default-directory)\n - This is to avoid any permission issues with `WSL`\n5. Open `WSL` and install `near-cli` globally by running:\n\n```bash\nnpm install -g near-cli\n```\n\n---\n\n### Network selection\n\n> The default network for `near-cli` is `testnet`.\n\n- You can change the network by prepending an environment variable to your command.\n\n```bash\nNEAR_ENV=betanet near send ...\n```\n\n- Alternatively, you can set up a global environment variable by running:\n\n```bash\nexport NEAR_ENV=mainnet\n```\n\n---\n\n### Custom RPC server selection\nYou can set custom RPC server URL by setting this env variables:\n```bash\nNEAR_CLI_MAINNET_RPC_SERVER_URL\nNEAR_CLI_TESTNET_RPC_SERVER_URL\nNEAR_CLI_BETANET_RPC_SERVER_URL\nNEAR_CLI_GUILDNET_RPC_SERVER_URL\nNEAR_CLI_LOCALNET_RPC_SERVER_URL\nNEAR_CLI_SHARDNET_RPC_SERVER_URL\nNEAR_CLI_CI_RPC_SERVER_URL\n```\nClear them in case you want to get back to the default RPC server.\n\nExample:\n```bash\nexport NEAR_CLI_TESTNET_RPC_SERVER_URL=\n```\n---\n### RPC server API Keys\nSome RPC servers may require that you provide a valid API key to use them.\n\nYou can set `x-api-key` for a server by running the next command:\n```bash\nnear set-api-key \n```\nThis API Key will be saved in a config and used for each command you execute with this RPC URL.\n\n---\n\n## Access Keys\n\n### `near login`\n\n> locally stores a full access key of an account you created with [NEAR Wallet](https://wallet.testnet.near.org/).\n\n- arguments: `none`\n- options: `default`\n\n**Example:**\n\n```bash\nnear login\n```\n\n#### Access Key Location:\n\n- Once complete you will now have your Access Key stored locally in a hidden directory called `.near-credentials`\n\n - This directory is located at the root of your `HOME` directory:\n - `~/.near-credentials` _(MAC / Linux)_\n - `C:\\Users\\YOUR_ACCOUNT\\.near-credentials` _(Windows)_\n\n- Inside `.near-credentials`, access keys are organized in network subdirectories:\n - `default` _for `testnet`_\n - `betanet`\n - `mainnet`\n- These network subdirectories contain `.JSON` objects with an:\n - `account_id`\n - `private_key`\n - `public_key`\n\n**Example:**\n\n```json\n{\n \"account_id\": \"example-acct.testnet\",\n \"public_key\": \"ed25519:7ns2AZVaG8XZrFrgRw7g8qhgddNTN64Zkz7Eo8JBnV5g\",\n \"private_key\": \"ed25519:4Ijd3vNUmdWJ4L922BxcsGN1aDrdpvUHEgqLQAUSLmL7S2qE9tYR9fqL6DqabGGDxCSHkKwdaAGNcHJ2Sfd\"\n}\n```\n\n---\n\n### `near keys`\n\n> Displays all access keys for a given account.\n\n- arguments: `accountId`\n- options: `default`\n\n**Example:**\n\n```bash\nnear keys client.chainlink.testnet\n```\n\n ` to be able to interact with JS enclaved contracts. Run `near js --help` for instructions. An optional `--jsvm ` argument can be supplied to the following `js` subcommands to point to a different JSVM enclave contract. The default is set to `jsvm.testnet` and `jsvm.near` respectively for testnet and mainnet. Note that anything changing state in the enclave will require a deposit to maintain storage of either the contract bytes or the state of the contract itself.\n\n### `near js deploy`\n\n> Deploys a smart contract to a given accountId on the JSVM enclave.\n\n- arguments: `accountId`, `base64File`, `deposit`\n- options: `jsvm`\n\n**Note:** You will need a full access key for the account you are deploying the contract to. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n**Example:**\n\n```bash\nnear deploy --accountId example-contract.testnet --base64File out/example.base64 --deposit 0.1\n```\n\nAsk it on StackOverflow! \n\n## License\n\nThis repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).\nSee [LICENSE](LICENSE) and [LICENSE-APACHE](LICENSE-APACHE) for details.\n# magic-string\n\n\n ![\"build](\"http://img.shields.io/travis/Rich-Harris/magic-string.svg\"\n)
\n\n\n ![\"npm](\"https://img.shields.io/npm/v/magic-string.svg\"\n)
\n\n\n ![\"license\"](\"https://img.shields.io/npm/l/magic-string.svg\"\n)
\n\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\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\nimport MagicString from 'magic-string';\nimport fs from 'fs'\n\nconst 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\nconst map = s.generateMap({\n source: 'source.js',\n file: 'converted.js.map',\n includeContent: true\n}); // generates a v3 sourcemap\n\nfs.writeFileSync('converted.js', s.toString());\nfs.writeFileSync('converted.js.map', map.toString());\n```\n\nYou can pass an options argument:\n\n```js\nconst 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.generateDecodedMap( options )\n\nGenerates a sourcemap object with raw mappings in array form, rather than encoded as a string. See `generateMap` documentation below for options details. Useful if you need to manipulate the sourcemap further, but most of the time you will use `generateMap` instead.\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### s.isEmpty()\n\nReturns true if the resulting source is empty (disregarding white space).\n\n## Bundling\n\nTo concatenate several sources, use `MagicString.Bundle`:\n\n```js\nconst 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\nconst 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\nconst bundle = new MagicString.Bundle();\nconst source = new MagicString(someCode, {\n filename: 'foo.js'\n});\n\nbundle.addSource(source);\n```\n\n## License\n\nMIT\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```\nare-we-there-yet\n----------------\n\nTrack complex hiearchies of asynchronous task completion statuses. This is\nintended to give you a way of recording and reporting the progress of the big\nrecursive fan-out and gather type workflows that are so common in async.\n\nWhat you do with this completion data is up to you, but the most common use case is to\nfeed it to one of the many progress bar modules.\n\nMost progress bar modules include a rudamentary version of this, but my\nneeds were more complex.\n\nUsage\n=====\n\n```javascript\nvar TrackerGroup = require(\"are-we-there-yet\").TrackerGroup\n\nvar top = new TrackerGroup(\"program\")\n\nvar single = top.newItem(\"one thing\", 100)\nsingle.completeWork(20)\n\nconsole.log(top.completed()) // 0.2\n\nfs.stat(\"file\", function(er, stat) {\n if (er) throw er \n var stream = top.newStream(\"file\", stat.size)\n console.log(top.completed()) // now 0.1 as single is 50% of the job and is 20% complete\n // and 50% * 20% == 10%\n fs.createReadStream(\"file\").pipe(stream).on(\"data\", function (chunk) {\n // do stuff with chunk\n })\n top.on(\"change\", function (name) {\n // called each time a chunk is read from \"file\"\n // top.completed() will start at 0.1 and fill up to 0.6 as the file is read\n })\n})\n```\n\nShared Methods\n==============\n\n* var completed = tracker.completed()\n\nImplemented in: `Tracker`, `TrackerGroup`, `TrackerStream`\n\nReturns the ratio of completed work to work to be done. Range of 0 to 1.\n\n* tracker.finish()\n\nImplemented in: `Tracker`, `TrackerGroup`\n\nMarks the tracker as completed. With a TrackerGroup this marks all of its\ncomponents as completed.\n\nMarks all of the components of this tracker as finished, which in turn means\nthat `tracker.completed()` for this will now be 1.\n\nThis will result in one or more `change` events being emitted.\n\nEvents\n======\n\nAll tracker objects emit `change` events with the following arguments:\n\n```\nfunction (name, completed, tracker)\n```\n\n`name` is the name of the tracker that originally emitted the event,\nor if it didn't have one, the first containing tracker group that had one.\n\n`completed` is the percent complete (as returned by `tracker.completed()` method).\n\n`tracker` is the tracker object that you are listening for events on.\n\nTrackerGroup\n============\n\n* var tracker = new TrackerGroup(**name**)\n\n * **name** *(optional)* - The name of this tracker group, used in change\n notifications if the component updating didn't have a name. Defaults to undefined.\n\nCreates a new empty tracker aggregation group. These are trackers whose\ncompletion status is determined by the completion status of other trackers.\n\n* tracker.addUnit(**otherTracker**, **weight**)\n\n * **otherTracker** - Any of the other are-we-there-yet tracker objects\n * **weight** *(optional)* - The weight to give the tracker, defaults to 1.\n\nAdds the **otherTracker** to this aggregation group. The weight determines\nhow long you expect this tracker to take to complete in proportion to other\nunits. So for instance, if you add one tracker with a weight of 1 and\nanother with a weight of 2, you're saying the second will take twice as long\nto complete as the first. As such, the first will account for 33% of the\ncompletion of this tracker and the second will account for the other 67%.\n\nReturns **otherTracker**.\n\n* var subGroup = tracker.newGroup(**name**, **weight**)\n\nThe above is exactly equivalent to:\n\n```javascript\n var subGroup = tracker.addUnit(new TrackerGroup(name), weight)\n```\n\n* var subItem = tracker.newItem(**name**, **todo**, **weight**)\n\nThe above is exactly equivalent to:\n\n```javascript\n var subItem = tracker.addUnit(new Tracker(name, todo), weight)\n```\n\n* var subStream = tracker.newStream(**name**, **todo**, **weight**)\n\nThe above is exactly equivalent to:\n\n```javascript\n var subStream = tracker.addUnit(new TrackerStream(name, todo), weight)\n```\n\n* console.log( tracker.debug() )\n\nReturns a tree showing the completion of this tracker group and all of its\nchildren, including recursively entering all of the children.\n\nTracker\n=======\n\n* var tracker = new Tracker(**name**, **todo**)\n\n * **name** *(optional)* The name of this counter to report in change\n events. Defaults to undefined.\n * **todo** *(optional)* The amount of work todo (a number). Defaults to 0.\n\nOrdinarily these are constructed as a part of a tracker group (via\n`newItem`).\n\n* var completed = tracker.completed()\n\nReturns the ratio of completed work to work to be done. Range of 0 to 1. If\ntotal work to be done is 0 then it will return 0.\n\n* tracker.addWork(**todo**)\n\n * **todo** A number to add to the amount of work to be done.\n\nIncreases the amount of work to be done, thus decreasing the completion\npercentage. Triggers a `change` event.\n\n* tracker.completeWork(**completed**)\n\n * **completed** A number to add to the work complete\n\nIncrease the amount of work complete, thus increasing the completion percentage.\nWill never increase the work completed past the amount of work todo. That is,\npercentages > 100% are not allowed. Triggers a `change` event.\n\n* tracker.finish()\n\nMarks this tracker as finished, tracker.completed() will now be 1. Triggers\na `change` event.\n\nTrackerStream\n=============\n\n* var tracker = new TrackerStream(**name**, **size**, **options**)\n\n * **name** *(optional)* The name of this counter to report in change\n events. Defaults to undefined.\n * **size** *(optional)* The number of bytes being sent through this stream.\n * **options** *(optional)* A hash of stream options\n\nThe tracker stream object is a pass through stream that updates an internal\ntracker object each time a block passes through. It's intended to track\ndownloads, file extraction and other related activities. You use it by piping\nyour data source into it and then using it as your data source.\n\nIf your data has a length attribute then that's used as the amount of work\ncompleted when the chunk is passed through. If it does not (eg, object\nstreams) then each chunk counts as completing 1 unit of work, so your size\nshould be the total number of objects being streamed.\n\n* tracker.addWork(**todo**)\n\n * **todo** Increase the expected overall size by **todo** bytes.\n\nIncreases the amount of work to be done, thus decreasing the completion\npercentage. Triggers a `change` event.\n# function-bind\n\n\n\n\n\nImplementation of function.prototype.bind\n\n## Example\n\nI mainly do this for unit tests I run on phantomjs.\nPhantomJS does not have Function.prototype.bind :(\n\n```js\nFunction.prototype.bind = require(\"function-bind\")\n```\n\n## Installation\n\n`npm install function-bind`\n\n## Contributors\n\n - Raynos\n\n## MIT Licenced\n\n [travis-svg]: https://travis-ci.org/Raynos/function-bind.svg\n [travis-url]: https://travis-ci.org/Raynos/function-bind\n [npm-badge-svg]: https://badge.fury.io/js/function-bind.svg\n [npm-url]: https://npmjs.org/package/function-bind\n [5]: https://coveralls.io/repos/Raynos/function-bind/badge.png\n [6]: https://coveralls.io/r/Raynos/function-bind\n [7]: https://gemnasium.com/Raynos/function-bind.png\n [8]: https://gemnasium.com/Raynos/function-bind\n [deps-svg]: https://david-dm.org/Raynos/function-bind.svg\n [deps-url]: https://david-dm.org/Raynos/function-bind\n [dev-deps-svg]: https://david-dm.org/Raynos/function-bind/dev-status.svg\n [dev-deps-url]: https://david-dm.org/Raynos/function-bind#info=devDependencies\n [11]: https://ci.testling.com/Raynos/function-bind.png\n [12]: https://ci.testling.com/Raynos/function-bind\n# Borsh JS\n\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://opensource.org/licenses/MIT)\n[](https://discord.gg/Vyp7ETM)\n[](https://travis-ci.com/near/borsh-js)\n[](https://npmjs.com/borsh)\n[](https://npmjs.com/borsh)\n\n**Borsh JS** is an implementation of the [Borsh] binary serialization format for\nJavaScript and TypeScript projects.\n\nBorsh stands for _Binary Object Representation Serializer for Hashing_. It is meant to be used in security-critical projects as it prioritizes consistency,\nsafety, speed, and comes with a strict specification.\n\n## Examples\n### Serializing an object\n```javascript\nconst value = new Test({ x: 255, y: 20, z: '123', q: [1, 2, 3] });\nconst schema = new Map([[Test, { kind: 'struct', fields: [['x', 'u8'], ['y', 'u64'], ['z', 'string'], ['q', [3]]] }]]);\nconst buffer = borsh.serialize(schema, value);\n```\n\n### Deserializing an object\n```javascript\nconst newValue = borsh.deserialize(schema, Test, buffer);\n```\n\n## Type Mappings\n\n| Borsh | TypeScript |\n|-----------------------|----------------|\n| `u8` integer | `number` |\n| `u16` integer | `number` |\n| `u32` integer | `number` |\n| `u64` integer | `BN` |\n| `u128` integer | `BN` |\n| `u256` integer | `BN` |\n| `u512` integer | `BN` |\n| `f32` float | N/A |\n| `f64` float | N/A |\n| fixed-size byte array | `Uint8Array` |\n| UTF-8 string | `string` |\n| option | `null` or type |\n| map | N/A |\n| set | N/A |\n| structs | `any` |\n\n## Contributing\n\nInstall dependencies:\n```bash\nyarn install\n```\n\nContinuously build with:\n```bash\nyarn dev\n```\n\nRun tests:\n```bash\nyarn test\n```\n\nRun linter\n```bash\nyarn lint\n```\n## Publish\n\nPrepare `dist` version by running:\n```bash\nyarn build\n```\n\nWhen publishing to npm use [np](https://github.com/sindresorhus/np).\n\n# License\nThis repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).\nSee [LICENSE-MIT](LICENSE-MIT.txt) and [LICENSE-APACHE](LICENSE-APACHE) for details.\n\n[Borsh]: https://borsh.io\n\n\n# [](https://typestrong.org/ts-node)\n\n[](https://npmjs.org/package/ts-node)\n[](https://npmjs.org/package/ts-node)\n[](https://github.com/TypeStrong/ts-node/actions?query=workflow%3A%22Continuous+Integration%22)\n[](https://codecov.io/gh/TypeStrong/ts-node)\n\n> TypeScript execution and REPL for node.js, with source map and native ESM support.\n\nThe latest documentation can also be found on our website: \n\n# Table of Contents\n\n* [Overview](#overview)\n * [Features](#features)\n* [Installation](#installation)\n* [Usage](#usage)\n * [Command Line](#command-line)\n * [Shebang](#shebang)\n * [node flags and other tools](#node-flags-and-other-tools)\n * [Programmatic](#programmatic)\n* [Configuration](#configuration)\n * [CLI flags](#cli-flags)\n * [Via tsconfig.json (recommended)](#via-tsconfigjson-recommended)\n * [@tsconfig/bases](#tsconfigbases)\n * [Default config](#default-config)\n * [`node` flags](#node-flags)\n* [Options](#options)\n * [CLI Options](#cli-options)\n * [help](#help)\n * [version](#version)\n * [eval](#eval)\n * [print](#print)\n * [interactive](#interactive)\n * [esm](#esm)\n * [TSConfig Options](#tsconfig-options)\n * [project](#project)\n * [skipProject](#skipproject)\n * [cwdMode](#cwdmode)\n * [compilerOptions](#compileroptions)\n * [showConfig](#showconfig)\n * [Typechecking](#typechecking)\n * [transpileOnly](#transpileonly)\n * [typeCheck](#typecheck)\n * [compilerHost](#compilerhost)\n * [files](#files)\n * [ignoreDiagnostics](#ignorediagnostics)\n * [Transpilation Options](#transpilation-options)\n * [ignore](#ignore)\n * [skipIgnore](#skipignore)\n * [compiler](#compiler)\n * [swc](#swc)\n * [transpiler](#transpiler)\n * [preferTsExts](#prefertsexts)\n * [Diagnostic Options](#diagnostic-options)\n * [logError](#logerror)\n * [pretty](#pretty)\n * [TS_NODE_DEBUG](#ts_node_debug)\n * [Advanced Options](#advanced-options)\n * [require](#require)\n * [cwd](#cwd)\n * [emit](#emit)\n * [scope](#scope)\n * [scopeDir](#scopedir)\n * [moduleTypes](#moduletypes)\n * [TS_NODE_HISTORY](#ts_node_history)\n * [noExperimentalReplAwait](#noexperimentalreplawait)\n * [experimentalResolver](#experimentalresolver)\n * [experimentalSpecifierResolution](#experimentalspecifierresolution)\n * [API Options](#api-options)\n* [SWC](#swc-1)\n* [CommonJS vs native ECMAScript modules](#commonjs-vs-native-ecmascript-modules)\n * [CommonJS](#commonjs)\n * [Native ECMAScript modules](#native-ecmascript-modules)\n* [Troubleshooting](#troubleshooting)\n * [Configuration](#configuration-1)\n * [Common errors](#common-errors)\n * [`TSError`](#tserror)\n * [`SyntaxError`](#syntaxerror)\n * [Unsupported JavaScript syntax](#unsupported-javascript-syntax)\n * [`ERR_REQUIRE_ESM`](#err_require_esm)\n * [`ERR_UNKNOWN_FILE_EXTENSION`](#err_unknown_file_extension)\n * [Missing Types](#missing-types)\n * [npx, yarn dlx, and node_modules](#npx-yarn-dlx-and-node_modules)\n* [Performance](#performance)\n * [Skip typechecking](#skip-typechecking)\n * [With typechecking](#with-typechecking)\n* [Advanced](#advanced)\n * [How it works](#how-it-works)\n * [Ignored files](#ignored-files)\n * [File extensions](#file-extensions)\n * [Skipping `node_modules`](#skipping-node_modules)\n * [Skipping pre-compiled TypeScript](#skipping-pre-compiled-typescript)\n * [Scope by directory](#scope-by-directory)\n * [Ignore by regexp](#ignore-by-regexp)\n * [paths and baseUrl\n ](#paths-and-baseurl)\n * [Why is this not built-in to ts-node?](#why-is-this-not-built-in-to-ts-node)\n * [Third-party compilers](#third-party-compilers)\n * [Transpilers](#transpilers)\n * [Third-party plugins](#third-party-plugins)\n * [Write your own plugin](#write-your-own-plugin)\n * [Module type overrides](#module-type-overrides)\n * [Caveats](#caveats)\n * [API](#api)\n* [Recipes](#recipes)\n * [Watching and restarting](#watching-and-restarting)\n * [AVA](#ava)\n * [CommonJS](#commonjs-1)\n * [Native ECMAScript modules](#native-ecmascript-modules-1)\n * [Gulp](#gulp)\n * [IntelliJ and Webstorm](#intellij-and-webstorm)\n * [Mocha](#mocha)\n * [Mocha 7 and newer](#mocha-7-and-newer)\n * [Mocha <=6](#mocha-6)\n * [Tape](#tape)\n * [Visual Studio Code](#visual-studio-code)\n * [Other](#other)\n* [License](#license)\n\n# Overview\n\nts-node is a TypeScript execution engine and REPL for Node.js.\n\nIt JIT transforms TypeScript into JavaScript, enabling you to directly execute TypeScript on Node.js without precompiling.\nThis is accomplished by hooking node's module loading APIs, enabling it to be used seamlessly alongside other Node.js\ntools and libraries.\n\n## Features\n\n* Automatic sourcemaps in stack traces\n* Automatic `tsconfig.json` parsing\n* Automatic defaults to match your node version\n* Typechecking (optional)\n* REPL\n* Write standalone scripts\n* Native ESM loader\n* Use third-party transpilers\n* Use custom transformers\n* Integrate with test runners, debuggers, and CLI tools\n* Compatible with pre-compilation for production\n\n\n\n# Installation\n\n```shell\n# Locally in your project.\nnpm install -D typescript\nnpm install -D ts-node\n\n# Or globally with TypeScript.\nnpm install -g typescript\nnpm install -g ts-node\n\n# Depending on configuration, you may also need these\nnpm install -D tslib @types/node\n```\n\n**Tip:** Installing modules locally allows you to control and share the versions through `package.json`. ts-node will always resolve the compiler from `cwd` before checking relative to its own installation.\n\n# Usage\n\n## Command Line\n\n```shell\n# Execute a script as `node` + `tsc`.\nts-node script.ts\n\n# Starts a TypeScript REPL.\nts-node\n\n# Execute code with TypeScript.\nts-node -e 'console.log(\"Hello, world!\")'\n\n# Execute, and print, code with TypeScript.\nts-node -p -e '\"Hello, world!\"'\n\n# Pipe scripts to execute with TypeScript.\necho 'console.log(\"Hello, world!\")' | ts-node\n\n# Equivalent to ts-node --transpileOnly\nts-node-transpile-only script.ts\n\n# Equivalent to ts-node --cwdMode\nts-node-cwd script.ts\n\n# Equivalent to ts-node --esm\nts-node-esm script.ts\n```\n\n## Shebang\n\nTo write scripts with maximum portability, [specify options in your `tsconfig.json`](#via-tsconfigjson-recommended) and omit them from the shebang.\n\n```typescript twoslash\n#!/usr/bin/env ts-node\n\n// ts-node options are read from tsconfig.json\n\nconsole.log(\"Hello, world!\")\n```\n\nIncluding options within the shebang requires the [`env -S` flag](https://manpages.debian.org/bullseye/coreutils/env.1.en.html#S), which is available on recent versions of `env`. ([compatibility](https://github.com/TypeStrong/ts-node/pull/1448#issuecomment-913895766))\n\n```typescript twoslash\n#!/usr/bin/env -S ts-node --files\n// This shebang works on Mac and Linux with newer versions of env\n// Technically, Mac allows omitting `-S`, but Linux requires it\n```\n\nTo test your version of `env` for compatibility with `-S`:\n\n```shell\n# Note that these unusual quotes are necessary\n/usr/bin/env --debug '-S echo foo bar'\n```\n\n## node flags and other tools\n\nYou can register ts-node without using our CLI: `node -r ts-node/register` and `node --loader ts-node/esm`\n\nIn many cases, setting [`NODE_OPTIONS`](https://nodejs.org/api/cli.html#cli_node_options_options) will enable `ts-node` within other node tools, child processes, and worker threads. This can be combined with other node flags.\n\n```shell\nNODE_OPTIONS=\"-r ts-node/register --no-warnings\" node ./index.ts\n```\n\nOr, if you require native ESM support:\n\n```shell\nNODE_OPTIONS=\"--loader ts-node/esm\"\n```\n\nThis tells any node processes which receive this environment variable to install `ts-node`'s hooks before executing other code.\n\nIf you are invoking node directly, you can avoid the environment variable and pass those flags to node.\n\n```shell\nnode --loader ts-node/esm --inspect ./index.ts\n```\n\n## Programmatic\n\nYou can require ts-node and register the loader for future requires by using `require('ts-node').register({ /* options */ })`.\n\nCheck out our [API](#api) for more features.\n\n# Configuration\n\nts-node supports a variety of options which can be specified via `tsconfig.json`, as CLI flags, as environment variables, or programmatically.\n\nFor a complete list, see [Options](#options).\n\n## CLI flags\n\nts-node CLI flags must come *before* the entrypoint script. For example:\n\n```shell\n$ ts-node --project tsconfig-dev.json say-hello.ts Ronald\nHello, Ronald!\n```\n\n## Via tsconfig.json (recommended)\n\nts-node automatically finds and loads `tsconfig.json`. Most ts-node options can be specified in a `\"ts-node\"` object using their programmatic, camelCase names. We recommend this because it works even when you cannot pass CLI flags, such as `node --require ts-node/register` and when using shebangs.\n\nUse `--skipProject` to skip loading the `tsconfig.json`. Use `--project` to explicitly specify the path to a `tsconfig.json`.\n\nWhen searching, it is resolved using [the same search behavior as `tsc`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html). By default, this search is performed relative to the entrypoint script. In `--cwdMode` or if no entrypoint is specified -- for example when using the REPL -- the search is performed relative to `--cwd` / `process.cwd()`.\n\nYou can use this sample configuration as a starting point:\n\n```jsonc title=\"tsconfig.json\"\n{\n // This is an alias to @tsconfig/node16: https://github.com/tsconfig/bases\n \"extends\": \"ts-node/node16/tsconfig.json\",\n\n // Most ts-node options can be specified here using their programmatic names.\n \"ts-node\": {\n // It is faster to skip typechecking.\n // Remove if you want ts-node to do typechecking.\n \"transpileOnly\": true,\n\n \"files\": true,\n\n \"compilerOptions\": {\n // compilerOptions specified here will override those declared below,\n // but *only* in ts-node. Useful if you want ts-node and tsc to use\n // different options with a single tsconfig.json.\n }\n },\n \"compilerOptions\": {\n // typescript options here\n }\n}\n```\n\nOur bundled [JSON schema](https://unpkg.com/browse/ts-node@latest/tsconfig.schema.json) lists all compatible options.\n\n### @tsconfig/bases\n\n[@tsconfig/bases](https://github.com/tsconfig/bases) maintains recommended configurations for several node versions.\nAs a convenience, these are bundled with ts-node.\n\n```jsonc title=\"tsconfig.json\"\n{\n \"extends\": \"ts-node/node16/tsconfig.json\",\n\n // Or install directly with `npm i -D @tsconfig/node16`\n \"extends\": \"@tsconfig/node16/tsconfig.json\",\n}\n```\n\n### Default config\n\nIf no `tsconfig.json` is loaded from disk, ts-node will use the newest recommended defaults from\n[@tsconfig/bases](https://github.com/tsconfig/bases/) compatible with your `node` and `typescript` versions.\nWith the latest `node` and `typescript`, this is [`@tsconfig/node16`](https://github.com/tsconfig/bases/blob/master/bases/node16.json).\n\nOlder versions of `typescript` are incompatible with `@tsconfig/node16`. In those cases we will use an older default configuration.\n\nWhen in doubt, `ts-node --showConfig` will log the configuration being used, and `ts-node -vv` will log `node` and `typescript` versions.\n\n## `node` flags\n\n[`node` flags](https://nodejs.org/api/cli.html) must be passed directly to `node`; they cannot be passed to the ts-node binary nor can they be specified in `tsconfig.json`\n\nWe recommend using the [`NODE_OPTIONS`](https://nodejs.org/api/cli.html#cli_node_options_options) environment variable to pass options to `node`.\n\n```shell\nNODE_OPTIONS='--trace-deprecation --abort-on-uncaught-exception' ts-node ./index.ts\n```\n\nAlternatively, you can invoke `node` directly and install ts-node via `--require`/`-r`\n\n```shell\nnode --trace-deprecation --abort-on-uncaught-exception -r ts-node/register ./index.ts\n```\n\n# Options\n\nAll command-line flags support both `--camelCase` and `--hyphen-case`.\n\nMost options can be declared in your tsconfig.json: [Configuration via tsconfig.json](#via-tsconfigjson-recommended)\n\n`ts-node` supports `--print` (`-p`), `--eval` (`-e`), `--require` (`-r`) and `--interactive` (`-i`) similar to the [node.js CLI](https://nodejs.org/api/cli.html).\n\n`ts-node` supports `--project` and `--showConfig` similar to the [tsc CLI](https://www.typescriptlang.org/docs/handbook/compiler-options.html#compiler-options).\n\n*Environment variables, where available, are in `ALL_CAPS`*\n\n## CLI Options\n\n### help\n\n```shell\nts-node --help\n```\n\nPrints the help text\n\n### version\n\n```shell\nts-node -v\nts-node -vvv\n```\n\nPrints the version. `-vv` includes node and typescript compiler versions. `-vvv` includes absolute paths to ts-node and\ntypescript installations.\n\n### eval\n\n```shell\nts-node -e \n# Example\nts-node -e 'console.log(\"Hello world!\")'\n```\n\nEvaluate code\n\n### print\n\n```shell\nts-node -p -e \n# Example\nts-node -p -e '\"Hello world!\"'\n```\n\nPrint result of `--eval`\n\n### interactive\n\n```shell\nts-node -i\n```\n\nOpens the REPL even if stdin does not appear to be a terminal\n\n### esm\n\n```shell\nts-node --esm\nts-node-esm\n```\n\nBootstrap with the ESM loader, enabling full ESM support\n\n## TSConfig Options\n\n### project\n\n```shell\nts-node -P \nts-node --project \n```\n\nPath to tsconfig file.\n\n*Note the uppercase `-P`. This is different from `tsc`'s `-p/--project` option.*\n\n*Environment:* `TS_NODE_PROJECT`\n\n### skipProject\n\n```shell\nts-node --skipProject\n```\n\nSkip project config resolution and loading\n\n*Default:* `false`
\n*Environment:* `TS_NODE_SKIP_PROJECT`\n\n### cwdMode\n\n```shell\nts-node -c\nts-node --cwdMode\nts-node-cwd\n```\n\nResolve config relative to the current directory instead of the directory of the entrypoint script\n\n### compilerOptions\n\n```shell\nts-node -O\nts-node --compilerOptions \n```\n\nJSON object to merge with compiler options\n\n*Environment:* `TS_NODE_COMPILER_OPTIONS`\n\n### showConfig\n\n```shell\nts-node --showConfig\n```\n\nPrint resolved `tsconfig.json`, including `ts-node` options, and exit\n\n## Typechecking\n\n### transpileOnly\n\n```shell\nts-node -T\nts-node --transpileOnly\n```\n\nUse TypeScript's faster `transpileModule`\n\n*Default:* `false`
\n*Environment:* `TS_NODE_TRANSPILE_ONLY`\n\n### typeCheck\n\n```shell\nts-node --typeCheck\n```\n\nOpposite of `--transpileOnly`\n\n*Default:* `true`
\n*Environment:* `TS_NODE_TYPE_CHECK`\n\n### compilerHost\n\n```shell\nts-node -H\nts-node --compilerHost\n```\n\nUse TypeScript's compiler host API\n\n*Default:* `false`
\n*Environment:* `TS_NODE_COMPILER_HOST`\n\n### files\n\n```shell\nts-node --files\n```\n\nLoad `files`, `include` and `exclude` from `tsconfig.json` on startup. This may\navoid certain typechecking failures. See [Missing types](#missing-types) for details.\n\n*Default:* `false`
\n*Environment:* `TS_NODE_FILES`\n\n### ignoreDiagnostics\n\n```shell\nts-node -D\nts-node --ignoreDiagnostics \n```\n\nIgnore TypeScript warnings by diagnostic code\n\n*Environment:* `TS_NODE_IGNORE_DIAGNOSTICS`\n\n## Transpilation Options\n\n### ignore\n\n```shell\nts-node -I \nts-node --ignore \n```\n\nOverride the path patterns to skip compilation\n\n*Default:* `/node_modules/`
\n*Environment:* `TS_NODE_IGNORE`\n\n### skipIgnore\n\n```shell\nts-node --skipIgnore\n```\n\nSkip ignore checks\n\n*Default:* `false`
\n*Environment:* `TS_NODE_SKIP_IGNORE`\n\n### compiler\n\n```shell\nts-node -C\nts-node --compiler \n```\n\nSpecify a custom TypeScript compiler\n\n*Default:* `typescript`
\n*Environment:* `TS_NODE_COMPILER`\n\n### swc\n\n```shell\nts-node --swc\n```\n\nTranspile with [swc](#swc). Implies `--transpileOnly`\n\n*Default:* `false`\n\n### transpiler\n\n```shell\nts-node --transpiler\n# Example\nts-node --transpiler ts-node/transpilers/swc\n```\n\nUse a third-party, non-typechecking transpiler\n\n### preferTsExts\n\n```shell\nts-node --preferTsExts\n```\n\nRe-order file extensions so that TypeScript imports are preferred\n\n*Default:* `false`
\n*Environment:* `TS_NODE_PREFER_TS_EXTS`\n\n## Diagnostic Options\n\n### logError\n\n```shell\nts-node --logError\n```\n\nLogs TypeScript errors to stderr instead of throwing exceptions\n\n*Default:* `false`
\n*Environment:* `TS_NODE_LOG_ERROR`\n\n### pretty\n\n```shell\nts-node --pretty\n```\n\nUse pretty diagnostic formatter\n\n*Default:* `false`
\n*Environment:* `TS_NODE_PRETTY`\n\n### TS_NODE_DEBUG\n\n```shell\nTS_NODE_DEBUG=true ts-node\n```\n\nEnable debug logging\n\n## Advanced Options\n\n### require\n\n```shell\nts-node -r\nts-node --require \n```\n\nRequire a node module before execution\n\n### cwd\n\n```shell\nts-node --cwd \n```\n\nBehave as if invoked in this working directory\n\n*Default:* `process.cwd()`
\n*Environment:* `TS_NODE_CWD`\n\n### emit\n\n```shell\nts-node --emit\n```\n\nEmit output files into `.ts-node` directory. Requires `--compilerHost`\n\n*Default:* `false`
\n*Environment:* `TS_NODE_EMIT`\n\n### scope\n\n```shell\nts-node --scope\n```\n\nScope compiler to files within `scopeDir`. Anything outside this directory is ignored.\n\n*Default:* `false`
\n*Environment:* `TS_NODE_SCOPE`\n\n### scopeDir\n\n```shell\nts-node --scopeDir\n```\n\nDirectory within which compiler is limited when `scope` is enabled.\n\n*Default:* First of: `tsconfig.json` \"rootDir\" if specified, directory containing `tsconfig.json`, or cwd if no `tsconfig.json` is loaded.
\n*Environment:* `TS_NODE_SCOPE_DIR`\n\n### moduleTypes\n\nOverride the module type of certain files, ignoring the `package.json` `\"type\"` field. See [Module type overrides](#module-type-overrides) for details.\n\n*Default:* obeys `package.json` `\"type\"` and `tsconfig.json` `\"module\"`
\n*Can only be specified via `tsconfig.json` or API.*\n\n### TS_NODE_HISTORY\n\n```shell\nTS_NODE_HISTORY= ts-node\n```\n\nPath to history file for REPL\n\n*Default:* `~/.ts_node_repl_history`\n\n### noExperimentalReplAwait\n\n```shell\nts-node --noExperimentalReplAwait\n```\n\nDisable top-level await in REPL. Equivalent to node's [`--no-experimental-repl-await`](https://nodejs.org/api/cli.html#cli_no_experimental_repl_await)\n\n*Default:* Enabled if TypeScript version is 3.8 or higher and target is ES2018 or higher.
\n*Environment:* `TS_NODE_EXPERIMENTAL_REPL_AWAIT` set `false` to disable\n\n### experimentalResolver\n\nEnable experimental hooks that re-map imports and require calls to support:\n\n* remapping extensions, e.g. so that `import \"./foo.js\"` will execute `foo.ts`. Currently the following extensions will be mapped:\n * `.js` to `.ts`, `.tsx`, or `.jsx`\n * `.cjs` to `.cts`\n * `.mjs` to `.mts`\n * `.jsx` to `.tsx`\n* including file extensions in CommonJS, for consistency with ESM where this is often mandatory\n\nIn the future, this hook will also support:\n\n* `baseUrl`, `paths`\n* `rootDirs`\n* `outDir` to `rootDir` mappings for composite projects and monorepos\n\nFor details, see [#1514](https://github.com/TypeStrong/ts-node/issues/1514).\n\n*Default:* `false`, but will likely be enabled by default in a future version
\n*Can only be specified via `tsconfig.json` or API.*\n\n### experimentalSpecifierResolution\n\n```shell\nts-node --experimentalSpecifierResolution node\n```\n\nLike node's [`--experimental-specifier-resolution`](https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm), but can also be set in your `tsconfig.json` for convenience.\nRequires [`esm`](#esm) to be enabled.\n\n*Default:* `explicit`
\n\n## API Options\n\nThe API includes [additional options](https://typestrong.org/ts-node/api/interfaces/RegisterOptions.html) not shown here.\n\n# SWC\n\nSWC support is built-in via the `--swc` flag or `\"swc\": true` tsconfig option.\n\n[SWC](https://swc.rs) is a TypeScript-compatible transpiler implemented in Rust. This makes it an order of magnitude faster than vanilla `transpileOnly`.\n\nTo use it, first install `@swc/core` or `@swc/wasm`. If using `importHelpers`, also install `@swc/helpers`. If `target` is less than \"es2015\" and using `async`/`await` or generator functions, also install `regenerator-runtime`.\n\n```shell\nnpm i -D @swc/core @swc/helpers regenerator-runtime\n```\n\nThen add the following to your `tsconfig.json`.\n\n```jsonc title=\"tsconfig.json\"\n{\n \"ts-node\": {\n \"swc\": true\n }\n}\n```\n\n> SWC uses `@swc/helpers` instead of `tslib`. If you have enabled `importHelpers`, you must also install `@swc/helpers`.\n\n# CommonJS vs native ECMAScript modules\n\nTypeScript is almost always written using modern `import` syntax, but it is also transformed before being executed by the underlying runtime. You can choose to either transform to CommonJS or to preserve the native `import` syntax, using node's native ESM support. Configuration is different for each.\n\nHere is a brief comparison of the two.\n\n| CommonJS | Native ECMAScript modules |\n|---|---|\n| Write native `import` syntax | Write native `import` syntax |\n| Transforms `import` into `require()` | Does not transform `import` |\n| Node executes scripts using the classic [CommonJS loader](https://nodejs.org/dist/latest-v16.x/docs/api/modules.html) | Node executes scripts using the new [ESM loader](https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) |\n| Use any of:
`ts-node`
`node -r ts-node/register`
`NODE_OPTIONS=\"ts-node/register\" node`
`require('ts-node').register({/* options */})` | Use any of:
`ts-node --esm`
`ts-node-esm`
Set `\"esm\": true` in `tsconfig.json`
`node --loader ts-node/esm`
`NODE_OPTIONS=\"--loader ts-node/esm\" node` |\n\n## CommonJS\n\nTransforming to CommonJS is typically simpler and more widely supported because it is older. You must remove [`\"type\": \"module\"`](https://nodejs.org/api/packages.html#packages_type) from `package.json` and set [`\"module\": \"CommonJS\"`](https://www.typescriptlang.org/tsconfig/#module) in `tsconfig.json`.\n\n```jsonc title=\"package.json\"\n{\n // This can be omitted; commonjs is the default\n \"type\": \"commonjs\"\n}\n```\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"module\": \"CommonJS\"\n }\n}\n```\n\nIf you must keep `\"module\": \"ESNext\"` for `tsc`, webpack, or another build tool, you can set an override for ts-node.\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"module\": \"ESNext\"\n },\n \"ts-node\": {\n \"compilerOptions\": {\n \"module\": \"CommonJS\"\n }\n }\n}\n```\n\n## Native ECMAScript modules\n\n[Node's ESM loader hooks](https://nodejs.org/api/esm.html#esm_experimental_loaders) are [**experimental**](https://nodejs.org/api/documentation.html#documentation_stability_index) and subject to change. ts-node's ESM support is as stable as possible, but it relies on APIs which node can *and will* break in new versions of node. Thus it is not recommended for production.\n\nFor complete usage, limitations, and to provide feedback, see [#1007](https://github.com/TypeStrong/ts-node/issues/1007).\n\nYou must set [`\"type\": \"module\"`](https://nodejs.org/api/packages.html#packages_type) in `package.json` and [`\"module\": \"ESNext\"`](https://www.typescriptlang.org/tsconfig/#module) in `tsconfig.json`.\n\n```jsonc title=\"package.json\"\n{\n \"type\": \"module\"\n}\n```\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"module\": \"ESNext\" // or ES2015, ES2020\n },\n \"ts-node\": {\n // Tell ts-node CLI to install the --loader automatically, explained below\n \"esm\": true\n }\n}\n```\n\nYou must also ensure node is passed `--loader`. The ts-node CLI will do this automatically with our `esm` option.\n\n> Note: `--esm` must spawn a child process to pass it `--loader`. This may change if node adds the ability to install loader hooks\n> into the current process.\n\n```shell\n# pass the flag\nts-node --esm\n# Use the convenience binary\nts-node-esm\n# or add `\"esm\": true` to your tsconfig.json to make it automatic\nts-node\n```\n\nIf you are not using our CLI, pass the loader flag to node.\n\n```shell\nnode --loader ts-node/esm ./index.ts\n# Or via environment variable\nNODE_OPTIONS=\"--loader ts-node/esm\" node ./index.ts\n```\n\n# Troubleshooting\n\n## Configuration\n\nts-node uses sensible default configurations to reduce boilerplate while still respecting `tsconfig.json` if you\nhave one. If you are unsure which configuration is used, you can log it with `ts-node --showConfig`. This is similar to\n`tsc --showConfig` but includes `\"ts-node\"` options as well.\n\nts-node also respects your locally-installed `typescript` version, but global installations fallback to the globally-installed\n`typescript`. If you are unsure which versions are used, `ts-node -vv` will log them.\n\n```shell\n$ ts-node -vv\nts-node v10.0.0\nnode v16.1.0\ncompiler v4.2.2\n\n$ ts-node --showConfig\n{\n \"compilerOptions\": {\n \"target\": \"es6\",\n \"lib\": [\n \"es6\",\n \"dom\"\n ],\n \"rootDir\": \"./src\",\n \"outDir\": \"./.ts-node\",\n \"module\": \"commonjs\",\n \"moduleResolution\": \"node\",\n \"strict\": true,\n \"declaration\": false,\n \"sourceMap\": true,\n \"inlineSources\": true,\n \"types\": [\n \"node\"\n ],\n \"stripInternal\": true,\n \"incremental\": true,\n \"skipLibCheck\": true,\n \"importsNotUsedAsValues\": \"error\",\n \"inlineSourceMap\": false,\n \"noEmit\": false\n },\n \"ts-node\": {\n \"cwd\": \"/d/project\",\n \"projectSearchDir\": \"/d/project\",\n \"require\": [],\n \"project\": \"/d/project/tsconfig.json\"\n }\n}\n```\n\n## Common errors\n\nIt is important to differentiate between errors from ts-node, errors from the TypeScript compiler, and errors from `node`. It is also important to understand when errors are caused by a type error in your code, a bug in your code, or a flaw in your configuration.\n\n### `TSError`\n\nType errors from the compiler are thrown as a `TSError`. These are the same as errors you get from `tsc`.\n\n### `SyntaxError`\n\nAny error that is not a `TSError` is from node.js (e.g. `SyntaxError`), and cannot be fixed by TypeScript or ts-node. These are bugs in your code or configuration.\n\n#### Unsupported JavaScript syntax\n\nYour version of `node` may not support all JavaScript syntax supported by TypeScript. The compiler must transform this syntax via \"downleveling,\" which is controlled by\nthe [tsconfig `\"target\"` option](https://www.typescriptlang.org/tsconfig#target). Otherwise your code will compile fine, but node will throw a `SyntaxError`.\n\nFor example, `node` 12 does not understand the `?.` optional chaining operator. If you use `\"target\": \"esnext\"`, then the following TypeScript syntax:\n\n```typescript twoslash\nconst bar: string | undefined = foo?.bar;\n```\n\nwill compile into this JavaScript:\n\n```javascript\nconst a = foo?.bar;\n```\n\nWhen you try to run this code, node 12 will throw a `SyntaxError`. To fix this, you must switch to `\"target\": \"es2019\"` or lower so TypeScript transforms `?.` into something `node` can understand.\n\n### `ERR_REQUIRE_ESM`\n\nThis error is thrown by node when a module is `require()`d, but node believes it should execute as native ESM. This can happen for a few reasons:\n\n* You have installed an ESM dependency but your own code compiles to CommonJS.\n * Solution: configure your project to compile and execute as native ESM. [Docs](#native-ecmascript-modules)\n * Solution: downgrade the dependency to an older, CommonJS version.\n* You have moved your project to ESM but still have a config file, such as `webpack.config.ts`, which must be executed as CommonJS \n * Solution: if supported by the relevant tool, rename your config file to `.cts`\n * Solution: Configure a module type override. [Docs](#module-type-overrides)\n* You have a mix of CommonJS and native ESM in your project\n * Solution: double-check all package.json \"type\" and tsconfig.json \"module\" configuration [Docs](#commonjs-vs-native-ecmascript-modules)\n * Solution: consider simplifying by making your project entirely CommonJS or entirely native ESM\n\n### `ERR_UNKNOWN_FILE_EXTENSION`\n\nThis error is thrown by node when a module has an unrecognized file extension, or no extension at all, and is being executed as native ESM. This can happen for a few reasons:\n\n* You are using a tool which has an extensionless binary, such as `mocha`.\n * CommonJS supports extensionless files but native ESM does not.\n * Solution: upgrade to ts-node >=[v10.6.0](https://github.com/TypeStrong/ts-node/releases/tag/v10.6.0), which implements a workaround.\n* Our ESM loader is not installed.\n * Solution: Use `ts-node-esm`, `ts-node --esm`, or add `\"ts-node\": {\"esm\": true}` to your tsconfig.json. [Docs](#native-ecmascript-modules)\n* You have moved your project to ESM but still have a config file, such as `webpack.config.ts`, which must be executed as CommonJS \n * Solution: if supported by the relevant tool, rename your config file to `.cts`\n * Solution: Configure a module type override. [Docs](#module-type-overrides)\n\n## Missing Types\n\nts-node does *not* eagerly load `files`, `include` or `exclude` by default. This is because a large majority of projects do not use all of the files in a project directory (e.g. `Gulpfile.ts`, runtime vs tests) and parsing every file for types slows startup time. Instead, ts-node starts with the script file (e.g. `ts-node index.ts`) and TypeScript resolves dependencies based on imports and references.\n\nOccasionally, this optimization leads to missing types. Fortunately, there are other ways to include them in typechecking.\n\nFor global definitions, you can use the `typeRoots` compiler option. This requires that your type definitions be structured as type packages (not loose TypeScript definition files). More details on how this works can be found in the [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types).\n\nExample `tsconfig.json`:\n\n```jsonc\n{\n \"compilerOptions\": {\n \"typeRoots\" : [\"./node_modules/@types\", \"./typings\"]\n }\n}\n```\n\nExample project structure:\n\n```text\n/\n-- tsconfig.json\n-- typings/\n -- /\n -- index.d.ts\n```\n\nExample module declaration file:\n\n```typescript twoslash\ndeclare module '' {\n // module definitions go here\n}\n```\n\nFor module definitions, you can use [`paths`](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping):\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"baseUrl\": \".\",\n \"paths\": {\n \"custom-module-type\": [\"types/custom-module-type\"]\n }\n }\n}\n```\n\nAnother option is [triple-slash directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html). This may be helpful if you prefer not to change your `compilerOptions` or structure your type definitions for `typeRoots`. Below is an example of a triple-slash directive as a relative path within your project:\n\n```typescript twoslash\n/// ` command line argument as per the [Configuration Options](#configuration), and want to apply this same behavior when launching in IntelliJ, specify under \"Environment Variables\": `TS_NODE_PROJECT=`.\n\n## Mocha\n\n### Mocha 7 and newer\n\n```shell\nmocha --require ts-node/register --extensions ts,tsx --watch --watch-files src 'tests/**/*.{ts,tsx}' [...args]\n```\n\nOr specify options via your mocha config file.\n\n```jsonc title=\".mocharc.json\"\n{\n // Specify \"require\" for CommonJS\n \"require\": \"ts-node/register\",\n // Specify \"loader\" for native ESM\n \"loader\": \"ts-node/esm\",\n \"extensions\": [\"ts\", \"tsx\"],\n \"spec\": [\n \"tests/**/*.spec.*\"\n ],\n \"watch-files\": [\n \"src\"\n ]\n}\n```\n\nSee also: https://mochajs.org/#configuring-mocha-nodejs\n\n### Mocha <=6\n\n```shell\nmocha --require ts-node/register --watch-extensions ts,tsx \"test/**/*.{ts,tsx}\" [...args]\n```\n\n**Note:** `--watch-extensions` is only used in `--watch` mode.\n\n## Tape\n\n```shell\nts-node node_modules/tape/bin/tape [...args]\n```\n\n## Visual Studio Code\n\nCreate a new Node.js debug configuration, add `-r ts-node/register` to node args and move the `program` to the `args` list (so VS Code doesn't look for `outFiles`).\n\n```jsonc title=\".vscode/launch.json\"\n{\n \"configurations\": [{\n \"type\": \"node\",\n \"request\": \"launch\",\n \"name\": \"Launch Program\",\n \"runtimeArgs\": [\n \"-r\",\n \"ts-node/register\"\n ],\n \"args\": [\n \"${workspaceFolder}/src/index.ts\"\n ]\n }],\n}\n```\n\n**Note:** If you are using the `--project ` command line argument as per the [Configuration Options](#configuration), and want to apply this same behavior when launching in VS Code, add an \"env\" key into the launch configuration: `\"env\": { \"TS_NODE_PROJECT\": \"\" }`.\n\n## Other\n\nIn many cases, setting [`NODE_OPTIONS`](https://nodejs.org/api/cli.html#cli_node_options_options) will enable `ts-node` within other node tools, child processes, and worker threads.\n\n```shell\nNODE_OPTIONS=\"-r ts-node/register\"\n```\n\nOr, if you require native ESM support:\n\n```shell\nNODE_OPTIONS=\"--loader ts-node/esm\"\n```\n\nThis tells any node processes which receive this environment variable to install `ts-node`'s hooks before executing other code.\n\n# License\n\nts-node is licensed under the MIT license. [MIT](https://github.com/TypeStrong/ts-node/blob/main/LICENSE)\n\nts-node includes source code from Node.js which is licensed under the MIT license. [Node.js license information](https://raw.githubusercontent.com/nodejs/node/master/LICENSE)\n\nts-node includes source code from the TypeScript compiler which is licensed under the Apache License 2.0. [TypeScript license information](https://github.com/microsoft/TypeScript/blob/master/LICENSE.txt)\nNOTE: The default branch has been renamed!\nmaster is now named main\n\nIf you have a local clone, you can update it by running:\n\n```shell\ngit branch -m master main\ngit fetch origin\ngit branch -u origin/main main\n```\n\n# **node-addon-api module**\nThis module contains **header-only C++ wrapper classes** which simplify\nthe use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)\nprovided by Node.js when using C++. It provides a C++ object model\nand exception handling semantics with low overhead.\n\nThere are three options for implementing addons: Node-API, nan, or direct\nuse of internal V8, libuv and Node.js libraries. Unless there is a need for\ndirect access to functionality which is not exposed by Node-API as outlined\nin [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)\nin Node.js core, use Node-API. Refer to\n[C/C++ addons with Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)\nfor more information on Node-API.\n\nNode-API is an ABI stable C interface provided by Node.js for building native\naddons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore)\nand is maintained as part of Node.js itself. It is intended to insulate\nnative addons from changes in the underlying JavaScript engine and allow\nmodules compiled for one version to run on later versions of Node.js without\nrecompilation.\n\nThe `node-addon-api` module, which is not part of Node.js, preserves the benefits\nof the Node-API as it consists only of inline code that depends only on the stable API\nprovided by Node-API. As such, modules built against one version of Node.js\nusing node-addon-api should run without having to be rebuilt with newer versions\nof Node.js.\n\nIt is important to remember that *other* Node.js interfaces such as\n`libuv` (included in a project via `#include `) are not ABI-stable across\nNode.js major versions. Thus, an addon must use Node-API and/or `node-addon-api`\nexclusively and build against a version of Node.js that includes an\nimplementation of Node-API (meaning an active LTS version of Node.js) in\norder to benefit from ABI stability across Node.js major versions. Node.js\nprovides an [ABI stability guide][] containing a detailed explanation of ABI\nstability in general, and the Node-API ABI stability guarantee in particular.\n\nAs new APIs are added to Node-API, node-addon-api must be updated to provide\nwrappers for those new APIs. For this reason node-addon-api provides\nmethods that allow callers to obtain the underlying Node-API handles so\ndirect calls to Node-API and the use of the objects/methods provided by\nnode-addon-api can be used together. For example, in order to be able\nto use an API for which the node-addon-api does not yet provide a wrapper.\n\nAPIs exposed by node-addon-api are generally used to create and\nmanipulate JavaScript values. Concepts and operations generally map\nto ideas specified in the **ECMA262 Language Specification**.\n\nThe [Node-API Resource](https://nodejs.github.io/node-addon-examples/) offers an\nexcellent orientation and tips for developers just getting started with Node-API\nand node-addon-api.\n\n- **[Setup](#setup)**\n- **[API Documentation](#api)**\n- **[Examples](#examples)**\n- **[Tests](#tests)**\n- **[More resource and info about native Addons](#resources)**\n- **[Badges](#badges)**\n- **[Code of Conduct](CODE_OF_CONDUCT.md)**\n- **[Contributors](#contributors)**\n- **[License](#license)**\n\n## **Current version: 3.2.1**\n\n(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)\n\n[](https://nodei.co/npm/node-addon-api/) [](https://nodei.co/npm/node-addon-api/)\n\n\n\nnode-addon-api is based on [Node-API](https://nodejs.org/api/n-api.html) and supports using different Node-API versions.\nThis allows addons built with it to run with Node.js versions which support the targeted Node-API version.\n**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that\nevery year there will be a new major which drops support for the Node.js LTS version which has gone out of service.\n\nThe oldest Node.js version supported by the current version of node-addon-api is Node.js 10.x.\n\n## Setup\n - [Installation and usage](doc/setup.md)\n - [node-gyp](doc/node-gyp.md)\n - [cmake-js](doc/cmake-js.md)\n - [Conversion tool](doc/conversion-tool.md)\n - [Checker tool](doc/checker-tool.md)\n - [Generator](doc/generator.md)\n - [Prebuild tools](doc/prebuild_tools.md)\n\n\n\n### **API Documentation**\n\nThe following is the documentation for node-addon-api.\n\n - [Full Class Hierarchy](doc/hierarchy.md)\n - [Addon Structure](doc/addon.md)\n - Data Types:\n - [Env](doc/env.md)\n - [CallbackInfo](doc/callbackinfo.md)\n - [Reference](doc/reference.md)\n - [Value](doc/value.md)\n - [Name](doc/name.md)\n - [Symbol](doc/symbol.md)\n - [String](doc/string.md)\n - [Number](doc/number.md)\n - [Date](doc/date.md)\n - [BigInt](doc/bigint.md)\n - [Boolean](doc/boolean.md)\n - [External](doc/external.md)\n - [Object](doc/object.md)\n - [Array](doc/array.md)\n - [ObjectReference](doc/object_reference.md)\n - [PropertyDescriptor](doc/property_descriptor.md)\n - [Function](doc/function.md)\n - [FunctionReference](doc/function_reference.md)\n - [ObjectWrap](doc/object_wrap.md)\n - [ClassPropertyDescriptor](doc/class_property_descriptor.md)\n - [Buffer](doc/buffer.md)\n - [ArrayBuffer](doc/array_buffer.md)\n - [TypedArray](doc/typed_array.md)\n - [TypedArrayOf](doc/typed_array_of.md)\n - [DataView](doc/dataview.md)\n - [Error Handling](doc/error_handling.md)\n - [Error](doc/error.md)\n - [TypeError](doc/type_error.md)\n - [RangeError](doc/range_error.md)\n - [Object Lifetime Management](doc/object_lifetime_management.md)\n - [HandleScope](doc/handle_scope.md)\n - [EscapableHandleScope](doc/escapable_handle_scope.md)\n - [Memory Management](doc/memory_management.md)\n - [Async Operations](doc/async_operations.md)\n - [AsyncWorker](doc/async_worker.md)\n - [AsyncContext](doc/async_context.md)\n - [AsyncWorker Variants](doc/async_worker_variants.md)\n - [Thread-safe Functions](doc/threadsafe.md)\n - [ThreadSafeFunction](doc/threadsafe_function.md)\n - [TypedThreadSafeFunction](doc/typed_threadsafe_function.md)\n - [Promises](doc/promises.md)\n - [Version management](doc/version_management.md)\n\n\n\n### **Examples**\n\nAre you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**\n\n- **[Hello World](https://github.com/nodejs/node-addon-examples/tree/HEAD/1_hello_world/node-addon-api)**\n- **[Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/HEAD/2_function_arguments/node-addon-api)**\n- **[Callbacks](https://github.com/nodejs/node-addon-examples/tree/HEAD/3_callbacks/node-addon-api)**\n- **[Object factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/4_object_factory/node-addon-api)**\n- **[Function factory](https://github.com/nodejs/node-addon-examples/tree/HEAD/5_function_factory/node-addon-api)**\n- **[Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/HEAD/6_object_wrap/node-addon-api)**\n- **[Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/HEAD/7_factory_wrap/node-addon-api)**\n- **[Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/HEAD/8_passing_wrapped/node-addon-api)**\n\n\n\n### **Tests**\n\nTo run the **node-addon-api** tests do:\n\n```\nnpm install\nnpm test\n```\n\nTo avoid testing the deprecated portions of the API run\n```\nnpm install\nnpm test --disable-deprecated\n```\n\nTo run the tests targeting a specific version of Node-API run\n```\nnpm install\nexport NAPI_VERSION=X\nnpm test --NAPI_VERSION=X\n```\n\nwhere X is the version of Node-API you want to target.\n\n### **Debug**\n\nTo run the **node-addon-api** tests with `--debug` option:\n\n```\nnpm run-script dev\n```\n\nIf you want faster build, you might use the following option:\n\n```\nnpm run-script dev:incremental\n```\n\nTake a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/HEAD/test)**\n\n### **Benchmarks**\n\nYou can run the available benchmarks using the following command:\n\n```\nnpm run-script benchmark\n```\n\nSee [benchmark/README.md](benchmark/README.md) for more details about running and adding benchmarks.\n\n\n\n### **More resource and info about native Addons**\n- **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)**\n- **[Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html)**\n- **[Node-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)**\n- **[How We Migrated Realm JavaScript From NAN to Node-API](https://developer.mongodb.com/article/realm-javascript-nan-to-n-api)**\n\nAs node-addon-api's core mission is to expose the plain C Node-API as C++\nwrappers, tools that facilitate n-api/node-addon-api providing more\nconvenient patterns on developing a Node.js add-ons with n-api/node-addon-api\ncan be published to NPM as standalone packages. It is also recommended to tag\nsuch packages with `node-addon-api` to provide more visibility to the community.\n\nQuick links to NPM searches: [keywords:node-addon-api](https://www.npmjs.com/search?q=keywords%3Anode-addon-api).\n\n\n\n### **Other bindings**\n\n- **[napi-rs](https://napi.rs)** - (`Rust`)\n\n\n\n### **Badges**\n\nThe use of badges is recommended to indicate the minimum version of Node-API\nrequired for the module. This helps to determine which Node.js major versions are\nsupported. Addon maintainers can consult the [Node-API support matrix][] to determine\nwhich Node.js versions provide a given Node-API version. The following badges are\navailable:\n\n\n\n\n\n\n\n\n\n\n\n## **Contributing**\n\nWe love contributions from the community to **node-addon-api**!\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.\n\n\n\n## Team members\n\n### Active\n| Name | GitHub Link |\n| ------------------- | ----------------------------------------------------- |\n| Anna Henningsen | [addaleax](https://github.com/addaleax) |\n| Chengzhong Wu | [legendecas](https://github.com/legendecas) |\n| Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |\n| Jim Schlight | [jschlight](https://github.com/jschlight) |\n| Michael Dawson | [mhdawson](https://github.com/mhdawson) |\n| Kevin Eady | [KevinEady](https://github.com/KevinEady)\n| Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) |\n\n### Emeritus\n| Name | GitHub Link |\n| ------------------- | ----------------------------------------------------- |\n| Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |\n| Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |\n| Jason Ginchereau | [jasongin](https://github.com/jasongin) |\n| Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |\n| Sampson Gao | [sampsongao](https://github.com/sampsongao) |\n| Taylor Woll | [boingoing](https://github.com/boingoing) |\n\n\n\nLicensed under [MIT](./LICENSE.md)\n\n[ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/\n[Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#n_api_n_api_version_matrix\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}` 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}` 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}` 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* `fs` File-system object with Node's `fs` API. By default, the built-in\n `fs` module will be used. Set to a volume provided by a library like\n `memfs` to avoid using the \"real\" file-system.\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# 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# napi-build-utils\n\n[](https://www.npmjs.com/package/napi-build-utils)\n\n[](https://travis-ci.org/inspiredware/napi-build-utils) \n[](http://standardjs.com/) \n[](https://opensource.org/licenses/MIT) \n\nA set of utilities to assist developers of tools that build [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.\n\n## Background\n\nThis module is targeted to developers creating tools that build N-API native add-ons. \n\nIt implements a set of functions that aid in determining the N-API version supported by the currently running Node instance and the set of N-API versions against which the N-API native add-on is designed to be built. Other functions determine whether a particular N-API version can be built and can issue console warnings for unsupported N-API versions. \n\nUnlike the modules this code is designed to facilitate building, this module is written entirely in JavaScript. \n\n## Quick start\n\n```bash\n$ npm install napi-build-utils\n```\n\nThe module exports a set of functions documented [here](./index.md). For example:\n\n```javascript\nvar napiBuildUtils = require('napi-build-utils');\nvar napiVersion = napiBuildUtils.getNapiVersion(); // N-API version supported by Node, or undefined.\n```\n\n## Declaring supported N-API versions\n\nNative modules that are designed to work with [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) must explicitly declare the N-API version(s) against which they are coded to build. This is accomplished by including a `binary.napi_versions` property in the module's `package.json` file. For example:\n\n```json\n\"binary\": {\n \"napi_versions\": [2,3]\n}\n``` \n\nIn the absence of a need to compile against a specific N-API version, the value `3` is a good choice as this is the N-API version that was supported when N-API left experimental status. \n\nModules that are built against a specific N-API version will continue to operate indefinitely, even as later versions of N-API are introduced. \n\n## Support\n\nIf you run into problems or limitations, please file an issue and we'll take a look. Pull requests are also welcome.\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 process 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# 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 from 'setprototypeof'\n```\n# pretty-format\n\nStringify any JavaScript value.\n\n- Serialize built-in JavaScript types.\n- Serialize application-specific data types with built-in or user-defined plugins.\n\n## Installation\n\n```sh\n$ yarn add pretty-format\n```\n\n## Usage\n\n```js\nconst {format: prettyFormat} = require('pretty-format'); // CommonJS\n```\n\n```js\nimport {format as prettyFormat} from 'pretty-format'; // ES2015 modules\n```\n\n```js\nconst val = {object: {}};\nval.circularReference = val;\nval[Symbol('foo')] = 'foo';\nval.map = new Map([['prop', 'value']]);\nval.array = [-0, Infinity, NaN];\n\nconsole.log(prettyFormat(val));\n/*\nObject {\n \"array\": Array [\n -0,\n Infinity,\n NaN,\n ],\n \"circularReference\": [Circular],\n \"map\": Map {\n \"prop\" => \"value\",\n },\n \"object\": Object {},\n Symbol(foo): \"foo\",\n}\n*/\n```\n\n## Usage with options\n\n```js\nfunction onClick() {}\n\nconsole.log(prettyFormat(onClick));\n/*\n[Function onClick]\n*/\n\nconst options = {\n printFunctionName: false,\n};\nconsole.log(prettyFormat(onClick, options));\n/*\n[Function]\n*/\n```\n\n\n| key | type | default | description |\n| :-------------------- | :-------- | :--------- | :------------------------------------------------------ |\n| `callToJSON` | `boolean` | `true` | call `toJSON` method (if it exists) on objects |\n| `compareKeys` | `function`| `undefined`| compare function used when sorting object keys |\n| `escapeRegex` | `boolean` | `false` | escape special characters in regular expressions |\n| `escapeString` | `boolean` | `true` | escape special characters in strings |\n| `highlight` | `boolean` | `false` | highlight syntax with colors in terminal (some plugins) |\n| `indent` | `number` | `2` | spaces in each level of indentation |\n| `maxDepth` | `number` | `Infinity` | levels to print in arrays, objects, elements, and so on |\n| `min` | `boolean` | `false` | minimize added space: no indentation nor line breaks |\n| `plugins` | `array` | `[]` | plugins to serialize application-specific data types |\n| `printBasicPrototype` | `boolean` | `false` | print the prototype for plain objects and arrays |\n| `printFunctionName` | `boolean` | `true` | include or omit the name of a function |\n| `theme` | `object` | | colors to highlight syntax in terminal |\n\nProperty values of `theme` are from [ansi-styles colors](https://github.com/chalk/ansi-styles#colors)\n\n```js\nconst DEFAULT_THEME = {\n comment: 'gray',\n content: 'reset',\n prop: 'yellow',\n tag: 'cyan',\n value: 'green',\n};\n```\n\n## Usage with plugins\n\nThe `pretty-format` package provides some built-in plugins, including:\n\n- `ReactElement` for elements from `react`\n- `ReactTestComponent` for test objects from `react-test-renderer`\n\n```js\n// CommonJS\nconst React = require('react');\nconst renderer = require('react-test-renderer');\nconst {format: prettyFormat, plugins} = require('pretty-format');\n\nconst {ReactElement, ReactTestComponent} = plugins;\n```\n\n```js\n// ES2015 modules and destructuring assignment\nimport React from 'react';\nimport renderer from 'react-test-renderer';\nimport {plugins, format as prettyFormat} from 'pretty-format';\n\nconst {ReactElement, ReactTestComponent} = plugins;\n```\n\n```js\nconst onClick = () => {};\nconst element = React.createElement('button', {onClick}, 'Hello World');\n\nconst formatted1 = prettyFormat(element, {\n plugins: [ReactElement],\n printFunctionName: false,\n});\nconst formatted2 = prettyFormat(renderer.create(element).toJSON(), {\n plugins: [ReactTestComponent],\n printFunctionName: false,\n});\n/*\n\n Hello World\n\n*/\n```\n\n## Usage in Jest\n\nFor snapshot tests, Jest uses `pretty-format` with options that include some of its built-in plugins. For this purpose, plugins are also known as **snapshot serializers**.\n\nTo serialize application-specific data types, you can add modules to `devDependencies` of a project, and then:\n\nIn an **individual** test file, you can add a module as follows. It precedes any modules from Jest configuration.\n\n```js\nimport serializer from 'my-serializer-module';\nexpect.addSnapshotSerializer(serializer);\n\n// tests which have `expect(value).toMatchSnapshot()` assertions\n```\n\nFor **all** test files, you can specify modules in Jest configuration. They precede built-in plugins for React, HTML, and Immutable.js data types. For example, in a `package.json` file:\n\n```json\n{\n \"jest\": {\n \"snapshotSerializers\": [\"my-serializer-module\"]\n }\n}\n```\n\n## Writing plugins\n\nA plugin is a JavaScript object.\n\nIf `options` has a `plugins` array: for the first plugin whose `test(val)` method returns a truthy value, then `prettyFormat(val, options)` returns the result from either:\n\n- `serialize(val, …)` method of the **improved** interface (available in **version 21** or later)\n- `print(val, …)` method of the **original** interface (if plugin does not have `serialize` method)\n\n### test\n\nWrite `test` so it can receive `val` argument of any type. To serialize **objects** which have certain properties, then a guarded expression like `val != null && …` or more concise `val && …` prevents the following errors:\n\n- `TypeError: Cannot read property 'whatever' of null`\n- `TypeError: Cannot read property 'whatever' of undefined`\n\nFor example, `test` method of built-in `ReactElement` plugin:\n\n```js\nconst elementSymbol = Symbol.for('react.element');\nconst test = val => val && val.$$typeof === elementSymbol;\n```\n\nPay attention to efficiency in `test` because `pretty-format` calls it often.\n\n### serialize\n\nThe **improved** interface is available in **version 21** or later.\n\nWrite `serialize` to return a string, given the arguments:\n\n- `val` which “passed the test”\n- unchanging `config` object: derived from `options`\n- current `indentation` string: concatenate to `indent` from `config`\n- current `depth` number: compare to `maxDepth` from `config`\n- current `refs` array: find circular references in objects\n- `printer` callback function: serialize children\n\n### config\n\n\n| key | type | description |\n| :------------------ | :-------- | :------------------------------------------------------ |\n| `callToJSON` | `boolean` | call `toJSON` method (if it exists) on objects |\n| `compareKeys` | `function`| compare function used when sorting object keys |\n| `colors` | `Object` | escape codes for colors to highlight syntax |\n| `escapeRegex` | `boolean` | escape special characters in regular expressions |\n| `escapeString` | `boolean` | escape special characters in strings |\n| `indent` | `string` | spaces in each level of indentation |\n| `maxDepth` | `number` | levels to print in arrays, objects, elements, and so on |\n| `min` | `boolean` | minimize added space: no indentation nor line breaks |\n| `plugins` | `array` | plugins to serialize application-specific data types |\n| `printFunctionName` | `boolean` | include or omit the name of a function |\n| `spacingInner` | `strong` | spacing to separate items in a list |\n| `spacingOuter` | `strong` | spacing to enclose a list of items |\n\nEach property of `colors` in `config` corresponds to a property of `theme` in `options`:\n\n- the key is the same (for example, `tag`)\n- the value in `colors` is a object with `open` and `close` properties whose values are escape codes from [ansi-styles](https://github.com/chalk/ansi-styles) for the color value in `theme` (for example, `'cyan'`)\n\nSome properties in `config` are derived from `min` in `options`:\n\n- `spacingInner` and `spacingOuter` are **newline** if `min` is `false`\n- `spacingInner` is **space** and `spacingOuter` is **empty string** if `min` is `true`\n\n### Example of serialize and test\n\nThis plugin is a pattern you can apply to serialize composite data types. Side note: `pretty-format` does not need a plugin to serialize arrays.\n\n```js\n// We reused more code when we factored out a function for child items\n// that is independent of depth, name, and enclosing punctuation (see below).\nconst SEPARATOR = ',';\nfunction serializeItems(items, config, indentation, depth, refs, printer) {\n if (items.length === 0) {\n return '';\n }\n const indentationItems = indentation + config.indent;\n return (\n config.spacingOuter +\n items\n .map(\n item =>\n indentationItems +\n printer(item, config, indentationItems, depth, refs), // callback\n )\n .join(SEPARATOR + config.spacingInner) +\n (config.min ? '' : SEPARATOR) + // following the last item\n config.spacingOuter +\n indentation\n );\n}\n\nconst plugin = {\n test(val) {\n return Array.isArray(val);\n },\n serialize(array, config, indentation, depth, refs, printer) {\n const name = array.constructor.name;\n return ++depth > config.maxDepth\n ? '[' + name + ']'\n : (config.min ? '' : name + ' ') +\n '[' +\n serializeItems(array, config, indentation, depth, refs, printer) +\n ']';\n },\n};\n```\n\n```js\nconst val = {\n filter: 'completed',\n items: [\n {\n text: 'Write test',\n completed: true,\n },\n {\n text: 'Write serialize',\n completed: true,\n },\n ],\n};\n```\n\n```js\nconsole.log(\n prettyFormat(val, {\n plugins: [plugin],\n }),\n);\n/*\nObject {\n \"filter\": \"completed\",\n \"items\": Array [\n Object {\n \"completed\": true,\n \"text\": \"Write test\",\n },\n Object {\n \"completed\": true,\n \"text\": \"Write serialize\",\n },\n ],\n}\n*/\n```\n\n```js\nconsole.log(\n prettyFormat(val, {\n indent: 4,\n plugins: [plugin],\n }),\n);\n/*\nObject {\n \"filter\": \"completed\",\n \"items\": Array [\n Object {\n \"completed\": true,\n \"text\": \"Write test\",\n },\n Object {\n \"completed\": true,\n \"text\": \"Write serialize\",\n },\n ],\n}\n*/\n```\n\n```js\nconsole.log(\n prettyFormat(val, {\n maxDepth: 1,\n plugins: [plugin],\n }),\n);\n/*\nObject {\n \"filter\": \"completed\",\n \"items\": [Array],\n}\n*/\n```\n\n```js\nconsole.log(\n prettyFormat(val, {\n min: true,\n plugins: [plugin],\n }),\n);\n/*\n{\"filter\": \"completed\", \"items\": [{\"completed\": true, \"text\": \"Write test\"}, {\"completed\": true, \"text\": \"Write serialize\"}]}\n*/\n```\n\n### print\n\nThe **original** interface is adequate for plugins:\n\n- that **do not** depend on options other than `highlight` or `min`\n- that **do not** depend on `depth` or `refs` in recursive traversal, and\n- if values either\n - do **not** require indentation, or\n - do **not** occur as children of JavaScript data structures (for example, array)\n\nWrite `print` to return a string, given the arguments:\n\n- `val` which “passed the test”\n- current `printer(valChild)` callback function: serialize children\n- current `indenter(lines)` callback function: indent lines at the next level\n- unchanging `config` object: derived from `options`\n- unchanging `colors` object: derived from `options`\n\nThe 3 properties of `config` are `min` in `options` and:\n\n- `spacing` and `edgeSpacing` are **newline** if `min` is `false`\n- `spacing` is **space** and `edgeSpacing` is **empty string** if `min` is `true`\n\nEach property of `colors` corresponds to a property of `theme` in `options`:\n\n- the key is the same (for example, `tag`)\n- the value in `colors` is a object with `open` and `close` properties whose values are escape codes from [ansi-styles](https://github.com/chalk/ansi-styles) for the color value in `theme` (for example, `'cyan'`)\n\n### Example of print and test\n\nThis plugin prints functions with the **number of named arguments** excluding rest argument.\n\n```js\nconst plugin = {\n print(val) {\n return `[Function ${val.name || 'anonymous'} ${val.length}]`;\n },\n test(val) {\n return typeof val === 'function';\n },\n};\n```\n\n```js\nconst val = {\n onClick(event) {},\n render() {},\n};\n\nprettyFormat(val, {\n plugins: [plugin],\n});\n/*\nObject {\n \"onClick\": [Function onClick 1],\n \"render\": [Function render 0],\n}\n*/\n\nprettyFormat(val);\n/*\nObject {\n \"onClick\": [Function onClick],\n \"render\": [Function render],\n}\n*/\n```\n\nThis plugin **ignores** the `printFunctionName` option. That limitation of the original `print` interface is a reason to use the improved `serialize` interface, described above.\n\n```js\nprettyFormat(val, {\n plugins: [pluginOld],\n printFunctionName: false,\n});\n/*\nObject {\n \"onClick\": [Function onClick 1],\n \"render\": [Function render 0],\n}\n*/\n\nprettyFormat(val, {\n printFunctionName: false,\n});\n/*\nObject {\n \"onClick\": [Function],\n \"render\": [Function],\n}\n*/\n```\n# `react-is`\n\nThis package allows you to test arbitrary values and see if they're a particular React element type.\n\n## Installation\n\n```sh\n# Yarn\nyarn add react-is\n\n# NPM\nnpm install react-is\n```\n\n## Usage\n\n### Determining if a Component is Valid\n\n```js\nimport React from \"react\";\nimport * as ReactIs from \"react-is\";\n\nclass ClassComponent extends React.Component {\n render() {\n return React.createElement(\"div\");\n }\n}\n\nconst FunctionComponent = () => React.createElement(\"div\");\n\nconst ForwardRefComponent = React.forwardRef((props, ref) =>\n React.createElement(Component, { forwardedRef: ref, ...props })\n);\n\nconst Context = React.createContext(false);\n\nReactIs.isValidElementType(\"div\"); // true\nReactIs.isValidElementType(ClassComponent); // true\nReactIs.isValidElementType(FunctionComponent); // true\nReactIs.isValidElementType(ForwardRefComponent); // true\nReactIs.isValidElementType(Context.Provider); // true\nReactIs.isValidElementType(Context.Consumer); // true\nReactIs.isValidElementType(React.createFactory(\"div\")); // true\n```\n\n### Determining an Element's Type\n\n#### Context\n\n```js\nimport React from \"react\";\nimport * as ReactIs from 'react-is';\n\nconst ThemeContext = React.createContext(\"blue\");\n\nReactIs.isContextConsumer( [ [...]]\nPrints valid versions sorted by SemVer precedence\n\nOptions:\n-r --range \n Print versions that match the specified range.\n\n-i --increment []\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 \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\n--rtl\n Coerce version strings right to left\n\n--ltr\n Coerce version strings left to right (default)\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
\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`
\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`
\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`
\nDefault: `undefined`\n\nLimits TTL. The `number` represents milliseconds.\n\n###### opts.automaticFailover\n\nType: `boolean`
\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`
\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# has\n\n> Object.prototype.hasOwnProperty.call shortcut\n\n## Installation\n\n```sh\nnpm install --save has\n```\n\n## Usage\n\n```js\nvar has = require('has');\n\nhas({}, 'hasOwnProperty'); // false\nhas(Object.prototype, 'hasOwnProperty'); // true\n```\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# axios // adapters\n\nThe modules under `adapters/` are modules that handle dispatching a request and settling a returned `Promise` once a response is received.\n\n## Example\n\n```js\nvar settle = require('./../core/settle');\n\nmodule.exports = function myAdapter(config) {\n // At this point:\n // - config has been merged with defaults\n // - request transformers have already run\n // - request interceptors have already run\n \n // Make the request using config provided\n // Upon response settle the Promise\n\n return new Promise(function(resolve, reject) {\n \n var response = {\n data: responseData,\n status: request.status,\n statusText: request.statusText,\n headers: responseHeaders,\n config: config,\n request: request\n };\n\n settle(resolve, reject, response);\n\n // From here:\n // - response transformers will run\n // - response interceptors will run\n });\n}\n```\n# MD5\n\n[](http://travis-ci.org/pvorb/node-md5) [](http://npm-stat.com/charts.html?package=md5)\n\na JavaScript function for hashing messages with MD5.\n\nnode-md5 is being sponsored by the following tool; please help to support us by taking a look and signing up to a free trial \n![\"GitAds\"/](\"https://images.gitads.io/node-md5\")
\n\n## Installation\n\nYou can use this package on the server side as well as the client side.\n\n### [Node.js](http://nodejs.org/):\n\n~~~\nnpm install md5\n~~~\n\n## API\n\n~~~ javascript\nmd5(message)\n~~~\n\n * `message` -- `String`, `Buffer`, `Array` or `Uint8Array`\n * returns `String`\n\n## Usage\n\n~~~ javascript\nvar md5 = require('md5');\n\nconsole.log(md5('message'));\n~~~\n\nThis will print the following\n\n~~~\n78e731027d8fd50ed642340b7c9a63b3\n~~~\n\nIt supports buffers, too\n\n~~~ javascript\nvar fs = require('fs');\nvar md5 = require('md5');\n\nfs.readFile('example.txt', function(err, buf) {\n console.log(md5(buf));\n});\n~~~\n\n## Versions\n\nBefore version 2.0.0 there were two packages called md5 on npm, one lowercase,\none uppercase (the one you're looking at). As of version 2.0.0, all new versions\nof this module will go to lowercase [md5](https://www.npmjs.com/package/md5) on\nnpm. To use the correct version, users of this module will have to change their\ncode from `require('MD5')` to `require('md5')` if they want to use versions >=\n2.0.0.\n\n## Bugs and Issues\n\nIf you encounter any bugs or issues, feel free to open an issue at\n[github](https://github.com/pvorb/node-md5/issues).\n\n## Credits\n\nThis package is based on the work of Jeff Mott, who did a pure JS implementation\nof the MD5 algorithm that was published by Ronald L. Rivest in 1991. I needed a\nnpm package of the algorithm, so I used Jeff’s implementation for this package.\nThe original implementation can be found in the\n[CryptoJS](http://code.google.com/p/crypto-js/) project.\n\n## License\n\n~~~\nCopyright © 2011-2015, Paul Vorbach.\nCopyright © 2009, Jeff Mott.\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* 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* Neither the name Crypto-JS nor the names of its contributors may be used to\n endorse or promote products derived from this software without specific prior\n written permission.\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~~~\ntcp-port-used\n=============\n\nA simple Node.js module to check if a TCP port is currently in use. It returns a\ndeferred promise from the q library.\n\n## Installation\n\n npm install tcp-port-used\n\n## Examples\nTo check a port's state:\n\n var tcpPortUsed = require('tcp-port-used');\n\n tcpPortUsed.check(44201, '127.0.0.1')\n .then(function(inUse) {\n console.log('Port 44201 usage: '+inUse);\n }, function(err) {\n console.error('Error on check:', err.message);\n });\n\nTo wait until a port on localhost is available:\n\n tcpPortUsed.waitUntilFree(44203, 500, 4000)\n .then(function() {\n console.log('Port 44203 is now free.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on a host is available:\n\n tcpPortUsed.waitUntilFreeOnHost(44203, 'some.host.com', 500, 4000)\n .then(function() {\n console.log('Port 44203 on some.host.com is now free.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on localhost is accepting connections:\n\n tcpPortUsed.waitUntilUsed(44204, 500, 4000)\n .then(function() {\n console.log('Port 44204 is now in use.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on a host is accepting connections:\n\n tcpPortUsed.waitUntilUsedOnHost(44204, 'some.host.com', 500, 4000)\n .then(function() {\n console.log('Port 44204 on some.host.com is now in use.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on a host is in specific state:\n\n var inUse = true; // wait until the port is in use\n tcpPortUsed.waitForStatus(44204, 'some.host.com', inUse, 500, 4000)\n .then(function() {\n console.log('Port 44204 on some.host.com is now in use.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\n## API\n\n### check(port [, host])\nChecks if a TCP port is in use by attempting to connect to the port on host.\nIf no host is specified, the module uses '127.0.0.1' (localhost). When the\npromise is resolved, there is a parameter `inUse`, when true means the port is\nin use and false means the port is free.\n\n**Parameters:**\n\n* **Number|Object** *port* The port you are curious to see if available. If an\n object, must contain all the parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilFree(port [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the localhost socket is\nfree. Will retry on an interval specified in retryTimeMs until the timeout. If\nnot defined the retryTime is 200 ms and the timeout is 2000 ms.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object must contain\n all the parameters as properties.\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilFreeOnHost(port [, host] [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the localhost socket is\nfree. Will retry on an interval specified in retryTimeMs until the timeout. If\nnot defined the retryTime is 200 ms and the timeout is 2000 ms. If the host is\nnot defined, the modules uses the default '127.0.0.1'.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object, must contain\n all the parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilUsed(port [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the socket is accepting\nconnections. Will retry on an interval specified in retryTimeMs until the\ntimeout. If the host is not defined the retryTime is 200 ms and the timeout is\n2000 ms.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object, must contain\n all the parameters as properties.\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilUsedOnHost(port [, host] [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the socket is accepting\nconnections. Will retry on an interval specified in retryTimeMs until the\ntimeout. If not defined the retryTime is 200 ms and the timeout is 2000 ms.\nIf the host is not defined the module uses the default '127.0.0.1'.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object, must contain\n all the parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitForStatus(port, host, status [, retryTimeMs] [, timeOutMs])\nWaits until the port on host matches the boolean status in terms of use. If the\nstatus is true, the promise defers until the port is in use. If the status is\nfalse the promise defers until the port is free. If the host is undefined or\nnull, the module uses the default '127.0.0.1'. Also, if not defined the\nretryTime is 200 ms and the timeout is 2000 ms.\n\n**Parameters:**\n\n* **Number** *port* a valid TCP port number. If an object, must contain all the\n parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n* **Boolean** *status* A boolean describing the condition to wait for in terms of \"in use.\" True indicates wait until the port is in use. False indicates wait until the port is free.\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2013 jut-io\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, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# ncp - Asynchronous recursive file & directory copying\n\n[](http://travis-ci.org/AvianFlu/ncp)\n\nThink `cp -r`, but pure node, and asynchronous. `ncp` can be used both as a CLI tool and programmatically.\n\n## Command Line usage\n\nUsage is simple: `ncp [source] [dest] [--limit=concurrency limit]\n[--filter=filter] --stopOnErr`\n\nThe 'filter' is a Regular Expression - matched files will be copied.\n\nThe 'concurrency limit' is an integer that represents how many pending file system requests `ncp` has at a time.\n\n'stoponerr' is a boolean flag that will tell `ncp` to stop immediately if any\nerrors arise, rather than attempting to continue while logging errors. The default behavior is to complete as many copies as possible, logging errors along the way.\n\nIf there are no errors, `ncp` will output `done.` when complete. If there are errors, the error messages will be logged to `stdout` and to `./ncp-debug.log`, and the copy operation will attempt to continue.\n\n## Programmatic usage\n\nProgrammatic usage of `ncp` is just as simple. The only argument to the completion callback is a possible error. \n\n```javascript\nvar ncp = require('ncp').ncp;\n\nncp.limit = 16;\n\nncp(source, destination, function (err) {\n if (err) {\n return console.error(err);\n }\n console.log('done!');\n});\n```\n\nYou can also call ncp like `ncp(source, destination, options, callback)`. \n`options` should be a dictionary. Currently, such options are available:\n\n * `options.filter` - a `RegExp` instance, against which each file name is\n tested to determine whether to copy it or not, or a function taking single\n parameter: copied file name, returning `true` or `false`, determining\n whether to copy file or not.\n\n * `options.transform` - a function: `function (read, write) { read.pipe(write) }`\n used to apply streaming transforms while copying.\n\n * `options.clobber` - boolean=true. if set to false, `ncp` will not overwrite \n destination files that already exist.\n\n * `options.dereference` - boolean=false. If set to true, `ncp` will follow symbolic\n links. For example, a symlink in the source tree pointing to a regular file\n will become a regular file in the destination tree. Broken symlinks will result in\n errors.\n\n * `options.stopOnErr` - boolean=false. If set to true, `ncp` will behave like `cp -r`,\n and stop on the first error it encounters. By default, `ncp` continues copying, logging all\n errors and returning an array.\n\n * `options.errs` - stream. If `options.stopOnErr` is `false`, a stream can be provided, and errors will be written to this stream.\n\nPlease open an issue if any bugs arise. As always, I accept (working) pull requests, and refunds are available at `/dev/null`.\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\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\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: \n\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n // Prints: \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\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\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\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 // \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 // \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 // \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\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 // \n // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n // \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\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# wrappy\n\nCallback wrapping utility\n\n## USAGE\n\n```javascript\nvar wrappy = require(\"wrappy\")\n\n// var wrapper = wrappy(wrapperFunction)\n\n// make sure a cb is called only once\n// See also: http://npm.im/once for this specific use case\nvar once = wrappy(function (cb) {\n var called = false\n return function () {\n if (called) return\n called = true\n return cb.apply(this, arguments)\n }\n})\n\nfunction printBoo () {\n console.log('boo')\n}\n// has some rando property\nprintBoo.iAmBooPrinter = true\n\nvar onlyPrintOnce = once(printBoo)\n\nonlyPrintOnce() // prints 'boo'\nonlyPrintOnce() // does nothing\n\n// random property is retained!\nassert.equal(onlyPrintOnce.iAmBooPrinter, true)\n```\n# 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# libusb\n\n[](https://travis-ci.org/libusb/libusb)\n[](https://ci.appveyor.com/project/LudovicRousseau/libusb)\n[](https://scan.coverity.com/projects/libusb-libusb)\n\nlibusb is a library for USB device access from Linux, macOS,\nWindows, OpenBSD/NetBSD and Haiku userspace.\nIt is written in C (Haiku backend in C++) and licensed under the GNU\nLesser General Public License version 2.1 or, at your option, any later\nversion (see [COPYING](COPYING)).\n\nlibusb is abstracted internally in such a way that it can hopefully\nbe ported to other operating systems. Please see the [PORTING](PORTING)\nfile for more information.\n\nlibusb homepage:\nhttp://libusb.info/\n\nDevelopers will wish to consult the API documentation:\nhttp://api.libusb.info\n\nUse the mailing list for questions, comments, etc:\nhttp://mailing-list.libusb.info\n\n- Hans de Goede \n- Xiaofan Chen \n- Ludovic Rousseau \n- Nathan Hjelm \n- Chris Dickens \n\n(Please use the mailing list rather than mailing developers directly)\nLike `chown -R`.\n\nTakes the same arguments as `fs.chown()`\nPure-UUID\n=========\n\n**Pure JavaScript Based Universally Unique Identifier (UUID)**\n\n\n![\"\"/](\"https://nodei.co/npm/pure-uuid.png?downloads=true&stars=true\")
\n\n\n![\"\"/](\"https://david-dm.org/rse/pure-uuid.png\")
\n\nAbstract\n--------\n\nThis is a pure JavaScript and dependency-free library for the generation\nof DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122 compliant Universally\nUnique Identifier (UUID). It supports DCE 1.1 variant UUIDs of version\n1 (time and node based), version 3 (name based, MD5), version 4 (random\nnumber based) and version 5 (name based, SHA-1). It can be used in both\n[Node.js](http://nodejs.org/) based server and browser based client\nenvironments.\n\nThe essential points of this implementation (in contrast to the many\nothers) are: First, although internally 32/64 bit unsigned integer\narithmentic and MD5/SHA-1 digest algorithmic is required, this UUID\nimplementation is fully self-contained and dependency-free. Second,\nthis implementation wraps around either `Uint8Array`, `Buffer` or\n`Array` standard classes and this way tries to represent UUIDs as best\nas possible in the particular environment. Third, thanks to a Universal\nModule Definition (UMD) wrapper, this library works out-of-the-box in\nall important JavaScript run-time environments.\n\nWhat is a UUID?\n---------------\n\nUUIDs are 128 bit numbers which are intended to have a high likelihood\nof uniqueness over space and time and are computationally difficult to\nguess. They are globally unique identifiers which can be locally\ngenerated without contacting a global registration authority. UUIDs are\nintended as unique identifiers for both mass tagging objects with an\nextremely short lifetime and to reliably identifying very persistent\nobjects across a network.\n\n### UUID Binary Representation\n\nAccording to the DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122\nstandards, a DCE 1.1 variant UUID is a 128 bit number defined out of 7\nfields, each field a multiple of an octet in size and stored in network\nbyte order:\n\n```txt\n [4]\n version\n -->| |<--\n | |\n | | [16]\n [32] [16] | |time_hi\n time_low time_mid | _and_version\n |<---------------------------->||<------------>||<------------>|\n | MSB || || | |\n | / || || | |\n |/ || || | |\n\n +------++------++------++------++------++------++------++------+~~\n | 15 || 14 || 13 || 12 || 11 || 10 |####9 || 8 |\n | MSO || || || || || |#### || |\n +------++------++------++------++------++------++------++------+~~\n 7654321076543210765432107654321076543210765432107654321076543210\n\n ~~+------++------++------++------++------++------++------++------+\n ##* 7 || 6 || 5 || 4 || 3 || 2 || 1 || 0 |\n ##* || || || || || || || LSO |\n ~~+------++------++------++------++------++------++------++------+\n 7654321076543210765432107654321076543210765432107654321076543210\n\n | | || || /|\n | | || || / |\n | | || || LSB |\n |<---->||<---->||<-------------------------------------------->|\n |clk_seq clk_seq node\n |_hi_res _low [48]\n |[5-6] [8]\n | |\n -->| |<--\n variant\n [2-3]\n```\n\nAn example of a UUID binary representation is the octet stream 0xF8\n0x1D 0x4F 0xAE 0x7D 0xEC 0x11 0xD0 0xA7 0x65 0x00 0xA0 0xC9 0x1E 0x6B\n0xF6.\n\n### UUID ASCII String Representation\n\nAccording to the DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122\nstandards, a DCE 1.1 variant UUID is represented as an ASCII string\nconsisting of 8 hexadecimal digits followed by a hyphen, then three\ngroups of 4 hexadecimal digits each followed by a hyphen, then 12\nhexadecimal digits.\n\nGetting Pure-UUID\n-----------------\n\n```\n$ npm install pure-uuid\n```\n\nUsing Pure-UUID\n---------------\n\n- global environment:\n\n```js\nvar uuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n```\n\n- CommonJS environment:\n\n```js\nvar UUID = require(\"pure-uuid\");\nvar uuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n```\n\n- AMD environment:\n\n```js\ndefine([\"pure-uuid\"], function (UUID) {\n var uuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n});\n```\n\nAPI\n---\n\n```ts\ninterface UUID {\n /* making */\n make(version: number, ...params: any[]): UUID;\n\n /* parsing */\n parse(str: string): UUID;\n\n /* formatting */\n format(type?: string): string;\n\n /* formatting (alias) */\n toString(type?: string): string;\n\n /* sensible JSON serialization */\n toJSON(): string;\n\n /* importing */\n import(arr: number[]): UUID;\n\n /* exporting */\n export(): number[];\n\n /* byte-wise comparison */\n compare(other: UUID): boolean;\n\n /* equal check */\n equal(other: UUID): boolean;\n\n /* fold 1-4 times */\n fold(k: number): number[];\n}\n\nexport interface UUIDConstructor {\n /* default construction */\n new(): UUID;\n\n /* parsing construction */\n new(uuid: string): UUID;\n\n /* making construction */\n new(version: number): UUID;\n new(version: number, ns: string, data: string): UUID;\n}\n\ndeclare var UUID: UUIDConstructor;\nexport default UUID;\n```\n\nExamples\n--------\n\n```js\n// load a UUID\nuuid = new UUID(\"0a300ee9-f9e4-5697-a51a-efc7fafaba67\");\n\n// make a UUID version 1 (time and node based)\nuuid = new UUID(1);\n\n// make a UUID version 3 (name-based, MD5)\nuuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n\n// make a UUID version 4 (random number based)\nuuid = new UUID(4);\n\n// make a UUID version 5 (name-based, SHA-1)\nuuid = new UUID(5, \"ns:URL\", \"http://example.com/\");\n\n// format a UUID in standard format\nstr = uuid.format()\nstr = uuid.format(\"std\")\n\n// format a UUID in Base16 format\nstr = uuid.format(\"b16\")\n\n// format a UUID in ZeroMQ-Base85 format\nstr = uuid.format(\"z85\")\n```\n\nLicense\n-------\n\nCopyright (c) 2004-2021 Dr. Ralf S. Engelschall (http://engelschall.com/)\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 included\nin 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\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n // Prints: \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\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\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\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 // \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 // \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 // \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\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 // \n // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n // \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\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# path-browserify [](https://travis-ci.org/browserify/path-browserify)\n\n> The `path` module from Node.js for browsers\n\nThis implements the Node.js [`path`][path] module for environments that do not have it, like browsers.\n\n> `path-browserify` currently matches the **Node.js 10.3** API.\n\n## Install\n\nYou usually do not have to install `path-browserify` yourself! If your code runs in Node.js, `path` is built in. If your code runs in the browser, bundlers like [browserify](https://github.com/browserify/browserify) or [webpack](https://github.com/webpack/webpack) include the `path-browserify` module by default.\n\nBut if none of those apply, with npm do:\n\n```\nnpm install path-browserify\n```\n\n## Usage\n\n```javascript\nvar path = require('path')\n\nvar filename = 'logo.png';\nvar logo = path.join('./assets/img', filename);\ndocument.querySelector('#logo').src = logo;\n```\n\n## API\n\nSee the [Node.js path docs][path]. `path-browserify` currently matches the Node.js 10.3 API.\n`path-browserify` only implements the POSIX functions, not the win32 ones.\n\n## Contributing\n\nPRs are very welcome! The main way to contribute to `path-browserify` is by porting features, bugfixes and tests from Node.js. Ideally, code contributions to this module are copy-pasted from Node.js and transpiled to ES5, rather than reimplemented from scratch. Matching the Node.js code as closely as possible makes maintenance simpler when new changes land in Node.js.\nThis module intends to provide exactly the same API as Node.js, so features that are not available in the core `path` module will not be accepted. Feature requests should instead be directed at [nodejs/node](https://github.com/nodejs/node) and will be added to this module once they are implemented in Node.js.\n\nIf there is a difference in behaviour between Node.js's `path` module and this module, please open an issue!\n\n## License\n\n[MIT](./LICENSE)\n\n[path]: https://nodejs.org/docs/v10.3.0/api/path.html\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# jsesc [](https://travis-ci.org/mathiasbynens/jsesc) [](https://coveralls.io/r/mathiasbynens/jsesc) [](https://gemnasium.com/mathiasbynens/jsesc)\n\nGiven some data, _jsesc_ returns a stringified representation of that data. jsesc is similar to `JSON.stringify()` except:\n\n1. it outputs JavaScript instead of JSON [by default](#json), enabling support for data structures like ES6 maps and sets;\n2. it offers [many options](#api) to customize the output;\n3. its output is ASCII-safe [by default](#minimal), thanks to its use of [escape sequences](https://mathiasbynens.be/notes/javascript-escapes) where needed.\n\nFor any input, jsesc generates the shortest possible valid printable-ASCII-only output. [Here’s an online demo.](https://mothereff.in/js-escapes)\n\njsesc’s output can be used instead of `JSON.stringify`’s to avoid [mojibake](https://en.wikipedia.org/wiki/Mojibake) and other encoding issues, or even to [avoid errors](https://twitter.com/annevk/status/380000829643571200) when passing JSON-formatted data (which may contain U+2028 LINE SEPARATOR, U+2029 PARAGRAPH SEPARATOR, or [lone surrogates](https://esdiscuss.org/topic/code-points-vs-unicode-scalar-values#content-14)) to a JavaScript parser or an UTF-8 encoder.\n\n## Installation\n\nVia [npm](https://www.npmjs.com/):\n\n```bash\nnpm install jsesc\n```\n\nIn [Node.js](https://nodejs.org/):\n\n```js\nconst jsesc = require('jsesc');\n```\n\n## API\n\n### `jsesc(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 JavaScript strings](https://mathiasbynens.be/notes/javascript-escapes). The first supported value type is strings:\n\n```js\njsesc('Ich ♥ Bücher');\n// → 'Ich \\\\u2665 B\\\\xFCcher'\n\njsesc('foo 𝌆 bar');\n// → 'foo \\\\uD834\\\\uDF06 bar'\n```\n\nInstead of a string, the `value` can also be an array, an object, a map, a set, or a buffer. In such cases, `jsesc` returns a stringified version of the value where any characters that are not printable ASCII symbols are escaped in the same way.\n\n```js\n// Escaping an array\njsesc([\n 'Ich ♥ Bücher', 'foo 𝌆 bar'\n]);\n// → '[\\'Ich \\\\u2665 B\\\\xFCcher\\',\\'foo \\\\uD834\\\\uDF06 bar\\']'\n\n// Escaping an object\njsesc({\n 'Ich ♥ Bücher': 'foo 𝌆 bar'\n});\n// → '{\\'Ich \\\\u2665 B\\\\xFCcher\\':\\'foo \\\\uD834\\\\uDF06 bar\\'}'\n```\n\nThe optional `options` argument accepts an object with the following options:\n\n#### `quotes`\n\nThe default value for the `quotes` option is `'single'`. This means that any occurrences of `'` in the input string are escaped as `\\'`, so that the output can be used in a string literal wrapped in single quotes.\n\n```js\njsesc('`Lorem` ipsum \"dolor\" sit \\'amet\\' etc.');\n// → 'Lorem ipsum \"dolor\" sit \\\\\\'amet\\\\\\' etc.'\n\njsesc('`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 string literal wrapped in double quotes, set the `quotes` option to `'double'`.\n\n```js\njsesc('`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\nIf you want to use the output as part of a template literal (i.e. wrapped in backticks), set the `quotes` option to `'backtick'`.\n\n```js\njsesc('`Lorem` ipsum \"dolor\" sit \\'amet\\' etc.', {\n 'quotes': 'backtick'\n});\n// → '\\\\`Lorem\\\\` ipsum \"dolor\" sit \\'amet\\' etc.'\n// → \"\\\\`Lorem\\\\` ipsum \\\"dolor\\\" sit 'amet' etc.\"\n// → `\\\\\\`Lorem\\\\\\` ipsum \"dolor\" sit 'amet' etc.`\n```\n\nThis setting also affects the output for arrays and objects:\n\n```js\njsesc({ 'Ich ♥ Bücher': 'foo 𝌆 bar' }, {\n 'quotes': 'double'\n});\n// → '{\"Ich \\\\u2665 B\\\\xFCcher\":\"foo \\\\uD834\\\\uDF06 bar\"}'\n\njsesc([ 'Ich ♥ Bücher', 'foo 𝌆 bar' ], {\n 'quotes': 'double'\n});\n// → '[\"Ich \\\\u2665 B\\\\xFCcher\",\"foo \\\\uD834\\\\uDF06 bar\"]'\n```\n\n#### `numbers`\n\nThe default value for the `numbers` option is `'decimal'`. This means that any numeric values are represented using decimal integer literals. Other valid options are `binary`, `octal`, and `hexadecimal`, which result in binary integer literals, octal integer literals, and hexadecimal integer literals, respectively.\n\n```js\njsesc(42, {\n 'numbers': 'binary'\n});\n// → '0b101010'\n\njsesc(42, {\n 'numbers': 'octal'\n});\n// → '0o52'\n\njsesc(42, {\n 'numbers': 'decimal'\n});\n// → '42'\n\njsesc(42, {\n 'numbers': 'hexadecimal'\n});\n// → '0x2A'\n```\n\n#### `wrap`\n\nThe `wrap` option takes a boolean value (`true` or `false`), and defaults to `false` (disabled). When enabled, the output is a valid JavaScript string literal wrapped in quotes. The type of quotes can be specified through the `quotes` setting.\n\n```js\njsesc('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\njsesc('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#### `es6`\n\nThe `es6` option takes a boolean value (`true` or `false`), and defaults to `false` (disabled). When enabled, any astral Unicode symbols in the input are escaped using [ECMAScript 6 Unicode code point escape sequences](https://mathiasbynens.be/notes/javascript-escapes#unicode-code-point) instead of using separate escape sequences for each surrogate half. If backwards compatibility with ES5 environments is a concern, don’t enable this setting. If the `json` setting is enabled, the value for the `es6` setting is ignored (as if it was `false`).\n\n```js\n// By default, the `es6` option is disabled:\njsesc('foo 𝌆 bar 💩 baz');\n// → 'foo \\\\uD834\\\\uDF06 bar \\\\uD83D\\\\uDCA9 baz'\n\n// To explicitly disable it:\njsesc('foo 𝌆 bar 💩 baz', {\n 'es6': false\n});\n// → 'foo \\\\uD834\\\\uDF06 bar \\\\uD83D\\\\uDCA9 baz'\n\n// To enable it:\njsesc('foo 𝌆 bar 💩 baz', {\n 'es6': true\n});\n// → 'foo \\\\u{1D306} bar \\\\u{1F4A9} baz'\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 are escaped — even printable ASCII symbols.\n\n```js\njsesc('lolwat\"foo\\'bar', {\n 'escapeEverything': true\n});\n// → '\\\\x6C\\\\x6F\\\\x6C\\\\x77\\\\x61\\\\x74\\\\\"\\\\x66\\\\x6F\\\\x6F\\\\\\'\\\\x62\\\\x61\\\\x72'\n// → \"\\\\x6C\\\\x6F\\\\x6C\\\\x77\\\\x61\\\\x74\\\\\\\"\\\\x66\\\\x6F\\\\x6F\\\\'\\\\x62\\\\x61\\\\x72\"\n```\n\nThis setting also affects the output for string literals within arrays and objects.\n\n#### `minimal`\n\nThe `minimal` option takes a boolean value (`true` or `false`), and defaults to `false` (disabled). When enabled, only a limited set of symbols in the output are escaped:\n\n* U+0000 `\\0`\n* U+0008 `\\b`\n* U+0009 `\\t`\n* U+000A `\\n`\n* U+000C `\\f`\n* U+000D `\\r`\n* U+005C `\\\\`\n* U+2028 `\\u2028`\n* U+2029 `\\u2029`\n* whatever symbol is being used for wrapping string literals (based on [the `quotes` option](#quotes))\n\nNote: with this option enabled, jsesc output is no longer guaranteed to be ASCII-safe.\n\n```js\njsesc('foo\\u2029bar\\nbaz©qux𝌆flops', {\n 'minimal': false\n});\n// → 'foo\\\\u2029bar\\\\nbaz©qux𝌆flops'\n```\n\n#### `isScriptContext`\n\nThe `isScriptContext` option takes a boolean value (`true` or `false`), and defaults to `false` (disabled). When enabled, occurrences of [`` or `\n \n \n \n ${normalizeAssets(assetsByChunkName.main)\n .filter((path) => path.endsWith('.js'))\n .map((path) => ``)\n .join('\\n')}\n \n
\n
\n\n## Highlights\n\n* Fast. Probably the fastest.\n* Supports multiple and negative patterns.\n* Synchronous, Promise and Stream API.\n* Object mode. Can return more than just strings.\n* Error-tolerant.\n\n## Donation\n\nDo you like this project? Support it by donating, creating an issue or pull request.\n\n[][paypal_mrmlnc]\n\n## Old and modern mode\n\nThis package works in two modes, depending on the environment in which it is used.\n\n* **Old mode**. Node.js below 10.10 or when the [`stats`](#stats) option is *enabled*.\n* **Modern mode**. Node.js 10.10+ and the [`stats`](#stats) option is *disabled*.\n\nThe modern mode is faster. Learn more about the [internal mechanism][nodelib_fs_scandir_old_and_modern_modern].\n\n## Pattern syntax\n\n> :warning: Always use forward-slashes in glob expressions (patterns and [`ignore`](#ignore) option). Use backslashes for escaping characters.\n\nThere is more than one form of syntax: basic and advanced. Below is a brief overview of the supported features. Also pay attention to our [FAQ](#faq).\n\n> :book: This package uses a [`micromatch`][micromatch] as a library for pattern matching.\n\n### Basic syntax\n\n* An asterisk (`*`) — matches everything except slashes (path separators), hidden files (names starting with `.`).\n* A double star or globstar (`**`) — matches zero or more directories.\n* Question mark (`?`) – matches any single character except slashes (path separators).\n* Sequence (`[seq]`) — matches any character in sequence.\n\n> :book: A few additional words about the [basic matching behavior][picomatch_matching_behavior].\n\nSome examples:\n\n* `src/**/*.js` — matches all files in the `src` directory (any level of nesting) that have the `.js` extension.\n* `src/*.??` — matches all files in the `src` directory (only first level of nesting) that have a two-character extension.\n* `file-[01].js` — matches files: `file-0.js`, `file-1.js`.\n\n### Advanced syntax\n\n* [Escapes characters][micromatch_backslashes] (`\\\\`) — matching special characters (`$^*+?()[]`) as literals.\n* [POSIX character classes][picomatch_posix_brackets] (`[[:digit:]]`).\n* [Extended globs][micromatch_extglobs] (`?(pattern-list)`).\n* [Bash style brace expansions][micromatch_braces] (`{}`).\n* [Regexp character classes][micromatch_regex_character_classes] (`[1-5]`).\n* [Regex groups][regular_expressions_brackets] (`(a|b)`).\n\n> :book: A few additional words about the [advanced matching behavior][micromatch_extended_globbing].\n\nSome examples:\n\n* `src/**/*.{css,scss}` — matches all files in the `src` directory (any level of nesting) that have the `.css` or `.scss` extension.\n* `file-[[:digit:]].js` — matches files: `file-0.js`, `file-1.js`, …, `file-9.js`.\n* `file-{1..3}.js` — matches files: `file-1.js`, `file-2.js`, `file-3.js`.\n* `file-(1|2)` — matches files: `file-1.js`, `file-2.js`.\n\n## Installation\n\n```console\nnpm install fast-glob\n```\n\n## API\n\n### Asynchronous\n\n```js\nfg(patterns, [options])\n```\n\nReturns a `Promise` with an array of matching entries.\n\n```js\nconst fg = require('fast-glob');\n\nconst entries = await fg(['.editorconfig', '**/index.js'], { dot: true });\n\n// ['.editorconfig', 'services/index.js']\n```\n\n### Synchronous\n\n```js\nfg.sync(patterns, [options])\n```\n\nReturns an array of matching entries.\n\n```js\nconst fg = require('fast-glob');\n\nconst entries = fg.sync(['.editorconfig', '**/index.js'], { dot: true });\n\n// ['.editorconfig', 'services/index.js']\n```\n\n### Stream\n\n```js\nfg.stream(patterns, [options])\n```\n\nReturns a [`ReadableStream`][node_js_stream_readable_streams] when the `data` event will be emitted with matching entry.\n\n```js\nconst fg = require('fast-glob');\n\nconst stream = fg.stream(['.editorconfig', '**/index.js'], { dot: true });\n\nfor await (const entry of stream) {\n\t// .editorconfig\n\t// services/index.js\n}\n```\n\n#### patterns\n\n* Required: `true`\n* Type: `string | string[]`\n\nAny correct pattern(s).\n\n> :1234: [Pattern syntax](#pattern-syntax)\n>\n> :warning: This package does not respect the order of patterns. First, all the negative patterns are applied, and only then the positive patterns. If you want to get a certain order of records, use sorting or split calls.\n\n#### [options]\n\n* Required: `false`\n* Type: [`Options`](#options-3)\n\nSee [Options](#options-3) section.\n\n### Helpers\n\n#### `generateTasks(patterns, [options])`\n\nReturns the internal representation of patterns ([`Task`](./src/managers/tasks.ts) is a combining patterns by base directory).\n\n```js\nfg.generateTasks('*');\n\n[{\n base: '.', // Parent directory for all patterns inside this task\n dynamic: true, // Dynamic or static patterns are in this task\n patterns: ['*'],\n positive: ['*'],\n negative: []\n}]\n```\n\n##### patterns\n\n* Required: `true`\n* Type: `string | string[]`\n\nAny correct pattern(s).\n\n##### [options]\n\n* Required: `false`\n* Type: [`Options`](#options-3)\n\nSee [Options](#options-3) section.\n\n#### `isDynamicPattern(pattern, [options])`\n\nReturns `true` if the passed pattern is a dynamic pattern.\n\n> :1234: [What is a static or dynamic pattern?](#what-is-a-static-or-dynamic-pattern)\n\n```js\nfg.isDynamicPattern('*'); // true\nfg.isDynamicPattern('abc'); // false\n```\n\n##### pattern\n\n* Required: `true`\n* Type: `string`\n\nAny correct pattern.\n\n##### [options]\n\n* Required: `false`\n* Type: [`Options`](#options-3)\n\nSee [Options](#options-3) section.\n\n#### `escapePath(pattern)`\n\nReturns a path with escaped special characters (`*?|(){}[]`, `!` at the beginning of line, `@+!` before the opening parenthesis).\n\n```js\nfg.escapePath('!abc'); // \\\\!abc\nfg.escapePath('C:/Program Files (x86)'); // C:/Program Files \\\\(x86\\\\)\n```\n\n##### pattern\n\n* Required: `true`\n* Type: `string`\n\nAny string, for example, a path to a file.\n\n## Options\n\n### Common options\n\n#### concurrency\n\n* Type: `number`\n* Default: `os.cpus().length`\n\nSpecifies the maximum number of concurrent requests from a reader to read directories.\n\n> :book: The higher the number, the higher the performance and load on the file system. If you want to read in quiet mode, set the value to a comfortable number or `1`.\n\n#### cwd\n\n* Type: `string`\n* Default: `process.cwd()`\n\nThe current working directory in which to search.\n\n#### deep\n\n* Type: `number`\n* Default: `Infinity`\n\nSpecifies the maximum depth of a read directory relative to the start directory.\n\nFor example, you have the following tree:\n\n```js\ndir/\n└── one/ // 1\n └── two/ // 2\n └── file.js // 3\n```\n\n```js\n// With base directory\nfg.sync('dir/**', { onlyFiles: false, deep: 1 }); // ['dir/one']\nfg.sync('dir/**', { onlyFiles: false, deep: 2 }); // ['dir/one', 'dir/one/two']\n\n// With cwd option\nfg.sync('**', { onlyFiles: false, cwd: 'dir', deep: 1 }); // ['one']\nfg.sync('**', { onlyFiles: false, cwd: 'dir', deep: 2 }); // ['one', 'one/two']\n```\n\n> :book: If you specify a pattern with some base directory, this directory will not participate in the calculation of the depth of the found directories. Think of it as a [`cwd`](#cwd) option.\n\n#### followSymbolicLinks\n\n* Type: `boolean`\n* Default: `true`\n\nIndicates whether to traverse descendants of symbolic link directories when expanding `**` patterns.\n\n> :book: Note that this option does not affect the base directory of the pattern. For example, if `./a` is a symlink to directory `./b` and you specified `['./a**', './b/**']` patterns, then directory `./a` will still be read.\n\n> :book: If the [`stats`](#stats) option is specified, the information about the symbolic link (`fs.lstat`) will be replaced with information about the entry (`fs.stat`) behind it.\n\n#### fs\n\n* Type: `FileSystemAdapter`\n* Default: `fs.*`\n\nCustom implementation of methods for working with the file system.\n\n```ts\nexport interface FileSystemAdapter {\n lstat?: typeof fs.lstat;\n stat?: typeof fs.stat;\n lstatSync?: typeof fs.lstatSync;\n statSync?: typeof fs.statSync;\n readdir?: typeof fs.readdir;\n readdirSync?: typeof fs.readdirSync;\n}\n```\n\n#### ignore\n\n* Type: `string[]`\n* Default: `[]`\n\nAn array of glob patterns to exclude matches. This is an alternative way to use negative patterns.\n\n```js\ndir/\n├── package-lock.json\n└── package.json\n```\n\n```js\nfg.sync(['*.json', '!package-lock.json']); // ['package.json']\nfg.sync('*.json', { ignore: ['package-lock.json'] }); // ['package.json']\n```\n\n#### suppressErrors\n\n* Type: `boolean`\n* Default: `false`\n\nBy default this package suppress only `ENOENT` errors. Set to `true` to suppress any error.\n\n> :book: Can be useful when the directory has entries with a special level of access.\n\n#### throwErrorOnBrokenSymbolicLink\n\n* Type: `boolean`\n* Default: `false`\n\nThrow an error when symbolic link is broken if `true` or safely return `lstat` call if `false`.\n\n> :book: This option has no effect on errors when reading the symbolic link directory.\n\n### Output control\n\n#### absolute\n\n* Type: `boolean`\n* Default: `false`\n\nReturn the absolute path for entries.\n\n```js\nfg.sync('*.js', { absolute: false }); // ['index.js']\nfg.sync('*.js', { absolute: true }); // ['/home/user/index.js']\n```\n\n> :book: This option is required if you want to use negative patterns with absolute path, for example, `!${__dirname}/*.js`.\n\n#### markDirectories\n\n* Type: `boolean`\n* Default: `false`\n\nMark the directory path with the final slash.\n\n```js\nfg.sync('*', { onlyFiles: false, markDirectories: false }); // ['index.js', 'controllers']\nfg.sync('*', { onlyFiles: false, markDirectories: true }); // ['index.js', 'controllers/']\n```\n\n#### objectMode\n\n* Type: `boolean`\n* Default: `false`\n\nReturns objects (instead of strings) describing entries.\n\n```js\nfg.sync('*', { objectMode: false }); // ['src/index.js']\nfg.sync('*', { objectMode: true }); // [{ name: 'index.js', path: 'src/index.js', dirent: Details
\n\n* [Highlights](#highlights)\n* [Donation](#donation)\n* [Old and modern mode](#old-and-modern-mode)\n* [Pattern syntax](#pattern-syntax)\n * [Basic syntax](#basic-syntax)\n * [Advanced syntax](#advanced-syntax)\n* [Installation](#installation)\n* [API](#api)\n * [Asynchronous](#asynchronous)\n * [Synchronous](#synchronous)\n * [Stream](#stream)\n * [patterns](#patterns)\n * [[options]](#options)\n * [Helpers](#helpers)\n * [generateTasks](#generatetaskspatterns-options)\n * [isDynamicPattern](#isdynamicpatternpattern-options)\n * [escapePath](#escapepathpattern)\n* [Options](#options-3)\n * [Common](#common)\n * [concurrency](#concurrency)\n * [cwd](#cwd)\n * [deep](#deep)\n * [followSymbolicLinks](#followsymboliclinks)\n * [fs](#fs)\n * [ignore](#ignore)\n * [suppressErrors](#suppresserrors)\n * [throwErrorOnBrokenSymbolicLink](#throwerroronbrokensymboliclink)\n * [Output control](#output-control)\n * [absolute](#absolute)\n * [markDirectories](#markdirectories)\n * [objectMode](#objectmode)\n * [onlyDirectories](#onlydirectories)\n * [onlyFiles](#onlyfiles)\n * [stats](#stats)\n * [unique](#unique)\n * [Matching control](#matching-control)\n * [braceExpansion](#braceexpansion)\n * [caseSensitiveMatch](#casesensitivematch)\n * [dot](#dot)\n * [extglob](#extglob)\n * [globstar](#globstar)\n * [baseNameMatch](#basenamematch)\n* [FAQ](#faq)\n * [What is a static or dynamic pattern?](#what-is-a-static-or-dynamic-pattern)\n * [How to write patterns on Windows?](#how-to-write-patterns-on-windows)\n * [Why are parentheses match wrong?](#why-are-parentheses-match-wrong)\n * [How to exclude directory from reading?](#how-to-exclude-directory-from-reading)\n * [How to use UNC path?](#how-to-use-unc-path)\n * [Compatible with `node-glob`?](#compatible-with-node-glob)\n* [Benchmarks](#benchmarks)\n * [Server](#server)\n * [Nettop](#nettop)\n* [Changelog](#changelog)\n* [License](#license)\n\n\n\n## Layout DSL\n\ncliui exposes a simple layout DSL:\n\nIf you create a single `ui.div`, passing a string rather than an\nobject:\n\n* `\\n`: characters will be interpreted as new rows.\n* `\\t`: characters will be interpreted as new columns.\n* `\\s`: characters will be interpreted as padding.\n\n**as an example...**\n\n```js\nvar ui = require('./')({\n width: 60\n})\n\nui.div(\n 'Usage: node ./bin/foo.js\\n' +\n ' \n \n ![](\"https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png\")
\n \n
_(e.g. `appname_foo__bar__baz` => `foo.bar.baz`)_\n * if you passed an option `--config file` then from that file\n * a local `.${appname}rc` or the first found looking in `./ ../ ../../ ../../../` etc.\n * `$HOME/.${appname}rc`\n * `$HOME/.${appname}/config`\n * `$HOME/.config/${appname}`\n * `$HOME/.config/${appname}/config`\n * `/etc/${appname}rc`\n * `/etc/${appname}/config`\n * the defaults object you passed in.\n\nAll configuration sources that were found will be flattened into one object,\nso that sources **earlier** in this list override later ones.\n\n## Configuration File Formats\n\nConfiguration files (e.g. `.appnamerc`) may be in either [json](http://json.org/example) or [ini](http://en.wikipedia.org/wiki/INI_file) format. **No** file extension (`.json` or `.ini`) should be used. The example configurations below are equivalent:\n\n#### Formatted as `ini`\n\n```\n; You can include comments in `ini` format if you want.\n\ndependsOn=0.10.0\n\n; `rc` has built-in support for ini sections, see?\n\n[commands]\n www = ./commands/www\n console = ./commands/repl\n\n; You can even do nested sections\n\n[generators.options]\n engine = ejs\n\n[generators.modules]\n new = generate-new\n engine = generate-backend\n\n```\n\n#### Formatted as `json`\n\n```javascript\n{\n // You can even comment your JSON, if you want\n \"dependsOn\": \"0.10.0\",\n \"commands\": {\n \"www\": \"./commands/www\",\n \"console\": \"./commands/repl\"\n },\n \"generators\": {\n \"options\": {\n \"engine\": \"ejs\"\n },\n \"modules\": {\n \"new\": \"generate-new\",\n \"backend\": \"generate-backend\"\n }\n }\n}\n```\n\nComments are stripped from JSON config via [strip-json-comments](https://github.com/sindresorhus/strip-json-comments).\n\n> Since ini, and env variables do not have a standard for types, your application needs be prepared for strings.\n\nTo ensure that string representations of booleans and numbers are always converted into their proper types (especially useful if you intend to do strict `===` comparisons), consider using a module such as [parse-strings-in-object](https://github.com/anselanza/parse-strings-in-object) to wrap the config object returned from rc.\n\n## Simple example demonstrating precedence\nAssume you have an application like this (notice the hard-coded defaults passed to rc):\n```\nconst conf = require('rc')('myapp', {\n port: 12345,\n mode: 'test'\n});\n\nconsole.log(JSON.stringify(conf, null, 2));\n```\nYou also have a file `config.json`, with these contents:\n```\n{\n \"port\": 9000,\n \"foo\": \"from config json\",\n \"something\": \"else\"\n}\n```\nAnd a file `.myapprc` in the same folder, with these contents:\n```\n{\n \"port\": \"3001\",\n \"foo\": \"bar\"\n}\n```\nHere is the expected output from various commands:\n\n`node .`\n```\n{\n \"port\": \"3001\",\n \"mode\": \"test\",\n \"foo\": \"bar\",\n \"_\": [],\n \"configs\": [\n \"/Users/stephen/repos/conftest/.myapprc\"\n ],\n \"config\": \"/Users/stephen/repos/conftest/.myapprc\"\n}\n```\n*Default `mode` from hard-coded object is retained, but port is overridden by `.myapprc` file (automatically found based on appname match), and `foo` is added.*\n\n`node . --foo baz`\n```\n{\n \"port\": \"3001\",\n \"mode\": \"test\",\n \"foo\": \"baz\",\n \"_\": [],\n \"configs\": [\n \"/Users/stephen/repos/conftest/.myapprc\"\n ],\n \"config\": \"/Users/stephen/repos/conftest/.myapprc\"\n}\n```\n*Same result as above but `foo` is overridden because command-line arguments take precedence over `.myapprc` file.*\n\n`node . --foo barbar --config config.json`\n```\n{\n \"port\": 9000,\n \"mode\": \"test\",\n \"foo\": \"barbar\",\n \"something\": \"else\",\n \"_\": [],\n \"config\": \"config.json\",\n \"configs\": [\n \"/Users/stephen/repos/conftest/.myapprc\",\n \"config.json\"\n ]\n}\n```\n*Now the `port` comes from the `config.json` file specified (overriding the value from `.myapprc`), and `foo` value is overriden by command-line despite also being specified in the `config.json` file.*\n \n\n## Advanced Usage\n\n#### Pass in your own `argv`\n\nYou may pass in your own `argv` as the third argument to `rc`. This is in case you want to [use your own command-line opts parser](https://github.com/dominictarr/rc/pull/12).\n\n```javascript\nrequire('rc')(appname, defaults, customArgvParser);\n```\n\n## Pass in your own parser\n\nIf you have a special need to use a non-standard parser,\nyou can do so by passing in the parser as the 4th argument.\n(leave the 3rd as null to get the default args parser)\n\n```javascript\nrequire('rc')(appname, defaults, null, parser);\n```\n\nThis may also be used to force a more strict format,\nsuch as strict, valid JSON only.\n\n## Note on Performance\n\n`rc` is running `fs.statSync`-- so make sure you don't use it in a hot code path (e.g. a request handler) \n\n## License\n\nMulti-licensed under the two-clause BSD License, MIT License, or Apache License, version 2.0\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# 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][ci-image]][ci-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n\nThis is a large database of mime types and information about them.\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```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-types.json` or\n`src/custom-suffix.json`.\n\nThe `src/custom-types.json` file is a JSON object with the MIME type as the\nkeys and 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[ci-image]: https://badgen.net/github/checks/jshttp/mime-db/master?label=ci\n[ci-url]: https://github.com/jshttp/mime-db/actions?query=workflow%3Aci\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#
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# node-gyp-build\n\n> Build tool and bindings loader for [`node-gyp`][node-gyp] that supports prebuilds.\n\n```\nnpm install node-gyp-build\n```\n\n[](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml)\n\nUse together with [`prebuildify`][prebuildify] to easily support prebuilds for your native modules.\n\n## Usage\n\n> **Note.** Prebuild names have changed in [`prebuildify@3`][prebuildify] and `node-gyp-build@4`. Please see the documentation below.\n\n`node-gyp-build` works similar to [`node-gyp build`][node-gyp] except that it will check if a build or prebuild is present before rebuilding your project.\n\nIt's main intended use is as an npm install script and bindings loader for native modules that bundle prebuilds using [`prebuildify`][prebuildify].\n\nFirst add `node-gyp-build` as an install script to your native project\n\n``` js\n{\n ...\n \"scripts\": {\n \"install\": \"node-gyp-build\"\n }\n}\n```\n\nThen in your `index.js`, instead of using the [`bindings`](https://www.npmjs.com/package/bindings) module use `node-gyp-build` to load your binding.\n\n``` js\nvar binding = require('node-gyp-build')(__dirname)\n```\n\nIf you do these two things and bundle prebuilds with [`prebuildify`][prebuildify] your native module will work for most platforms\nwithout having to compile on install time AND will work in both node and electron without the need to recompile between usage.\n\nUsers can override `node-gyp-build` and force compiling by doing `npm install --build-from-source`.\n\nPrebuilds will be attempted loaded from `MODULE_PATH/prebuilds/...` and then next `EXEC_PATH/prebuilds/...` (the latter allowing use with `zeit/pkg`)\n\n## Supported prebuild names\n\nIf so desired you can bundle more specific flavors, for example `musl` builds to support Alpine, or targeting a numbered ARM architecture version.\n\nThese prebuilds can be bundled in addition to generic prebuilds; `node-gyp-build` will try to find the most specific flavor first. Prebuild filenames are composed of _tags_. The runtime tag takes precedence, as does an `abi` tag over `napi`. For more details on tags, please see [`prebuildify`][prebuildify].\n\nValues for the `libc` and `armv` tags are auto-detected but can be overridden through the `LIBC` and `ARM_VERSION` environment variables, respectively.\n\n## License\n\nMIT\n\n[prebuildify]: https://github.com/prebuild/prebuildify\n[node-gyp]: https://www.npmjs.com/package/node-gyp\n# NEAR CLI (command line interface)\n\n[](https://gitpod.io/#https://github.com/near/near-cli)\n\nNEAR CLI is a Node.js application that relies on [`near-api-js`](https://github.com/near/near-api-js) to connect to and interact with the NEAR blockchain. Create accounts, access keys, sign & send transactions with this versatile command line interface tool.\n\n**Note:** Node.js version 10+ is required to run NEAR CLI.\n\n## Release notes\n\n**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**\n\n## Overview\n\n_Click on a command for more information and examples._\n\n| Command | Description |\n| ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| **ACCESS KEYS** | |\n| [`near login`](#near-login) | stores a full access key locally using [NEAR Wallet](https://wallet.testnet.near.org/) |\n| [`near keys`](#near-keys) | displays all access keys and their details for a given account |\n| [`near generate-key`](#near-generate-key) | generates a local key pair **or** shows public key & [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts) |\n| [`near add-key`](#near-add-key) | adds a new access key to an account |\n| [`near delete-key`](#near-delete-key) | deletes an access key from an account |\n| **ACCOUNTS** | |\n| [`near create-account`](#near-create-account) | creates an account |\n| [`near state`](#near-state) | shows general details of an account |\n| [`near keys`](#near-keys) | displays all access keys for a given account |\n| [`near send`](#near-send) | sends tokens from one account to another |\n| [`near delete`](#near-delete) | deletes an account and transfers remaining balance to a beneficiary account |\n| **CONTRACTS** | |\n| [`near deploy`](#near-deploy) | deploys a smart contract to the NEAR blockchain |\n| [`near dev-deploy`](#near-dev-deploy) | creates a development account and deploys a contract to it _(`testnet` only)_ |\n| [`near call`](#near-call) | makes a contract call which can invoke `change` _or_ `view` methods |\n| [`near view`](#near-view) | makes a contract call which can **only** invoke a `view` method |\n| **TRANSACTIONS** | |\n| [`near tx-status`](#near-tx-status) | queries a transaction's status by `txHash` |\n| **VALIDATORS** | |\n| [`near validators current`](#near-validators-current) | displays current [epoch](http://docs.near.org/docs/concepts/epoch) validator pool details |\n| [`near validators next`](#near-validators-next) | displays validator details for the next [epoch](http://docs.near.org/docs/concepts/epoch) |\n| [`near proposals`](#near-proposals) | displays validator proposals for the [epoch](http://docs.near.org/docs/concepts/epoch) _after_ next |\n| **JS-SDK** | |\n| [`near js`](#near-js) | Work with JS contract enclave |\n| **REPL** | |\n| [`near repl`](#near-repl) | launches an interactive connection to the NEAR blockchain ([REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop)) |\n| | can also run a JS/TS file which exports an async main function that takes a [context](./context/index.d.ts) object |\n\n[ [**OPTIONS**](#options) ]\n\n> For EVM support see [Project Aurora's](https://aurora.dev) [`aurora-cli`](https://github.com/aurora-is-near/aurora-cli).\n\n---\n\n## Setup\n\n### Installation\n\n> Make sure you have a current version of `npm` and `NodeJS` installed.\n\n#### Mac and Linux\n\n1. Install `npm` and `node` using a package manager like `nvm` as sometimes there are issues using Ledger due to how OS X handles node packages related to USB devices. [[click here]](https://nodejs.org/en/download/package-manager/)\n2. Ensure you have installed Node version 12 or above.\n3. Install `near-cli` globally by running:\n\n```bash\nnpm install -g near-cli\n```\n\n#### Windows\n\n> For Windows users, we recommend using Windows Subsystem for Linux (`WSL`).\n\n1. Install `WSL` [[click here]](https://docs.microsoft.com/en-us/windows/wsl/install-manual#downloading-distros)\n2. Install `npm` [[click here]](https://www.npmjs.com/get-npm)\n3. Install ` Node.js` [ [ click here ]](https://nodejs.org/en/download/package-manager/)\n4. Change `npm` default directory [ [ click here ] ](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally#manually-change-npms-default-directory)\n - This is to avoid any permission issues with `WSL`\n5. Open `WSL` and install `near-cli` globally by running:\n\n```bash\nnpm install -g near-cli\n```\n\n---\n\n### Network selection\n\n> The default network for `near-cli` is `testnet`.\n\n- You can change the network by prepending an environment variable to your command.\n\n```bash\nNEAR_ENV=betanet near send ...\n```\n\n- Alternatively, you can set up a global environment variable by running:\n\n```bash\nexport NEAR_ENV=mainnet\n```\n\n---\n\n### Custom RPC server selection\nYou can set custom RPC server URL by setting this env variables:\n```bash\nNEAR_CLI_MAINNET_RPC_SERVER_URL\nNEAR_CLI_TESTNET_RPC_SERVER_URL\nNEAR_CLI_BETANET_RPC_SERVER_URL\nNEAR_CLI_GUILDNET_RPC_SERVER_URL\nNEAR_CLI_LOCALNET_RPC_SERVER_URL\nNEAR_CLI_SHARDNET_RPC_SERVER_URL\nNEAR_CLI_CI_RPC_SERVER_URL\n```\nClear them in case you want to get back to the default RPC server.\n\nExample:\n```bash\nexport NEAR_CLI_TESTNET_RPC_SERVER_URL=\n
\n\n---\n\n### `near generate-key`\n\n> Creates a key pair locally in `.near-credentials` **or** displays public key from Ledger or seed phrase.\n\n- arguments: `accountId` or `none`\n- options: `--useLedgerKey`, `--seedPhrase`, or `--seedPath`\n\n**Note:** There are several ways to use `generate-key` that return very different results. Please reference the examples below for further details.\n\n---\n\n#### 1) `near generate-key`\n\n> Creates a key pair locally in `.near-credentials` with an [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts) as the accountId. _(hash representation of the public key)_\n\n```bash\nnear generate-key\n```\n\nExample Response
\n\n\n```\nKeys for account client.chainlink.testnet\n[\n {\n public_key: 'ed25519:4wrVrZbHrurMYgkcyusfvSJGLburmaw7m3gmCApxgvY4',\n access_key: { nonce: 97, permission: 'FullAccess' }\n },\n {\n public_key: 'ed25519:H9k5eiU4xXS3M4z8HzKJSLaZdqGdGwBG49o7orNC4eZW',\n access_key: {\n nonce: 88,\n permission: {\n FunctionCall: {\n allowance: '18483247987345065500000000',\n receiver_id: 'client.chainlink.testnet',\n method_names: [ 'get_token_price', [length]: 1 ]\n }\n }\n }\n },\n [length]: 2\n]\n```\n\n
\n\n
\n\n---\n\n#### 2) `near generate-key accountId`\n\n> Creates a key pair locally in `.near-credentials` with an `accountId` that you specify.\n\n**Note:** This does NOT create an account with this name, and will overwrite an existing `.json` file with the same name.\n\n```bash\nnear generate-key example.testnet\n```\n\nExample Response
\n\n\n```bash\nKey pair with ed25519:33Vn9VtNEtWQPPd1f4jf5HzJ5weLcvGHU8oz7o5UnPqy public key for an account \"1e5b1346bdb4fc5ccd465f6757a9082a84bcacfd396e7d80b0c726252fe8b3e8\"\n```\n\n
\n\n
\n\n---\n\n#### 3a) `near generate-key --useLedgerKey`\n\n> Uses a connected Ledger device to display a public key and [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts) using the default HD path (`\"44'/397'/0'/0'/1'\"`)\n\n```bash\nnear generate-key --useLedgerKey\n```\n\nYou should then see the following prompt to confirm this request on your Ledger device:\n\n Make sure to connect your Ledger and open NEAR app\n Waiting for confirmation on Ledger...\n\nAfter confirming the request on your Ledger device, a public key and implicit accountId will be displayed.\n\nExample Response
\n\n\n```bash\nKey pair with ed25519:CcH3oMEFg8tpJLekyvF7Wp49G81K3QLhGbaWEFwtCjht public key for an account \"example.testnet\"\n```\n\n
\n\n
\n\n---\n\n#### 3b) `near generate-key --useLedgerKey=\"HD path you specify\"`\n\n> Uses a connected Ledger device to display a public key and [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts) using a custom HD path.\n\n```bash\nnear generate-key --useLedgerKey=\"44'/397'/0'/0'/2'\"\n```\n\nYou should then see the following prompt to confirm this request on your Ledger device:\n\n Make sure to connect your Ledger and open NEAR app\n Waiting for confirmation on Ledger...\n\nAfter confirming the request on your Ledger device, a public key and implicit accountId will be displayed.\n\nExample Response
\n\n\n```bash\nUsing public key: ed25519:B22RP10g695wyeRvKIWv61NjmQZEkWTMzAYgdfx6oSeB2\nImplicit account: 42c320xc20739fd9a6bqf2f89z61rd14efe5d3de234199bc771235a4bb8b0e1\n```\n\n
\n\n
\n\n---\n\n#### 4a) `near generate-key --seedPhrase=\"your seed phrase\"`\n\n> Uses a seed phrase to display a public key and [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts)\n\n```bash\nnear generate-key --seedPhrase=\"cow moon right send now cool dense quark pretty see light after\"\n```\n\nExample Response
\n\n\n```bash\nUsing public key: ed25519:B22RP10g695wye3dfa32rDjmQZEkWTMzAYgCX6oSeB2\nImplicit account: 42c320xc20739ASD9a6bqf2Dsaf289z61rd14efe5d3de23213789009afDsd5bb8b0e1\n```\n\n
\n\n
\n\n---\n\n#### 4b) `near generate-key accountId --seedPhrase=\"your seed phrase\"`\n\n> Uses a seed phrase to display a public key **without** the [implicit account](http://docs.near.org/docs/roles/integrator/implicit-accounts).\n\n```bash\nnear generate-key example.testnet --seedPhrase=\"cow moon right send now cool dense quark pretty see light after\"\n```\n\nExample Response
\n\n\n Key pair with ed25519:GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi public key for an account \"e9fa50ac20522987a87e566fcd6febdc97bd35c8c489999ca8aff465c56969c3\"\n\n
\n\n
\n\n---\n\n### `near add-key`\n\n> Adds an either a **full access** or **function access** key to a given account.\n\n**Note:** You will use an _existing_ full access key for the account you would like to add a _new_ key to. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n#### 1) add a `full access` key\n\n- arguments: `accountId` `publicKey`\n\n**Example:**\n\n```bash\nnear add-key example-acct.testnet Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S\n```\n\nExample Response
\n\n\n Key pair with ed25519:GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi public key for an account \"example.testnet\"\n\n
\n\n
\n\n#### 2) add a `function access` key\n\n- arguments: `accountId` `publicKey` `--contract-id`\n- options: `--method-names` `--allowance`\n\n> `accountId` is the account you are adding the key to\n>\n> `--contract-id` is the contract you are allowing methods to be called on\n>\n> `--method-names` are optional and if omitted, all methods of the `--contract-id` can be called.\n>\n> `--allowance` is the amount of Ⓝ the key is allowed to spend on gas fees _only_. If omitted then key will only be able to call view methods.\n\n**Note:** Each transaction made with this key will have gas fees deducted from the initial allowance and once it runs out a new key must be issued.\n\n**Example:**\n\n```bash\nnear add-key example-acct.testnet GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi --contract-id example-contract.testnet --method-names example_method --allowance 30000000000\n```\n\nExample Response
\n\n\n Adding full access key = Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S to example-acct.testnet.\n Transaction Id EwU1ooEvkR42HvGoJHu5ou3xLYT3JcgQwFV3fAwevGJg\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/EwU1ooEvkR42HvGoJHu5ou3xLYT3JcgQwFV3fAwevGJg\n\n
\n\n
\n\n---\n\n### `near delete-key`\n\n> Deletes an existing key for a given account.\n\n- arguments: `accountId` `publicKey`\n- options: `default`\n\n**Note:** You will need separate full access key for the account you would like to delete a key from. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n**Example:**\n\n```bash\nnear delete-key example-acct.testnet Cxg2wgFYrdLTEkMu6j5D6aEZqTb3kXbmJygS48ZKbo1S\n```\n\nExample Response
\n\n\n Adding function call access key = GkMNfc92fwM1AmwH1MTjF4b7UZuceamsq96XPkHsQ9vi to example-acct.testnet.\n Transaction Id H2BQL9fXVmdTbwkXcMFfZ7qhZqC8fFhsA8KDHFdT9q2r\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/H2BQL9fXVmdTbwkXcMFfZ7qhZqC8fFhsA8KDHFdT9q2r\n\n
\n\n
\n\n---\n\n## Accounts\n\n### `near create-account`\n\n> Creates an account using a `--masterAccount` that will pay for the account's creation and any initial balance.\n\n- arguments: `accountId` `--masterAccount`\n- options: `--initialBalance`\n\n**Note:** You will only be able to create subaccounts of the `--masterAccount` unless the name of the new account is ≥ 32 characters.\n\n**Example**:\n\n```bash\nnear create-account 12345678901234567890123456789012 --masterAccount example-acct.testnet\n```\n\n**Subaccount example:**\n\n```bash\nnear create-account sub-acct.example-acct.testnet --masterAccount example-acct.testnet\n```\n\n**Example using `--initialBalance`:**\n\n```bash\nnear create-account sub-acct2.example-acct.testnet --masterAccount example-acct.testnet --initialBalance 10\n```\n\nExample Response
\n\n\n Transaction Id 4PwW7vjzTCno7W433nu4ieA6FvsAjp7zNFwicNLKjQFT\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/4PwW7vjzTCno7W433nu4ieA6FvsAjp7zNFwicNLKjQFT\n\n
\n\n
\n\n---\n\n### `near state`\n\n> Shows details of an account's state.\n\n- arguments: `accountId`\n- options: `default`\n\n**Example:**\n\n```bash\nnear state example.testnet\n```\n\nExample Response
\n\n\n Saving key to '/HOME_DIR/.near-credentials/default/sub-acct2.example-acct.testnet.json'\n Account sub-acct2.example-acct.testnet for network \"default\" was created.\n\n
\n\n
\n\n---\n\n### `near send`\n\n> Sends NEAR tokens (Ⓝ) from one account to another.\n\n- arguments: `senderId` `receiverId` `amount`\n- options: `default`\n\n**Note:** You will need a full access key for the sending account. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n**Example:**\n\n```bash\nnear send sender.testnet receiver.testnet 10\n```\n\nExample Response
\n\n\n```json\n{\n \"amount\": \"99999999303364037168535000\",\n \"locked\": \"0\",\n \"code_hash\": \"G1PCjeQbvbUsJ8piXNb7Yg6dn3mfivDQN7QkvsVuMt4e\",\n \"storage_usage\": 53528,\n \"storage_paid_at\": 0,\n \"block_height\": 21577354,\n \"block_hash\": \"AWu1mrT3eMJLjqyhNHvMKrrbahN6DqcNxXanB5UH1RjB\",\n \"formattedAmount\": \"99.999999303364037168535\"\n}\n```\n\n
\n\n
\n\n---\n\n### `near delete`\n\n> Deletes an account and transfers remaining balance to a beneficiary account.\n\n- arguments: `accountId` `beneficiaryId`\n- options: `default`\n\n**Example:**\n\n```bash\nnear delete sub-acct2.example-acct.testnet example-acct.testnet\n```\n\nExample Response
\n\n\n Sending 10 NEAR to receiver.testnet from sender.testnet\n Transaction Id BYTr6WNyaEy2ykAiQB9P5VvTyrJcFk6Yw95HPhXC6KfN\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/BYTr6WNyaEy2ykAiQB9P5VvTyrJcFk6Yw95HPhXC6KfN\n\n
\n\n
\n\n---\n\n## Contracts\n\n### `near deploy`\n\n> Deploys a smart contract to a given accountId.\n\n- arguments: `accountId` `.wasmFile`\n- options: `initFunction` `initArgs` `initGas` `initDeposit`\n\n**Note:** You will need a full access key for the account you are deploying the contract to. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n**Example:**\n\n```bash\nnear deploy --accountId example-contract.testnet --wasmFile out/example.wasm\n```\n\n**Initialize Example:**\n\n```bash\nnear deploy --accountId example-contract.testnet --wasmFile out/example.wasm --initFunction new --initArgs '{\"owner_id\": \"example-contract.testnet\", \"total_supply\": \"10000000\"}'\n```\n\nExample Response
\n\n\n Deleting account. Account id: sub-acct2.example-acct.testnet, node: https://rpc.testnet.near.org, helper: https://helper.testnet.near.org, beneficiary: example-acct.testnet\n Transaction Id 4x8xohER1E3yxeYdXPfG8GvXin1ShiaroqE5GdCd5YxX\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/4x8xohER1E3yxeYdXPfG8GvXin1ShiaroqE5GdCd5YxX\n Account sub-acct2.example-acct.testnet for network \"default\" was deleted.\n\n
\n\n
\n\n### `near dev-deploy`\n\n> Creates a development account and deploys a smart contract to it. No access keys needed. **_(`testnet` only)_**\n\n- options: `wasmFile`, `initFunction`, `initArgs`, `initGas`, `initDeposit`, `initialBalance`, `force`\n\n**Example:**\n\n```bash\nnear dev-deploy --wasmFile out/example.wasm\n```\n\n**Initialize Example:**\n\n```bash\nnear dev-deploy --wasmFile out/example.wasm --initFunction new --initArgs '{\"owner_id\": \"example-contract.testnet\", \"total_supply\": \"10000000\"}'\n```\n\nExample Response
\n\n\n Starting deployment. Account id: example-contract.testnet, node: https://rpc.testnet.near.org, helper: https://helper.testnet.near.org, file: main.wasm\n Transaction Id G8GhhPuujMHTRnwursPXE1Lv5iUZ8WUecwiST1PcKWMt\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/G8GhhPuujMHTRnwursPXE1Lv5iUZ8WUecwiST1PcKWMt\n Done deploying to example-contract.testnet\n\n
\n\n
\n\n---\n\n### `near call`\n\n> makes a contract call which can modify _or_ view state.\n\n**Note:** Contract calls require a transaction fee (gas) so you will need an access key for the `--accountId` that will be charged. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n- arguments: `contractName` `method_name` `{ args }` `--accountId`\n- options: `--gas` `--deposit`\n\n**Example:**\n\n```bash\nnear call guest-book.testnet addMessage '{\"text\": \"Aloha\"}' --account-id example-acct.testnet\n```\n\nExample Response
\n\n\n Starting deployment. Account id: dev-1603749005325-6432576, node: https://rpc.testnet.near.org, helper: https://helper.testnet.near.org, file: out/main.wasm\n Transaction Id 5nixQT87KeN3eZFX7zwBLUAKSY4nyjhwzLF27SWWKkAp\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/5nixQT87KeN3eZFX7zwBLUAKSY4nyjhwzLF27SWWKkAp\n Done deploying to dev-1603749005325-6432576\n\n
\n\n
\n\n---\n\n### `near view`\n\n> Makes a contract call which can **only** view state. _(Call is free of charge)_\n\n- arguments: `contractName` `method_name` `{ args }`\n- options: `default`\n\n**Example:**\n\n```bash\nnear view guest-book.testnet getMessages '{}'\n```\n\nExample Response
\n\n\n Scheduling a call: guest-book.testnet.addMessage({\"text\": \"Aloha\"})\n Transaction Id FY8hBam2iyQfdHkdR1dp6w5XEPJzJSosX1wUeVPyUvVK\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/FY8hBam2iyQfdHkdR1dp6w5XEPJzJSosX1wUeVPyUvVK\n ''\n\n
\n\n
\n\n---\n\n## NEAR EVM Contracts\n\n### `near evm-view`\n\n> Makes an EVM contract call which can **only** view state. _(Call is free of charge)_\n\n- arguments: `evmAccount` `contractName` `methodName` `[arguments]` `--abi` `--accountId`\n- options: `default`\n\n**Example:**\n\n```bash\nnear evm-view evm 0x89dfB1Cd61F05ad3971EC1f83056Fd9793c2D521 getAdopters '[]' --abi /path/to/contract/abi/Adoption.json --accountId test.near\n```\n\nExample Response
\n\n\n View call: guest-book.testnet.getMessages({})\n [\n { premium: false, sender: 'waverlymaven.testnet', text: 'TGIF' },\n {\n premium: true,\n sender: 'waverlymaven.testnet',\n text: 'Hello from New York 🌈'\n },\n { premium: false, sender: 'fhr.testnet', text: 'Hi' },\n { premium: true, sender: 'eugenethedream', text: 'test' },\n { premium: false, sender: 'dongri.testnet', text: 'test' },\n { premium: false, sender: 'dongri.testnet', text: 'hello' },\n { premium: true, sender: 'dongri.testnet', text: 'hey' },\n { premium: false, sender: 'hirokihori.testnet', text: 'hello' },\n { premium: true, sender: 'eugenethedream', text: 'hello' },\n { premium: false, sender: 'example-acct.testnet', text: 'Aloha' },\n [length]: 10\n ]\n\n
\n\n
\n\n---\n\n### `near evm-call (deprecated)`\n\n> makes an EVM contract call which can modify _or_ view state.\n\n**Note:** Contract calls require a transaction fee (gas) so you will need an access key for the `--accountId` that will be charged. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n- arguments: `evmAccount` `contractName` `methodName` `[arguments]` `--abi` `--accountId`\n- options: `default` (`--gas` and `--deposit` coming soon…)\n\n**Example:**\n\n```bash\nnear evm-call evm 0x89dfB1Cd61F05ad3971EC1f83056Fd9793c2D521 adopt '[\"6\"]' --abi /path/to/contract/abi/Adoption.json --accountId test.near\n```\n\nExample Response
\n\n\n```json\n[\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\",\n \"0x0000000000000000000000000000000000000000\"\n]\n```\n\n
\n\n
\n\n---\n\n### `near evm-dev-init`\n\n> Used for running EVM tests — creates a given number of test accounts on the desired network using a master NEAR account\n\n- arguments: `accountId`\n- options: `numAccounts`\n\n```bash\nNEAR_ENV=betanet near evm-dev-init you.betanet 3\n```\n\nThe above will create 3 subaccounts of `you.betanet`. This is useful for tests that require multiple accounts, for instance, sending fungible tokens back and forth. If the `3` value were to be omitted, it would use the default of 5.\n\n---\n\n## Transactions\n\n### `near tx-status`\n\n> Queries transaction status by hash and accountId.\n\n- arguments: `txHash` `--accountId`\n- options: `default`\n\n**Example:**\n\n```bash\nnear tx-status FY8hBam2iyQfdHkdR1dp6w5XEPJzJSosX1wUeVPyUvVK --accountId guest-book.testnet\n```\n\nExample Response
\n\n\n Scheduling a call inside evm EVM:\n 0x89dfB1Cd61F05ad3971EC1f83056Fd9793c2D521.adopt()\n with args [ '6' ]\n\n
\n\n
\n\n---\n\n## Validators\n\n### `near validators current`\n\n> Displays details of current validators.\n>\n> - amount staked\n> - number of seats\n> - percentage of uptime\n> - expected block production\n> - blocks actually produced\n\n- arguments: `current`\n- options: `default`\n\n**Example:**\n\n```bash\nnear validators current\n```\n\n**Example for `mainnet`:**\n\n```bash\nNEAR_ENV=mainnet near validators current\n```\n\nExample Response
\n\n\n```json\nTransaction guest-book.testnet:FY8hBam2iyQfdHkdR1dp6w5XEPJzJSosX1wUeVPyUvVK\n{\n status: { SuccessValue: '' },\n transaction: {\n signer_id: 'example-acct.testnet',\n public_key: 'ed25519:AXZZKnp6ZcWXyRNdy8FztYrniKf1qt6YZw6mCCReXrDB',\n nonce: 20,\n receiver_id: 'guest-book.testnet',\n actions: [\n {\n FunctionCall: {\n method_name: 'addMessage',\n args: 'eyJ0ZXh0IjoiQWxvaGEifQ==',\n gas: 300000000000000,\n deposit: '0'\n }\n },\n [length]: 1\n ],\n signature: 'ed25519:5S6nZXPU72nzgAsTQLmAFfdVSykdKHWhtPMb5U7duacfPdUjrj8ipJxuRiWkZ4yDodvDNt92wcHLJxGLsyNEsZNB',\n hash: 'FY8hBam2iyQfdHkdR1dp6w5XEPJzJSosX1wUeVPyUvVK'\n },\n transaction_outcome: {\n proof: [ [length]: 0 ],\n block_hash: '6nsjvzt6C52SSuJ8UvfaXTsdrUwcx8JtHfnUj8XjdKy1',\n id: 'FY8hBam2iyQfdHkdR1dp6w5XEPJzJSosX1wUeVPyUvVK',\n outcome: {\n logs: [ [length]: 0 ],\n receipt_ids: [ '7n6wjMgpoBTp22ScLHxeMLzcCvN8Vf5FUuC9PMmCX6yU', [length]: 1 ],\n gas_burnt: 2427979134284,\n tokens_burnt: '242797913428400000000',\n executor_id: 'example-acct.testnet',\n status: {\n SuccessReceiptId: '7n6wjMgpoBTp22ScLHxeMLzcCvN8Vf5FUuC9PMmCX6yU'\n }\n }\n },\n receipts_outcome: [\n {\n proof: [ [length]: 0 ],\n block_hash: 'At6QMrBuFQYgEPAh6fuRBmrTAe9hXTY1NzAB5VxTH1J2',\n id: '7n6wjMgpoBTp22ScLHxeMLzcCvN8Vf5FUuC9PMmCX6yU',\n outcome: {\n logs: [ [length]: 0 ],\n receipt_ids: [ 'FUttfoM2odAhKNQrJ8F4tiBpQJPYu66NzFbxRKii294e', [length]: 1 ],\n gas_burnt: 3559403233496,\n tokens_burnt: '355940323349600000000',\n executor_id: 'guest-book.testnet',\n status: { SuccessValue: '' }\n }\n },\n {\n proof: [ [length]: 0 ],\n block_hash: 'J7KjpMPzAqE7iX82FAQT3qERDs6UR1EAqBLPJXBzoLCk',\n id: 'FUttfoM2odAhKNQrJ8F4tiBpQJPYu66NzFbxRKii294e',\n outcome: {\n logs: [ [length]: 0 ],\n receipt_ids: [ [length]: 0 ],\n gas_burnt: 0,\n tokens_burnt: '0',\n executor_id: 'example-acct.testnet',\n status: { SuccessValue: '' }\n }\n },\n [length]: 2\n ]\n}\n```\n\n
\n\n
\n\n---\n\n### `near validators next`\n\n> Displays details for the next round of validators.\n>\n> - total number of seats available\n> - seat price\n> - amount staked\n> - number of seats assigned per validator\n\n- arguments: `next`\n- options: `default`\n\n**Example:**\n\n```bash\nnear validators next\n```\n\n**Example for `mainnet`:**\n\n```bash\nNEAR_ENV=mainnet near validators next\n```\n\nExample Response
\n\n\n```bash\nValidators (total: 49, seat price: 1,976,588):\n.--------------------------------------------------------------------------------------------------------------------.\n| Validator Id | Stake | Seats | % Online | Blocks produced | Blocks expected |\n|----------------------------------------------|------------|---------|----------|-----------------|-----------------|\n| cryptium.poolv1.near | 13,945,727 | 7 | 100% | 1143 | 1143 |\n| astro-stakers.poolv1.near | 11,660,189 | 5 | 100% | 817 | 817 |\n| blockdaemon.poolv1.near | 11,542,867 | 5 | 76.74% | 627 | 817 |\n| zavodil.poolv1.near | 11,183,187 | 5 | 100% | 818 | 818 |\n| bisontrails.poolv1.near | 10,291,696 | 5 | 99.38% | 810 | 815 |\n| dokiacapital.poolv1.near | 7,906,352 | 3 | 99.54% | 650 | 653 |\n| chorusone.poolv1.near | 7,480,508 | 3 | 100% | 490 | 490 |\n| figment.poolv1.near | 6,931,070 | 3 | 100% | 489 | 489 |\n| stardust.poolv1.near | 6,401,678 | 3 | 100% | 491 | 491 |\n| anonymous.poolv1.near | 6,291,821 | 3 | 97.55% | 479 | 491 |\n| d1.poolv1.near | 6,265,109 | 3 | 100% | 491 | 491 |\n| near8888.poolv1.near | 6,202,968 | 3 | 99.38% | 486 | 489 |\n| rekt.poolv1.near | 5,950,212 | 3 | 100% | 490 | 490 |\n| epic.poolv1.near | 5,639,256 | 2 | 100% | 326 | 326 |\n| fresh.poolv1.near | 5,460,410 | 2 | 100% | 327 | 327 |\n| buildlinks.poolv1.near | 4,838,398 | 2 | 99.38% | 325 | 327 |\n| jubi.poolv1.near | 4,805,921 | 2 | 100% | 326 | 326 |\n| openshards.poolv1.near | 4,644,553 | 2 | 100% | 326 | 326 |\n| jazza.poolv1.near | 4,563,432 | 2 | 100% | 327 | 327 |\n| northernlights.poolv1.near | 4,467,978 | 2 | 99.39% | 326 | 328 |\n| inotel.poolv1.near | 4,427,152 | 2 | 100% | 327 | 327 |\n| baziliknear.poolv1.near | 4,261,142 | 2 | 100% | 328 | 328 |\n| stakesabai.poolv1.near | 4,242,618 | 2 | 100% | 326 | 326 |\n| everstake.poolv1.near | 4,234,552 | 2 | 100% | 327 | 327 |\n| stakin.poolv1.near | 4,071,704 | 2 | 100% | 327 | 327 |\n| certusone.poolv1.near | 3,734,505 | 1 | 100% | 164 | 164 |\n| lux.poolv1.near | 3,705,394 | 1 | 100% | 163 | 163 |\n| staked.poolv1.near | 3,683,365 | 1 | 100% | 164 | 164 |\n| lunanova.poolv1.near | 3,597,231 | 1 | 100% | 163 | 163 |\n| appload.poolv1.near | 3,133,163 | 1 | 100% | 163 | 163 |\n| smart-stake.poolv1.near | 3,095,711 | 1 | 100% | 164 | 164 |\n| artemis.poolv1.near | 3,009,462 | 1 | 99.39% | 163 | 164 |\n| moonlet.poolv1.near | 2,790,296 | 1 | 100% | 163 | 163 |\n| nearfans.poolv1.near | 2,771,137 | 1 | 100% | 163 | 163 |\n| nodeasy.poolv1.near | 2,692,745 | 1 | 99.39% | 163 | 164 |\n| erm.poolv1.near | 2,653,524 | 1 | 100% | 164 | 164 |\n| zkv_staketosupportprivacy.poolv1.near | 2,548,343 | 1 | 99.39% | 163 | 164 |\n| dsrvlabs.poolv1.near | 2,542,925 | 1 | 100% | 164 | 164 |\n| 08investinwomen_runbybisontrails.poolv1.near | 2,493,123 | 1 | 100% | 163 | 163 |\n| electric.poolv1.near | 2,400,532 | 1 | 99.39% | 163 | 164 |\n| sparkpool.poolv1.near | 2,378,191 | 1 | 100% | 163 | 163 |\n| hashquark.poolv1.near | 2,376,424 | 1 | 100% | 164 | 164 |\n| masternode24.poolv1.near | 2,355,634 | 1 | 100% | 164 | 164 |\n| sharpdarts.poolv1.near | 2,332,398 | 1 | 99.38% | 162 | 163 |\n| fish.poolv1.near | 2,315,249 | 1 | 100% | 163 | 163 |\n| ashert.poolv1.near | 2,103,327 | 1 | 97.56% | 160 | 164 |\n| 01node.poolv1.near | 2,058,200 | 1 | 100% | 163 | 163 |\n| finoa.poolv1.near | 2,012,304 | 1 | 100% | 163 | 163 |\n| majlovesreg.poolv1.near | 2,005,032 | 1 | 100% | 164 | 164 |\n'--------------------------------------------------------------------------------------------------------------------'\n```\n\n
\n\n
\n\n---\n\n### `near proposals`\n\n> Displays validator proposals for [epoch](http://docs.near.org/docs/concepts/epoch) after next.\n>\n> - expected seat price\n> - status of proposals\n> - previous amount staked and new amount that _will_ be staked\n> - amount of seats assigned per validator\n\n- arguments: `none`\n- options: `default`\n\n**Example:**\n\n```bash\nnear proposals\n```\n\n**Example for `mainnet`:**\n\n```bash\nNEAR_ENV=mainnet near proposals\n```\n\nExample Response
\n\n\n```bash\nNext validators (total: 49, seat price: 1,983,932):\n.----------------------------------------------------------------------------------------------.\n| Status | Validator | Stake | Seats |\n|----------|----------------------------------------------|--------------------------|---------|\n| Rewarded | cryptium.poolv1.near | 13,945,727 -> 14,048,816 | 7 |\n| Rewarded | astro-stakers.poolv1.near | 11,660,189 -> 11,704,904 | 5 |\n| Rewarded | blockdaemon.poolv1.near | 11,542,867 -> 11,545,942 | 5 |\n| Rewarded | zavodil.poolv1.near | 11,183,187 -> 11,204,123 | 5 |\n| Rewarded | bisontrails.poolv1.near | 10,291,696 -> 10,297,923 | 5 |\n| Rewarded | dokiacapital.poolv1.near | 7,906,352 -> 8,097,275 | 4 |\n| Rewarded | chorusone.poolv1.near | 7,480,508 -> 7,500,576 | 3 |\n| Rewarded | figment.poolv1.near | 6,931,070 -> 6,932,916 | 3 |\n| Rewarded | stardust.poolv1.near | 6,401,678 -> 6,449,363 | 3 |\n| Rewarded | anonymous.poolv1.near | 6,291,821 -> 6,293,497 | 3 |\n| Rewarded | d1.poolv1.near | 6,265,109 -> 6,266,777 | 3 |\n| Rewarded | near8888.poolv1.near | 6,202,968 -> 6,204,620 | 3 |\n| Rewarded | rekt.poolv1.near | 5,950,212 -> 5,951,797 | 2 |\n| Rewarded | epic.poolv1.near | 5,639,256 -> 5,640,758 | 2 |\n| Rewarded | fresh.poolv1.near | 5,460,410 -> 5,461,811 | 2 |\n| Rewarded | buildlinks.poolv1.near | 4,838,398 -> 4,839,686 | 2 |\n| Rewarded | jubi.poolv1.near | 4,805,921 -> 4,807,201 | 2 |\n| Rewarded | openshards.poolv1.near | 4,644,553 -> 4,776,692 | 2 |\n| Rewarded | jazza.poolv1.near | 4,563,432 -> 4,564,648 | 2 |\n| Rewarded | northernlights.poolv1.near | 4,467,978 -> 4,469,168 | 2 |\n| Rewarded | inotel.poolv1.near | 4,427,152 -> 4,428,331 | 2 |\n| Rewarded | baziliknear.poolv1.near | 4,261,142 -> 4,290,338 | 2 |\n| Rewarded | stakesabai.poolv1.near | 4,242,618 -> 4,243,748 | 2 |\n| Rewarded | everstake.poolv1.near | 4,234,552 -> 4,235,679 | 2 |\n| Rewarded | stakin.poolv1.near | 4,071,704 -> 4,072,773 | 2 |\n| Rewarded | certusone.poolv1.near | 3,734,505 -> 3,735,500 | 1 |\n| Rewarded | lux.poolv1.near | 3,705,394 -> 3,716,381 | 1 |\n| Rewarded | staked.poolv1.near | 3,683,365 -> 3,684,346 | 1 |\n| Rewarded | lunanova.poolv1.near | 3,597,231 -> 3,597,836 | 1 |\n| Rewarded | appload.poolv1.near | 3,133,163 -> 3,152,302 | 1 |\n| Rewarded | smart-stake.poolv1.near | 3,095,711 -> 3,096,509 | 1 |\n| Rewarded | artemis.poolv1.near | 3,009,462 -> 3,010,265 | 1 |\n| Rewarded | moonlet.poolv1.near | 2,790,296 -> 2,948,565 | 1 |\n| Rewarded | nearfans.poolv1.near | 2,771,137 -> 2,771,875 | 1 |\n| Rewarded | nodeasy.poolv1.near | 2,692,745 -> 2,693,463 | 1 |\n| Rewarded | erm.poolv1.near | 2,653,524 -> 2,654,231 | 1 |\n| Rewarded | dsrvlabs.poolv1.near | 2,542,925 -> 2,571,865 | 1 |\n| Rewarded | zkv_staketosupportprivacy.poolv1.near | 2,548,343 -> 2,549,022 | 1 |\n| Rewarded | 08investinwomen_runbybisontrails.poolv1.near | 2,493,123 -> 2,493,787 | 1 |\n| Rewarded | masternode24.poolv1.near | 2,355,634 -> 2,456,226 | 1 |\n| Rewarded | fish.poolv1.near | 2,315,249 -> 2,415,831 | 1 |\n| Rewarded | electric.poolv1.near | 2,400,532 -> 2,401,172 | 1 |\n| Rewarded | sparkpool.poolv1.near | 2,378,191 -> 2,378,824 | 1 |\n| Rewarded | hashquark.poolv1.near | 2,376,424 -> 2,377,057 | 1 |\n| Rewarded | sharpdarts.poolv1.near | 2,332,398 -> 2,332,948 | 1 |\n| Rewarded | ashert.poolv1.near | 2,103,327 -> 2,103,887 | 1 |\n| Rewarded | 01node.poolv1.near | 2,058,200 -> 2,058,760 | 1 |\n| Rewarded | finoa.poolv1.near | 2,012,304 -> 2,015,808 | 1 |\n| Rewarded | majlovesreg.poolv1.near | 2,005,032 -> 2,005,566 | 1 |\n'----------------------------------------------------------------------------------------------'\n```\n\n
\n\n
\n\n---\n\n## JS Contracts Enclave\n\n### `near js`\nYou can use `near js Example Response
\n\n\n```bash\nProposals for the epoch after next (new: 51, passing: 49, expected seat price = 1,983,932)\n.--------------------------------------------------------------------------------------------------------.\n| Status | Validator | Stake => New Stake | Seats |\n|--------------------|----------------------------------------------|--------------------------|---------|\n| Proposal(Accepted) | cryptium.poolv1.near | 13,945,727 => 14,041,766 | 7 |\n| Proposal(Accepted) | astro-stakers.poolv1.near | 11,660,189 => 11,705,673 | 5 |\n| Proposal(Accepted) | blockdaemon.poolv1.near | 11,542,867 => 11,545,942 | 5 |\n| Proposal(Accepted) | zavodil.poolv1.near | 11,183,187 => 11,207,805 | 5 |\n| Proposal(Accepted) | bisontrails.poolv1.near | 10,291,696 => 10,300,978 | 5 |\n| Proposal(Accepted) | dokiacapital.poolv1.near | 7,906,352 => 8,097,275 | 4 |\n| Proposal(Accepted) | chorusone.poolv1.near | 7,480,508 => 7,568,268 | 3 |\n| Proposal(Accepted) | figment.poolv1.near | 6,931,070 => 6,932,916 | 3 |\n| Proposal(Accepted) | stardust.poolv1.near | 6,401,678 => 6,449,363 | 3 |\n| Proposal(Accepted) | anonymous.poolv1.near | 6,291,821 => 6,293,497 | 3 |\n| Proposal(Accepted) | d1.poolv1.near | 6,265,109 => 6,266,777 | 3 |\n| Proposal(Accepted) | near8888.poolv1.near | 6,202,968 => 6,204,620 | 3 |\n| Proposal(Accepted) | rekt.poolv1.near | 5,950,212 => 5,951,797 | 2 |\n| Proposal(Accepted) | epic.poolv1.near | 5,639,256 => 5,640,758 | 2 |\n| Proposal(Accepted) | fresh.poolv1.near | 5,460,410 => 5,461,811 | 2 |\n| Proposal(Accepted) | buildlinks.poolv1.near | 4,838,398 => 4,839,686 | 2 |\n| Proposal(Accepted) | jubi.poolv1.near | 4,805,921 => 4,807,201 | 2 |\n| Proposal(Accepted) | openshards.poolv1.near | 4,644,553 => 4,776,692 | 2 |\n| Proposal(Accepted) | jazza.poolv1.near | 4,563,432 => 4,564,648 | 2 |\n| Proposal(Accepted) | northernlights.poolv1.near | 4,467,978 => 4,469,168 | 2 |\n| Proposal(Accepted) | inotel.poolv1.near | 4,427,152 => 4,428,331 | 2 |\n| Proposal(Accepted) | baziliknear.poolv1.near | 4,261,142 => 4,290,891 | 2 |\n| Proposal(Accepted) | stakesabai.poolv1.near | 4,242,618 => 4,243,748 | 2 |\n| Proposal(Accepted) | everstake.poolv1.near | 4,234,552 => 4,235,679 | 2 |\n| Proposal(Accepted) | stakin.poolv1.near | 4,071,704 => 4,072,773 | 2 |\n| Proposal(Accepted) | certusone.poolv1.near | 3,734,505 => 3,735,500 | 1 |\n| Proposal(Accepted) | lux.poolv1.near | 3,705,394 => 3,716,381 | 1 |\n| Proposal(Accepted) | staked.poolv1.near | 3,683,365 => 3,684,346 | 1 |\n| Proposal(Accepted) | lunanova.poolv1.near | 3,597,231 => 3,597,836 | 1 |\n| Proposal(Accepted) | appload.poolv1.near | 3,133,163 => 3,152,302 | 1 |\n| Proposal(Accepted) | smart-stake.poolv1.near | 3,095,711 => 3,096,509 | 1 |\n| Proposal(Accepted) | artemis.poolv1.near | 3,009,462 => 3,010,265 | 1 |\n| Proposal(Accepted) | moonlet.poolv1.near | 2,790,296 => 2,948,565 | 1 |\n| Proposal(Accepted) | nearfans.poolv1.near | 2,771,137 => 2,771,875 | 1 |\n| Proposal(Accepted) | nodeasy.poolv1.near | 2,692,745 => 2,693,463 | 1 |\n| Proposal(Accepted) | erm.poolv1.near | 2,653,524 => 2,654,231 | 1 |\n| Proposal(Accepted) | dsrvlabs.poolv1.near | 2,542,925 => 2,571,865 | 1 |\n| Proposal(Accepted) | zkv_staketosupportprivacy.poolv1.near | 2,548,343 => 2,549,022 | 1 |\n| Proposal(Accepted) | 08investinwomen_runbybisontrails.poolv1.near | 2,493,123 => 2,493,787 | 1 |\n| Proposal(Accepted) | masternode24.poolv1.near | 2,355,634 => 2,456,226 | 1 |\n| Proposal(Accepted) | fish.poolv1.near | 2,315,249 => 2,415,831 | 1 |\n| Proposal(Accepted) | electric.poolv1.near | 2,400,532 => 2,401,172 | 1 |\n| Proposal(Accepted) | sparkpool.poolv1.near | 2,378,191 => 2,378,824 | 1 |\n| Proposal(Accepted) | hashquark.poolv1.near | 2,376,424 => 2,377,057 | 1 |\n| Proposal(Accepted) | sharpdarts.poolv1.near | 2,332,398 => 2,332,948 | 1 |\n| Proposal(Accepted) | ashert.poolv1.near | 2,103,327 => 2,103,887 | 1 |\n| Proposal(Accepted) | 01node.poolv1.near | 2,058,200 => 2,059,314 | 1 |\n| Proposal(Accepted) | finoa.poolv1.near | 2,012,304 => 2,015,808 | 1 |\n| Proposal(Accepted) | majlovesreg.poolv1.near | 2,005,032 => 2,005,566 | 1 |\n| Proposal(Declined) | huobipool.poolv1.near | 1,666,976 | 0 |\n| Proposal(Declined) | hb436_pool.poolv1.near | 500,030 | 0 |\n'--------------------------------------------------------------------------------------------------------'\n\n```\n\n
\n\n
\n\n### `near js dev-deploy`\n\n> Creates a development account and deploys a smart contract to the enclave associated to the dev-account. No access keys needed. **_(`testnet` only)_**\n\n- arguments: `base64File` `deposit`\n- options: `jsvm`\n\n**Example:**\n\n```bash\nnear js dev-deploy --base64File out/example.base64 --deposit 0.1\n```\n\nExample Response
\n\n\n Starting deployment. Account id: example-contract.testnet, node: https://rpc.testnet.near.org, helper: https://helper.testnet.near.org, file: out/example.base64, JSVM: jsvm.testnet\n Transaction Id 4Nxsszgh2LaXPZph37peZKDqPZeJEErPih6n4jWcGDEB\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/4Nxsszgh2LaXPZph37peZKDqPZeJEErPih6n4jWcGDEB\n Done deploying to example-contract.testnet\n\n
\n\n
\n\n### `near js call`\n\n> makes a contract call which can modify _or_ view state into the JSVM enclase\n\n**Note:** Contract calls require a transaction fee (gas) so you will need an access key for the `--accountId` that will be charged. ([`near login`](http://docs.near.org/docs/tools/near-cli#near-login))\n\n- arguments: `contractName` `methodName` `{ args }` `--accountId` `--deposit`\n- options: `--gas` `--jsvm`\n\n**Example:**\n\n```bash\nnear js call dev-1653005231830-15694723179173 set_status '[\"hello world\"]' --deposit 0.1 --account-id dev-1653005231830-15694723179173\n```\n\nExample Response
\n\n\n Starting deployment. Account id: dev-1653005231830-15694723179173, node: https://rpc.testnet.near.org, helper: https://helper.testnet.near.org, file: out/example.base64, JSVM: jsvm.testnet\n Transaction Id FTVd4TKzy9mrmWvok6qHaoX68cVZnUJp2VqUgH6Y446n\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/FTVd4TKzy9mrmWvok6qHaoX68cVZnUJp2VqUgH6Y446n\n Done deploying to dev-1653005231830-15694723179173\n\n
\n\n
\n\n### `near js view`\n\n> Makes a contract call which can **only** view state. _(Call is free of charge and does not require deposit)_\n\n- arguments: `contractName` `method_name` `{ args }`\n- options: `jsvm`\n\n**Example:**\n\n```bash\nnear js view dev-1653005231830-15694723179173 get_status '[\"dev-1653005231830-15694723179173\"]' --accountId dev-1653005231830-15694723179173\n```\n\nExample Response
\n\n\n Scheduling a call in JSVM[jsvm.testnet]: dev-1653005231830-15694723179173.set_status([\"hello world\"]) with attached 0.1 NEAR\n Receipts: 5QUuNwSYrDcEPKuSnU7fKN7YCGfXmdmZR9m3zUSTek7P, 3YU4eFhqBruc4z8KKLZr1U1oY31A6Bfks45GLA2rq5GS\n Log [jsvm.testnet]: dev-1653005231830-15694723179173 set_status with message hello world\n Transaction Id sP8s9REgK9YcZzkudyccg8R968zYWDVGCNv4wxeZsUe\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/sP8s9REgK9YcZzkudyccg8R968zYWDVGCNv4wxeZsUe\n ''\n\n
\n\n
\n\n### `near js remove`\n\n> Removes the contract on the JS enclase and refunds all the deposit to the actual account.\n\n- arguments: `accountId`\n- options: `jsvm`\n\n```bash\nnear js remove --accountId dev-1653005231830-15694723179173\n```\n\nExample Response
\n\n\n View call in JSVM[jsvm.testnet]: dev-1653005231830-15694723179173.get_status([\"dev-1653005231830-15694723179173\"])\n Log [jsvm.testnet]: get_status for account_id dev-1653005231830-15694723179173\n 'hello world'\n\n
\n\n
\n\n## REPL\n\n### `near repl`\n\n> Launches NEAR [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) _(an interactive JavaScript programming invironment)_ connected to NEAR.\n\n- arguments: `none`\n- options: `--accountId`, `--script`\n\nTo launch, run:\n\n```bash\nnear repl\n```\n\n- You will then be shown a prompt `>` and can begin interacting with NEAR.\n- Try typing the following into your prompt that converts NEAR (Ⓝ) into yoctoNEAR (10^-24):\n\n```bash\nnearAPI.utils.format.parseNearAmount('1000')\n```\n\n> You can also use an `--accountId` with `near repl`.\n\nThe `script` argument allows you to pass the path to a javascript/typescript file that exports a `main` function taking a [`Context`](./context/index.d.ts) as an argument. Anything passed after `--` is passed to the script as the `argv` argument.\n\nNote: you will need to add `near-cli` as a dependency in order to import the types.\n\ne.g.\n\n```ts\nimport { Context } from \"near-cli/context\";\n```\n\n**Example:**\n\n```bash\nnear repl --accountId example-acct.testnet\n```\n\n- Then try console logging `account` after the `>` prompt.\n\n```bash\nconsole.log(account)\n```\n\nOr in a JS files\n\n```js\nmodule.exports.main = async function main({account, near, nearAPI, argv}) {\n console.log(account);\n}\n```\n\nExample Response
\n\n\n Removing contract from enclave. Account id: dev-1653005231830-15694723179173, JSVM: jsvm.testnet\n Transaction Id FGSfvoWmhS1fWb6ckpPMYvc7seNaGQ5MU7iSrY43ZWiG\n To see the transaction in the transaction explorer, please open this url in your browser\n https://explorer.testnet.near.org/transactions/FGSfvoWmhS1fWb6ckpPMYvc7seNaGQ5MU7iSrY43ZWiG\n\n
\n\n
\n\n> You can also get a private key's public key.\n\n- First, declare a `privateKey` variable:\n\n```js\nconst myPrivateKey =\n \"3fKM9Rr7LHyzhhzmmedXLvc59rayfh1oUYS3VfUcxwpAFQZtdx1G9aTY6i8hG9mQtYoycTEFTBtatgNKHRtYamrS\";\n```\n\n- Then run:\n\n```js\nnearAPI.KeyPair.fromString(myPrivateKey).publicKey.toString();\n```\n\nWith NEAR REPL you have complete access to [`near-api-js`](https://github.com/near/near-api-js) to help you develop on the NEAR platform.\n\n---\n\n## Options\n\n| Option | Description |\n| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| `--help` | Show help [boolean] |\n| `--version` | Show version number [boolean] |\n| `--nodeUrl, --node_url` | NEAR node URL [string] [default: \"https://rpc.testnet.near.org\"] |\n| `--networkId, --network_id`| NEAR network ID, allows using different keys based on network [string] [default: \"testnet\"] |\n| `--helperUrl` | NEAR contract helper URL [string] |\n| `--keyPath` | Path to master account key [string] |\n| `--accountId, --account_id`| Unique identifier for the account [string] |\n| `--useLedgerKey` | Use Ledger for signing with given HD key path [string] [default: \"44'/397'/0'/0'/1'\"] |\n| `--seedPhrase` | Seed phrase mnemonic [string] |\n| `--seedPath` | HD path derivation [string] [default: \"m/44'/397'/0'\"] |\n| `--walletUrl` | Website for NEAR Wallet [string] |\n| `--contractName` | Account name of contract [string] |\n| `--masterAccount` | Master account used when creating new accounts [string] |\n| `--helperAccount` | Expected top-level account for a network [string] |\n| `-v, --verbose` | Prints out verbose output [boolean] [default: false] |\n|`-f, --force` | Forcefully execute the desired action even if it is unsafe to do so [boolean] [default: false]|\n\n> Got a question? Example Response
\n\n\n```json\nAccount {\n accessKeyByPublicKeyCache: {},\n connection: Connection {\n networkId: 'default',\n provider: JsonRpcProvider { connection: [Object] },\n signer: InMemorySigner { keyStore: [MergeKeyStore] }\n },\n accountId: 'example-acct.testnet',\n _ready: Promise { undefined },\n _state: {\n amount: '98786165075093615800000000',\n locked: '0',\n code_hash: '11111111111111111111111111111111',\n storage_usage: 741,\n storage_paid_at: 0,\n block_height: 21661252,\n block_hash: 'HbAj25dTzP3ssYjNRHov9BQ72UxpHGVqZK1mZwGdGNbo'\n }\n}\n```\n\n
\n\n\n\n \n\n\n \n\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\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\nimport MagicString from 'magic-string';\nimport fs from 'fs'\n\nconst 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\nconst map = s.generateMap({\n source: 'source.js',\n file: 'converted.js.map',\n includeContent: true\n}); // generates a v3 sourcemap\n\nfs.writeFileSync('converted.js', s.toString());\nfs.writeFileSync('converted.js.map', map.toString());\n```\n\nYou can pass an options argument:\n\n```js\nconst 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.generateDecodedMap( options )\n\nGenerates a sourcemap object with raw mappings in array form, rather than encoded as a string. See `generateMap` documentation below for options details. Useful if you need to manipulate the sourcemap further, but most of the time you will use `generateMap` instead.\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### s.isEmpty()\n\nReturns true if the resulting source is empty (disregarding white space).\n\n## Bundling\n\nTo concatenate several sources, use `MagicString.Bundle`:\n\n```js\nconst 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\nconst 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\nconst bundle = new MagicString.Bundle();\nconst source = new MagicString(someCode, {\n filename: 'foo.js'\n});\n\nbundle.addSource(source);\n```\n\n## License\n\nMIT\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```\nare-we-there-yet\n----------------\n\nTrack complex hiearchies of asynchronous task completion statuses. This is\nintended to give you a way of recording and reporting the progress of the big\nrecursive fan-out and gather type workflows that are so common in async.\n\nWhat you do with this completion data is up to you, but the most common use case is to\nfeed it to one of the many progress bar modules.\n\nMost progress bar modules include a rudamentary version of this, but my\nneeds were more complex.\n\nUsage\n=====\n\n```javascript\nvar TrackerGroup = require(\"are-we-there-yet\").TrackerGroup\n\nvar top = new TrackerGroup(\"program\")\n\nvar single = top.newItem(\"one thing\", 100)\nsingle.completeWork(20)\n\nconsole.log(top.completed()) // 0.2\n\nfs.stat(\"file\", function(er, stat) {\n if (er) throw er \n var stream = top.newStream(\"file\", stat.size)\n console.log(top.completed()) // now 0.1 as single is 50% of the job and is 20% complete\n // and 50% * 20% == 10%\n fs.createReadStream(\"file\").pipe(stream).on(\"data\", function (chunk) {\n // do stuff with chunk\n })\n top.on(\"change\", function (name) {\n // called each time a chunk is read from \"file\"\n // top.completed() will start at 0.1 and fill up to 0.6 as the file is read\n })\n})\n```\n\nShared Methods\n==============\n\n* var completed = tracker.completed()\n\nImplemented in: `Tracker`, `TrackerGroup`, `TrackerStream`\n\nReturns the ratio of completed work to work to be done. Range of 0 to 1.\n\n* tracker.finish()\n\nImplemented in: `Tracker`, `TrackerGroup`\n\nMarks the tracker as completed. With a TrackerGroup this marks all of its\ncomponents as completed.\n\nMarks all of the components of this tracker as finished, which in turn means\nthat `tracker.completed()` for this will now be 1.\n\nThis will result in one or more `change` events being emitted.\n\nEvents\n======\n\nAll tracker objects emit `change` events with the following arguments:\n\n```\nfunction (name, completed, tracker)\n```\n\n`name` is the name of the tracker that originally emitted the event,\nor if it didn't have one, the first containing tracker group that had one.\n\n`completed` is the percent complete (as returned by `tracker.completed()` method).\n\n`tracker` is the tracker object that you are listening for events on.\n\nTrackerGroup\n============\n\n* var tracker = new TrackerGroup(**name**)\n\n * **name** *(optional)* - The name of this tracker group, used in change\n notifications if the component updating didn't have a name. Defaults to undefined.\n\nCreates a new empty tracker aggregation group. These are trackers whose\ncompletion status is determined by the completion status of other trackers.\n\n* tracker.addUnit(**otherTracker**, **weight**)\n\n * **otherTracker** - Any of the other are-we-there-yet tracker objects\n * **weight** *(optional)* - The weight to give the tracker, defaults to 1.\n\nAdds the **otherTracker** to this aggregation group. The weight determines\nhow long you expect this tracker to take to complete in proportion to other\nunits. So for instance, if you add one tracker with a weight of 1 and\nanother with a weight of 2, you're saying the second will take twice as long\nto complete as the first. As such, the first will account for 33% of the\ncompletion of this tracker and the second will account for the other 67%.\n\nReturns **otherTracker**.\n\n* var subGroup = tracker.newGroup(**name**, **weight**)\n\nThe above is exactly equivalent to:\n\n```javascript\n var subGroup = tracker.addUnit(new TrackerGroup(name), weight)\n```\n\n* var subItem = tracker.newItem(**name**, **todo**, **weight**)\n\nThe above is exactly equivalent to:\n\n```javascript\n var subItem = tracker.addUnit(new Tracker(name, todo), weight)\n```\n\n* var subStream = tracker.newStream(**name**, **todo**, **weight**)\n\nThe above is exactly equivalent to:\n\n```javascript\n var subStream = tracker.addUnit(new TrackerStream(name, todo), weight)\n```\n\n* console.log( tracker.debug() )\n\nReturns a tree showing the completion of this tracker group and all of its\nchildren, including recursively entering all of the children.\n\nTracker\n=======\n\n* var tracker = new Tracker(**name**, **todo**)\n\n * **name** *(optional)* The name of this counter to report in change\n events. Defaults to undefined.\n * **todo** *(optional)* The amount of work todo (a number). Defaults to 0.\n\nOrdinarily these are constructed as a part of a tracker group (via\n`newItem`).\n\n* var completed = tracker.completed()\n\nReturns the ratio of completed work to work to be done. Range of 0 to 1. If\ntotal work to be done is 0 then it will return 0.\n\n* tracker.addWork(**todo**)\n\n * **todo** A number to add to the amount of work to be done.\n\nIncreases the amount of work to be done, thus decreasing the completion\npercentage. Triggers a `change` event.\n\n* tracker.completeWork(**completed**)\n\n * **completed** A number to add to the work complete\n\nIncrease the amount of work complete, thus increasing the completion percentage.\nWill never increase the work completed past the amount of work todo. That is,\npercentages > 100% are not allowed. Triggers a `change` event.\n\n* tracker.finish()\n\nMarks this tracker as finished, tracker.completed() will now be 1. Triggers\na `change` event.\n\nTrackerStream\n=============\n\n* var tracker = new TrackerStream(**name**, **size**, **options**)\n\n * **name** *(optional)* The name of this counter to report in change\n events. Defaults to undefined.\n * **size** *(optional)* The number of bytes being sent through this stream.\n * **options** *(optional)* A hash of stream options\n\nThe tracker stream object is a pass through stream that updates an internal\ntracker object each time a block passes through. It's intended to track\ndownloads, file extraction and other related activities. You use it by piping\nyour data source into it and then using it as your data source.\n\nIf your data has a length attribute then that's used as the amount of work\ncompleted when the chunk is passed through. If it does not (eg, object\nstreams) then each chunk counts as completing 1 unit of work, so your size\nshould be the total number of objects being streamed.\n\n* tracker.addWork(**todo**)\n\n * **todo** Increase the expected overall size by **todo** bytes.\n\nIncreases the amount of work to be done, thus decreasing the completion\npercentage. Triggers a `change` event.\n# function-bind\n\n\n\n\n\nImplementation of function.prototype.bind\n\n## Example\n\nI mainly do this for unit tests I run on phantomjs.\nPhantomJS does not have Function.prototype.bind :(\n\n```js\nFunction.prototype.bind = require(\"function-bind\")\n```\n\n## Installation\n\n`npm install function-bind`\n\n## Contributors\n\n - Raynos\n\n## MIT Licenced\n\n [travis-svg]: https://travis-ci.org/Raynos/function-bind.svg\n [travis-url]: https://travis-ci.org/Raynos/function-bind\n [npm-badge-svg]: https://badge.fury.io/js/function-bind.svg\n [npm-url]: https://npmjs.org/package/function-bind\n [5]: https://coveralls.io/repos/Raynos/function-bind/badge.png\n [6]: https://coveralls.io/r/Raynos/function-bind\n [7]: https://gemnasium.com/Raynos/function-bind.png\n [8]: https://gemnasium.com/Raynos/function-bind\n [deps-svg]: https://david-dm.org/Raynos/function-bind.svg\n [deps-url]: https://david-dm.org/Raynos/function-bind\n [dev-deps-svg]: https://david-dm.org/Raynos/function-bind/dev-status.svg\n [dev-deps-url]: https://david-dm.org/Raynos/function-bind#info=devDependencies\n [11]: https://ci.testling.com/Raynos/function-bind.png\n [12]: https://ci.testling.com/Raynos/function-bind\n# Borsh JS\n\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://opensource.org/licenses/MIT)\n[](https://discord.gg/Vyp7ETM)\n[](https://travis-ci.com/near/borsh-js)\n[](https://npmjs.com/borsh)\n[](https://npmjs.com/borsh)\n\n**Borsh JS** is an implementation of the [Borsh] binary serialization format for\nJavaScript and TypeScript projects.\n\nBorsh stands for _Binary Object Representation Serializer for Hashing_. It is meant to be used in security-critical projects as it prioritizes consistency,\nsafety, speed, and comes with a strict specification.\n\n## Examples\n### Serializing an object\n```javascript\nconst value = new Test({ x: 255, y: 20, z: '123', q: [1, 2, 3] });\nconst schema = new Map([[Test, { kind: 'struct', fields: [['x', 'u8'], ['y', 'u64'], ['z', 'string'], ['q', [3]]] }]]);\nconst buffer = borsh.serialize(schema, value);\n```\n\n### Deserializing an object\n```javascript\nconst newValue = borsh.deserialize(schema, Test, buffer);\n```\n\n## Type Mappings\n\n| Borsh | TypeScript |\n|-----------------------|----------------|\n| `u8` integer | `number` |\n| `u16` integer | `number` |\n| `u32` integer | `number` |\n| `u64` integer | `BN` |\n| `u128` integer | `BN` |\n| `u256` integer | `BN` |\n| `u512` integer | `BN` |\n| `f32` float | N/A |\n| `f64` float | N/A |\n| fixed-size byte array | `Uint8Array` |\n| UTF-8 string | `string` |\n| option | `null` or type |\n| map | N/A |\n| set | N/A |\n| structs | `any` |\n\n## Contributing\n\nInstall dependencies:\n```bash\nyarn install\n```\n\nContinuously build with:\n```bash\nyarn dev\n```\n\nRun tests:\n```bash\nyarn test\n```\n\nRun linter\n```bash\nyarn lint\n```\n## Publish\n\nPrepare `dist` version by running:\n```bash\nyarn build\n```\n\nWhen publishing to npm use [np](https://github.com/sindresorhus/np).\n\n# License\nThis repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).\nSee [LICENSE-MIT](LICENSE-MIT.txt) and [LICENSE-APACHE](LICENSE-APACHE) for details.\n\n[Borsh]: https://borsh.io\n\n\n# [](https://typestrong.org/ts-node)\n\n[](https://npmjs.org/package/ts-node)\n[](https://npmjs.org/package/ts-node)\n[](https://github.com/TypeStrong/ts-node/actions?query=workflow%3A%22Continuous+Integration%22)\n[](https://codecov.io/gh/TypeStrong/ts-node)\n\n> TypeScript execution and REPL for node.js, with source map and native ESM support.\n\nThe latest documentation can also be found on our website: \n*Environment:* `TS_NODE_SKIP_PROJECT`\n\n### cwdMode\n\n```shell\nts-node -c\nts-node --cwdMode\nts-node-cwd\n```\n\nResolve config relative to the current directory instead of the directory of the entrypoint script\n\n### compilerOptions\n\n```shell\nts-node -O
\n*Environment:* `TS_NODE_TRANSPILE_ONLY`\n\n### typeCheck\n\n```shell\nts-node --typeCheck\n```\n\nOpposite of `--transpileOnly`\n\n*Default:* `true`
\n*Environment:* `TS_NODE_TYPE_CHECK`\n\n### compilerHost\n\n```shell\nts-node -H\nts-node --compilerHost\n```\n\nUse TypeScript's compiler host API\n\n*Default:* `false`
\n*Environment:* `TS_NODE_COMPILER_HOST`\n\n### files\n\n```shell\nts-node --files\n```\n\nLoad `files`, `include` and `exclude` from `tsconfig.json` on startup. This may\navoid certain typechecking failures. See [Missing types](#missing-types) for details.\n\n*Default:* `false`
\n*Environment:* `TS_NODE_FILES`\n\n### ignoreDiagnostics\n\n```shell\nts-node -D
\n*Environment:* `TS_NODE_IGNORE`\n\n### skipIgnore\n\n```shell\nts-node --skipIgnore\n```\n\nSkip ignore checks\n\n*Default:* `false`
\n*Environment:* `TS_NODE_SKIP_IGNORE`\n\n### compiler\n\n```shell\nts-node -C
\n*Environment:* `TS_NODE_COMPILER`\n\n### swc\n\n```shell\nts-node --swc\n```\n\nTranspile with [swc](#swc). Implies `--transpileOnly`\n\n*Default:* `false`\n\n### transpiler\n\n```shell\nts-node --transpiler
\n*Environment:* `TS_NODE_PREFER_TS_EXTS`\n\n## Diagnostic Options\n\n### logError\n\n```shell\nts-node --logError\n```\n\nLogs TypeScript errors to stderr instead of throwing exceptions\n\n*Default:* `false`
\n*Environment:* `TS_NODE_LOG_ERROR`\n\n### pretty\n\n```shell\nts-node --pretty\n```\n\nUse pretty diagnostic formatter\n\n*Default:* `false`
\n*Environment:* `TS_NODE_PRETTY`\n\n### TS_NODE_DEBUG\n\n```shell\nTS_NODE_DEBUG=true ts-node\n```\n\nEnable debug logging\n\n## Advanced Options\n\n### require\n\n```shell\nts-node -r
\n*Environment:* `TS_NODE_CWD`\n\n### emit\n\n```shell\nts-node --emit\n```\n\nEmit output files into `.ts-node` directory. Requires `--compilerHost`\n\n*Default:* `false`
\n*Environment:* `TS_NODE_EMIT`\n\n### scope\n\n```shell\nts-node --scope\n```\n\nScope compiler to files within `scopeDir`. Anything outside this directory is ignored.\n\n*Default:* `false`
\n*Environment:* `TS_NODE_SCOPE`\n\n### scopeDir\n\n```shell\nts-node --scopeDir
\n*Environment:* `TS_NODE_SCOPE_DIR`\n\n### moduleTypes\n\nOverride the module type of certain files, ignoring the `package.json` `\"type\"` field. See [Module type overrides](#module-type-overrides) for details.\n\n*Default:* obeys `package.json` `\"type\"` and `tsconfig.json` `\"module\"`
\n*Can only be specified via `tsconfig.json` or API.*\n\n### TS_NODE_HISTORY\n\n```shell\nTS_NODE_HISTORY=
\n*Environment:* `TS_NODE_EXPERIMENTAL_REPL_AWAIT` set `false` to disable\n\n### experimentalResolver\n\nEnable experimental hooks that re-map imports and require calls to support:\n\n* remapping extensions, e.g. so that `import \"./foo.js\"` will execute `foo.ts`. Currently the following extensions will be mapped:\n * `.js` to `.ts`, `.tsx`, or `.jsx`\n * `.cjs` to `.cts`\n * `.mjs` to `.mts`\n * `.jsx` to `.tsx`\n* including file extensions in CommonJS, for consistency with ESM where this is often mandatory\n\nIn the future, this hook will also support:\n\n* `baseUrl`, `paths`\n* `rootDirs`\n* `outDir` to `rootDir` mappings for composite projects and monorepos\n\nFor details, see [#1514](https://github.com/TypeStrong/ts-node/issues/1514).\n\n*Default:* `false`, but will likely be enabled by default in a future version
\n*Can only be specified via `tsconfig.json` or API.*\n\n### experimentalSpecifierResolution\n\n```shell\nts-node --experimentalSpecifierResolution node\n```\n\nLike node's [`--experimental-specifier-resolution`](https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm), but can also be set in your `tsconfig.json` for convenience.\nRequires [`esm`](#esm) to be enabled.\n\n*Default:* `explicit`
\n\n## API Options\n\nThe API includes [additional options](https://typestrong.org/ts-node/api/interfaces/RegisterOptions.html) not shown here.\n\n# SWC\n\nSWC support is built-in via the `--swc` flag or `\"swc\": true` tsconfig option.\n\n[SWC](https://swc.rs) is a TypeScript-compatible transpiler implemented in Rust. This makes it an order of magnitude faster than vanilla `transpileOnly`.\n\nTo use it, first install `@swc/core` or `@swc/wasm`. If using `importHelpers`, also install `@swc/helpers`. If `target` is less than \"es2015\" and using `async`/`await` or generator functions, also install `regenerator-runtime`.\n\n```shell\nnpm i -D @swc/core @swc/helpers regenerator-runtime\n```\n\nThen add the following to your `tsconfig.json`.\n\n```jsonc title=\"tsconfig.json\"\n{\n \"ts-node\": {\n \"swc\": true\n }\n}\n```\n\n> SWC uses `@swc/helpers` instead of `tslib`. If you have enabled `importHelpers`, you must also install `@swc/helpers`.\n\n# CommonJS vs native ECMAScript modules\n\nTypeScript is almost always written using modern `import` syntax, but it is also transformed before being executed by the underlying runtime. You can choose to either transform to CommonJS or to preserve the native `import` syntax, using node's native ESM support. Configuration is different for each.\n\nHere is a brief comparison of the two.\n\n| CommonJS | Native ECMAScript modules |\n|---|---|\n| Write native `import` syntax | Write native `import` syntax |\n| Transforms `import` into `require()` | Does not transform `import` |\n| Node executes scripts using the classic [CommonJS loader](https://nodejs.org/dist/latest-v16.x/docs/api/modules.html) | Node executes scripts using the new [ESM loader](https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) |\n| Use any of:
`ts-node`
`node -r ts-node/register`
`NODE_OPTIONS=\"ts-node/register\" node`
`require('ts-node').register({/* options */})` | Use any of:
`ts-node --esm`
`ts-node-esm`
Set `\"esm\": true` in `tsconfig.json`
`node --loader ts-node/esm`
`NODE_OPTIONS=\"--loader ts-node/esm\" node` |\n\n## CommonJS\n\nTransforming to CommonJS is typically simpler and more widely supported because it is older. You must remove [`\"type\": \"module\"`](https://nodejs.org/api/packages.html#packages_type) from `package.json` and set [`\"module\": \"CommonJS\"`](https://www.typescriptlang.org/tsconfig/#module) in `tsconfig.json`.\n\n```jsonc title=\"package.json\"\n{\n // This can be omitted; commonjs is the default\n \"type\": \"commonjs\"\n}\n```\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"module\": \"CommonJS\"\n }\n}\n```\n\nIf you must keep `\"module\": \"ESNext\"` for `tsc`, webpack, or another build tool, you can set an override for ts-node.\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"module\": \"ESNext\"\n },\n \"ts-node\": {\n \"compilerOptions\": {\n \"module\": \"CommonJS\"\n }\n }\n}\n```\n\n## Native ECMAScript modules\n\n[Node's ESM loader hooks](https://nodejs.org/api/esm.html#esm_experimental_loaders) are [**experimental**](https://nodejs.org/api/documentation.html#documentation_stability_index) and subject to change. ts-node's ESM support is as stable as possible, but it relies on APIs which node can *and will* break in new versions of node. Thus it is not recommended for production.\n\nFor complete usage, limitations, and to provide feedback, see [#1007](https://github.com/TypeStrong/ts-node/issues/1007).\n\nYou must set [`\"type\": \"module\"`](https://nodejs.org/api/packages.html#packages_type) in `package.json` and [`\"module\": \"ESNext\"`](https://www.typescriptlang.org/tsconfig/#module) in `tsconfig.json`.\n\n```jsonc title=\"package.json\"\n{\n \"type\": \"module\"\n}\n```\n\n```jsonc title=\"tsconfig.json\"\n{\n \"compilerOptions\": {\n \"module\": \"ESNext\" // or ES2015, ES2020\n },\n \"ts-node\": {\n // Tell ts-node CLI to install the --loader automatically, explained below\n \"esm\": true\n }\n}\n```\n\nYou must also ensure node is passed `--loader`. The ts-node CLI will do this automatically with our `esm` option.\n\n> Note: `--esm` must spawn a child process to pass it `--loader`. This may change if node adds the ability to install loader hooks\n> into the current process.\n\n```shell\n# pass the flag\nts-node --esm\n# Use the convenience binary\nts-node-esm\n# or add `\"esm\": true` to your tsconfig.json to make it automatic\nts-node\n```\n\nIf you are not using our CLI, pass the loader flag to node.\n\n```shell\nnode --loader ts-node/esm ./index.ts\n# Or via environment variable\nNODE_OPTIONS=\"--loader ts-node/esm\" node ./index.ts\n```\n\n# Troubleshooting\n\n## Configuration\n\nts-node uses sensible default configurations to reduce boilerplate while still respecting `tsconfig.json` if you\nhave one. If you are unsure which configuration is used, you can log it with `ts-node --showConfig`. This is similar to\n`tsc --showConfig` but includes `\"ts-node\"` options as well.\n\nts-node also respects your locally-installed `typescript` version, but global installations fallback to the globally-installed\n`typescript`. If you are unsure which versions are used, `ts-node -vv` will log them.\n\n```shell\n$ ts-node -vv\nts-node v10.0.0\nnode v16.1.0\ncompiler v4.2.2\n\n$ ts-node --showConfig\n{\n \"compilerOptions\": {\n \"target\": \"es6\",\n \"lib\": [\n \"es6\",\n \"dom\"\n ],\n \"rootDir\": \"./src\",\n \"outDir\": \"./.ts-node\",\n \"module\": \"commonjs\",\n \"moduleResolution\": \"node\",\n \"strict\": true,\n \"declaration\": false,\n \"sourceMap\": true,\n \"inlineSources\": true,\n \"types\": [\n \"node\"\n ],\n \"stripInternal\": true,\n \"incremental\": true,\n \"skipLibCheck\": true,\n \"importsNotUsedAsValues\": \"error\",\n \"inlineSourceMap\": false,\n \"noEmit\": false\n },\n \"ts-node\": {\n \"cwd\": \"/d/project\",\n \"projectSearchDir\": \"/d/project\",\n \"require\": [],\n \"project\": \"/d/project/tsconfig.json\"\n }\n}\n```\n\n## Common errors\n\nIt is important to differentiate between errors from ts-node, errors from the TypeScript compiler, and errors from `node`. It is also important to understand when errors are caused by a type error in your code, a bug in your code, or a flaw in your configuration.\n\n### `TSError`\n\nType errors from the compiler are thrown as a `TSError`. These are the same as errors you get from `tsc`.\n\n### `SyntaxError`\n\nAny error that is not a `TSError` is from node.js (e.g. `SyntaxError`), and cannot be fixed by TypeScript or ts-node. These are bugs in your code or configuration.\n\n#### Unsupported JavaScript syntax\n\nYour version of `node` may not support all JavaScript syntax supported by TypeScript. The compiler must transform this syntax via \"downleveling,\" which is controlled by\nthe [tsconfig `\"target\"` option](https://www.typescriptlang.org/tsconfig#target). Otherwise your code will compile fine, but node will throw a `SyntaxError`.\n\nFor example, `node` 12 does not understand the `?.` optional chaining operator. If you use `\"target\": \"esnext\"`, then the following TypeScript syntax:\n\n```typescript twoslash\nconst bar: string | undefined = foo?.bar;\n```\n\nwill compile into this JavaScript:\n\n```javascript\nconst a = foo?.bar;\n```\n\nWhen you try to run this code, node 12 will throw a `SyntaxError`. To fix this, you must switch to `\"target\": \"es2019\"` or lower so TypeScript transforms `?.` into something `node` can understand.\n\n### `ERR_REQUIRE_ESM`\n\nThis error is thrown by node when a module is `require()`d, but node believes it should execute as native ESM. This can happen for a few reasons:\n\n* You have installed an ESM dependency but your own code compiles to CommonJS.\n * Solution: configure your project to compile and execute as native ESM. [Docs](#native-ecmascript-modules)\n * Solution: downgrade the dependency to an older, CommonJS version.\n* You have moved your project to ESM but still have a config file, such as `webpack.config.ts`, which must be executed as CommonJS \n * Solution: if supported by the relevant tool, rename your config file to `.cts`\n * Solution: Configure a module type override. [Docs](#module-type-overrides)\n* You have a mix of CommonJS and native ESM in your project\n * Solution: double-check all package.json \"type\" and tsconfig.json \"module\" configuration [Docs](#commonjs-vs-native-ecmascript-modules)\n * Solution: consider simplifying by making your project entirely CommonJS or entirely native ESM\n\n### `ERR_UNKNOWN_FILE_EXTENSION`\n\nThis error is thrown by node when a module has an unrecognized file extension, or no extension at all, and is being executed as native ESM. This can happen for a few reasons:\n\n* You are using a tool which has an extensionless binary, such as `mocha`.\n * CommonJS supports extensionless files but native ESM does not.\n * Solution: upgrade to ts-node >=[v10.6.0](https://github.com/TypeStrong/ts-node/releases/tag/v10.6.0), which implements a workaround.\n* Our ESM loader is not installed.\n * Solution: Use `ts-node-esm`, `ts-node --esm`, or add `\"ts-node\": {\"esm\": true}` to your tsconfig.json. [Docs](#native-ecmascript-modules)\n* You have moved your project to ESM but still have a config file, such as `webpack.config.ts`, which must be executed as CommonJS \n * Solution: if supported by the relevant tool, rename your config file to `.cts`\n * Solution: Configure a module type override. [Docs](#module-type-overrides)\n\n## Missing Types\n\nts-node does *not* eagerly load `files`, `include` or `exclude` by default. This is because a large majority of projects do not use all of the files in a project directory (e.g. `Gulpfile.ts`, runtime vs tests) and parsing every file for types slows startup time. Instead, ts-node starts with the script file (e.g. `ts-node index.ts`) and TypeScript resolves dependencies based on imports and references.\n\nOccasionally, this optimization leads to missing types. Fortunately, there are other ways to include them in typechecking.\n\nFor global definitions, you can use the `typeRoots` compiler option. This requires that your type definitions be structured as type packages (not loose TypeScript definition files). More details on how this works can be found in the [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types).\n\nExample `tsconfig.json`:\n\n```jsonc\n{\n \"compilerOptions\": {\n \"typeRoots\" : [\"./node_modules/@types\", \"./typings\"]\n }\n}\n```\n\nExample project structure:\n\n```text\n
\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`
\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`
\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`
\nDefault: `undefined`\n\nLimits TTL. The `number` represents milliseconds.\n\n###### opts.automaticFailover\n\nType: `boolean`
\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`
\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# has\n\n> Object.prototype.hasOwnProperty.call shortcut\n\n## Installation\n\n```sh\nnpm install --save has\n```\n\n## Usage\n\n```js\nvar has = require('has');\n\nhas({}, 'hasOwnProperty'); // false\nhas(Object.prototype, 'hasOwnProperty'); // true\n```\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# axios // adapters\n\nThe modules under `adapters/` are modules that handle dispatching a request and settling a returned `Promise` once a response is received.\n\n## Example\n\n```js\nvar settle = require('./../core/settle');\n\nmodule.exports = function myAdapter(config) {\n // At this point:\n // - config has been merged with defaults\n // - request transformers have already run\n // - request interceptors have already run\n \n // Make the request using config provided\n // Upon response settle the Promise\n\n return new Promise(function(resolve, reject) {\n \n var response = {\n data: responseData,\n status: request.status,\n statusText: request.statusText,\n headers: responseHeaders,\n config: config,\n request: request\n };\n\n settle(resolve, reject, response);\n\n // From here:\n // - response transformers will run\n // - response interceptors will run\n });\n}\n```\n# MD5\n\n[](http://travis-ci.org/pvorb/node-md5) [](http://npm-stat.com/charts.html?package=md5)\n\na JavaScript function for hashing messages with MD5.\n\nnode-md5 is being sponsored by the following tool; please help to support us by taking a look and signing up to a free trial \n
\n\n## Installation\n\nYou can use this package on the server side as well as the client side.\n\n### [Node.js](http://nodejs.org/):\n\n~~~\nnpm install md5\n~~~\n\n## API\n\n~~~ javascript\nmd5(message)\n~~~\n\n * `message` -- `String`, `Buffer`, `Array` or `Uint8Array`\n * returns `String`\n\n## Usage\n\n~~~ javascript\nvar md5 = require('md5');\n\nconsole.log(md5('message'));\n~~~\n\nThis will print the following\n\n~~~\n78e731027d8fd50ed642340b7c9a63b3\n~~~\n\nIt supports buffers, too\n\n~~~ javascript\nvar fs = require('fs');\nvar md5 = require('md5');\n\nfs.readFile('example.txt', function(err, buf) {\n console.log(md5(buf));\n});\n~~~\n\n## Versions\n\nBefore version 2.0.0 there were two packages called md5 on npm, one lowercase,\none uppercase (the one you're looking at). As of version 2.0.0, all new versions\nof this module will go to lowercase [md5](https://www.npmjs.com/package/md5) on\nnpm. To use the correct version, users of this module will have to change their\ncode from `require('MD5')` to `require('md5')` if they want to use versions >=\n2.0.0.\n\n## Bugs and Issues\n\nIf you encounter any bugs or issues, feel free to open an issue at\n[github](https://github.com/pvorb/node-md5/issues).\n\n## Credits\n\nThis package is based on the work of Jeff Mott, who did a pure JS implementation\nof the MD5 algorithm that was published by Ronald L. Rivest in 1991. I needed a\nnpm package of the algorithm, so I used Jeff’s implementation for this package.\nThe original implementation can be found in the\n[CryptoJS](http://code.google.com/p/crypto-js/) project.\n\n## License\n\n~~~\nCopyright © 2011-2015, Paul Vorbach.\nCopyright © 2009, Jeff Mott.\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* 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* Neither the name Crypto-JS nor the names of its contributors may be used to\n endorse or promote products derived from this software without specific prior\n written permission.\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~~~\ntcp-port-used\n=============\n\nA simple Node.js module to check if a TCP port is currently in use. It returns a\ndeferred promise from the q library.\n\n## Installation\n\n npm install tcp-port-used\n\n## Examples\nTo check a port's state:\n\n var tcpPortUsed = require('tcp-port-used');\n\n tcpPortUsed.check(44201, '127.0.0.1')\n .then(function(inUse) {\n console.log('Port 44201 usage: '+inUse);\n }, function(err) {\n console.error('Error on check:', err.message);\n });\n\nTo wait until a port on localhost is available:\n\n tcpPortUsed.waitUntilFree(44203, 500, 4000)\n .then(function() {\n console.log('Port 44203 is now free.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on a host is available:\n\n tcpPortUsed.waitUntilFreeOnHost(44203, 'some.host.com', 500, 4000)\n .then(function() {\n console.log('Port 44203 on some.host.com is now free.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on localhost is accepting connections:\n\n tcpPortUsed.waitUntilUsed(44204, 500, 4000)\n .then(function() {\n console.log('Port 44204 is now in use.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on a host is accepting connections:\n\n tcpPortUsed.waitUntilUsedOnHost(44204, 'some.host.com', 500, 4000)\n .then(function() {\n console.log('Port 44204 on some.host.com is now in use.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\nTo wait until a port on a host is in specific state:\n\n var inUse = true; // wait until the port is in use\n tcpPortUsed.waitForStatus(44204, 'some.host.com', inUse, 500, 4000)\n .then(function() {\n console.log('Port 44204 on some.host.com is now in use.');\n }, function(err) {\n console.log('Error:', err.message);\n });\n\n## API\n\n### check(port [, host])\nChecks if a TCP port is in use by attempting to connect to the port on host.\nIf no host is specified, the module uses '127.0.0.1' (localhost). When the\npromise is resolved, there is a parameter `inUse`, when true means the port is\nin use and false means the port is free.\n\n**Parameters:**\n\n* **Number|Object** *port* The port you are curious to see if available. If an\n object, must contain all the parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilFree(port [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the localhost socket is\nfree. Will retry on an interval specified in retryTimeMs until the timeout. If\nnot defined the retryTime is 200 ms and the timeout is 2000 ms.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object must contain\n all the parameters as properties.\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilFreeOnHost(port [, host] [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the localhost socket is\nfree. Will retry on an interval specified in retryTimeMs until the timeout. If\nnot defined the retryTime is 200 ms and the timeout is 2000 ms. If the host is\nnot defined, the modules uses the default '127.0.0.1'.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object, must contain\n all the parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilUsed(port [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the socket is accepting\nconnections. Will retry on an interval specified in retryTimeMs until the\ntimeout. If the host is not defined the retryTime is 200 ms and the timeout is\n2000 ms.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object, must contain\n all the parameters as properties.\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitUntilUsedOnHost(port [, host] [, retryTimeMs] [, timeOutMs])\nReturns a deferred promise and fulfills it only when the socket is accepting\nconnections. Will retry on an interval specified in retryTimeMs until the\ntimeout. If not defined the retryTime is 200 ms and the timeout is 2000 ms.\nIf the host is not defined the module uses the default '127.0.0.1'.\n\n**Parameters:**\n\n* **Number|Object** *port* a valid TCP port number. If an object, must contain\n all the parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n### waitForStatus(port, host, status [, retryTimeMs] [, timeOutMs])\nWaits until the port on host matches the boolean status in terms of use. If the\nstatus is true, the promise defers until the port is in use. If the status is\nfalse the promise defers until the port is free. If the host is undefined or\nnull, the module uses the default '127.0.0.1'. Also, if not defined the\nretryTime is 200 ms and the timeout is 2000 ms.\n\n**Parameters:**\n\n* **Number** *port* a valid TCP port number. If an object, must contain all the\n parameters as properties.\n* **String** *host* The host name or IP address of the host. Default, if not defined: '127.0.0.1'\n* **Boolean** *status* A boolean describing the condition to wait for in terms of \"in use.\" True indicates wait until the port is in use. False indicates wait until the port is free.\n* **Number** *[retryTimeMs]* the retry interval in milliseconds - defaultis is 100ms.\n* **Number** *[timeOutMs]* the amount of time to wait until port is free. Default 300ms.\n\n**Returns:**\n\n**Object** A deferred promise from the q module.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2013 jut-io\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, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n# ncp - Asynchronous recursive file & directory copying\n\n[](http://travis-ci.org/AvianFlu/ncp)\n\nThink `cp -r`, but pure node, and asynchronous. `ncp` can be used both as a CLI tool and programmatically.\n\n## Command Line usage\n\nUsage is simple: `ncp [source] [dest] [--limit=concurrency limit]\n[--filter=filter] --stopOnErr`\n\nThe 'filter' is a Regular Expression - matched files will be copied.\n\nThe 'concurrency limit' is an integer that represents how many pending file system requests `ncp` has at a time.\n\n'stoponerr' is a boolean flag that will tell `ncp` to stop immediately if any\nerrors arise, rather than attempting to continue while logging errors. The default behavior is to complete as many copies as possible, logging errors along the way.\n\nIf there are no errors, `ncp` will output `done.` when complete. If there are errors, the error messages will be logged to `stdout` and to `./ncp-debug.log`, and the copy operation will attempt to continue.\n\n## Programmatic usage\n\nProgrammatic usage of `ncp` is just as simple. The only argument to the completion callback is a possible error. \n\n```javascript\nvar ncp = require('ncp').ncp;\n\nncp.limit = 16;\n\nncp(source, destination, function (err) {\n if (err) {\n return console.error(err);\n }\n console.log('done!');\n});\n```\n\nYou can also call ncp like `ncp(source, destination, options, callback)`. \n`options` should be a dictionary. Currently, such options are available:\n\n * `options.filter` - a `RegExp` instance, against which each file name is\n tested to determine whether to copy it or not, or a function taking single\n parameter: copied file name, returning `true` or `false`, determining\n whether to copy file or not.\n\n * `options.transform` - a function: `function (read, write) { read.pipe(write) }`\n used to apply streaming transforms while copying.\n\n * `options.clobber` - boolean=true. if set to false, `ncp` will not overwrite \n destination files that already exist.\n\n * `options.dereference` - boolean=false. If set to true, `ncp` will follow symbolic\n links. For example, a symlink in the source tree pointing to a regular file\n will become a regular file in the destination tree. Broken symlinks will result in\n errors.\n\n * `options.stopOnErr` - boolean=false. If set to true, `ncp` will behave like `cp -r`,\n and stop on the first error it encounters. By default, `ncp` continues copying, logging all\n errors and returning an array.\n\n * `options.errs` - stream. If `options.stopOnErr` is `false`, a stream can be provided, and errors will be written to this stream.\n\nPlease open an issue if any bugs arise. As always, I accept (working) pull requests, and refunds are available at `/dev/null`.\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\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\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: 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# libusb\n\n[](https://travis-ci.org/libusb/libusb)\n[](https://ci.appveyor.com/project/LudovicRousseau/libusb)\n[](https://scan.coverity.com/projects/libusb-libusb)\n\nlibusb is a library for USB device access from Linux, macOS,\nWindows, OpenBSD/NetBSD and Haiku userspace.\nIt is written in C (Haiku backend in C++) and licensed under the GNU\nLesser General Public License version 2.1 or, at your option, any later\nversion (see [COPYING](COPYING)).\n\nlibusb is abstracted internally in such a way that it can hopefully\nbe ported to other operating systems. Please see the [PORTING](PORTING)\nfile for more information.\n\nlibusb homepage:\nhttp://libusb.info/\n\nDevelopers will wish to consult the API documentation:\nhttp://api.libusb.info\n\nUse the mailing list for questions, comments, etc:\nhttp://mailing-list.libusb.info\n\n- Hans de Goede \n\n\n\n\nAbstract\n--------\n\nThis is a pure JavaScript and dependency-free library for the generation\nof DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122 compliant Universally\nUnique Identifier (UUID). It supports DCE 1.1 variant UUIDs of version\n1 (time and node based), version 3 (name based, MD5), version 4 (random\nnumber based) and version 5 (name based, SHA-1). It can be used in both\n[Node.js](http://nodejs.org/) based server and browser based client\nenvironments.\n\nThe essential points of this implementation (in contrast to the many\nothers) are: First, although internally 32/64 bit unsigned integer\narithmentic and MD5/SHA-1 digest algorithmic is required, this UUID\nimplementation is fully self-contained and dependency-free. Second,\nthis implementation wraps around either `Uint8Array`, `Buffer` or\n`Array` standard classes and this way tries to represent UUIDs as best\nas possible in the particular environment. Third, thanks to a Universal\nModule Definition (UMD) wrapper, this library works out-of-the-box in\nall important JavaScript run-time environments.\n\nWhat is a UUID?\n---------------\n\nUUIDs are 128 bit numbers which are intended to have a high likelihood\nof uniqueness over space and time and are computationally difficult to\nguess. They are globally unique identifiers which can be locally\ngenerated without contacting a global registration authority. UUIDs are\nintended as unique identifiers for both mass tagging objects with an\nextremely short lifetime and to reliably identifying very persistent\nobjects across a network.\n\n### UUID Binary Representation\n\nAccording to the DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122\nstandards, a DCE 1.1 variant UUID is a 128 bit number defined out of 7\nfields, each field a multiple of an octet in size and stored in network\nbyte order:\n\n```txt\n [4]\n version\n -->| |<--\n | |\n | | [16]\n [32] [16] | |time_hi\n time_low time_mid | _and_version\n |<---------------------------->||<------------>||<------------>|\n | MSB || || | |\n | / || || | |\n |/ || || | |\n\n +------++------++------++------++------++------++------++------+~~\n | 15 || 14 || 13 || 12 || 11 || 10 |####9 || 8 |\n | MSO || || || || || |#### || |\n +------++------++------++------++------++------++------++------+~~\n 7654321076543210765432107654321076543210765432107654321076543210\n\n ~~+------++------++------++------++------++------++------++------+\n ##* 7 || 6 || 5 || 4 || 3 || 2 || 1 || 0 |\n ##* || || || || || || || LSO |\n ~~+------++------++------++------++------++------++------++------+\n 7654321076543210765432107654321076543210765432107654321076543210\n\n | | || || /|\n | | || || / |\n | | || || LSB |\n |<---->||<---->||<-------------------------------------------->|\n |clk_seq clk_seq node\n |_hi_res _low [48]\n |[5-6] [8]\n | |\n -->| |<--\n variant\n [2-3]\n```\n\nAn example of a UUID binary representation is the octet stream 0xF8\n0x1D 0x4F 0xAE 0x7D 0xEC 0x11 0xD0 0xA7 0x65 0x00 0xA0 0xC9 0x1E 0x6B\n0xF6.\n\n### UUID ASCII String Representation\n\nAccording to the DCE 1.1, ISO/IEC 11578:1996 and IETF RFC-4122\nstandards, a DCE 1.1 variant UUID is represented as an ASCII string\nconsisting of 8 hexadecimal digits followed by a hyphen, then three\ngroups of 4 hexadecimal digits each followed by a hyphen, then 12\nhexadecimal digits.\n\nGetting Pure-UUID\n-----------------\n\n```\n$ npm install pure-uuid\n```\n\nUsing Pure-UUID\n---------------\n\n- global environment:\n\n```js\nvar uuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n```\n\n- CommonJS environment:\n\n```js\nvar UUID = require(\"pure-uuid\");\nvar uuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n```\n\n- AMD environment:\n\n```js\ndefine([\"pure-uuid\"], function (UUID) {\n var uuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n});\n```\n\nAPI\n---\n\n```ts\ninterface UUID {\n /* making */\n make(version: number, ...params: any[]): UUID;\n\n /* parsing */\n parse(str: string): UUID;\n\n /* formatting */\n format(type?: string): string;\n\n /* formatting (alias) */\n toString(type?: string): string;\n\n /* sensible JSON serialization */\n toJSON(): string;\n\n /* importing */\n import(arr: number[]): UUID;\n\n /* exporting */\n export(): number[];\n\n /* byte-wise comparison */\n compare(other: UUID): boolean;\n\n /* equal check */\n equal(other: UUID): boolean;\n\n /* fold 1-4 times */\n fold(k: number): number[];\n}\n\nexport interface UUIDConstructor {\n /* default construction */\n new(): UUID;\n\n /* parsing construction */\n new(uuid: string): UUID;\n\n /* making construction */\n new(version: number): UUID;\n new(version: number, ns: string, data: string): UUID;\n}\n\ndeclare var UUID: UUIDConstructor;\nexport default UUID;\n```\n\nExamples\n--------\n\n```js\n// load a UUID\nuuid = new UUID(\"0a300ee9-f9e4-5697-a51a-efc7fafaba67\");\n\n// make a UUID version 1 (time and node based)\nuuid = new UUID(1);\n\n// make a UUID version 3 (name-based, MD5)\nuuid = new UUID(3, \"ns:URL\", \"http://example.com/\");\n\n// make a UUID version 4 (random number based)\nuuid = new UUID(4);\n\n// make a UUID version 5 (name-based, SHA-1)\nuuid = new UUID(5, \"ns:URL\", \"http://example.com/\");\n\n// format a UUID in standard format\nstr = uuid.format()\nstr = uuid.format(\"std\")\n\n// format a UUID in Base16 format\nstr = uuid.format(\"b16\")\n\n// format a UUID in ZeroMQ-Base85 format\nstr = uuid.format(\"z85\")\n```\n\nLicense\n-------\n\nCopyright (c) 2004-2021 Dr. Ralf S. Engelschall (http://engelschall.com/)\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 included\nin 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 \n \n \n