mrs-toolbox-cli 8.1.10-3a3a1e1 → 8.1.10-8dea2f1

package/npm-cache/_cacache/content-v2/sha512/{b6/2c/043132d5ab36ba788c87228b26623ecacdf8db43e7b0aef8b47a8c6e113b5de865be22c64d0c4d39a085a5741791086131332b0b083d44f6fb758051d613 → 11/64/0e967b3a6505dcc81eee650bcf063a3b83d3e0652bb42225f49ce3672724bc7822278898106068c00d4a6b7d3a5e413d89c5758ab24d8321cd8826f511d9}

@@ -28825,12 +28825,232 @@
       },
       "_hasShrinkwrap": false,
       "contributors": []
+    },
+    "3.957.0": {
+      "name": "@aws-sdk/credential-provider-web-identity",
+      "version": "3.957.0",
+      "description": "AWS credential provider that calls STS assumeRole for temporary AWS credentials",
+      "main": "./dist-cjs/index.js",
+      "module": "./dist-es/index.js",
+      "scripts": {
+        "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
+        "build:cjs": "node ../../scripts/compilation/inline credential-provider-web-identity",
+        "build:es": "tsc -p tsconfig.es.json",
+        "build:include:deps": "yarn g:turbo run build -F=\"$npm_package_name\"",
+        "build:types": "tsc -p tsconfig.types.json",
+        "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
+        "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+        "test": "yarn g:vitest run",
+        "test:watch": "yarn g:vitest watch"
+      },
+      "browser": {
+        "./dist-cjs/fromTokenFile": false,
+        "./dist-es/fromTokenFile": false
+      },
+      "react-native": {
+        "./dist-es/fromTokenFile": false,
+        "./dist-cjs/fromTokenFile": false
+      },
+      "keywords": [
+        "aws",
+        "credentials"
+      ],
+      "sideEffects": false,
+      "author": {
+        "name": "AWS SDK for JavaScript Team",
+        "url": "https://aws.amazon.com/javascript/"
+      },
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@aws-sdk/core": "3.957.0",
+        "@aws-sdk/nested-clients": "3.957.0",
+        "@aws-sdk/types": "3.957.0",
+        "@smithy/property-provider": "^4.2.7",
+        "@smithy/shared-ini-file-loader": "^4.4.2",
+        "@smithy/types": "^4.11.0",
+        "tslib": "^2.6.2"
+      },
+      "devDependencies": {
+        "@tsconfig/recommended": "1.0.1",
+        "@types/node": "^18.19.69",
+        "concurrently": "7.0.0",
+        "downlevel-dts": "0.10.1",
+        "rimraf": "3.0.2",
+        "typescript": "~5.8.3"
+      },
+      "types": "./dist-types/index.d.ts",
+      "engines": {
+        "node": ">=18.0.0"
+      },
+      "typesVersions": {
+        "<4.0": {
+          "dist-types/*": [
+            "dist-types/ts3.4/*"
+          ]
+        }
+      },
+      "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/credential-provider-web-identity",
+      "repository": {
+        "type": "git",
+        "url": "git+https://github.com/aws/aws-sdk-js-v3.git",
+        "directory": "packages/credential-provider-web-identity"
+      },
+      "_id": "@aws-sdk/credential-provider-web-identity@3.957.0",
+      "bugs": {
+        "url": "https://github.com/aws/aws-sdk-js-v3/issues"
+      },
+      "_nodeVersion": "20.19.5",
+      "_npmVersion": "11.6.2",
+      "dist": {
+        "integrity": "sha512-x17xMeD7c+rKEsWachGIMifACqkugskrETWz18QDWismFcrmUuOcZu5rUa8s9y1pnITLKUQ1xU/qDLPH52jLlA==",
+        "shasum": "fe8a7e3f475277df3f3e14797fe2c9872fbeba36",
+        "tarball": "https://verdaccio.mrsdev.ru/@aws-sdk%2fcredential-provider-web-identity/-/credential-provider-web-identity-3.957.0.tgz",
+        "fileCount": 15,
+        "unpackedSize": 33012,
+        "signatures": [
+          {
+            "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U",
+            "sig": "MEYCIQCMTKRJf4il+2oB6eNst9IOr0e+Q7hulcha0AbPCB8g+QIhAJOYtzZP645mYG5YOC57PTOQ3pQTzansMYqgEP5Fx9G0"
+          }
+        ]
+      },
+      "_npmUser": {
+        "name": "aws-sdk-bot",
+        "email": "aws-sdk-js-automation@amazon.com"
+      },
+      "directories": {},
+      "maintainers": [
+        {
+          "name": "amzn-oss",
+          "email": "osa-3p@amazon.com"
+        },
+        {
+          "name": "aws-sdk-bot",
+          "email": "aws-sdk-js-automation@amazon.com"
+        }
+      ],
+      "_npmOperationalInternal": {
+        "host": "s3://npm-registry-packages-npm-production",
+        "tmp": "tmp/credential-provider-web-identity_3.957.0_1766434073415_0.6878292569904967"
+      },
+      "_hasShrinkwrap": false,
+      "contributors": []
+    },
+    "3.958.0": {
+      "name": "@aws-sdk/credential-provider-web-identity",
+      "version": "3.958.0",
+      "description": "AWS credential provider that calls STS assumeRole for temporary AWS credentials",
+      "main": "./dist-cjs/index.js",
+      "module": "./dist-es/index.js",
+      "scripts": {
+        "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
+        "build:cjs": "node ../../scripts/compilation/inline credential-provider-web-identity",
+        "build:es": "tsc -p tsconfig.es.json",
+        "build:include:deps": "yarn g:turbo run build -F=\"$npm_package_name\"",
+        "build:types": "tsc -p tsconfig.types.json",
+        "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
+        "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+        "test": "yarn g:vitest run",
+        "test:watch": "yarn g:vitest watch"
+      },
+      "browser": {
+        "./dist-cjs/fromTokenFile": false,
+        "./dist-es/fromTokenFile": false
+      },
+      "react-native": {
+        "./dist-es/fromTokenFile": false,
+        "./dist-cjs/fromTokenFile": false
+      },
+      "keywords": [
+        "aws",
+        "credentials"
+      ],
+      "sideEffects": false,
+      "author": {
+        "name": "AWS SDK for JavaScript Team",
+        "url": "https://aws.amazon.com/javascript/"
+      },
+      "license": "Apache-2.0",
+      "dependencies": {
+        "@aws-sdk/core": "3.957.0",
+        "@aws-sdk/nested-clients": "3.958.0",
+        "@aws-sdk/types": "3.957.0",
+        "@smithy/property-provider": "^4.2.7",
+        "@smithy/shared-ini-file-loader": "^4.4.2",
+        "@smithy/types": "^4.11.0",
+        "tslib": "^2.6.2"
+      },
+      "devDependencies": {
+        "@tsconfig/recommended": "1.0.1",
+        "@types/node": "^18.19.69",
+        "concurrently": "7.0.0",
+        "downlevel-dts": "0.10.1",
+        "rimraf": "3.0.2",
+        "typescript": "~5.8.3"
+      },
+      "types": "./dist-types/index.d.ts",
+      "engines": {
+        "node": ">=18.0.0"
+      },
+      "typesVersions": {
+        "<4.0": {
+          "dist-types/*": [
+            "dist-types/ts3.4/*"
+          ]
+        }
+      },
+      "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/credential-provider-web-identity",
+      "repository": {
+        "type": "git",
+        "url": "git+https://github.com/aws/aws-sdk-js-v3.git",
+        "directory": "packages/credential-provider-web-identity"
+      },
+      "_id": "@aws-sdk/credential-provider-web-identity@3.958.0",
+      "bugs": {
+        "url": "https://github.com/aws/aws-sdk-js-v3/issues"
+      },
+      "_nodeVersion": "20.19.5",
+      "_npmVersion": "11.6.2",
+      "dist": {
+        "integrity": "sha512-dgnvwjMq5Y66WozzUzxNkCFap+umHUtqMMKlr8z/vl9NYMLem/WUbWNpFFOVFWquXikc+ewtpBMR4KEDXfZ+KA==",
+        "shasum": "98f044d8f8a9f08f96f8f66402bbce2e62120b4a",
+        "tarball": "https://verdaccio.mrsdev.ru/@aws-sdk%2fcredential-provider-web-identity/-/credential-provider-web-identity-3.958.0.tgz",
+        "fileCount": 15,
+        "unpackedSize": 33012,
+        "signatures": [
+          {
+            "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U",
+            "sig": "MEUCIFjz9xFTXtdgm1sVgjISFT4LsNtOsnFy7ixCs8NiUD14AiEA5PrR0cH/I0dCSKzGUoIbSQijqEqYCuNsBbtUc+9hR64="
+          }
+        ]
+      },
+      "_npmUser": {
+        "name": "aws-sdk-bot",
+        "email": "aws-sdk-js-automation@amazon.com"
+      },
+      "directories": {},
+      "maintainers": [
+        {
+          "name": "amzn-oss",
+          "email": "osa-3p@amazon.com"
+        },
+        {
+          "name": "aws-sdk-bot",
+          "email": "aws-sdk-js-automation@amazon.com"
+        }
+      ],
+      "_npmOperationalInternal": {
+        "host": "s3://npm-registry-packages-npm-production",
+        "tmp": "tmp/credential-provider-web-identity_3.958.0_1766520740014_0.6131768158384894"
+      },
+      "_hasShrinkwrap": false,
+      "contributors": []
     }
   },
   "time": {
     "created": "2021-03-27T00:21:53.642Z",
     "3.10.0": "2021-03-27T00:21:53.930Z",
-    "modified": "2025-12-19T20:03:00.048Z",
+    "modified": "2025-12-23T20:12:20.378Z",
     "3.11.0": "2021-04-01T23:21:52.589Z",
     "3.12.0": "2021-04-09T23:23:48.140Z",
     "3.13.1": "2021-04-22T21:43:04.050Z",
@@ -29079,13 +29299,15 @@
     "3.953.0": "2025-12-16T20:53:20.904Z",
     "3.954.0": "2025-12-17T20:27:34.715Z",
     "3.955.0": "2025-12-18T19:58:57.698Z",
-    "3.956.0": "2025-12-19T20:02:59.838Z"
+    "3.956.0": "2025-12-19T20:02:59.838Z",
+    "3.957.0": "2025-12-22T20:07:53.541Z",
+    "3.958.0": "2025-12-23T20:12:20.156Z"
   },
   "users": {},
   "dist-tags": {
-    "latest": "3.956.0"
+    "latest": "3.958.0"
   },
-  "_rev": "274-03767f6ef0326965",
+  "_rev": "280-d8e33352bf476197",
   "_id": "@aws-sdk/credential-provider-web-identity",
   "readme": "# @aws-sdk/credential-provider-web-identity\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-web-identity/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-web-identity)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-web-identity.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-web-identity)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly. Please use [@aws-sdk/credential-providers](https://www.npmjs.com/package/@aws-sdk/credential-providers)\ninstead.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{5a/cd/a8690ec010d44cfd4fbb8a85eb1892b3b5b24060b12f8e120a268bb217c42039c505ca80362f7d6f039e2ee7da17cf58e296e49db69e5b84f859013a1b0f → 12/32/a9a211d7fec0a9b05ea99d2f57dd95f3749acf44d05ff54fcc49e392e6fd63ea8513429e194263cf08e05e356fa3848001831fc0e7d9c037798e0b1e4c08}

@@ -14043,7 +14043,7 @@
   "dist-tags": {
     "latest": "3.20.0"
   },
-  "_rev": "169-4173c6d8c13c18aa",
+  "_rev": "175-72d918104e078408",
   "_id": "@smithy/core",
   "readme": "# @smithy/core\n\n[![NPM version](https://img.shields.io/npm/v/@smithy/core/latest.svg)](https://www.npmjs.com/package/@smithy/core)\n[![NPM downloads](https://img.shields.io/npm/dm/@smithy/core.svg)](https://www.npmjs.com/package/@smithy/core)\n\n> An internal package. You probably shouldn't use this package, at least directly.\n\nThis package provides common or core functionality for generic Smithy clients.\n\nYou do not need to explicitly install this package, since it will be installed during code generation if used.\n\n## Development of `@smithy/core` submodules\n\nCore submodules are organized for distribution via the `package.json` `exports` field.\n\n`exports` is supported by default by the latest Node.js, webpack, and esbuild. For react-native, it can be\nenabled via instructions found at [reactnative.dev/blog](https://reactnative.dev/blog/2023/06/21/package-exports-support), but we also provide a compatibility redirect.\n\nThink of `@smithy/core` as a mono-package within the monorepo.\nIt preserves the benefits of modularization, for example to optimize Node.js initialization speed,\nwhile making it easier to have a consistent version of core dependencies, reducing package sprawl when\ninstalling a Smithy runtime client.\n\n### Guide for submodules\n\n- Each `index.ts` file corresponding to the pattern `./src/submodules/<MODULE_NAME>/index.ts` will be\n  published as a separate `dist-cjs` bundled submodule index using the `Inliner.js` build script.\n- create a folder as `./src/submodules/<SUBMODULE>` including an `index.ts` file and a `README.md` file.\n  - The linter will throw an error on missing submodule metadata in `package.json` and the various `tsconfig.json` files, but it will automatically fix them if possible.\n- a submodule is equivalent to a standalone `@smithy/<pkg>` package in that importing it in Node.js will resolve a separate bundle.\n- submodules may not relatively import files from other submodules. Instead, directly use the `@scope/pkg/submodule` name as the import.\n  - The linter will check for this and throw an error.\n- To the extent possible, correctly declaring submodule metadata is validated by the linter in `@smithy/core`.\n  The linter runs during `yarn build` and also as `yarn lint`.\n\n### When should I create an `@smithy/core/submodule` vs. `@smithy/new-package`?\n\nKeep in mind that the core package is installed by all downstream clients.\n\nIf the component functionality is upstream of multiple clients, it is\na good candidate for a core submodule. For example, if `middleware-retry` had been written\nafter the support for submodules was added, it would have been a submodule.\n\nIf the component's functionality is downstream of a client (rare), or only expected to be used by a very small\nsubset of clients, it could be written as a standalone package.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{35/be/3a7269ca7ae6379e4a2db09d94aaa2efc24935fc9bdaa9aa7c8c4278187ef8653ebb665936c5651cf106595906b8510f2b1ef3339e6a438a990bd28b5b0a → 15/3e/7411187eedb94f2891bc22c149b0bc9bc1a6caf0e7cebc38407df190170f5ef0f8486f096e335e4928c30c86117ffa1d4b78561928bf797f270a95bdbcbf}

@@ -2670,7 +2670,7 @@
     "latest": "6.0.2",
     "next": "5.0.0-beta.0"
   },
-  "_rev": "723-fe0f7e2e6ba3c80c",
+  "_rev": "751-60a57830cad56dd6",
   "_id": "event-target-shim",
   "readme": "# event-target-shim\n\n[![npm version](https://img.shields.io/npm/v/event-target-shim.svg)](https://www.npmjs.com/package/event-target-shim)\n[![Downloads/month](https://img.shields.io/npm/dm/event-target-shim.svg)](http://www.npmtrends.com/event-target-shim)\n[![Build Status](https://github.com/mysticatea/event-target-shim/workflows/CI/badge.svg)](https://github.com/mysticatea/event-target-shim/actions)\n[![Coverage Status](https://codecov.io/gh/mysticatea/event-target-shim/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/event-target-shim)\n[![Dependency Status](https://david-dm.org/mysticatea/event-target-shim.svg)](https://david-dm.org/mysticatea/event-target-shim)\n\nAn implementation of [WHATWG `EventTarget` interface](https://dom.spec.whatwg.org/#interface-eventtarget) and [WHATWG `Event` interface](https://dom.spec.whatwg.org/#interface-event). This implementation supports constructor, `passive`, `once`, and `signal`.\n\nThis implementation is designed ...\n\n- Working fine on both browsers and Node.js.\n- TypeScript friendly.\n\n## 💿 Installation\n\nUse [npm](https://www.npmjs.com/) or a compatible tool.\n\n```\nnpm install event-target-shim\n```\n\n## 📖 Getting started\n\n```js\nimport { EventTarget, Event } from \"event-target-shim\";\n\n// constructor (was added to the standard on 8 Jul 2017)\nconst myNode = new EventTarget();\n\n// passive flag (was added to the standard on 6 Jan 2016)\nmyNode.addEventListener(\n  \"hello\",\n  (e) => {\n    e.preventDefault(); // ignored and print warning on console.\n  },\n  { passive: true }\n);\n\n// once flag (was added to the standard on 15 Apr 2016)\nmyNode.addEventListener(\"hello\", listener, { once: true });\nmyNode.dispatchEvent(new Event(\"hello\")); // remove the listener after call.\n\n// signal (was added to the standard on 4 Dec 2020)\nconst ac = new AbortController();\nmyNode.addEventListener(\"hello\", listener, { signal: ac.signal });\nac.abort(); // remove the listener.\n```\n\n- For browsers, use a bundler such as [Webpack](https://webpack.js.org/) to bundle.\n  - If you want to support IE11, use `import {} from \"event-target-shim/es5\"` instead. It's a transpiled code by babel. It depends on `@baebl/runtime` (`^7.12.0`) package.\n- The `AbortController` class was added to the standard on 14 Jul 2017. If you want the shim of that, use [abort-controller](https://www.npmjs.com/package/abort-controller) package.\n\n## 📚 API Reference\n\nSee [docs/reference.md](docs/reference.md).\n\n## 💥 Migrating to v6\n\nSee [docs/migrating-to-v6.md](docs/migrating-to-v6.md).\n\n## 📰 Changelog\n\nSee [GitHub releases](https://github.com/mysticatea/event-target-shim/releases).\n\n## 🍻 Contributing\n\nContributing is welcome ❤️\n\nPlease use GitHub issues/PRs.\n\n### Development tools\n\n- `npm install` installs dependencies for development.\n- `npm test` runs tests and measures code coverage.\n- `npm run watch:mocha` runs tests on each file change.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{9d/69/0eda916ea2f71197c90132c7561f58ef584cd43bf24a4c9e6517d530c72724394a0eadb7737823bdd2a6fd333389faf728847516e240f99abafb6aa40e91 → 15/99/e5b65c7d7776094a9f5970981ad438dd80b00f8a8e461154c222d74b4b6fc45f7e05b0aad19597660e3610441c9df2cfe28ead7e331a5840e279fa8c0974}

@@ -1238,7 +1238,7 @@
   "dist-tags": {
     "latest": "4.2.0"
   },
-  "_rev": "154-ff700378ecddd9cd",
+  "_rev": "160-e33a2cb5589ae1b6",
   "_id": "@smithy/util-buffer-from",
   "readme": "# @smithy/util-buffer-from\n\n[![NPM version](https://img.shields.io/npm/v/@smithy/util-buffer-from/latest.svg)](https://www.npmjs.com/package/@smithy/util-buffer-from)\n[![NPM downloads](https://img.shields.io/npm/dm/@smithy/util-buffer-from.svg)](https://www.npmjs.com/package/@smithy/util-buffer-from)\n\n> An internal package\n\n## Usage\n\nYou probably shouldn't, at least directly.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{92/7b/403bb1a224224e4bec0c4790a59d217ea67c37aa68386fe4ff6a4643c0a60d66c8e364d0d410205ac81a8205f6a612631b12af2b6cf61816eefc08e929f2 → 15/e3/ac223fee1c21eff862a2060a7978e8fda17ecf022584b6de8fe85a6ba2eaed8d58d385b8b4fe17ca57cfa340cf866f0fe0197cbf7b78b08118ac9644f357}

@@ -378,7 +378,7 @@
   "dist-tags": {
     "latest": "1.1.2"
   },
-  "_rev": "3020-f587b6301e1d4c04",
+  "_rev": "3097-4c4fff57933c7b49",
   "_id": "buffer-from",
   "readme": "# Buffer From\n\nA [ponyfill](https://ponyfill.com) for `Buffer.from`, uses native implementation if available.\n\n## Installation\n\n```sh\nnpm install --save buffer-from\n```\n\n## Usage\n\n```js\nconst bufferFrom = require('buffer-from')\n\nconsole.log(bufferFrom([1, 2, 3, 4]))\n//=> <Buffer 01 02 03 04>\n\nconst arr = new Uint8Array([1, 2, 3, 4])\nconsole.log(bufferFrom(arr.buffer, 1, 2))\n//=> <Buffer 02 03>\n\nconsole.log(bufferFrom('test', 'utf8'))\n//=> <Buffer 74 65 73 74>\n\nconst buf = bufferFrom('test')\nconsole.log(bufferFrom(buf))\n//=> <Buffer 74 65 73 74>\n```\n\n## API\n\n### bufferFrom(array)\n\n- `array` &lt;Array&gt;\n\nAllocates a new `Buffer` using an `array` of octets.\n\n### bufferFrom(arrayBuffer[, byteOffset[, length]])\n\n- `arrayBuffer` &lt;ArrayBuffer&gt; The `.buffer` property of a TypedArray or ArrayBuffer\n- `byteOffset` &lt;Integer&gt; Where to start copying from `arrayBuffer`. **Default:** `0`\n- `length` &lt;Integer&gt; How many bytes to copy from `arrayBuffer`. **Default:** `arrayBuffer.length - byteOffset`\n\nWhen passed a reference to the `.buffer` property of a TypedArray instance, the\nnewly created `Buffer` will share the same allocated memory as the TypedArray.\n\nThe optional `byteOffset` and `length` arguments specify a memory range within\nthe `arrayBuffer` that will be shared by the `Buffer`.\n\n### bufferFrom(buffer)\n\n- `buffer` &lt;Buffer&gt; An existing `Buffer` to copy data from\n\nCopies the passed `buffer` data onto a new `Buffer` instance.\n\n### bufferFrom(string[, encoding])\n\n- `string` &lt;String&gt; A string to encode.\n- `encoding` &lt;String&gt; The encoding of `string`. **Default:** `'utf8'`\n\nCreates a new `Buffer` containing the given JavaScript string `string`. If\nprovided, the `encoding` parameter identifies the character encoding of\n`string`.\n\n## See also\n\n- [buffer-alloc](https://github.com/LinusU/buffer-alloc) A ponyfill for `Buffer.alloc`\n- [buffer-alloc-unsafe](https://github.com/LinusU/buffer-alloc-unsafe) A ponyfill for `Buffer.allocUnsafe`",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{12/69/e09ac7c71d63e9bac2e5825cf0dfc3890341a3b8adc84dd68140d7fcfd71b4725e5772b33044ff20bc44f1289c40cd05066fc7f13fb2530d20d489e8866e → 15/f0/a14019e31a850572e7513dc371a5b2683f46a766f4526da8223ccced330e5163699058080fd6839aa10281d6b4fef12c65e20d17c194b268a80f08522b93}

@@ -969,7 +969,7 @@
   "dist-tags": {
     "latest": "0.11.0"
   },
-  "_rev": "773-d121bdd5252adb1b",
+  "_rev": "816-25bb3ccc93ba3af3",
   "_id": "@pkgjs/parseargs",
   "readme": "<!-- omit in toc -->\n# parseArgs\n\n[![Coverage][coverage-image]][coverage-url]\n\nPolyfill of `util.parseArgs()`\n\n## `util.parseArgs([config])`\n\n<!-- YAML\nadded: v18.3.0\nchanges:\n  - version: REPLACEME\n    pr-url: https://github.com/nodejs/node/pull/43459\n    description: add support for returning detailed parse information\n                 using `tokens` in input `config` and returned properties.\n-->\n\n> Stability: 1 - Experimental\n\n* `config` {Object} Used to provide arguments for parsing and to configure\n  the parser. `config` supports the following properties:\n  * `args` {string\\[]} array of argument strings. **Default:** `process.argv`\n    with `execPath` and `filename` removed.\n  * `options` {Object} Used to describe arguments known to the parser.\n    Keys of `options` are the long names of options and values are an\n    {Object} accepting the following properties:\n    * `type` {string} Type of argument, which must be either `boolean` or `string`.\n    * `multiple` {boolean} Whether this option can be provided multiple\n      times. If `true`, all values will be collected in an array. If\n      `false`, values for the option are last-wins. **Default:** `false`.\n    * `short` {string} A single character alias for the option.\n    * `default` {string | boolean | string\\[] | boolean\\[]} The default option\n      value when it is not set by args. It must be of the same type as the\n      the `type` property. When `multiple` is `true`, it must be an array.\n  * `strict` {boolean} Should an error be thrown when unknown arguments\n    are encountered, or when arguments are passed that do not match the\n    `type` configured in `options`.\n    **Default:** `true`.\n  * `allowPositionals` {boolean} Whether this command accepts positional\n    arguments.\n    **Default:** `false` if `strict` is `true`, otherwise `true`.\n  * `tokens` {boolean} Return the parsed tokens. This is useful for extending\n    the built-in behavior, from adding additional checks through to reprocessing\n    the tokens in different ways.\n    **Default:** `false`.\n\n* Returns: {Object} The parsed command line arguments:\n  * `values` {Object} A mapping of parsed option names with their {string}\n    or {boolean} values.\n  * `positionals` {string\\[]} Positional arguments.\n  * `tokens` {Object\\[] | undefined} See [parseArgs tokens](#parseargs-tokens)\n    section. Only returned if `config` includes `tokens: true`.\n\nProvides a higher level API for command-line argument parsing than interacting\nwith `process.argv` directly. Takes a specification for the expected arguments\nand returns a structured object with the parsed options and positionals.\n\n```mjs\nimport { parseArgs } from 'node:util';\nconst args = ['-f', '--bar', 'b'];\nconst options = {\n  foo: {\n    type: 'boolean',\n    short: 'f'\n  },\n  bar: {\n    type: 'string'\n  }\n};\nconst {\n  values,\n  positionals\n} = parseArgs({ args, options });\nconsole.log(values, positionals);\n// Prints: [Object: null prototype] { foo: true, bar: 'b' } []\n```\n\n```cjs\nconst { parseArgs } = require('node:util');\nconst args = ['-f', '--bar', 'b'];\nconst options = {\n  foo: {\n    type: 'boolean',\n    short: 'f'\n  },\n  bar: {\n    type: 'string'\n  }\n};\nconst {\n  values,\n  positionals\n} = parseArgs({ args, options });\nconsole.log(values, positionals);\n// Prints: [Object: null prototype] { foo: true, bar: 'b' } []\n```\n\n`util.parseArgs` is experimental and behavior may change. Join the\nconversation in [pkgjs/parseargs][] to contribute to the design.\n\n### `parseArgs` `tokens`\n\nDetailed parse information is available for adding custom behaviours by\nspecifying `tokens: true` in the configuration.\nThe returned tokens have properties describing:\n\n* all tokens\n  * `kind` {string} One of 'option', 'positional', or 'option-terminator'.\n  * `index` {number} Index of element in `args` containing token. So the\n    source argument for a token is `args[token.index]`.\n* option tokens\n  * `name` {string} Long name of option.\n  * `rawName` {string} How option used in args, like `-f` of `--foo`.\n  * `value` {string | undefined} Option value specified in args.\n    Undefined for boolean options.\n  * `inlineValue` {boolean | undefined} Whether option value specified inline,\n    like `--foo=bar`.\n* positional tokens\n  * `value` {string} The value of the positional argument in args (i.e. `args[index]`).\n* option-terminator token\n\nThe returned tokens are in the order encountered in the input args. Options\nthat appear more than once in args produce a token for each use. Short option\ngroups like `-xy` expand to a token for each option. So `-xxx` produces\nthree tokens.\n\nFor example to use the returned tokens to add support for a negated option\nlike `--no-color`, the tokens can be reprocessed to change the value stored\nfor the negated option.\n\n```mjs\nimport { parseArgs } from 'node:util';\n\nconst options = {\n  'color': { type: 'boolean' },\n  'no-color': { type: 'boolean' },\n  'logfile': { type: 'string' },\n  'no-logfile': { type: 'boolean' },\n};\nconst { values, tokens } = parseArgs({ options, tokens: true });\n\n// Reprocess the option tokens and overwrite the returned values.\ntokens\n  .filter((token) => token.kind === 'option')\n  .forEach((token) => {\n    if (token.name.startsWith('no-')) {\n      // Store foo:false for --no-foo\n      const positiveName = token.name.slice(3);\n      values[positiveName] = false;\n      delete values[token.name];\n    } else {\n      // Resave value so last one wins if both --foo and --no-foo.\n      values[token.name] = token.value ?? true;\n    }\n  });\n\nconst color = values.color;\nconst logfile = values.logfile ?? 'default.log';\n\nconsole.log({ logfile, color });\n```\n\n```cjs\nconst { parseArgs } = require('node:util');\n\nconst options = {\n  'color': { type: 'boolean' },\n  'no-color': { type: 'boolean' },\n  'logfile': { type: 'string' },\n  'no-logfile': { type: 'boolean' },\n};\nconst { values, tokens } = parseArgs({ options, tokens: true });\n\n// Reprocess the option tokens and overwrite the returned values.\ntokens\n  .filter((token) => token.kind === 'option')\n  .forEach((token) => {\n    if (token.name.startsWith('no-')) {\n      // Store foo:false for --no-foo\n      const positiveName = token.name.slice(3);\n      values[positiveName] = false;\n      delete values[token.name];\n    } else {\n      // Resave value so last one wins if both --foo and --no-foo.\n      values[token.name] = token.value ?? true;\n    }\n  });\n\nconst color = values.color;\nconst logfile = values.logfile ?? 'default.log';\n\nconsole.log({ logfile, color });\n```\n\nExample usage showing negated options, and when an option is used\nmultiple ways then last one wins.\n\n```console\n$ node negate.js\n{ logfile: 'default.log', color: undefined }\n$ node negate.js --no-logfile --no-color\n{ logfile: false, color: false }\n$ node negate.js --logfile=test.log --color\n{ logfile: 'test.log', color: true }\n$ node negate.js --no-logfile --logfile=test.log --color --no-color\n{ logfile: 'test.log', color: false }\n```\n\n-----\n\n<!-- omit in toc -->\n## Table of Contents\n- [`util.parseArgs([config])`](#utilparseargsconfig)\n- [Scope](#scope)\n- [Version Matchups](#version-matchups)\n- [🚀 Getting Started](#-getting-started)\n- [🙌 Contributing](#-contributing)\n- [💡 `process.mainArgs` Proposal](#-processmainargs-proposal)\n  - [Implementation:](#implementation)\n- [📃 Examples](#-examples)\n- [F.A.Qs](#faqs)\n- [Links & Resources](#links--resources)\n\n-----\n\n## Scope\n\nIt is already possible to build great arg parsing modules on top of what Node.js provides; the prickly API is abstracted away by these modules. Thus, process.parseArgs() is not necessarily intended for library authors; it is intended for developers of simple CLI tools, ad-hoc scripts, deployed Node.js applications, and learning materials.\n\nIt is exceedingly difficult to provide an API which would both be friendly to these Node.js users while being extensible enough for libraries to build upon. We chose to prioritize these use cases because these are currently not well-served by Node.js' API.\n\n----\n\n## Version Matchups\n\n| Node.js | @pkgjs/parseArgs |\n| -- | -- |\n| [v18.3.0](https://nodejs.org/docs/latest-v18.x/api/util.html#utilparseargsconfig) | [v0.9.1](https://github.com/pkgjs/parseargs/tree/v0.9.1#utilparseargsconfig) |\n| [v16.17.0](https://nodejs.org/dist/latest-v16.x/docs/api/util.html#utilparseargsconfig), [v18.7.0](https://nodejs.org/docs/latest-v18.x/api/util.html#utilparseargsconfig) | [0.10.0](https://github.com/pkgjs/parseargs/tree/v0.10.0#utilparseargsconfig) |\n\n----\n\n## 🚀 Getting Started\n\n1. **Install dependencies.**\n\n   ```bash\n   npm install\n   ```\n\n2. **Open the index.js file and start editing!**\n\n3. **Test your code by calling parseArgs through our test file**\n\n   ```bash\n   npm test\n   ```\n\n----\n\n## 🙌 Contributing\n\nAny person who wants to contribute to the initiative is welcome! Please first read the [Contributing Guide](CONTRIBUTING.md)\n\nAdditionally, reading the [`Examples w/ Output`](#-examples-w-output) section of this document will be the best way to familiarize yourself with the target expected behavior for parseArgs() once it is fully implemented.\n\nThis package was implemented using [tape](https://www.npmjs.com/package/tape) as its test harness.\n\n----\n\n## 💡 `process.mainArgs` Proposal\n\n> Note: This can be moved forward independently of the `util.parseArgs()` proposal/work.\n\n### Implementation:\n\n```javascript\nprocess.mainArgs = process.argv.slice(process._exec ? 1 : 2)\n```\n\n----\n\n## 📃 Examples\n\n```js\nconst { parseArgs } = require('@pkgjs/parseargs');\n```\n\n```js\nconst { parseArgs } = require('@pkgjs/parseargs');\n// specify the options that may be used\nconst options = {\n  foo: { type: 'string'},\n  bar: { type: 'boolean' },\n};\nconst args = ['--foo=a', '--bar'];\nconst { values, positionals } = parseArgs({ args, options });\n// values = { foo: 'a', bar: true }\n// positionals = []\n```\n\n```js\nconst { parseArgs } = require('@pkgjs/parseargs');\n// type:string & multiple\nconst options = {\n  foo: {\n    type: 'string',\n    multiple: true,\n  },\n};\nconst args = ['--foo=a', '--foo', 'b'];\nconst { values, positionals } = parseArgs({ args, options });\n// values = { foo: [ 'a', 'b' ] }\n// positionals = []\n```\n\n```js\nconst { parseArgs } = require('@pkgjs/parseargs');\n// shorts\nconst options = {\n  foo: {\n    short: 'f',\n    type: 'boolean'\n  },\n};\nconst args = ['-f', 'b'];\nconst { values, positionals } = parseArgs({ args, options, allowPositionals: true });\n// values = { foo: true }\n// positionals = ['b']\n```\n\n```js\nconst { parseArgs } = require('@pkgjs/parseargs');\n// unconfigured\nconst options = {};\nconst args = ['-f', '--foo=a', '--bar', 'b'];\nconst { values, positionals } = parseArgs({ strict: false, args, options, allowPositionals: true });\n// values = { f: true, foo: 'a', bar: true }\n// positionals = ['b']\n```\n\n----\n\n## F.A.Qs\n\n- Is `cmd --foo=bar baz` the same as `cmd baz --foo=bar`?\n  - yes\n- Does the parser execute a function?\n  - no\n- Does the parser execute one of several functions, depending on input?\n  - no\n- Can subcommands take options that are distinct from the main command?\n  - no\n- Does it output generated help when no options match?\n  - no\n- Does it generated short usage?  Like: `usage: ls [-ABCFGHLOPRSTUWabcdefghiklmnopqrstuwx1] [file ...]`\n  - no (no usage/help at all)\n- Does the user provide the long usage text?  For each option?  For the whole command?\n  - no\n- Do subcommands (if implemented) have their own usage output?\n  - no\n- Does usage print if the user runs `cmd --help`?\n  - no\n- Does it set `process.exitCode`?\n  - no\n- Does usage print to stderr or stdout?\n  - N/A\n- Does it check types?  (Say, specify that an option is a boolean, number, etc.)\n  - no\n- Can an option have more than one type?  (string or false, for example)\n  - no\n- Can the user define a type?  (Say, `type: path` to call `path.resolve()` on the argument.)\n  - no\n- Does a `--foo=0o22` mean 0, 22, 18, or \"0o22\"?\n  - `\"0o22\"`\n- Does it coerce types?\n  - no\n- Does `--no-foo` coerce to `--foo=false`?  For all options?  Only boolean options?\n  - no, it sets `{values:{'no-foo': true}}`\n- Is `--foo` the same as `--foo=true`?  Only for known booleans?  Only at the end?\n  - no, they are not the same. There is no special handling of `true` as a value so it is just another string.\n- Does it read environment variables?  Ie, is `FOO=1 cmd` the same as `cmd --foo=1`?\n  - no\n- Do unknown arguments raise an error?  Are they parsed?  Are they treated as positional arguments?\n  - no, they are parsed, not treated as positionals\n- Does `--` signal the end of options?\n  - yes\n- Is `--` included as a positional?\n  - no\n- Is `program -- foo` the same as `program foo`?\n  - yes, both store `{positionals:['foo']}`\n- Does the API specify whether a `--` was present/relevant?\n  - no\n- Is `-bar` the same as `--bar`?\n  - no, `-bar` is a short option or options, with expansion logic that follows the\n    [Utility Syntax Guidelines in POSIX.1-2017](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html). `-bar` expands to `-b`, `-a`, `-r`.\n- Is `---foo` the same as `--foo`?\n  - no\n  - the first is a long option named `'-foo'`\n  - the second is a long option named `'foo'`\n- Is `-` a positional? ie, `bash some-test.sh | tap -`\n  - yes\n\n## Links & Resources\n\n* [Initial Tooling Issue](https://github.com/nodejs/tooling/issues/19)\n* [Initial Proposal](https://github.com/nodejs/node/pull/35015)\n* [parseArgs Proposal](https://github.com/nodejs/node/pull/42675)\n\n[coverage-image]: https://img.shields.io/nycrc/pkgjs/parseargs\n[coverage-url]: https://github.com/pkgjs/parseargs/blob/main/.nycrc\n[pkgjs/parseargs]: https://github.com/pkgjs/parseargs",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{80/05/25416f92719eb4aae700cde4d1ab51ccc45f9f8507089ffaa4baa7ba317638b995d76f204b80653174b1d6facebc748f6ce3be2b5adf656fba924baddaa2 → 16/e1/14fd280154b9947bb79d8133700a41d7d9b9819ca32acf313f390db3bf6f802fcc2d7900c38555b5a0d14497cc6f885c7d18bfa97fc5126393a5241a3605}

@@ -1934,7 +1934,7 @@
   "dist-tags": {
     "latest": "2.8.2"
   },
-  "_rev": "578-32f0e54428395949",
+  "_rev": "606-e7c016df986ab40b",
   "_id": "bare-events",
   "readme": "# bare-events\n\nEvent emitters for JavaScript.\n\n```\nnpm install bare-events\n```\n\n## Usage\n\n```js\nconst EventEmitter = require('bare-events')\n\nconst e = new EventEmitter()\n\ne.on('hello', function (data) {\n  console.log(data)\n})\n\ne.emit('hello', 'world')\n```\n\n## License\n\nApache-2.0",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{0f/e0/30233058339d8569ec60f46b3701c785e402e9df1821aa4d02c4fe16bd8eb99c7092008998bbdda0239f15e4d0d489e8b3a79e0823bad597a2aba5b61fc1 → 18/ce/45e795200fc98c2901995db4201f1f06085cd5e25b489289c3d57184a99be5e864dce1a29e53cde5c89d3b76375f9073804eb1c62bef86e82dbd18aa1cae}

@@ -270,7 +270,7 @@
   "dist-tags": {
     "latest": "0.3.0"
   },
-  "_rev": "444-56dbeb6cba5a2ff1",
+  "_rev": "465-9f9093c327f9789e",
   "_id": "eastasianwidth",
   "readme": "# East Asian Width\n\nGet [East Asian Width](http://www.unicode.org/reports/tr11/) from a character.\n\n'F'(Fullwidth), 'H'(Halfwidth), 'W'(Wide), 'Na'(Narrow), 'A'(Ambiguous) or 'N'(Natural).\n\nOriginal Code is [東アジアの文字幅 (East Asian Width) の判定 - 中途](http://d.hatena.ne.jp/takenspc/20111126#1322252878).\n\n## Install\n\n    $ npm install eastasianwidth\n\n## Usage\n\n    var eaw = require('eastasianwidth');\n    console.log(eaw.eastAsianWidth('￦')) // 'F'\n    console.log(eaw.eastAsianWidth('｡')) // 'H'\n    console.log(eaw.eastAsianWidth('뀀')) // 'W'\n    console.log(eaw.eastAsianWidth('a')) // 'Na'\n    console.log(eaw.eastAsianWidth('①')) // 'A'\n    console.log(eaw.eastAsianWidth('ف')) // 'N'\n\n    console.log(eaw.characterLength('￦')) // 2\n    console.log(eaw.characterLength('｡')) // 1\n    console.log(eaw.characterLength('뀀')) // 2\n    console.log(eaw.characterLength('a')) // 1\n    console.log(eaw.characterLength('①')) // 2\n    console.log(eaw.characterLength('ف')) // 1\n\n    console.log(eaw.length('あいうえお')) // 10\n    console.log(eaw.length('abcdefg')) // 7\n    console.log(eaw.length('￠￦｡ￜㄅ뀀¢⟭a⊙①بف')) // 19",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{13/fb/acee6c281e96710b28335160c10306af9df5fbab1e89ed9470c1c50bfd9da6fc693184c78616b8082b6eb910c2eba97a33a0d2dcdeb108f31fbf4f7709e4 → 1a/96/4870e272666c51c9492765394b811e8cdba535f251a8e58721f29d22fa35f1c8abdb243c4af627d96d609d14cbe0bc5b1212bc09351168a09a85d6cc2858}

@@ -2702,7 +2702,7 @@
     "latest": "6.0.6",
     "n-api": "4.0.0-napi"
   },
-  "_rev": "295-76f372292a2138ba",
+  "_rev": "301-90a1ea3cb25bef0a",
   "_id": "utf-8-validate",
   "readme": "# utf-8-validate\n\n[![Version npm](https://img.shields.io/npm/v/utf-8-validate.svg?logo=npm)](https://www.npmjs.com/package/utf-8-validate)\n[![Linux/macOS/Windows Build](https://img.shields.io/github/actions/workflow/status/websockets/utf-8-validate/ci.yml?branch=master&label=build&logo=github)](https://github.com/websockets/utf-8-validate/actions?query=workflow%3ACI+branch%3Amaster)\n\nCheck if a buffer contains valid UTF-8 encoded text.\n\n## Installation\n\n```\nnpm install utf-8-validate --save-optional\n```\n\nThe `--save-optional` flag tells npm to save the package in your package.json\nunder the\n[`optionalDependencies`](https://docs.npmjs.com/files/package.json#optionaldependencies)\nkey.\n\n## API\n\nThe module exports a single function that takes one argument. To maximize\nperformance, the argument is not validated. It is the caller's responsibility to\nensure that it is correct.\n\n### `isValidUTF8(buffer)`\n\nChecks whether a buffer contains valid UTF-8.\n\n#### Arguments\n\n- `buffer` - The buffer to check.\n\n#### Return value\n\n`true` if the buffer contains only correct UTF-8, else `false`.\n\n#### Example\n\n```js\n'use strict';\n\nconst isValidUTF8 = require('utf-8-validate');\n\nconst buf = Buffer.from([0xf0, 0x90, 0x80, 0x80]);\n\nconsole.log(isValidUTF8(buf));\n// => true\n```\n\n## License\n\n[MIT](LICENSE)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{52/8c/98286647f5cd34d8def79718b761c6bf65768ef00f57e48106a0acb6f3bb49efd61f8c7fd7f1b9e10121b3f46228b99bdb4fbbbb38d2e127258b1cea9df9 → 1b/78/c17b863110542051a9d94a8a846a17c3d1a3df23a6b63c4b0e4a899d89efabef2dc422c703f5d4424edb808a3c06919a7f16b43a4e1ada5dbd3530258416}

@@ -1209,7 +1209,7 @@
   "dist-tags": {
     "latest": "5.2.0"
   },
-  "_rev": "276-1ca6dc38447ba2a0",
+  "_rev": "285-48b8e984ddb49108",
   "_id": "@aws-crypto/supports-web-crypto",
   "readme": "# @aws-crypto/supports-web-crypto\n\nFunctions to check web crypto support for browsers.\n\n## Usage\n\n```\nimport {supportsWebCrypto} from '@aws-crypto/supports-web-crypto';\n\nif (supportsWebCrypto(window)) {\n  // window.crypto.subtle.encrypt will exist\n}\n\n```\n\n## supportsWebCrypto\n\nUsed to make sure `window.crypto.subtle` exists and implements crypto functions\nas well as a cryptographic secure random source exists.\n\n## supportsSecureRandom\n\nUsed to make sure that a cryptographic secure random source exists.\nDoes not check for `window.crypto.subtle`.\n\n## supportsSubtleCrypto\n\n## supportsZeroByteGCM\n\n## Test\n\n`npm test`",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{87/54/16b4c9d260e97e01550a6add26e9f8cee5b8225e190101574262c8708a78bfe7a77ea45f744d6ca89995d25f2bac5db41fe1a26649c7e7788c589afc1eb3 → 1d/38/fbb5c24c2ae4c08d39f4f9497cbe51b76f1b2f219fdb445252cf7796d77cabbf0bfdeb9f89bb5a8c3b5ce6ad673ef370ef6598632250e2467b892a767e6f}

@@ -1326,7 +1326,7 @@
   "dist-tags": {
     "latest": "4.2.0"
   },
-  "_rev": "150-3dacfb6cd74d0000",
+  "_rev": "156-bf2623f4bdb43699",
   "_id": "@smithy/util-config-provider",
   "readme": "# @smithy/util-config-provider\n\n[![NPM version](https://img.shields.io/npm/v/@smithy/util-config-provider/latest.svg)](https://www.npmjs.com/package/@smithy/util-config-provider)\n[![NPM downloads](https://img.shields.io/npm/dm/@smithy/util-config-provider.svg)](https://www.npmjs.com/package/@smithy/util-config-provider)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{5f/96/2b18053c25c2aa8902be1ac84ab36145604b75fee367c23eb9a355bd59b94dea44b1d0c0c71bd0f36b85a53c0f5b6e2c9bd5daa7f575a6101b3dbe45178e → 1d/53/58e81bc8b957bffac68c79ec55f4e90c5adf8bc602c6d0c93da0f28022fa0402e3a81247094088783fe7d3e8e22301fe3d728ac9c0e1d5ffe9e57ff23d2c}

@@ -505,7 +505,7 @@
   "dist-tags": {
     "latest": "4.0.0"
   },
-  "_rev": "2966-41418a76650a7ae7",
+  "_rev": "3046-02f5da82fe8d3c92",
   "_id": "path-key",
   "readme": "# path-key\n\n> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform\n\nIt's usually `PATH` but on Windows it can be any casing like `Path`...\n\n## Install\n\n```\n$ npm install path-key\n```\n\n## Usage\n\n```js\nimport pathKey from 'path-key';\n\nconst key = pathKey();\n//=> 'PATH'\n\nconst PATH = process.env[key];\n//=> '/usr/local/bin:/usr/bin:/bin'\n```\n\n## API\n\n### pathKey(options?)\n\n#### options\n\nType: `object`\n\n##### env\n\nType: `object`\\\nDefault: [`process.env`](https://nodejs.org/api/process.html#process_process_env)\n\nUse a custom environment variables object.\n\n#### platform\n\nType: `string`\\\nDefault: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)\n\nGet the PATH key for a specific platform.\n\n---\n\n<div align=\"center\">\n\t<b>\n\t\t<a href=\"https://tidelift.com/subscription/pkg/npm-path-key?utm_source=npm-path-key&utm_medium=referral&utm_campaign=readme\">Get professional support for this package with a Tidelift subscription</a>\n\t</b>\n\t<br>\n\t<sub>\n\t\tTidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.\n\t</sub>\n</div>",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{bf/99/62b41955b12e45c8fe4127bd0e1d849580a043717f1dc7a1978ead9725af4ced6d1ea295f9726445c4398fd24a1255765ecd511aec4d281ba52c42760a36 → 1e/32/7d4fde37955b2d8142049ff2e93ecafaecc10ea1fa0bfe29d012e836c19b3148d3f6a8f209d9d33f0768deadc49645776ea8eec86951afd5719b37c422a1}

@@ -4687,7 +4687,7 @@
   "dist-tags": {
     "latest": "2.23.0"
   },
-  "_rev": "581-5da58b3ad837e895",
+  "_rev": "609-73bfba807046650e",
   "_id": "streamx",
   "readme": "# streamx\n\nAn iteration of the Node.js core streams with a series of improvements.\n\n```\nnpm install streamx\n```\n\n[![Build Status](https://github.com/streamxorg/streamx/workflows/Build%20Status/badge.svg)](https://github.com/streamxorg/streamx/actions?query=workflow%3A%22Build+Status%22)\n\n## Main improvements from Node.js core stream\n\n#### Proper lifecycle support.\n\nStreams have an `_open` function that is called before any read/write operation and a `_destroy`\nfunction that is always run as the last part of the stream.\n\nThis makes it easy to maintain state.\n\n#### Easy error handling\n\nFully integrates a `.destroy()` function. When called the stream will wait for any\npending operation to finish and call the stream destroy logic.\n\nClose is *always* the last event emitted and `destroy` is always run.\n\n#### `pipe()` error handles\n\n`pipe` accepts a callback that is called when the pipeline is fully drained.\nIt also error handles the streams provided and destroys both streams if either\nof them fail.\n\n#### All streams are both binary and object mode streams\n\nA `map` function can be provided to map your input data into buffers\nor other formats. To indicate how much buffer space each data item takes\nan `byteLength` function can be provided as well.\n\nThis removes the need for two modes of streams.\n\n#### Simplicity\n\nThis is a full rewrite, all contained in one file.\n\nLots of stream methods are simplified based on how I and devs I work with actually use streams in the wild.\n\n#### Backwards compat\n\nstreamx aims to be compatible with Node.js streams whenever it is reasonable to do so.\n\nThis means that streamx streams behave a lot like Node.js streams from the outside but still provides the\nimprovements above.\n\n#### Smaller browser footprint\n\nstreamx has a much smaller footprint when compiled for the browser:\n\n```\n$ for x in stream{,x}; do echo $x: $(browserify -r $x | wc -c) bytes; done\nstream: 173844 bytes\nstreamx: 46943 bytes\n```\n\nWith optimizations turned on, the difference is even more stark:\n\n```\n$ for x in stream{,x}; do echo $x: $(browserify -r $x -p tinyify | wc -c) bytes; done\nstream: 62649 bytes\nstreamx: 8460 bytes\n$ for x in stream{,x}; do echo $x: $(browserify -r $x -p tinyify | gzip | wc -c) \"bytes (gzipped)\"; done\nstream: 18053 bytes (gzipped)\nstreamx: 2806 bytes (gzipped)\n```\n\n#### AbortSignal support\n\nTo make it easier to integrate streams in a `async/await` flow, all streams support a `signal` option\nthat accepts a [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to as an\nalternative means to `.destroy` streams.\n\n## Usage\n\n``` js\nconst { Readable } = require('streamx')\n\nconst rs = new Readable({\n  read (cb) {\n    this.push('Cool data')\n    cb(null)\n  }\n})\n\nrs.on('data', data => console.log('data:', data))\n```\n\n## API\n\nThis streamx package contains 4 streams similar to Node.js core.\n\n## Readable Stream\n\n#### `rs = new stream.Readable([options])`\n\nCreate a new readable stream.\n\nOptions include:\n\n```\n{\n  highWaterMark: 16384, // max buffer size in bytes\n  map: (data) => data, // optional function to map input data\n  byteLength: (data) => size, // optional function that calculates the byte size of input data\n  signal: abortController.signal, // optional AbortSignal that triggers `.destroy` when on `abort`\n  eagerOpen: false // eagerly open the stream\n}\n```\n\nIn addition you can pass the `open`, `read`, and `destroy` functions as shorthands in\nthe constructor instead of overwrite the methods below.\n\nThe default byteLength function returns the byte length of buffers and `1024`\nfor any other object. This means the buffer will contain around 16 non buffers\nor buffers worth 16kb when full if the defaults are used.\n\nIf you set highWaterMark to `0` then all read ahead buffering on the stream\nis disabled and it will only call `_read` when a user reads rather than ahead of time.\n\n#### `rs._read(cb)`\n\nThis function is called when the stream wants you to push new data.\nOverwrite this and add your own read logic.\nYou should call the callback when you are fully done with the read.\n\nCan also be set using `options.read` in the constructor.\n\nNote that this function differs from Node.js streams in that it takes\nthe \"read finished\" callback.\n\n#### `drained = rs.push(data)`\n\nPush new data to the stream. Returns true if the buffer is not full\nand you should push more data if you can.\n\nIf you call `rs.push(null)` you signal to the stream that no more\ndata will be pushed and that you want to end the stream.\n\n#### `data = rs.read()`\n\nRead a piece of data from the stream buffer. If the buffer is currently empty\n`null` will be returned and you should wait for `readable` to be emitted before\ntrying again. If the stream has been ended it will also return `null`.\n\nNote that this method differs from Node.js streams in that it does not accept\nan optional amounts of bytes to consume.\n\n#### `rs.unshift(data)`\n\nAdd a piece of data to the front of the buffer. Use this if you read too much\ndata using the `rs.read()` function.\n\n#### `rs._open(cb)`\n\nThis function is called once before the first read is issued. Use this function\nto implement your own open logic.\n\nCan also be set using `options.open` in the constructor.\n\n#### `rs._destroy(cb)`\n\nThis function is called just before the stream is fully destroyed. You should\nuse this to implement whatever teardown logic you need. The final part of the\nstream life cycle is always to call destroy itself so this function will always\nbe called wheather or not the stream ends gracefully or forcefully.\n\nCan also be set using `options.destroy` in the constructor.\n\nNote that the `_destroy` might be called without the open function being called\nin case no read was ever performed on the stream.\n\n#### `rs._predestroy()`\n\nA simple hook that is called as soon as the first `stream.destroy()` call is invoked.\n\nUse this in case you need to cancel pending reads (if possible) instead of waiting for them to finish.\n\nCan also be set using `options.predestroy` in the constructor.\n\n#### `rs.destroy([error])`\n\nForcefully destroy the stream. Will call `_destroy` as soon as all pending reads have finished.\nOnce the stream is fully destroyed `close` will be emitted.\n\nIf you pass an error this error will be emitted just before `close` is, signifying a reason\nas to why this stream was destroyed.\n\n#### `rs.pause()`\n\nPauses the stream. You will only need to call this if you want to pause a resumed stream.\n\nReturns this stream instance.\n\n#### `rs.resume()`\n\nWill start reading data from the stream as fast as possible.\n\nIf you do not call this, you need to use the `read()` method to read data or the `pipe()` method to\npipe the stream somewhere else or the `data` handler.\n\nIf none of these option are used the stream will stay paused.\n\nReturns this stream instance.\n\n#### `bool = Readable.isPaused(rs)`\n\nReturns `true` if the stream is paused, else `false`.\n\n#### `writableStream = rs.pipe(writableStream, [callback])`\n\nEfficently pipe the readable stream to a writable stream (can be Node.js core stream or a stream from this package).\nIf you provide a callback the callback is called when the pipeline has fully finished with an optional error in case\nit failed.\n\nTo cancel the pipeline destroy either of the streams.\n\n#### `rs.on('readable')`\n\nEmitted when data is pushed to the stream if the buffer was previously empty.\n\n#### `rs.on('data', data)`\n\nEmitted when data is being read from the stream. If you attach a data handler you are implicitly resuming the stream.\n\n#### `rs.on('end')`\n\nEmitted when the readable stream has ended and no data is left in it's buffer.\n\n#### `rs.on('close')`\n\nEmitted when the readable stream has fully closed (i.e. it's destroy function has completed)\n\n#### `rs.on('error', err)`\n\nEmitted if any of the stream operations fail with an error. `close` is always emitted right after this.\n\n#### `rs.on('piping', dest)`\n\nEmitted when the readable stream is pipeing to a destination.\n\n#### `rs.destroyed`\n\nBoolean property indicating wheather or not this stream has been destroyed.\n\n#### `bool = Readable.isBackpressured(rs)`\n\nStatic method to check if a readable stream is currently under backpressure.\n\n#### `stream = Readable.from(arrayOrBufferOrStringOrAsyncIterator)`\n\nStatic method to turn an array or buffer or string or AsyncIterator into a readable stream.\n\n## Writable Stream\n\n#### `ws = new stream.Writable([options])`\n\nCreate a new writable stream.\n\nOptions include:\n\n```\n{\n  highWaterMark: 16384, // max buffer size in bytes\n  map: (data) => data, // optional function to map input data\n  byteLength: (data) => size, // optional function that calculates the byte size of input data\n  signal: abortController.signal // optional AbortSignal that triggers `.destroy` when on `abort`\n}\n```\n\nIn addition you can pass the `open`, `write`, `final`, and `destroy` functions as shorthands in\nthe constructor instead of overwrite the methods below.\n\nThe default byteLength function returns the byte length of buffers and `1024`\nfor any other object. This means the buffer will contain around 16 non buffers\nor buffers worth 16kb when full if the defaults are used.\n\n#### `ws._open(cb)`\n\nThis function is called once before the first write is issued. Use this function\nto implement your own open logic.\n\nCan also be set using `options.open` in the constructor.\n\n#### `ws._destroy(cb)`\n\nThis function is called just before the stream is fully destroyed. You should\nuse this to implement whatever teardown logic you need. The final part of the\nstream life cycle is always to call destroy itself so this function will always\nbe called wheather or not the stream ends gracefully or forcefully.\n\nCan also be set using `options.destroy` in the constructor.\n\nNote that the `_destroy` might be called without the open function being called\nin case no write was ever performed on the stream.\n\n#### `ws._predestroy()`\n\nA simple hook that is called as soon as the first `stream.destroy()` call is invoked.\n\nUse this in case you need to cancel pending writes (if possible) instead of waiting for them to finish.\n\nCan also be set using `options.predestroy` in the constructor.\n\n#### `ws.destroy([error])`\n\nForcefully destroy the stream. Will call `_destroy` as soon as all pending reads have finished.\nOnce the stream is fully destroyed `close` will be emitted.\n\nIf you pass an error this error will be emitted just before `close` is, signifying a reason\nas to why this stream was destroyed.\n\n#### `drained = ws.write(data)`\n\nWrite a piece of data to the stream. Returns `true` if the stream buffer is not full and you\nshould keep writing to it if you can. If `false` is returned the stream will emit `drain`\nonce it's buffer is fully drained.\n\n#### `ws._write(data, callback)`\n\nThis function is called when the stream want to write some data. Use this to implement your own\nwrite logic. When done call the callback and the stream will call it again if more data exists in the buffer.\n\nCan also be set using `options.write` in the constructor.\n\n#### `ws._writev(batch, callback)`\n\nSimilar to `_write` but passes an array of all data in the current write buffer instead of the oldest one.\nUseful if the destination you are writing the data to supports batching.\n\nCan also be set using `options.writev` in the constructor.\n\n#### `ws.end()`\n\nGracefully end the writable stream. Call this when you no longer want to write to the stream.\n\nOnce all writes have been fully drained `finish` will be emitted.\n\nReturns this stream instance.\n\n#### `ws._final(callback)`\n\nThis function is called just before `finish` is emitted, i.e. when all writes have flushed but `ws.end()`\nhave been called. Use this to implement any logic that should happen after all writes but before finish.\n\nCan also be set using `options.final` in the constructor.\n\n#### `ws.on('finish')`\n\nEmitted when the stream has been ended and all writes have been drained.\n\n#### `ws.on('close')`\n\nEmitted when the readable stream has fully closed (i.e. it's destroy function has completed)\n\n#### `ws.on('error', err)`\n\nEmitted if any of the stream operations fail with an error. `close` is always emitted right after this.\n\n#### `ws.on('pipe', src)`\n\nEmitted when a readable stream is being piped to the writable one.\n\n#### `ws.destroyed`\n\nBoolean property indicating wheather or not this stream has been destroyed.\n\n#### `bool = Writable.isBackpressured(ws)`\n\nStatic method to check if a writable stream is currently under backpressure.\n\n#### `bool = await Writable.drained(ws)`\n\nStatic helper to wait for a stream to drain the currently queued writes.\nReturns true if they were drained and false otherwise if the stream was destroyed.\n\n## Duplex Stream\n\n#### `s = new stream.Duplex([options])`\n\nA duplex stream is a stream that is both readable and writable.\n\nSince JS does not support multiple inheritance it inherits directly from Readable\nbut implements the Writable API as well.\n\nIf you want to provide only a map function for the readable side use `mapReadable` instead.\nIf you want to provide only a byteLength function for the readable side use `byteLengthReadable` instead.\n\nSame goes for the writable side but using `mapWritable` and `byteLengthWritable` instead.\n\n## Transform Stream\n\nA Transform stream is a duplex stream with an `._transform` template method that allows to\nasynchronously map the input to a different output.\n\nThe transform stream overrides the `_write` and `_read` operations of `Readable` and `Writable` but\nstill allows the setting of these options in the constructor. Usually it is unnecessary to pass\nin `read` or `write`/`writev` or to override the corresponding `._read`, `._write` or `._writev` operation.\n\n#### `ts = new stream.Transform([options])`\n\nA transform stream is a duplex stream that maps the data written to it and emits that as readable data.\n\nHas the same options as a duplex stream except you can provide a `transform` function also.\n\n#### `ts._transform(data, callback)`\n\nTransform the incoming data. Call `callback(null, mappedData)` or use `ts.push(mappedData)` to\nreturn data to the readable side of the stream.\n\nPer default the transform function just remits the incoming data making it act as a pass-through stream.\n\n## Pipeline\n\n`pipeline` allows to stream form a readable through a set of duplex streams to a writable entry.\n\n```js\nconst { pipeline, Readable, Transform, Writable } = require('streamx')\nconst lastStream = pipeline(\n  Readable.from([1, 2, 3]),\n  new Transform({\n    transform (from, cb) {\n      this.push(from.toString())\n      cb()\n    }\n  }),\n  new Writable({\n    write (data, cb) {\n      console.log(data)\n      cb()\n    }\n  })\n  error => {\n    // Callback once write has finished\n  }\n)\n```\n\n#### `lastStream = stream.pipeline(...streams, [done])`\n\nPipe all streams together and return the last stream piped to.\nWhen the last stream finishes the pipeline ended succesfully.\n\nIf any of the streams error, whether they are Node.js core streams\nor streamx streams, all streams in the pipeline are shutdown.\n\nOptionally you can pass a done callback to know when the pipeline is done.\n\n#### `promise = stream.pipelinePromise(...streams)`\n\nSame as normal pipeline except instead of returning the last stream it returns\na promise representing the done callback. Note you should error handle this\npromise if you use this version.\n\n## Helpers\n\n#### `bool = isStream(stream)`\n\n#### `bool = isStreamx(stream)`\n\n#### `err = getStreamError(stream, [options])`\n\nReturns `null` if the stream has no errors.\n\n## Utilities\n\nStreamx aims to be minimal and stable. It therefore only contains a minimal set of utilities.\nTo help discover of other modules that help you build streamx apps, we link some useful utilities here\n\n* [stream-composer](https://github.com/mafintosh/stream-composer) - Compose streams like Node's `stream.compose` and the `duplexify` and `pumpify` modules.\n* [teex](https://github.com/mafintosh/teex) - Clone a readable stream into multiple new readable instances.\n\n## Contributing\n\nIf you want to help contribute to streamx a good way to start is to help writing more test\ncases, compatibility tests, documentation, or performance benchmarks.\n\nIf in doubt open an issue :)\n\n## License\n\nMIT",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{cf/78/8d1940f9eaedda9fa4532ceec0f2dd7f6116791c0fd08dc7f89d2aaccd046652e15dcda4f48e9a1ed34d608420b51f8c6335445db8077c50f9a09269dd6a → 21/49/a3fece9cf70ae1f19dea32350218a56ae10815286b1abfa7853bdce76df24780fabb8d0ca191a3bc9eb7f4c5f1234d306bfe15a6068d8d6989ee7abb0371}

@@ -385,7 +385,7 @@
   "dist-tags": {
     "latest": "1.3.2"
   },
-  "_rev": "571-48dc072921dec66f",
+  "_rev": "599-10785be5b89840ab",
   "_id": "fast-fifo",
   "readme": "# fast-fifo\n\nA fast fifo implementation similar to the one powering nextTick in Node.js core\n\n```\nnpm install fast-fifo\n```\n\nUses a linked list of growing fixed sized arrays to implement the FIFO to avoid\nallocating a wrapper object for each item.\n\n## Usage\n\n``` js\nconst FIFO = require('fast-fifo')\n\nconst q = new FIFO()\n\nq.push('hello')\nq.push('world')\n\nq.shift() // returns hello\nq.shift() // returns world\n```\n\n## API\n\n#### `q = new FIFO()`\n\nCreate a new FIFO.\n\n#### `q.push(value)`\n\nPush a value to the FIFO. `value` can be anything other than undefined.\n\n#### `value = q.shift()`\n\nReturn the oldest value from the FIFO.\n\n#### `q.clear()`\n\nRemove all values from the FIFO.\n\n#### `bool = q.isEmpty()`\n\nReturns `true` if the FIFO is empty and false otherwise.\n\n#### `value = q.peek()`\n\nReturn the oldest value from the FIFO without shifting it out.\n\n#### `len = q.length`\n\nGet the number of entries remaining in the FIFO.\n\n## Benchmarks\n\nIncluded in bench.js is a simple benchmark that benchmarks this against a simple\nlinked list based FIFO.\n\nOn my machine the benchmark looks like this:\n\n```\nfifo bulk push and shift: 2881.508ms\nfifo individual push and shift: 3248.437ms\nfast-fifo bulk push and shift: 1606.972ms\nfast-fifo individual push and shift: 1328.064ms\nfifo bulk push and shift: 3266.902ms\nfifo individual push and shift: 3320.944ms\nfast-fifo bulk push and shift: 1858.307ms\nfast-fifo individual push and shift: 1516.983ms\n```\n\nYMMV\n\n## License\n\nMIT",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{90/54/48145014f52306b18177e3da132ec6c0cc96d98bbefb114eb098353e7b2bc0b6694e2be9b448717561726314b547fd3ca88cb5fa46e9b7694331596b1a57 → 21/94/e59a5151f9bf646d74189e3f048fe847d6f27418f8eadd55f725ef84099fba1e57f847379a8e8d88ce794ea6c3d7eb041759f0aa4b6db22b7f35723903b9}

@@ -593,7 +593,7 @@
   "dist-tags": {
     "latest": "2.0.1"
   },
-  "_rev": "178-70c4d45d2f65fcc1",
+  "_rev": "184-516a3c4fe11c8ecb",
   "_id": "readdir-glob",
   "readme": "# Readdir-Glob\n![Build Status](https://github.com/Yqnn/node-readdir-glob/actions/workflows/test.yml/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/Yqnn/node-readdir-glob/badge.svg?branch=master)](https://coveralls.io/github/Yqnn/node-readdir-glob?branch=master)\n\nRecursive version of fs.readdir wih stream API and glob filtering.\nUses the `minimatch` library to do its matching.\n\nRequirements:\n- 1.x.x requires Node.js 10.0 or later.\n- 2.x.x requires Node.js 14.0 or later.\n\n## Performances\n\nCompared to `glob`, `readdir-glob` is memory efficient: no matter the file system size, or the number of returned files, the memory usage is constant.\n\nThe CPU cost is proportional to the number of files in `root` folder, minus the number files in `options.skip` folders.\n\n**Advice**: For better performances use `options.skip` to restrict the search as much as possible.\n\n## Usage\n\nInstall with npm\n```\nnpm i readdir-glob\n```\n\n```javascript\nconst readdirGlob = require('readdir-glob');\nconst globber = readdirGlob('.', {pattern: '**/*.js'});\nglobber.on('match', match => {\n    // m.relative: relative path of the matched file\n    // m.absolute: absolute path of the matched file\n    // m.stat: stat of the matched file (only if stat:true option is used)\n});\nglobber.on('error', err => {\n    console.error('fatal error', err);\n});\nglobber.on('end', (m) => {\n    console.log('done');\n});\n```\n\n## readdirGlob(root, [options])\n\n* `root` `{String}` Path to be read recursively, *default*: `'.'`\n* `options` `{Object}` Options, *default*: `{}`\n\nReturns a EventEmitter reading given root recursively.\n\n### Properties\n\n* `options`: The options object passed in.\n* `paused`: Boolean which is set to true when calling `pause()`.\n* `aborted` Boolean which is set to true when calling `abort()`.  There is no way at this time to continue a glob search after aborting.\n\n### Events\n\n* `match`: Every time a match is found, this is emitted with the specific thing that matched.\n* `end`: When the matching is finished, this is emitted with all the matches found. \n* `error`: Emitted when an unexpected error is encountered.\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\n* `pattern`: Glob pattern or Array of Glob patterns to match the found files with. A file has to match at least one of the provided patterns to be returned.\n* `ignore`: Glob pattern or Array of Glob patterns to exclude matches. If a file or a folder matches at least one of the provided patterns, it's not returned. It doesn't prevent files from folder content to be returned. Note: `ignore` patterns are *always* in `dot:true` mode.\n* `skip`: Glob pattern or Array of Glob patterns to exclude folders. If a folder matches one of the provided patterns, it's not returned, and it's not explored: this prevents any of its children to be returned. Note: `skip` patterns are *always* in `dot:true` mode.\n* `mark`: Add a `/` character to directory matches.\n* `stat`: Set to true to stat *all* results.  This reduces performance.\n* `silent`: When an unusual error is encountered when attempting to read a directory, a warning will be printed to stderr.  Set the `silent` option to true to suppress these warnings.\n* `nodir`: Do not match directories, only files.\n* `follow`: Follow symlinked directories. Note that requires to stat *all* results, and so reduces performance.\n\nThe following options apply only if `pattern` option is set, and are forwarded to `minimatch`:\n* `dot`: Allow `pattern` to match filenames starting with a period, even if the pattern does not explicitly have a period in that spot.\n* `noglobstar`: Disable `**` matching against multiple folder names.\n* `nocase`: Perform a case-insensitive match.  Note: on case-insensitive filesystems, non-magic patterns will match by default, since `stat` and `readdir` will not raise errors.\n* `matchBase`: Perform a basename-only match if the pattern does not  contain any slash characters.  That is, `*.js` would be treated as equivalent to `**/*.js`, matching all js files in all directories.\n\n\n## References\n\nUnit-test set is based on [node-glob](https://www.npmjs.com/package/glob) tests.",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{65/ca/dd45e5bc76dd9d19cd97f71ca7908c30dee7af9b56b6ab07fe405f380e63107680a3f061d21122da737bb2c5c8b8bb7dbe639ab34da3290bf1bfd564ff9a → 22/22/bae9edaa05039d9e3cbb79d20e4c4880eb2f73f926b3f640ada6c791816c6025169e3eb65fa722d898c41600468825a81295fa04fe81786092f215d2b9a6}

@@ -14919,7 +14919,7 @@
   "dist-tags": {
     "latest": "8.18.3"
   },
-  "_rev": "2270-72f2b0d4c4842c2c",
+  "_rev": "2298-989c0102c85f237b",
   "_id": "ws",
   "readme": "# ws: a Node.js WebSocket library\n\n[![Version npm](https://img.shields.io/npm/v/ws.svg?logo=npm)](https://www.npmjs.com/package/ws)\n[![CI](https://img.shields.io/github/actions/workflow/status/websockets/ws/ci.yml?branch=master&label=CI&logo=github)](https://github.com/websockets/ws/actions?query=workflow%3ACI+branch%3Amaster)\n[![Coverage Status](https://img.shields.io/coveralls/websockets/ws/master.svg?logo=coveralls)](https://coveralls.io/github/websockets/ws)\n\nws is a simple to use, blazing fast, and thoroughly tested WebSocket client and\nserver implementation.\n\nPasses the quite extensive Autobahn test suite: [server][server-report],\n[client][client-report].\n\n**Note**: This module does not work in the browser. The client in the docs is a\nreference to a backend with the role of a client in the WebSocket communication.\nBrowser clients must use the native\n[`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)\nobject. To make the same code work seamlessly on Node.js and the browser, you\ncan use one of the many wrappers available on npm, like\n[isomorphic-ws](https://github.com/heineiuo/isomorphic-ws).\n\n## Table of Contents\n\n- [Protocol support](#protocol-support)\n- [Installing](#installing)\n  - [Opt-in for performance](#opt-in-for-performance)\n    - [Legacy opt-in for performance](#legacy-opt-in-for-performance)\n- [API docs](#api-docs)\n- [WebSocket compression](#websocket-compression)\n- [Usage examples](#usage-examples)\n  - [Sending and receiving text data](#sending-and-receiving-text-data)\n  - [Sending binary data](#sending-binary-data)\n  - [Simple server](#simple-server)\n  - [External HTTP/S server](#external-https-server)\n  - [Multiple servers sharing a single HTTP/S server](#multiple-servers-sharing-a-single-https-server)\n  - [Client authentication](#client-authentication)\n  - [Server broadcast](#server-broadcast)\n  - [Round-trip time](#round-trip-time)\n  - [Use the Node.js streams API](#use-the-nodejs-streams-api)\n  - [Other examples](#other-examples)\n- [FAQ](#faq)\n  - [How to get the IP address of the client?](#how-to-get-the-ip-address-of-the-client)\n  - [How to detect and close broken connections?](#how-to-detect-and-close-broken-connections)\n  - [How to connect via a proxy?](#how-to-connect-via-a-proxy)\n- [Changelog](#changelog)\n- [License](#license)\n\n## Protocol support\n\n- **HyBi drafts 07-12** (Use the option `protocolVersion: 8`)\n- **HyBi drafts 13-17** (Current default, alternatively option\n  `protocolVersion: 13`)\n\n## Installing\n\n```\nnpm install ws\n```\n\n### Opt-in for performance\n\n[bufferutil][] is an optional module that can be installed alongside the ws\nmodule:\n\n```\nnpm install --save-optional bufferutil\n```\n\nThis is a binary addon that improves the performance of certain operations such\nas masking and unmasking the data payload of the WebSocket frames. Prebuilt\nbinaries are available for the most popular platforms, so you don't necessarily\nneed to have a C++ compiler installed on your machine.\n\nTo force ws to not use bufferutil, use the\n[`WS_NO_BUFFER_UTIL`](./doc/ws.md#ws_no_buffer_util) environment variable. This\ncan be useful to enhance security in systems where a user can put a package in\nthe package search path of an application of another user, due to how the\nNode.js resolver algorithm works.\n\n#### Legacy opt-in for performance\n\nIf you are running on an old version of Node.js (prior to v18.14.0), ws also\nsupports the [utf-8-validate][] module:\n\n```\nnpm install --save-optional utf-8-validate\n```\n\nThis contains a binary polyfill for [`buffer.isUtf8()`][].\n\nTo force ws not to use utf-8-validate, use the\n[`WS_NO_UTF_8_VALIDATE`](./doc/ws.md#ws_no_utf_8_validate) environment variable.\n\n## API docs\n\nSee [`/doc/ws.md`](./doc/ws.md) for Node.js-like documentation of ws classes and\nutility functions.\n\n## WebSocket compression\n\nws supports the [permessage-deflate extension][permessage-deflate] which enables\nthe client and server to negotiate a compression algorithm and its parameters,\nand then selectively apply it to the data payloads of each WebSocket message.\n\nThe extension is disabled by default on the server and enabled by default on the\nclient. It adds a significant overhead in terms of performance and memory\nconsumption so we suggest to enable it only if it is really needed.\n\nNote that Node.js has a variety of issues with high-performance compression,\nwhere increased concurrency, especially on Linux, can lead to [catastrophic\nmemory fragmentation][node-zlib-bug] and slow performance. If you intend to use\npermessage-deflate in production, it is worthwhile to set up a test\nrepresentative of your workload and ensure Node.js/zlib will handle it with\nacceptable performance and memory usage.\n\nTuning of permessage-deflate can be done via the options defined below. You can\nalso use `zlibDeflateOptions` and `zlibInflateOptions`, which is passed directly\ninto the creation of [raw deflate/inflate streams][node-zlib-deflaterawdocs].\n\nSee [the docs][ws-server-options] for more options.\n\n```js\nimport WebSocket, { WebSocketServer } from 'ws';\n\nconst wss = new WebSocketServer({\n  port: 8080,\n  perMessageDeflate: {\n    zlibDeflateOptions: {\n      // See zlib defaults.\n      chunkSize: 1024,\n      memLevel: 7,\n      level: 3\n    },\n    zlibInflateOptions: {\n      chunkSize: 10 * 1024\n    },\n    // Other options settable:\n    clientNoContextTakeover: true, // Defaults to negotiated value.\n    serverNoContextTakeover: true, // Defaults to negotiated value.\n    serverMaxWindowBits: 10, // Defaults to negotiated value.\n    // Below options specified as default values.\n    concurrencyLimit: 10, // Limits zlib concurrency for perf.\n    threshold: 1024 // Size (in bytes) below which messages\n    // should not be compressed if context takeover is disabled.\n  }\n});\n```\n\nThe client will only use the extension if it is supported and enabled on the\nserver. To always disable the extension on the client, set the\n`perMessageDeflate` option to `false`.\n\n```js\nimport WebSocket from 'ws';\n\nconst ws = new WebSocket('ws://www.host.com/path', {\n  perMessageDeflate: false\n});\n```\n\n## Usage examples\n\n### Sending and receiving text data\n\n```js\nimport WebSocket from 'ws';\n\nconst ws = new WebSocket('ws://www.host.com/path');\n\nws.on('error', console.error);\n\nws.on('open', function open() {\n  ws.send('something');\n});\n\nws.on('message', function message(data) {\n  console.log('received: %s', data);\n});\n```\n\n### Sending binary data\n\n```js\nimport WebSocket from 'ws';\n\nconst ws = new WebSocket('ws://www.host.com/path');\n\nws.on('error', console.error);\n\nws.on('open', function open() {\n  const array = new Float32Array(5);\n\n  for (var i = 0; i < array.length; ++i) {\n    array[i] = i / 2;\n  }\n\n  ws.send(array);\n});\n```\n\n### Simple server\n\n```js\nimport { WebSocketServer } from 'ws';\n\nconst wss = new WebSocketServer({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n  ws.on('error', console.error);\n\n  ws.on('message', function message(data) {\n    console.log('received: %s', data);\n  });\n\n  ws.send('something');\n});\n```\n\n### External HTTP/S server\n\n```js\nimport { createServer } from 'https';\nimport { readFileSync } from 'fs';\nimport { WebSocketServer } from 'ws';\n\nconst server = createServer({\n  cert: readFileSync('/path/to/cert.pem'),\n  key: readFileSync('/path/to/key.pem')\n});\nconst wss = new WebSocketServer({ server });\n\nwss.on('connection', function connection(ws) {\n  ws.on('error', console.error);\n\n  ws.on('message', function message(data) {\n    console.log('received: %s', data);\n  });\n\n  ws.send('something');\n});\n\nserver.listen(8080);\n```\n\n### Multiple servers sharing a single HTTP/S server\n\n```js\nimport { createServer } from 'http';\nimport { WebSocketServer } from 'ws';\n\nconst server = createServer();\nconst wss1 = new WebSocketServer({ noServer: true });\nconst wss2 = new WebSocketServer({ noServer: true });\n\nwss1.on('connection', function connection(ws) {\n  ws.on('error', console.error);\n\n  // ...\n});\n\nwss2.on('connection', function connection(ws) {\n  ws.on('error', console.error);\n\n  // ...\n});\n\nserver.on('upgrade', function upgrade(request, socket, head) {\n  const { pathname } = new URL(request.url, 'wss://base.url');\n\n  if (pathname === '/foo') {\n    wss1.handleUpgrade(request, socket, head, function done(ws) {\n      wss1.emit('connection', ws, request);\n    });\n  } else if (pathname === '/bar') {\n    wss2.handleUpgrade(request, socket, head, function done(ws) {\n      wss2.emit('connection', ws, request);\n    });\n  } else {\n    socket.destroy();\n  }\n});\n\nserver.listen(8080);\n```\n\n### Client authentication\n\n```js\nimport { createServer } from 'http';\nimport { WebSocketServer } from 'ws';\n\nfunction onSocketError(err) {\n  console.error(err);\n}\n\nconst server = createServer();\nconst wss = new WebSocketServer({ noServer: true });\n\nwss.on('connection', function connection(ws, request, client) {\n  ws.on('error', console.error);\n\n  ws.on('message', function message(data) {\n    console.log(`Received message ${data} from user ${client}`);\n  });\n});\n\nserver.on('upgrade', function upgrade(request, socket, head) {\n  socket.on('error', onSocketError);\n\n  // This function is not defined on purpose. Implement it with your own logic.\n  authenticate(request, function next(err, client) {\n    if (err || !client) {\n      socket.write('HTTP/1.1 401 Unauthorized\\r\\n\\r\\n');\n      socket.destroy();\n      return;\n    }\n\n    socket.removeListener('error', onSocketError);\n\n    wss.handleUpgrade(request, socket, head, function done(ws) {\n      wss.emit('connection', ws, request, client);\n    });\n  });\n});\n\nserver.listen(8080);\n```\n\nAlso see the provided [example][session-parse-example] using `express-session`.\n\n### Server broadcast\n\nA client WebSocket broadcasting to all connected WebSocket clients, including\nitself.\n\n```js\nimport WebSocket, { WebSocketServer } from 'ws';\n\nconst wss = new WebSocketServer({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n  ws.on('error', console.error);\n\n  ws.on('message', function message(data, isBinary) {\n    wss.clients.forEach(function each(client) {\n      if (client.readyState === WebSocket.OPEN) {\n        client.send(data, { binary: isBinary });\n      }\n    });\n  });\n});\n```\n\nA client WebSocket broadcasting to every other connected WebSocket clients,\nexcluding itself.\n\n```js\nimport WebSocket, { WebSocketServer } from 'ws';\n\nconst wss = new WebSocketServer({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n  ws.on('error', console.error);\n\n  ws.on('message', function message(data, isBinary) {\n    wss.clients.forEach(function each(client) {\n      if (client !== ws && client.readyState === WebSocket.OPEN) {\n        client.send(data, { binary: isBinary });\n      }\n    });\n  });\n});\n```\n\n### Round-trip time\n\n```js\nimport WebSocket from 'ws';\n\nconst ws = new WebSocket('wss://websocket-echo.com/');\n\nws.on('error', console.error);\n\nws.on('open', function open() {\n  console.log('connected');\n  ws.send(Date.now());\n});\n\nws.on('close', function close() {\n  console.log('disconnected');\n});\n\nws.on('message', function message(data) {\n  console.log(`Round-trip time: ${Date.now() - data} ms`);\n\n  setTimeout(function timeout() {\n    ws.send(Date.now());\n  }, 500);\n});\n```\n\n### Use the Node.js streams API\n\n```js\nimport WebSocket, { createWebSocketStream } from 'ws';\n\nconst ws = new WebSocket('wss://websocket-echo.com/');\n\nconst duplex = createWebSocketStream(ws, { encoding: 'utf8' });\n\nduplex.on('error', console.error);\n\nduplex.pipe(process.stdout);\nprocess.stdin.pipe(duplex);\n```\n\n### Other examples\n\nFor a full example with a browser client communicating with a ws server, see the\nexamples folder.\n\nOtherwise, see the test cases.\n\n## FAQ\n\n### How to get the IP address of the client?\n\nThe remote IP address can be obtained from the raw socket.\n\n```js\nimport { WebSocketServer } from 'ws';\n\nconst wss = new WebSocketServer({ port: 8080 });\n\nwss.on('connection', function connection(ws, req) {\n  const ip = req.socket.remoteAddress;\n\n  ws.on('error', console.error);\n});\n```\n\nWhen the server runs behind a proxy like NGINX, the de-facto standard is to use\nthe `X-Forwarded-For` header.\n\n```js\nwss.on('connection', function connection(ws, req) {\n  const ip = req.headers['x-forwarded-for'].split(',')[0].trim();\n\n  ws.on('error', console.error);\n});\n```\n\n### How to detect and close broken connections?\n\nSometimes, the link between the server and the client can be interrupted in a\nway that keeps both the server and the client unaware of the broken state of the\nconnection (e.g. when pulling the cord).\n\nIn these cases, ping messages can be used as a means to verify that the remote\nendpoint is still responsive.\n\n```js\nimport { WebSocketServer } from 'ws';\n\nfunction heartbeat() {\n  this.isAlive = true;\n}\n\nconst wss = new WebSocketServer({ port: 8080 });\n\nwss.on('connection', function connection(ws) {\n  ws.isAlive = true;\n  ws.on('error', console.error);\n  ws.on('pong', heartbeat);\n});\n\nconst interval = setInterval(function ping() {\n  wss.clients.forEach(function each(ws) {\n    if (ws.isAlive === false) return ws.terminate();\n\n    ws.isAlive = false;\n    ws.ping();\n  });\n}, 30000);\n\nwss.on('close', function close() {\n  clearInterval(interval);\n});\n```\n\nPong messages are automatically sent in response to ping messages as required by\nthe spec.\n\nJust like the server example above, your clients might as well lose connection\nwithout knowing it. You might want to add a ping listener on your clients to\nprevent that. A simple implementation would be:\n\n```js\nimport WebSocket from 'ws';\n\nfunction heartbeat() {\n  clearTimeout(this.pingTimeout);\n\n  // Use `WebSocket#terminate()`, which immediately destroys the connection,\n  // instead of `WebSocket#close()`, which waits for the close timer.\n  // Delay should be equal to the interval at which your server\n  // sends out pings plus a conservative assumption of the latency.\n  this.pingTimeout = setTimeout(() => {\n    this.terminate();\n  }, 30000 + 1000);\n}\n\nconst client = new WebSocket('wss://websocket-echo.com/');\n\nclient.on('error', console.error);\nclient.on('open', heartbeat);\nclient.on('ping', heartbeat);\nclient.on('close', function clear() {\n  clearTimeout(this.pingTimeout);\n});\n```\n\n### How to connect via a proxy?\n\nUse a custom `http.Agent` implementation like [https-proxy-agent][] or\n[socks-proxy-agent][].\n\n## Changelog\n\nWe're using the GitHub [releases][changelog] for changelog entries.\n\n## License\n\n[MIT](LICENSE)\n\n[`buffer.isutf8()`]: https://nodejs.org/api/buffer.html#bufferisutf8input\n[bufferutil]: https://github.com/websockets/bufferutil\n[changelog]: https://github.com/websockets/ws/releases\n[client-report]: http://websockets.github.io/ws/autobahn/clients/\n[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent\n[node-zlib-bug]: https://github.com/nodejs/node/issues/8871\n[node-zlib-deflaterawdocs]:\n  https://nodejs.org/api/zlib.html#zlib_zlib_createdeflateraw_options\n[permessage-deflate]: https://tools.ietf.org/html/rfc7692\n[server-report]: http://websockets.github.io/ws/autobahn/servers/\n[session-parse-example]: ./examples/express-session-parse\n[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent\n[utf-8-validate]: https://github.com/websockets/utf-8-validate\n[ws-server-options]: ./doc/ws.md#new-websocketserveroptions-callback",
   "_attachments": {}