mrs-toolbox-cli 11.0.0 → 11.0.2

package/npm-cache/_cacache/content-v2/sha512/{41/4f/64a856460fcaee1c49145344e84afb2ed7e1598c96ffc9e99b78a8c7c5101e0ab3750f11dad29715066b76d424e598ec5fe105541c37235ac66b29b0d0c1 → 94/17/52b1278f72abc5d4697fa950060426ce61fedb3c11600eb154b86679730705aa2be5a248ee7615c77bd4a484a566a6256313f394be46e394da1affe9840d}

@@ -18455,12 +18455,106 @@
       },
       "_hasShrinkwrap": false,
       "contributors": []
+    },
+    "3.973.10": {
+      "name": "@aws-sdk/types",
+      "version": "3.973.10",
+      "main": "./dist-cjs/index.js",
+      "module": "./dist-es/index.js",
+      "types": "./dist-types/index.d.ts",
+      "description": "Types for the AWS SDK",
+      "scripts": {
+        "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
+        "build:cjs": "node ../../scripts/compilation/inline types",
+        "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": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
+        "extract:docs": "api-extractor run --local",
+        "test": "tsc -p tsconfig.test.json"
+      },
+      "sideEffects": false,
+      "author": {
+        "name": "AWS SDK for JavaScript Team",
+        "url": "https://aws.amazon.com/javascript/"
+      },
+      "license": "Apache-2.0",
+      "engines": {
+        "node": ">=20.0.0"
+      },
+      "typesVersions": {
+        "<4.5": {
+          "dist-types/*": [
+            "dist-types/ts3.4/*"
+          ]
+        }
+      },
+      "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages-internal/types",
+      "repository": {
+        "type": "git",
+        "url": "git+https://github.com/aws/aws-sdk-js-v3.git",
+        "directory": "packages-internal/types"
+      },
+      "dependencies": {
+        "@smithy/types": "^4.14.3",
+        "tslib": "^2.6.2"
+      },
+      "devDependencies": {
+        "@tsconfig/recommended": "1.0.1",
+        "concurrently": "7.0.0",
+        "downlevel-dts": "0.10.1",
+        "premove": "4.0.0",
+        "typescript": "~5.8.3"
+      },
+      "browser": {},
+      "react-native": {},
+      "_id": "@aws-sdk/types@3.973.10",
+      "bugs": {
+        "url": "https://github.com/aws/aws-sdk-js-v3/issues"
+      },
+      "_nodeVersion": "24.14.0",
+      "_npmVersion": "11.7.0",
+      "dist": {
+        "integrity": "sha512-992QrTO7G9qCvKD0fx1rMlqcL14plUcRAbwmqqYVsuF3GrqcvlAL9qxR+baMafarEZ+l7DUQ5lCMmt5mbMhF7g==",
+        "shasum": "e0b6ab8b631aba7ac97b0ea14e06d6531926ee40",
+        "tarball": "https://verdaccio.mrsdev.ru/@aws-sdk%2ftypes/-/types-3.973.10.tgz",
+        "fileCount": 124,
+        "unpackedSize": 44950,
+        "signatures": [
+          {
+            "keyid": "SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U",
+            "sig": "MEYCIQDWNAytjsnqGLl8pvGvXtXs7pATfvB2bI5QOv+2vmuxuwIhAO2QKOnHrR8fDzmBf1BDfLf8g9NDd1BNKnYvHMu+Ruvv"
+          }
+        ]
+      },
+      "_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/types_3.973.10_1780427647540_0.3350049892016882"
+      },
+      "_hasShrinkwrap": false,
+      "contributors": []
     }
   },
   "time": {
     "created": "2018-11-19T23:21:46.457Z",
     "0.1.0-preview.1": "2018-11-19T23:21:46.852Z",
-    "modified": "2026-05-21T21:02:20.612Z",
+    "modified": "2026-06-02T19:14:07.847Z",
     "0.1.0-preview.2": "2019-03-27T19:14:41.672Z",
     "0.1.0-preview.3": "2019-04-19T20:53:45.901Z",
     "0.1.0-preview.4": "2019-07-12T18:53:21.916Z",
@@ -18649,18 +18743,19 @@
     "3.973.6": "2026-03-13T19:01:27.484Z",
     "3.973.7": "2026-04-07T19:04:21.900Z",
     "3.973.8": "2026-04-16T19:26:02.851Z",
-    "3.973.9": "2026-05-21T21:02:20.463Z"
+    "3.973.9": "2026-05-21T21:02:20.463Z",
+    "3.973.10": "2026-06-02T19:14:07.675Z"
   },
   "users": {},
   "dist-tags": {
     "preview": "0.1.0-preview.7",
-    "latest": "3.973.9",
+    "latest": "3.973.10",
     "alpha": "1.0.0-alpha.6",
     "beta": "1.0.0-beta.4",
     "gamma": "1.0.0-gamma.7",
     "rc": "1.0.0-rc.10"
   },
-  "_rev": "423-a60b4f30872ba650",
+  "_rev": "430-01037151826dd29d",
   "_id": "@aws-sdk/types",
   "readme": "# @aws-sdk/types\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/types/latest.svg)](https://www.npmjs.com/package/@aws-sdk/types)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/types.svg)](https://www.npmjs.com/package/@aws-sdk/types)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{d7/1e/38a4e0df3fad9bca829c01bcf3abe1fceccf678664862debff0a0d8fd922117eb88b55570caffc77a34d184fb3129d2645db49f0e3ee23d531c94e22a7e2 → 95/60/8c7cc81a939154fb7971a9027981263f81438277afe85a700256d9691342ae38ca06e15d0489c3e1291bf281b81f8706335bb2d44aa027351f39dacdbf02}

@@ -4185,7 +4185,7 @@
   "dist-tags": {
     "latest": "1.4.10"
   },
-  "_rev": "54-c4dddf565ec8b839",
+  "_rev": "61-287947a9b43023ff",
   "_id": "readline-sync",
   "readme": "# readlineSync\n\n[![npm](https://img.shields.io/npm/v/readline-sync.svg)](https://www.npmjs.com/package/readline-sync) [![GitHub issues](https://img.shields.io/github/issues/anseki/readline-sync.svg)](https://github.com/anseki/readline-sync/issues) [![dependencies](https://img.shields.io/badge/dependencies-No%20dependency-brightgreen.svg)](package.json) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE-MIT)\n\nSynchronous [Readline](http://nodejs.org/api/readline.html) for interactively running to have a conversation with the user via a console(TTY).\n\nreadlineSync tries to let your script have a conversation with the user via a console, even when the input/output stream is redirected like `your-script <foo.dat >bar.log`.\n\n<table>\n<tr><td><a href=\"#basic_options\">Basic Options</a></td><td><a href=\"#utility_methods\">Utility Methods</a></td><td><a href=\"#placeholders\">Placeholders</a></td></tr>\n</table>\n\n* Simple case:\n\n```js\nvar readlineSync = require('readline-sync');\n\n// Wait for user's response.\nvar userName = readlineSync.question('May I have your name? ');\nconsole.log('Hi ' + userName + '!');\n\n// Handle the secret text (e.g. password).\nvar favFood = readlineSync.question('What is your favorite food? ', {\n  hideEchoBack: true // The typed text on screen is hidden by `*` (default).\n});\nconsole.log('Oh, ' + userName + ' loves ' + favFood + '!');\n```\n\n```console\nMay I have your name? CookieMonster\nHi CookieMonster!\nWhat is your favorite food? ****\nOh, CookieMonster loves tofu!\n```\n\n* Get the user's response by a single key without the Enter key:\n\n```js\nvar readlineSync = require('readline-sync');\nif (readlineSync.keyInYN('Do you want this module?')) {\n  // 'Y' key was pressed.\n  console.log('Installing now...');\n  // Do something...\n} else {\n  // Another key was pressed.\n  console.log('Searching another...');\n  // Do something...\n}\n```\n\n* Let the user choose an item from a list:\n\n```js\nvar readlineSync = require('readline-sync'),\n  animals = ['Lion', 'Elephant', 'Crocodile', 'Giraffe', 'Hippo'],\n  index = readlineSync.keyInSelect(animals, 'Which animal?');\nconsole.log('Ok, ' + animals[index] + ' goes to your room.');\n```\n\n```console\n[1] Lion\n[2] Elephant\n[3] Crocodile\n[4] Giraffe\n[5] Hippo\n[0] CANCEL\n\nWhich animal? [1...5 / 0]: 2\nOk, Elephant goes to your room.\n```\n\n* An UI like the Range Slider:  \n(Press `Z` or `X` key to change a value, and Space Bar to exit)\n\n```js\nvar readlineSync = require('readline-sync'),\n  MAX = 60, MIN = 0, value = 30, key;\nconsole.log('\\n\\n' + (new Array(20)).join(' ') +\n  '[Z] <- -> [X]  FIX: [SPACE]\\n');\nwhile (true) {\n  console.log('\\x1B[1A\\x1B[K|' +\n    (new Array(value + 1)).join('-') + 'O' +\n    (new Array(MAX - value + 1)).join('-') + '| ' + value);\n  key = readlineSync.keyIn('',\n    {hideEchoBack: true, mask: '', limit: 'zx '});\n  if (key === 'z') { if (value > MIN) { value--; } }\n  else if (key === 'x') { if (value < MAX) { value++; } }\n  else { break; }\n}\nconsole.log('\\nA value the user requested: ' + value);\n```\n\n![sample](screen_03.gif)\n\n* Handle the commands repeatedly, such as the shell interface:\n\n```js\nreadlineSync.promptCLLoop({\n  add: function(target, into) {\n    console.log(target + ' is added into ' + into + '.');\n    // Do something...\n  },\n  remove: function(target) {\n    console.log(target + ' is removed.');\n    // Do something...\n  },\n  bye: function() { return true; }\n});\nconsole.log('Exited');\n```\n\n```console\n> add pic01.png archive\npic01.png is added into archive.\n> delete pic01.png\nRequested command is not available.\n> remove pic01.png\npic01.png is removed.\n> bye\nExited\n```\n\n## <a name=\"installation\"></a>Installation\n\n```console\nnpm install readline-sync\n```\n\n## <a name=\"quick_start\"></a>Quick Start\n\n**How does the user input?**\n\n- [Type a reply to a question, and press the Enter key](#quick_start-a) (A)\n- [Type a keyword like a command in prompt, and press the Enter key](#quick_start-b) (B)\n- [Press a single key without the Enter key](#quick_start-c) (C)\n\n<a name=\"quick_start-a\"></a>**(A) What does the user input?**\n\n- [E-mail address](#utility_methods-questionemail)\n- [New password](#utility_methods-questionnewpassword)\n- [Integer number](#utility_methods-questionint)\n- [Floating-point number](#utility_methods-questionfloat)\n- [Local file/directory path](#utility_methods-questionpath)\n- [Others](#basic_methods-question)\n\n<a name=\"quick_start-b\"></a>**(B) What does your script do?**\n\n- [Receive a parsed command-name and arguments](#utility_methods-promptcl)\n- [Receive an input repeatedly](#utility_methods-promptloop)\n- [Receive a parsed command-name and arguments repeatedly](#utility_methods-promptclloop)\n- [Receive an input with prompt that is similar to that of the user's shell](#utility_methods-promptsimshell)\n- [Others](#basic_methods-prompt)\n\n<a name=\"quick_start-c\"></a>**(C) What does the user do?**\n\n- [Say \"Yes\" or \"No\"](#utility_methods-keyinyn)\n- [Say \"Yes\" or \"No\" explicitly](#utility_methods-keyinynstrict)\n- [Make the running of script continue when ready](#utility_methods-keyinpause)\n- [Choose an item from a list](#utility_methods-keyinselect)\n- [Others](#basic_methods-keyin)\n\n## <a name=\"basic_methods\"></a>Basic Methods\n\nThese are used to control details of the behavior. It is recommended to use the [Utility Methods](#utility_methods) instead of Basic Methods if it satisfy your request.\n\n### <a name=\"basic_methods-question\"></a>`question`\n\n```js\nanswer = readlineSync.question([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then return the input from the user after it has been typed and the Enter key was pressed.  \nYou can specify an `options` (see [Basic Options](#basic_options)) to control the behavior (e.g. refusing unexpected input, avoiding trimming white spaces, etc.). **If you let the user input the secret text (e.g. password), you should consider [`hideEchoBack`](#basic_options-hideechoback) option.**\n\nThe `query` may be string, or may not be (e.g. number, Date, Object, etc.). It is converted to string (i.e. `toString` method is called) before it is displayed. (see [Note](#note) also)  \nIt can include the [placeholders](#placeholders).\n\nFor example:\n\n```js\nprogram = readlineSync.question('Which program starts do you want? ', {\n  defaultInput: 'firefox'\n});\n```\n\n### <a name=\"basic_methods-prompt\"></a>`prompt`\n\n```js\ninput = readlineSync.prompt([options])\n```\n\nDisplay a prompt-sign (see [`prompt`](#basic_options-prompt) option) to the user, and then return the input from the user after it has been typed and the Enter key was pressed.  \nYou can specify an `options` (see [Basic Options](#basic_options)) to control the behavior (e.g. refusing unexpected input, avoiding trimming white spaces, etc.).\n\nFor example:\n\n```js\nwhile (true) {\n  command = readlineSync.prompt();\n  // Do something...\n}\n```\n\n### <a name=\"basic_methods-keyin\"></a>`keyIn`\n\n```js\npressedKey = readlineSync.keyIn([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then return a character as a key immediately it was pressed by the user, **without pressing the Enter key**. Note that the user has no chance to change the input.  \nYou can specify an `options` (see [Basic Options](#basic_options)) to control the behavior (e.g. ignoring keys except some keys, checking target key, etc.).\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.\n\nFor example:\n\n```js\nmenuId = readlineSync.keyIn('Hit 1...5 key: ', {limit: '$<1-5>'});\n```\n\n### <a name=\"basic_methods-setdefaultoptions\"></a>`setDefaultOptions`\n\n```js\ncurrentDefaultOptions = readlineSync.setDefaultOptions([newDefaultOptions])\n```\n\nChange the [Default Options](#basic_options) to the values of properties of `newDefaultOptions` Object.  \nAll it takes is to specify options that you want change, because unspecified options are not updated.\n\n## <a name=\"basic_options\"></a>Basic Options\n\n[`prompt`](#basic_options-prompt), [`hideEchoBack`](#basic_options-hideechoback), [`mask`](#basic_options-mask), [`limit`](#basic_options-limit), [`limitMessage`](#basic_options-limitmessage), [`defaultInput`](#basic_options-defaultinput), [`trueValue`, `falseValue`](#basic_options-truevalue_falsevalue), [`caseSensitive`](#basic_options-casesensitive), [`keepWhitespace`](#basic_options-keepwhitespace), [`encoding`](#basic_options-encoding), [`bufferSize`](#basic_options-buffersize), [`print`](#basic_options-print), [`history`](#basic_options-history), [`cd`](#basic_options-cd)\n\nAn `options` Object can be specified to the methods to control the behavior of readlineSync. The options that were not specified to the methods are got from the Default Options. You can change the Default Options by [`setDefaultOptions`](#basic_methods-setdefaultoptions) method anytime, and it is kept until a current process is exited.  \nSpecify the options that are often used to the Default Options, and specify temporary options to the methods.\n\nFor example:\n\n```js\nreadlineSync.setDefaultOptions({limit: ['green', 'yellow', 'red']});\na1 = readlineSync.question('Which color of signal? '); // Input is limited to 3 things.\na2 = readlineSync.question('Which color of signal? '); // It's limited yet.\na3 = readlineSync.question('What is your favorite color? ', {limit: null}); // It's unlimited temporarily.\na4 = readlineSync.question('Which color of signal? '); // It's limited again.\nreadlineSync.setDefaultOptions({limit: ['beef', 'chicken']});\na5 = readlineSync.question('Beef or Chicken? ');        // Input is limited to new 2 things.\na6 = readlineSync.question('And you? ');                // It's limited to 2 things yet.\n```\n\nThe Object as `options` can have following properties.\n\n### <a name=\"basic_options-prompt\"></a>`prompt`\n\n_For `prompt*` methods only_  \n*Type:* string or others  \n*Default:* `'> '`\n\nSet the prompt-sign that is displayed to the user by `prompt*` methods. For example you see `> ` that is Node.js's prompt-sign when you run `node` on the command line.  \nThis may be string, or may not be (e.g. number, Date, Object, etc.). It is converted to string every time (i.e. `toString` method is called) before it is displayed. (see [Note](#note) also)  \nIt can include the [placeholders](#placeholders).\n\nFor example:\n\n```js\nreadlineSync.setDefaultOptions({prompt: '$ '});\n```\n\n```js\n// Display the memory usage always.\nreadlineSync.setDefaultOptions({\n  prompt: { // Simple Object that has toString method.\n    toString: function() {\n      var rss = process.memoryUsage().rss;\n      return '[' + (rss > 1024 ? Math.round(rss / 1024) + 'k' : rss) + 'b]$ ';\n    }\n  }\n});\n```\n\n```console\n[13148kb]$ foo\n[13160kb]$ bar\n[13200kb]$\n```\n\n### <a name=\"basic_options-hideechoback\"></a>`hideEchoBack`\n\n*Type:* boolean  \n*Default:* `false`\n\nIf `true` is specified, hide the secret text (e.g. password) which is typed by user on screen by the mask characters (see [`mask`](#basic_options-mask) option).\n\nFor example:\n\n```js\npassword = readlineSync.question('PASSWORD: ', {hideEchoBack: true});\nconsole.log('Login ...');\n```\n\n```console\nPASSWORD: ********\nLogin ...\n```\n\n### <a name=\"basic_options-mask\"></a>`mask`\n\n*Type:* string  \n*Default:* `'*'`\n\nSet the mask characters that are shown instead of the secret text (e.g. password) when `true` is specified to [`hideEchoBack`](#basic_options-hideechoback) option. If you want to show nothing, specify `''`. (But it might be not user friendly in some cases.)  \n**Note:** In some cases (e.g. when the input stream is redirected on Windows XP), `'*'` or `''` might be used whether other one is specified.\n\nFor example:\n\n```js\nsecret = readlineSync.question('Please whisper sweet words: ', {\n  hideEchoBack: true,\n  mask: require('chalk').magenta('\\u2665')\n});\n```\n\n![sample](screen_02.gif)\n\n### <a name=\"basic_options-limit\"></a>`limit`\n\nLimit the user's input.  \nThe usage differ depending on the method.\n\n#### <a name=\"basic_options-limit-for_question_and_prompt_methods\"></a>For `question*` and `prompt*` methods\n\n*Type:* string, number, RegExp, function or Array  \n*Default:* `[]`\n\nAccept only the input that matches value that is specified to this. If the user input others, display a string that is specified to [`limitMessage`](#basic_options-limitmessage) option, and wait for reinput.\n\n* The string is compared with the input. It is affected by [`caseSensitive`](#basic_options-casesensitive) option.\n* The number is compared with the input that is converted to number by `parseFloat()`. For example, it interprets `'   3.14   '`, `'003.1400'`, `'314e-2'` and `'3.14PI'` as `3.14`. And it interprets `'005'`, `'5files'`, `'5kb'` and `'5px'` as `5`.\n* The RegExp tests the input.\n* The function that returns a boolean to indicate whether it matches is called with the input.\n\nOne of above or an Array that includes multiple things (or Array includes Array) can be specified.\n\nFor example:\n\n```js\ncommand = readlineSync.prompt({limit: ['add', 'remove', /^clear( all)?$/]});\n// ** But `promptCL` method should be used instead of this. **\n```\n\n```js\nfile = readlineSync.question('Text File: ', {limit: /\\.txt$/i});\n// ** But `questionPath` method should be used instead of this. **\n```\n\n```js\nip = readlineSync.question('IP Address: ', {limit: function(input) {\n  return require('net').isIP(input); // Valid IP Address\n}});\n```\n\n```js\navailableActions = [];\nif (!blockExists())  { availableActions.push('jump'); }\nif (isLarge(place))  { availableActions.push('run'); }\nif (isNew(shoes))    { availableActions.push('kick'); }\nif (isNearby(enemy)) { availableActions.push('punch'); }\naction = readlineSync.prompt({limit: availableActions});\n// ** But `promptCL` method should be used instead of this. **\n```\n\n#### <a name=\"basic_options-limit-for_keyin_method\"></a>For `keyIn*` method\n\n*Type:* string, number or Array  \n*Default:* `[]`\n\nAccept only the key that matches value that is specified to this, ignore others.  \nSpecify the characters as the key. All strings or Array of those are decomposed into single characters. For example, `'abcde'` or `['a', 'bc', ['d', 'e']]` are the same as `['a', 'b', 'c', 'd', 'e']`.  \nThese strings are compared with the input. It is affected by [`caseSensitive`](#basic_options-casesensitive) option.\n\nThe [placeholders](#placeholders) like `'$<a-e>'` are replaced to an Array that is the character list like `['a', 'b', 'c', 'd', 'e']`.\n\nFor example:\n\n```js\ndirection = readlineSync.keyIn('Left or Right? ', {limit: 'lr'}); // 'l' or 'r'\n```\n\n```js\ndice = readlineSync.keyIn('Roll the dice, What will the result be? ',\n  {limit: '$<1-6>'}); // range of '1' to '6'\n```\n\n### <a name=\"basic_options-limitmessage\"></a>`limitMessage`\n\n_For `question*` and `prompt*` methods only_  \n*Type:* string  \n*Default:* `'Input another, please.$<( [)limit(])>'`\n\nDisplay this to the user when the [`limit`](#basic_options-limit) option is specified and the user input others.  \nThe [placeholders](#placeholders) can be included.\n\nFor example:\n\n```js\nfile = readlineSync.question('Name of Text File: ', {\n  limit: /\\.txt$/i,\n  limitMessage: 'Sorry, $<lastInput> is not text file.'\n});\n```\n\n### <a name=\"basic_options-defaultinput\"></a>`defaultInput`\n\n_For `question*` and `prompt*` methods only_  \n*Type:* string  \n*Default:* `''`\n\nIf the user input empty text (i.e. pressed the Enter key only), return this.\n\nFor example:\n\n```js\nlang = readlineSync.question('Which language? ', {defaultInput: 'javascript'});\n```\n\n### <a name=\"basic_options-truevalue_falsevalue\"></a>`trueValue`, `falseValue`\n\n*Type:* string, number, RegExp, function or Array  \n*Default:* `[]`\n\nIf the input matches `trueValue`, return `true`. If the input matches `falseValue`, return `false`. In any other case, return the input.\n\n* The string is compared with the input. It is affected by [`caseSensitive`](#basic_options-casesensitive) option.\n* The number is compared with the input that is converted to number by `parseFloat()`. For example, it interprets `'   3.14   '`, `'003.1400'`, `'314e-2'` and `'3.14PI'` as `3.14`. And it interprets `'005'`, `'5files'`, `'5kb'` and `'5px'` as `5`. Note that in `keyIn*` method, the input is every time one character (i.e. the number that is specified must be an integer within the range of `0` to `9`).\n* The RegExp tests the input.\n* The function that returns a boolean to indicate whether it matches is called with the input.\n\nOne of above or an Array that includes multiple things (or Array includes Array) can be specified.\n\nFor example:\n\n```js\nanswer = readlineSync.question('How do you like it? ', {\n  trueValue: ['yes', 'yeah', 'yep'],\n  falseValue: ['no', 'nah', 'nope']\n});\nif (answer === true) {\n  console.log('Let\\'s go!');\n} else if (answer === false) {\n  console.log('Oh... It\\'s ok...');\n} else {\n  console.log('Sorry. What does \"' + answer + '\" you said mean?');\n}\n```\n\n### <a name=\"basic_options-casesensitive\"></a>`caseSensitive`\n\n*Type:* boolean  \n*Default:* `false`\n\nBy default, the string comparisons are case-insensitive (i.e. `a` equals `A`). If `true` is specified, it is case-sensitive, the cases are not ignored (i.e. `a` is different from `A`).  \nIt affects: [`limit`](#basic_options-limit), [`trueValue`](#basic_options-truevalue_falsevalue), [`falseValue`](#basic_options-truevalue_falsevalue), some [placeholders](#placeholders), and some [Utility Methods](#utility_methods).\n\n### <a name=\"basic_options-keepwhitespace\"></a>`keepWhitespace`\n\n_For `question*` and `prompt*` methods only_  \n*Type:* boolean  \n*Default:* `false`\n\nBy default, remove the leading and trailing white spaces from the input text. If `true` is specified, don't remove those.\n\n### <a name=\"basic_options-encoding\"></a>`encoding`\n\n*Type:* string  \n*Default:* `'utf8'`\n\nSet the encoding method of the input and output.\n\n### <a name=\"basic_options-buffersize\"></a>`bufferSize`\n\n_For `question*` and `prompt*` methods only_  \n*Type:* number  \n*Default:* `1024`\n\nWhen readlineSync reads from a console directly (without [external program](#note-reading_by_external_program)), use a size `bufferSize` buffer.  \nEven if the input by user exceeds it, it's usually no problem, because the buffer is used repeatedly. But some platforms's (e.g. Windows) console might not accept input that exceeds it. And set an enough size.  \nNote that this might be limited by [version of Node.js](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding) and environment running your script (Big buffer size is usually not required). (See also: [issue](https://github.com/nodejs/node/issues/4660), [PR](https://github.com/nodejs/node/pull/4682))\n\n### <a name=\"basic_options-print\"></a>`print`\n\n*Type:* function or `undefined`  \n*Default:* `undefined`\n\nCall the specified function with every output. The function is given two arguments, `display` as an output text, and a value of [`encoding`](#basic_options-encoding) option.\n\nFor example:\n\n* Pass the plain texts to the Logger (e.g. [log4js](https://github.com/nomiddlename/log4js-node)), after clean the colored texts.\n\n![sample](screen_01.png)\n\n```js\nvar readlineSync = require('readline-sync'),\n  chalk = require('chalk'),\n  log4js = require('log4js'),\n  logger, user, pw, command;\n\nlog4js.configure({appenders: [{type: 'file', filename: 'fooApp.log'}]});\nlogger = log4js.getLogger('fooApp');\n\nreadlineSync.setDefaultOptions({\n  print: function(display, encoding)\n    { logger.info(chalk.stripColor(display)); }, // Remove ctrl-chars.\n  prompt: chalk.red.bold('> ')\n});\n\nconsole.log(chalk.black.bold.bgYellow('    Your Account    '));\nuser = readlineSync.question(chalk.gray.underline(' USER NAME ') + ' : ');\npw = readlineSync.question(chalk.gray.underline(' PASSWORD  ') + ' : ',\n  {hideEchoBack: true});\n// Authorization ...\nconsole.log(chalk.green('Welcome, ' + user + '!'));\ncommand = readlineSync.prompt();\n```\n\n* Output a conversation to a file when an output stream is redirected to record those into a file like `your-script >foo.log`. That is, a conversation isn't outputted to `foo.log` without this code.\n\n```js\nreadlineSync.setDefaultOptions({\n  print: function(display, encoding)\n    { process.stdout.write(display, encoding); }\n});\nvar name = readlineSync.question('May I have your name? ');\nvar loc = readlineSync.question('Hi ' + name + '! Where do you live? ');\n```\n\n* Let somebody hear our conversation in real time.  \nIt just uses a fifo with above sample code that was named `conv.js`.\n\nAnother terminal:\n\n```console\nmkfifo /tmp/fifo\ncat /tmp/fifo\n```\n\nMy terminal:\n\n```console\nnode conv.js >/tmp/fifo\n```\n\n```console\nMay I have your name? Oz\nHi Oz! Where do you live? Emerald City\n```\n\nAnd then, another terminal shows this synchronously:\n\n```console\nMay I have your name? Oz\nHi Oz! Where do you live? Emerald City\n```\n\n### <a name=\"basic_options-history\"></a>`history`\n\n_For `question*` and `prompt*` methods only_  \n*Type:* boolean  \n*Default:* `true`\n\nreadlineSync supports a history expansion feature that is similar to that of the shell. If `false` is specified, disable this feature.  \n*It keeps a previous input only.* That is, only `!!`, `!-1`, `!!:p` and `!-1:p` like bash or zsh etc. are supported.\n\n* `!!` or `!-1`: Return a previous input.\n* `!!:p` or `!-1:p`: Display a previous input but do not return it, and wait for reinput.\n\nFor example:\n\n```js\nwhile (true) {\n  input = readlineSync.prompt();\n  console.log('-- You said \"' + input + '\"');\n}\n```\n\n```console\n> hello\n-- You said \"hello\"\n> !!\nhello\n-- You said \"hello\"\n> !!:p\nhello\n> bye\n-- You said \"bye\"\n```\n\n### <a name=\"basic_options-cd\"></a>`cd`\n\n_For `question*` and `prompt*` methods only_  \n*Type:* boolean  \n*Default:* `false`\n\nreadlineSync supports the changing the current working directory feature that is similar to the `cd` and `pwd` commands in the shell. If `true` is specified, enable this feature.  \nThis helps the user when you let the user input the multiple local files or directories.  \nIt supports `cd` and `pwd` commands.\n\n* `cd <path>`: Change the current working directory to `<path>`. The `<path>` can include `~` as the home directory.\n* `pwd`: Display the current working directory.\n\nWhen these were input, do not return, and wait for reinput.\n\nFor example:\n\n```js\nwhile (true) {\n  file = readlineSync.questionPath('File: ');\n  console.log('-- Specified file is ' + file);\n}\n```\n\n```console\nFile: cd foo-dir/bar-dir\nFile: pwd\n/path/to/foo-dir/bar-dir\nFile: file-a.js\n-- Specified file is /path/to/foo-dir/bar-dir/file-a.js\nFile: file-b.png\n-- Specified file is /path/to/foo-dir/bar-dir/file-b.png\nFile: file-c.html\n-- Specified file is /path/to/foo-dir/bar-dir/file-c.html\n```\n\n## <a name=\"utility_methods\"></a>Utility Methods\n\n[`questionEMail`](#utility_methods-questionemail), [`questionNewPassword`](#utility_methods-questionnewpassword), [`questionInt`](#utility_methods-questionint), [`questionFloat`](#utility_methods-questionfloat), [`questionPath`](#utility_methods-questionpath), [`promptCL`](#utility_methods-promptcl), [`promptLoop`](#utility_methods-promptloop), [`promptCLLoop`](#utility_methods-promptclloop), [`promptSimShell`](#utility_methods-promptsimshell), [`keyInYN`](#utility_methods-keyinyn), [`keyInYNStrict`](#utility_methods-keyinynstrict), [`keyInPause`](#utility_methods-keyinpause), [`keyInSelect`](#utility_methods-keyinselect)\n\nThese are convenient methods that are extended [Basic Methods](#basic_methods) to be used easily.\n\n### <a name=\"utility_methods-questionemail\"></a>`questionEMail`\n\n```js\nemail = readlineSync.questionEMail([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then accept only a valid e-mail address, and then return it after the Enter key was pressed.\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Input e-mail address: '`.\n\n**Note:** The valid e-mail address requirement is a willful violation of [RFC5322](http://tools.ietf.org/html/rfc5322), this is defined in [HTML5](http://www.w3.org/TR/html5/forms.html). This works enough to prevent the user mistaking. If you want to change it, specify [`limit`](#basic_options-limit) option.\n\nFor example:\n\n```js\nemail = readlineSync.questionEMail();\nconsole.log('-- E-mail is ' + email);\n```\n\n```console\nInput e-mail address: abc\nInput valid e-mail address, please.\nInput e-mail address: mail@example.com\n-- E-mail is mail@example.com\n```\n\n#### <a name=\"utility_methods-questionemail-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n| [`limit`](#basic_options-limit) | RegExp by [HTML5](http://www.w3.org/TR/html5/forms.html) |\n| [`limitMessage`](#basic_options-limitmessage) | `'Input valid e-mail address, please.'` |\n| [`trueValue`](#basic_options-truevalue_falsevalue) | `null` |\n| [`falseValue`](#basic_options-truevalue_falsevalue) | `null` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-casesensitive\"><code>caseSensitive</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td></tr>\n<tr><td><a href=\"#basic_options-print\"><code>print</code></a></td><td><a href=\"#basic_options-history\"><code>history</code></a></td></tr>\n</table>\n\n### <a name=\"utility_methods-questionnewpassword\"></a>`questionNewPassword`\n\n```js\npassword = readlineSync.questionNewPassword([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then accept only a valid password, and then request same one again, and then return it after the Enter key was pressed.  \nIt's the password, or something that is the secret text like the password.  \nYou can specify the valid password requirement to the options.\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Input new password: '`.\n\n**Note:** Only the form of password is checked. Check it more if you want. For example, [zxcvbn](https://github.com/dropbox/zxcvbn) is password strength estimation library.\n\nFor example:\n\n```js\npassword = readlineSync.questionNewPassword();\nconsole.log('-- Password is ' + password);\n```\n\n```console\nInput new password: ************\nIt can include: 0...9, A...Z, a...z, !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~\nAnd the length must be: 12...24\nInput new password: *************\nReinput a same one to confirm it: *************\nIt differs from first one. Hit only the Enter key if you want to retry from first one.\nReinput a same one to confirm it: *************\n-- Password is _my_password_\n```\n\n#### <a name=\"utility_methods-questionnewpassword-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `true` |\n| [`mask`](#basic_options-mask) | `'*'` |\n| [`limitMessage`](#basic_options-limitmessage) | `'It can include: $<charlist>\\nAnd the length must be: $<length>'` |\n| [`trueValue`](#basic_options-truevalue_falsevalue) | `null` |\n| [`falseValue`](#basic_options-truevalue_falsevalue) | `null` |\n| [`caseSensitive`](#basic_options-casesensitive) | `true` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-keepwhitespace\"><code>keepWhitespace</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td><td><a href=\"#basic_options-print\"><code>print</code></a></td></tr>\n</table>\n\nAnd the following additional options are available.\n\n##### <a name=\"utility_methods-questionnewpassword-options-charlist\"></a>`charlist`\n\n*Type:* string  \n*Default:* `'$<!-~>'`\n\nA string as the characters that can be included in the password. For example, if `'abc123'` is specified, the passwords that include any character other than these 6 characters are refused.  \nThe [placeholders](#placeholders) like `'$<a-e>'` are replaced to the characters like `'abcde'`.  \n\nFor example, let the user input a password that is created with alphabet and some symbols:\n\n```js\npassword = readlineSync.questionNewPassword('PASSWORD: ', {charlist: '$<a-z>#$@%'});\n```\n\n##### <a name=\"utility_methods-questionnewpassword-options-min_max\"></a>`min`, `max`\n\n*Type:* number  \n*Default:* `min`: `12`, `max`: `24`\n\n`min`: A number as a minimum length of the password.  \n`max`: A number as a maximum length of the password.\n\n##### <a name=\"utility_methods-questionnewpassword-options-confirmmessage\"></a>`confirmMessage`\n\n*Type:* string or others  \n*Default:* `'Reinput a same one to confirm it: '`\n\nA message that lets the user input the same password again.  \nIt can include the [placeholders](#placeholders).  \nIf this is not string, it is converted to string (i.e. `toString` method is called).\n\n##### <a name=\"utility_methods-questionnewpassword-options-unmatchmessage\"></a>`unmatchMessage`\n\n*Type:* string or others  \n*Default:* `'It differs from first one. Hit only the Enter key if you want to retry from first one.'`\n\nA warning message that is displayed when the second input did not match first one.  \nThis is converted the same as the [`confirmMessage`](#utility_methods-questionnewpassword-options-confirmmessage) option.\n\n#### <a name=\"utility_methods-questionnewpassword-additional_placeholders\"></a>Additional Placeholders\n\nThe following additional [placeholder](#placeholders) parameters are available.\n\n##### <a name=\"utility_methods-questionnewpassword-additional_placeholders-charlist\"></a>`charlist`\n\nA current value of [`charlist`](#utility_methods-questionnewpassword-options-charlist) option that is converted to human readable if possible. (e.g. `'A...Z'`)\n\n##### <a name=\"utility_methods-questionnewpassword-additional_placeholders-length\"></a>`length`\n\nA current value of [`min` and `max`](#utility_methods-questionnewpassword-options-min_max) option that is converted to human readable. (e.g. `'12...24'`)\n\n### <a name=\"utility_methods-questionint\"></a>`questionInt`\n\n```js\nnumInt = readlineSync.questionInt([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then accept only an input that can be interpreted as an integer, and then return the number (not string) after the Enter key was pressed.  \nThis parses the input as much as possible by `parseInt()`. For example, it interprets `'   5   '`, `'5.6'`, `'005'`, `'5files'`, `'5kb'` and `'5px'` as `5`.\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.\n\n#### <a name=\"utility_methods-questionint-options\"></a>Options\n\nThe following option has independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`limitMessage`](#basic_options-limitmessage) | `'Input valid number, please.'` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-hideechoback\"><code>hideEchoBack</code></a></td><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td></tr>\n<tr><td><a href=\"#basic_options-print\"><code>print</code></a></td><td><a href=\"#basic_options-history\"><code>history</code></a></td></tr>\n</table>\n\n### <a name=\"utility_methods-questionfloat\"></a>`questionFloat`\n\n```js\nnumFloat = readlineSync.questionFloat([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then accept only an input that can be interpreted as a floating-point number, and then return the number (not string) after the Enter key was pressed.  \nThis parses the input as much as possible by `parseFloat()`. For example, it interprets `'   3.14   '`, `'003.1400'`, `'314e-2'` and `'3.14PI'` as `3.14`.\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.\n\n#### <a name=\"utility_methods-questionfloat-options\"></a>Options\n\nThe following option has independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`limitMessage`](#basic_options-limitmessage) | `'Input valid number, please.'` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-hideechoback\"><code>hideEchoBack</code></a></td><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td></tr>\n<tr><td><a href=\"#basic_options-print\"><code>print</code></a></td><td><a href=\"#basic_options-history\"><code>history</code></a></td></tr>\n</table>\n\n### <a name=\"utility_methods-questionpath\"></a>`questionPath`\n\n```js\npath = readlineSync.questionPath([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then accept only a valid local file or directory path, and then return an absolute path after the Enter key was pressed.  \nThe `~` that is input by the user is replaced to the home directory.  \nYou can specify the valid local file or directory path requirement to the options. And you can make it create a new file or directory when it doesn't exist.  \n\nIt is recommended to use this method with the [`cd`](#basic_options-cd) option. (Default: `true`)\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Input path (you can \"cd\" and \"pwd\"): '`.\n\nFor example:\n\n```js\nsourceFile = readlineSync.questionPath('Read from: ', {\n  isFile: true\n});\nconsole.log('-- sourceFile: ' + sourceFile);\n\nsaveDir = readlineSync.questionPath('Save to: ', {\n  isDirectory: true,\n  exists: null,\n  create: true\n});\nconsole.log('-- saveDir: ' + saveDir);\n```\n\n```console\nRead from: ~/fileA\nNo such file or directory: /home/user/fileA\nInput valid path, please.\nRead from: pwd\n/path/to/work\nRead from: cd ~/project-1\nRead from: fileA\n-- sourceFile: /home/user/project-1/fileA\nSave to: ~/deploy/data\n-- saveDir: /home/user/deploy/data\n```\n\n#### <a name=\"utility_methods-questionpath-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n| [`limitMessage`](#basic_options-limitmessage) | `'$<error(\\n)>Input valid path, please.$<( Min:)min>$<( Max:)max>'` |\n| [`history`](#basic_options-history) | `true` |\n| [`cd`](#basic_options-cd) | `true` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td><td><a href=\"#basic_options-print\"><code>print</code></a></td></tr>\n</table>\n\nAnd the following additional options are available.\n\n**Note:** It does not check the coherency about a combination of the options as the path requirement. For example, the `{exists: false, isFile: true}` never check that it is a file because it is limited to the path that does not exist.\n\n##### <a name=\"utility_methods-questionpath-options-exists\"></a>`exists`\n\n*Type:* boolean or others  \n*Default:* `true`\n\nIf `true` is specified, accept only a file or directory path that exists. If `false` is specified, accept only a file or directory path that does *not* exist.  \nIn any other case, the existence is not checked.\n\n##### <a name=\"utility_methods-questionpath-options-min_max\"></a>`min`, `max`\n\n*Type:* number or others  \n*Default:* `undefined`\n\n`min`: A number as a minimum size of the file that is accepted.  \n`max`: A number as a maximum size of the file that is accepted.  \nIf it is not specified or `0` is specified, the size is not checked. (A size of directory is `0`.)\n\n##### <a name=\"utility_methods-questionpath-options-isfile_isdirectory\"></a>`isFile`, `isDirectory`\n\n*Type:* boolean  \n*Default:* `false`\n\n`isFile`: If `true` is specified, accept only a file path.  \n`isDirectory`: If `true` is specified, accept only a directory path.\n\n##### <a name=\"utility_methods-questionpath-options-validate\"></a>`validate`\n\n*Type:* function or `undefined`  \n*Default:* `undefined`\n\nIf a function that returns `true` or an error message is specified, call it with a path that was input, and accept the input when the function returned `true`.  \nIf the function returned a string as an error message, that message is got by the [`error`](#utility_methods-questionpath-additional_placeholders-error) additional [placeholder](#placeholders) parameter.  \nA path that was input is parsed before it is passed to the function. `~` is replaced to a home directory, and a path is converted to an absolute path.  \nThis is also a return value from this method.\n\nFor example, accept only PNG file or tell it to the user:\n\n```js\nimageFile = readlineSync.questionPath('Image File: ', {\n  validate: function(path) { return /\\.png$/i.test(path) || 'It is not PNG'; }\n});\n```\n\n##### <a name=\"utility_methods-questionpath-options-create\"></a>`create`\n\n*Type:* boolean  \n*Default:* `false`\n\nIf `true` is specified, create a file or directory as a path that was input when it doesn't exist. If `true` is specified to the [`isDirectory`](#utility_methods-questionpath-options-isfile_isdirectory) option, create a directory, otherwise a file.  \nIt does not affect the existence check. Therefore, you can get a new file or directory path anytime by specifying: `{exists: false, create: true}`\n\n#### <a name=\"utility_methods-questionpath-additional_placeholders\"></a>Additional Placeholders\n\nThe following additional [placeholder](#placeholders) parameters are available.\n\n##### <a name=\"utility_methods-questionpath-additional_placeholders-error\"></a>`error`\n\nAn error message when the input was not accepted.  \nThis value is set by readlineSync, or the function that was specified to [`validate`](#utility_methods-questionpath-options-validate) option.\n\n##### <a name=\"utility_methods-questionpath-additional_placeholders-min_max\"></a>`min`, `max`\n\nA current value of [`min` and `max`](#utility_methods-questionpath-options-min_max) option.\n\n### <a name=\"utility_methods-promptcl\"></a>`promptCL`\n\n```js\nargsArray = readlineSync.promptCL([commandHandler[, options]])\n```\n\nDisplay a prompt-sign (see [`prompt`](#basic_options-prompt) option) to the user, and then consider the input as a command-line and parse it, and then return a result after the Enter key was pressed.  \nA return value is an Array that includes the tokens that were parsed. It parses the input from the user as the command-line, and it interprets whitespaces, quotes, etc., and it splits it to tokens properly. Usually, a first element of the Array is command-name, and remaining elements are arguments.\n\nFor example:\n\n```js\nargsArray = readlineSync.promptCL();\nconsole.log(argsArray.join('\\n'));\n```\n\n```console\n> command arg \"arg\" \" a r g \" \"\" 'a\"r\"g' \"a\"\"rg\" \"arg\ncommand\narg\narg\n a r g \n\na\"r\"g\narg\narg\n```\n\n#### <a name=\"utility_methods-promptcl-commandhandler\"></a>`commandHandler`\n\nBy using the `commandHandler` argument, this method will come into its own. Specifying the Object to this argument has the more merit. And it has the more merit for [`promptCLLoop`](#utility_methods-promptclloop) method.  \n\nIf a function is specified to `commandHandler` argument, it is just called with a parsed Array as an argument list of the function. And `this` is an original input string, in the function.\n\nFor example, the following 2 codes work same except that `this` is enabled in the second one:\n\n```js\nargsArray = readlineSync.promptCL();\nif (argsArray[0] === 'add') {\n  console.log(argsArray[1] + ' is added.');\n} else if (argsArray[0] === 'copy') {\n  console.log(argsArray[1] + ' is copied to ' + argsArray[2] + '.');\n}\n```\n\n```js\nreadlineSync.promptCL(function(command, arg1, arg2) {\n  console.log('You want to: ' + this); // All of command-line.\n  if (command === 'add') {\n    console.log(arg1 + ' is added.');\n  } else if (command === 'copy') {\n    console.log(arg1 + ' is copied to ' + arg2 + '.');\n  }\n});\n```\n\nIf an Object that has properties named as the command-name is specified, the command-name is interpreted, and a function as the value of matched property is called. A function is chosen properly by handling case of the command-name in accordance with the [`caseSensitive`](#basic_options-casesensitive) option.  \nThe function is called with a parsed Array that excludes a command-name (i.e. first element is removed from the Array) as an argument list of the function.  \nThat is, a structure of the `commandHandler` Object looks like:\n\n```js\n{\n  commandA: function(arg) { ... },        // commandA requires one argument.\n  commandB: function(arg1, arg2) { ... }, // readlineSync doesn't care those.\n  commandC: function() { ... }            // Of course, it can also ignore all.\n}\n```\n\nreadlineSync just receives the arguments from the user and passes those to these functions without checking. The functions may have to check whether the required argument was input by the user, and more validate those.\n\nFor example, the following code works same to the above code:\n\n```js\nreadlineSync.promptCL({\n  add: function(element) { // It's called by also \"ADD\", \"Add\", \"aDd\", etc..\n    console.log(element + ' is added.');\n  },\n  copy: function(from, to) {\n    console.log(from + ' is copied to ' + to + '.');\n  }\n});\n```\n\nIf the matched property is not found in the Object, a `_` property is chosen, and the function as the value of this property is called with a parsed Array as an argument list of the function. Note that this includes a command-name. That is, the function looks like `function(command, arg1, arg2, ...) { ... }`.  \nAnd if the Object doesn't have a `_` property, any command that the matched property is not found in the Object is refused.\n\nFor example:\n\n```js\nreadlineSync.promptCL({\n  copy: function(from, to) { // command-name is not included.\n    console.log(from + ' is copied to ' + to + '.');\n  },\n  _: function(command) { // command-name is included.\n    console.log('Sorry, ' + command + ' is not available.');\n  }\n});\n```\n\n#### <a name=\"utility_methods-promptcl-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n| [`limitMessage`](#basic_options-limitmessage) | `'Requested command is not available.'` |\n| [`caseSensitive`](#basic_options-casesensitive) | `false` |\n| [`history`](#basic_options-history) | `true` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-prompt\"><code>prompt</code></a></td><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td></tr>\n<tr><td><a href=\"#basic_options-print\"><code>print</code></a></td><td><a href=\"#basic_options-cd\"><code>cd</code></a></td></tr>\n</table>\n\n### <a name=\"utility_methods-promptloop\"></a>`promptLoop`\n\n```js\nreadlineSync.promptLoop(inputHandler[, options])\n```\n\nDisplay a prompt-sign (see [`prompt`](#basic_options-prompt) option) to the user, and then call `inputHandler` function with the input from the user after it has been typed and the Enter key was pressed. Do these repeatedly until `inputHandler` function returns `true`.\n\nFor example, the following 2 codes work same:\n\n```js\nwhile (true) {\n  input = readlineSync.prompt();\n  console.log('-- You said \"' + input + '\"');\n  if (input === 'bye') {\n    break;\n  }\n}\nconsole.log('It\\'s exited from loop.');\n```\n\n```js\nreadlineSync.promptLoop(function(input) {\n  console.log('-- You said \"' + input + '\"');\n  return input === 'bye';\n});\nconsole.log('It\\'s exited from loop.');\n```\n\n```console\n> hello\n-- You said \"hello\"\n> good morning\n-- You said \"good morning\"\n> bye\n-- You said \"bye\"\nIt's exited from loop.\n```\n\n#### <a name=\"utility_methods-promptloop-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n| [`trueValue`](#basic_options-truevalue_falsevalue) | `null` |\n| [`falseValue`](#basic_options-truevalue_falsevalue) | `null` |\n| [`caseSensitive`](#basic_options-casesensitive) | `false` |\n| [`history`](#basic_options-history) | `true` |\n\nThe other options work as shown in the [Basic Options](#basic_options) section.\n\n### <a name=\"utility_methods-promptclloop\"></a>`promptCLLoop`\n\n```js\nreadlineSync.promptCLLoop([commandHandler[, options]])\n```\n\nExecute [`promptCL`](#utility_methods-promptcl) method repeatedly until chosen [`commandHandler`](#utility_methods-promptcl-commandhandler) returns `true`.  \nThe [`commandHandler`](#utility_methods-promptcl-commandhandler) may be a function that is called like:\n\n```js\nexit = allCommands(command, arg1, arg2, ...);\n```\n\nor an Object that has the functions that are called like:\n\n```js\nexit = foundCommand(arg1, arg2, ...);\n```\n\nSee [`promptCL`](#utility_methods-promptcl) method for details.  \nThis method looks like a combination of [`promptCL`](#utility_methods-promptcl) method and [`promptLoop`](#utility_methods-promptloop) method.\n\nFor example:\n\n```js\nreadlineSync.promptCLLoop({\n  add: function(element) {\n    console.log(element + ' is added.');\n  },\n  copy: function(from, to) {\n    console.log(from + ' is copied to ' + to + '.');\n  },\n  bye: function() { return true; }\n});\nconsole.log('It\\'s exited from loop.');\n```\n\n```console\n> add \"New Hard Disk\"\nNew Hard Disk is added.\n> move filesOnOld \"New Hard Disk\"\nRequested command is not available.\n> copy filesOnOld \"New Hard Disk\"\nfilesOnOld is copied to New Hard Disk.\n> bye\nIt's exited from loop.\n```\n\n#### <a name=\"utility_methods-promptclloop-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n| [`limitMessage`](#basic_options-limitmessage) | `'Requested command is not available.'` |\n| [`caseSensitive`](#basic_options-casesensitive) | `false` |\n| [`history`](#basic_options-history) | `true` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-prompt\"><code>prompt</code></a></td><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-defaultinput\"><code>defaultInput</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-buffersize\"><code>bufferSize</code></a></td></tr>\n<tr><td><a href=\"#basic_options-print\"><code>print</code></a></td><td><a href=\"#basic_options-cd\"><code>cd</code></a></td></tr>\n</table>\n\n### <a name=\"utility_methods-promptsimshell\"></a>`promptSimShell`\n\n```js\ninput = readlineSync.promptSimShell([options])\n```\n\nDisplay a prompt-sign that is similar to that of the user's shell to the user, and then return the input from the user after it has been typed and the Enter key was pressed.  \nThis method displays a prompt-sign like:\n\nOn Windows:\n\n```console\nC:\\Users\\User\\Path\\To\\Directory>\n```\n\nOn others:\n\n```console\nuser@host:~/path/to/directory$ \n```\n\n#### <a name=\"utility_methods-promptsimshell-options\"></a>Options\n\nThe following options have independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n| [`history`](#basic_options-history) | `true` |\n\nThe other options other than [`prompt`](#basic_options-prompt) option work as shown in the [Basic Options](#basic_options) section.\n\n### <a name=\"utility_methods-keyinyn\"></a>`keyInYN`\n\n```js\nboolYesOrEmpty = readlineSync.keyInYN([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then return a boolean or an empty string immediately a key was pressed by the user, **without pressing the Enter key**. Note that the user has no chance to change the input.  \nThis method works like the `window.confirm` method of web browsers. A return value means \"Yes\" or \"No\" the user said. It differ depending on the pressed key:\n\n* `Y`: `true`\n* `N`: `false`\n* other: `''`\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Are you sure? '`.\n\nThe keys other than `Y` and `N` are also accepted (If you want to know a user's wish explicitly, use [`keyInYNStrict`](#utility_methods-keyinynstrict) method). Therefore, if you let the user make an important decision (e.g. files are removed), check whether the return value is not *falsy*. That is, a default is \"No\".\n\nFor example:\n\n```js\nif (!readlineSync.keyInYN('Do you want to install this?')) {\n  // Key that is not `Y` was pressed.\n  process.exit();\n}\n// Do something...\n```\n\nOr if you let the user stop something that must be done (e.g. something about the security), check whether the return value is `false` explicitly. That is, a default is \"Yes\".\n\nFor example:\n\n```js\n// Don't use `(!readlineSync.keyInYN())`.\nif (readlineSync.keyInYN('Continue virus scan?') === false) {\n  // `N` key was pressed.\n  process.exit();\n}\n// Continue...\n```\n\n#### <a name=\"utility_methods-keyinyn-options\"></a>Options\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-print\"><code>print</code></a></td></tr>\n</table>\n\nAnd the following additional option is available.\n\n##### <a name=\"utility_methods-keyinyn-options-guide\"></a>`guide`\n\n*Type:* boolean  \n*Default:* `true`\n\nIf `true` is specified, a string `'[y/n]'` as guide for the user is added to `query`. And `':'` is moved to the end of `query`, or it is added.\n\nFor example:\n\n```js\nreadlineSync.keyInYN('Do you like me?'); // No colon\nreadlineSync.keyInYN('Really? :'); // Colon already exists\n```\n\n```console\nDo you like me? [y/n]: y\nReally? [y/n]: y\n```\n\n### <a name=\"utility_methods-keyinynstrict\"></a>`keyInYNStrict`\n\n```js\nboolYes = readlineSync.keyInYNStrict([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then accept only `Y` or `N` key, and then return a boolean immediately it was pressed by the user, **without pressing the Enter key**. Note that the user has no chance to change the input.  \nThis method works like the `window.confirm` method of web browsers. A return value means \"Yes\" or \"No\" the user said. It differ depending on the pressed key:\n\n* `Y`: `true`\n* `N`: `false`\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Are you sure? '`.\n\nA key other than `Y` and `N` is not accepted. That is, a return value has no default. Therefore, the user has to tell an own wish explicitly. If you want to know a user's wish easily, use [`keyInYN`](#utility_methods-keyinyn) method.\n\nThis method works same to [`keyInYN`](#utility_methods-keyinyn) method except that this accept only `Y` or `N` key (Therefore, a return value is boolean every time). The options also work same to [`keyInYN`](#utility_methods-keyinyn) method.\n\n### <a name=\"utility_methods-keyinpause\"></a>`keyInPause`\n\n```js\nreadlineSync.keyInPause([query[, options]])\n```\n\nDisplay a `query` to the user if it's specified, and then just wait for a key to be pressed by the user.  \nThis method works like the `window.alert` method of web browsers. This is used to make the running of script pause and show something to the user, or wait for the user to be ready.  \nBy default, any key is accepted (See: [Note](#utility_methods-keyinpause-note)). You can change this behavior by specifying [`limit`](#basic_options-limit) option  (e.g. accept only a Space Bar).\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Continue...'`.\n\nFor example:\n\n```js\n// Have made the preparations for something...\nconsole.log('==== Information of Your Computer ====');\nconsole.log(info); // This can be `query`.\nreadlineSync.keyInPause();\nconsole.log('It\\'s executing now...');\n// Do something...\n```\n\n```console\n==== Information of Your Computer ====\nFOO: 123456\nBAR: abcdef\nContinue... (Hit any key)\nIt's executing now...\n```\n\n#### <a name=\"utility_methods-keyinpause-options\"></a>Options\n\nThe following option has independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`limit`](#basic_options-limit) | `null` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-casesensitive\"><code>caseSensitive</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-print\"><code>print</code></a></td></tr>\n</table>\n\nAnd the following additional option is available.\n\n##### <a name=\"utility_methods-keyinpause-options-guide\"></a>`guide`\n\n*Type:* boolean  \n*Default:* `true`\n\nIf `true` is specified, a string `'(Hit any key)'` as guide for the user is added to `query`.\n\nFor example:\n\n```js\nreadlineSync.keyInPause('It\\'s pausing now...');\n```\n\n```console\nIt's pausing now... (Hit any key)\n```\n\n#### <a name=\"utility_methods-keyinpause-note\"></a>Note\n\nControl keys including Enter key are not accepted by `keyIn*` methods.  \nIf you want to wait until the user presses Enter key, use `question*` methods instead of `keyIn*` methods. For example:\n\n```js\nreadlineSync.question('Hit Enter key to continue.', {hideEchoBack: true, mask: ''});\n```\n\n### <a name=\"utility_methods-keyinselect\"></a>`keyInSelect`\n\n```js\nindex = readlineSync.keyInSelect(items[, query[, options]])\n```\n\nDisplay the list that was created with the `items` Array, and the `query` to the user if it's specified, and then return the number as an index of the `items` Array immediately it was chosen by pressing a key by the user, **without pressing the Enter key**. Note that the user has no chance to change the input.\n\nThe `query` is handled the same as that of the [`question`](#basic_methods-question) method.  \nThe default value of `query` is `'Choose one from list: '`.\n\nThe minimum length of `items` Array is 1 and maximum length is 35. These elements are displayed as item list. A key to let the user choose an item is assigned to each item automatically in sequence like \"1, 2, 3 ... 9, A, B, C ...\". A number as an index of the `items` Array that corresponds to a chosen item by the user is returned.\n\n**Note:** Even if the `items` Array has only less than 35 items, a long Array that forces an user to scroll the list may irritate the user. Remember, the user might be in a console environment that doesn't support scrolling the screen. If you want to use a long `items` Array (e.g. more than 10 items), you should consider a \"Pagination\". (See [example](https://github.com/anseki/readline-sync/issues/60#issuecomment-324533678).)\n\nFor example:\n\n```js\nframeworks = ['Express', 'hapi', 'flatiron', 'MEAN.JS', 'locomotive'];\nindex = readlineSync.keyInSelect(frameworks, 'Which framework?');\nconsole.log(frameworks[index] + ' is enabled.');\n```\n\n```console\n[1] Express\n[2] hapi\n[3] flatiron\n[4] MEAN.JS\n[5] locomotive\n[0] CANCEL\n\nWhich framework? [1...5 / 0]: 2\nhapi is enabled.\n```\n\n#### <a name=\"utility_methods-keyinselect-options\"></a>Options\n\nThe following option has independent default value that is not affected by [Default Options](#basic_options).\n\n| Option Name       | Default Value |\n|-------------------|---------------|\n| [`hideEchoBack`](#basic_options-hideechoback) | `false` |\n\nThe following options work as shown in the [Basic Options](#basic_options) section.\n\n<table>\n<tr><td><a href=\"#basic_options-mask\"><code>mask</code></a></td><td><a href=\"#basic_options-encoding\"><code>encoding</code></a></td><td><a href=\"#basic_options-print\"><code>print</code></a></td></tr>\n</table>\n\nAnd the following additional options are available.\n\n##### <a name=\"utility_methods-keyinselect-options-guide\"></a>`guide`\n\n*Type:* boolean  \n*Default:* `true`\n\nIf `true` is specified, a string like `'[1...5]'` as guide for the user is added to `query`. And `':'` is moved to the end of `query`, or it is added. This is the key list that corresponds to the item list.\n\n##### <a name=\"utility_methods-keyinselect-options-cancel\"></a>`cancel`\n\n*Type:* boolean, string or others  \n*Default:* `'CANCEL'`\n\nIf a value other than `false` is specified, an item to let the user tell \"cancel\" is added to the item list. \"[0] CANCEL\" (default) is displayed, and if `0` key is pressed, `-1` is returned.  \nYou can specify a label of this item other than `'CANCEL'`. A string such as `'Go back'` (empty string `''` also), something that is converted to string such as `Date`, a string that includes [placeholder](#placeholders) such as `'Next $<itemsCount> items'` are accepted.\n\n#### <a name=\"utility_methods-keyinselect-additional_placeholders\"></a>Additional Placeholders\n\nThe following additional [placeholder](#placeholders) parameters are available.\n\n##### <a name=\"utility_methods-keyinselect-additional_placeholders-itemscount\"></a>`itemsCount`\n\nA length of a current `items` Array.\n\nFor example:\n\n```js\nitems = ['item-A', 'item-B', 'item-C', 'item-D', 'item-E'];\nindex = readlineSync.keyInSelect(items, null,\n  {cancel: 'Show more than $<itemsCount> items'});\n```\n\n```console\n[1] item-A\n[2] item-B\n[3] item-C\n[4] item-D\n[5] item-E\n[0] Show more than 5 items\n```\n\n##### <a name=\"utility_methods-keyinselect-additional_placeholders-firstitem\"></a>`firstItem`\n\nA first item in a current `items` Array.\n\nFor example:\n\n```js\nindex = readlineSync.keyInSelect(items, 'Choose $<firstItem> or another: ');\n```\n\n##### <a name=\"utility_methods-keyinselect-additional_placeholders-lastitem\"></a>`lastItem`\n\nA last item in a current `items` Array.\n\nFor example:\n\n```js\nitems = ['January', 'February', 'March', 'April', 'May', 'June'];\nindex = readlineSync.keyInSelect(items, null,\n  {cancel: 'In after $<lastItem>'});\n```\n\n```console\n[1] January\n[2] February\n[3] March\n[4] April\n[5] May\n[6] June\n[0] In after June\n```\n\n## <a name=\"placeholders\"></a>Placeholders\n\n[`hideEchoBack`, `mask`, `defaultInput`, `caseSensitive`, `keepWhitespace`, `encoding`, `bufferSize`, `history`, `cd`, `limit`, `trueValue`, `falseValue`](#placeholders-parameters-hideechoback_mask_defaultinput_casesensitive_keepwhitespace_encoding_buffersize_history_cd_limit_truevalue_falsevalue), [`limitCount`, `limitCountNotZero`](#placeholders-parameters-limitcount_limitcountnotzero), [`lastInput`](#placeholders-parameters-lastinput), [`history_mN`](#placeholders-parameters-historymn), [`cwd`, `CWD`, `cwdHome`](#placeholders-parameters-cwd_cwd_cwdhome), [`date`, `time`, `localeDate`, `localeTime`](#placeholders-parameters-date_time_localedate_localetime), [`C1-C2`](#placeholders-parameters-c1_c2)\n\nThe placeholders in the text are replaced to another string.\n\nFor example, the [`limitMessage`](#basic_options-limitmessage) option to display a warning message that means that the command the user requested is not available:\n\n```js\ncommand = readlineSync.prompt({\n  limit: ['add', 'remove'],\n  limitMessage: '$<lastInput> is not available.'\n});\n```\n\n```console\n> delete\ndelete is not available.\n```\n\nThe placeholders can be included in:\n\n* `query` argument\n* [`prompt`](#basic_options-prompt) and [`limitMessage`](#basic_options-limitmessage) options\n* [`limit` option for `keyIn*` method](#basic_options-limit-for_keyin_method) and [`charlist`](#utility_methods-questionnewpassword-options-charlist) option for [`questionNewPassword`](#utility_methods-questionnewpassword) method ([`C1-C2`](#placeholders-parameters-c1_c2) parameter only)\n* And some additional options for the [Utility Methods](#utility_methods).\n\n### <a name=\"placeholders-syntax\"></a>Syntax\n\n```\n$<parameter>\n```\n\nOr\n\n```\n$<(text1)parameter(text2)>\n```\n\nThe placeholder is replaced to a string that is got by a `parameter`.  \nBoth the `(text1)` and `(text2)` are optional.  \nA more added `'$'` at the left of the placeholder is used as an escape character, it disables a placeholder. For example, `'$$<foo>'` is replaced to `'$<foo>'`. If you want to put a `'$'` which is *not* an escape character at the left of a placeholder, specify it like `'$<($)bufferSize>'`, then it is replaced to `'$1024'`.\n\nAt the each position of `'(text1)'` and `'(text2)'`, `'text1'` and `'text2'` are put when a string that was got by a `parameter` has more than 0 length. If that got string is `''`, a placeholder with or without `'(text1)'` and `'(text2)'` is replaced to `''`.\n\nFor example, a warning message that means that the command the user requested is not available:\n\n```js\ncommand = readlineSync.prompt({\n  limit: ['add', 'remove'],\n  limitMessage: 'Refused $<lastInput> you requested. Please input another.'\n});\n```\n\n```console\n> give-me-car\nRefused give-me-car you requested. Please input another.\n```\n\nIt looks like no problem.  \nBut when the user input nothing (hit only the Enter key), and then a message is displayed:\n\n```console\n> \nRefused  you requested. Please input another.\n```\n\nThis goes well:\n\n```js\ncommand = readlineSync.prompt({\n  limit: ['add', 'remove'],\n  limitMessage: 'Refused $<lastInput( you requested)>. Please input another.'\n});\n```\n\n```console\n> \nRefused . Please input another.\n```\n\n(May be more better: `'$<(Refused )lastInput( you requested. )>Please input another.'`)\n\n**Note:** The syntax `${parameter}` of older version is still supported, but this should not be used because it may be confused with template string syntax of ES6. And this will not be supported in due course of time.\n\n### <a name=\"placeholders-parameters\"></a>Parameters\n\nThe following parameters are available. And some additional parameters are available in the [Utility Methods](#utility_methods).\n\n#### <a name=\"placeholders-parameters-hideechoback_mask_defaultinput_casesensitive_keepwhitespace_encoding_buffersize_history_cd_limit_truevalue_falsevalue\"></a>`hideEchoBack`, `mask`, `defaultInput`, `caseSensitive`, `keepWhitespace`, `encoding`, `bufferSize`, `history`, `cd`, `limit`, `trueValue`, `falseValue`\n\nA current value of each option.  \nIt is converted to human readable if possible. The boolean value is replaced to `'on'` or `'off'`, and the Array is replaced to the list of only string and number elements.  \nAnd in the `keyIn*` method, the parts of the list as characters sequence are suppressed. For example, when `['a', 'b', 'c', 'd', 'e']` is specified to the [`limit`](#basic_options-limit) option, `'$<limit>'` is replaced to `'a...e'`. If `true` is specified to the [`caseSensitive`](#basic_options-casesensitive) option, the characters are converted to lower case.\n\nFor example:\n\n```js\ninput = readlineSync.question(\n  'Input something or the Enter key as \"$<defaultInput>\": ',\n  {defaultInput: 'hello'}\n);\n```\n\n```console\nInput something or the Enter key as \"hello\":\n```\n\n#### <a name=\"placeholders-parameters-limitcount_limitcountnotzero\"></a>`limitCount`, `limitCountNotZero`\n\nA length of a current value of the [`limit`](#basic_options-limit) option.  \nWhen the value of the [`limit`](#basic_options-limit) option is empty, `'$<limitCount>'` is replaced to `'0'`, `'$<limitCountNotZero>'` is replaced to `''`.\n\nFor example:\n\n```js\naction = readlineSync.question(\n  'Choose action$<( from )limitCountNotZero( actions)>: ',\n  {limit: availableActions}\n);\n```\n\n```console\nChoose action from 5 actions:\n```\n\n#### <a name=\"placeholders-parameters-lastinput\"></a>`lastInput`\n\nA last input from the user.  \nIn any case, this is saved.\n\nFor example:\n\n```js\ncommand = readlineSync.prompt({\n  limit: availableCommands,\n  limitMessage: '$<lastInput> is not available.'\n});\n```\n\n```console\n> wrong-command\nwrong-command is not available.\n```\n\n#### <a name=\"placeholders-parameters-historymn\"></a>`history_mN`\n\nWhen the history expansion feature is enabled (see [`history`](#basic_opt",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{b8/d6/13aaaa00ff3c87060f98476d960bcc617c74dbddd03b7320a7d36d17bdbc72bee84205e4319932e99164af03cefdfd928fc465d8c33073920cd4e1895ae3 → 96/b7/dbe2bf715c2e46e3dd1bfc6b7cffa52efe869e7d0ae4494f95f12cbb0eea4fbad55b4dcb1442e4e582733925719b9329ad0e3cf5532b396219a37870959c}

@@ -826,7 +826,7 @@
   "dist-tags": {
     "latest": "5.2.0"
   },
-  "_rev": "388-fedf7e089f72dc9d",
+  "_rev": "395-c01e7274e6b5163f",
   "_id": "@aws-crypto/sha1-browser",
   "readme": "# @aws-crypto/sha1-browser\n\nSHA1 wrapper for browsers that prefers `window.crypto.subtle`.\n\nSHA1 is **NOT** a cryptographically secure algorithm.\nIt should _only_ be used for non cryptographic functions like checksums.\n\n## Usage\n\n```\nimport {Sha1} from '@aws-crypto/sha1-browser'\n\nconst hash = new Sha1();\nhash.update('some data');\nconst result = await hash.digest();\n\n```\n\n## Test\n\n`npm test`",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{84/d8/f97f1f08a4459ec532ed0088c43a8607b7400bd975755812def2d4092119df0cb568e073b9dc40319bfa02105505ef4acc9276f8ad8a54a74fa591fa0f18 → 98/dc/2c203dda8b5ecb6b00c5c388f5a08a716478f209577431e361513476de1f533fef451ef4d4449e698ac6b27847b6fdaba5b7e2aa0ea18990a10b585ac7bd}

@@ -22808,7 +22808,7 @@
     "latest": "5.8.0",
     "legacy": "4.5.6"
   },
-  "_rev": "1107-c742fcce02d38dab",
+  "_rev": "1118-1b105bc30d0e2b3a",
   "_id": "fast-xml-parser",
   "readme": "# [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser)\n\n[![NPM total downloads](https://img.shields.io/npm/dt/fast-xml-parser.svg)](https://npm.im/fast-xml-parser)\n\nValidate XML, Parse XML to JS Object, or Build XML from JS Object without C/C++ based libraries and no callback.\n\n<img align=\"right\" src=\"static/img/fxp_logo.png\" width=\"180px\" alt=\"FXP logo\"/>\n\n* Validate XML data syntactically. Use [detailed-xml-validator](https://github.com/NaturalIntelligence/detailed-xml-validator/) to verify business rules.\n* Parse XML to JS Objects and vice versa\n* Common JS, ESM, and browser compatible\n* Faster than any other pure JS implementation.\n\nIt can handle big files (tested up to 100mb). XML Entities, HTML entities, and DOCTYPE entites are supported. Unpaired tags (Eg `<br>` in HTML), stop nodes (Eg `<script>` in HTML) are supported. It can also preserve Order of tags in JS object\n\n> [Flexible-XML-Parser](https://github.com/nodable/flexible-xml-parser) is 2 times faster than this library and allows to deal with incomplete XML/HTML. Output is highly customizable. Build whatever you want. So if you're fine with some extra configuration then try it out.\n\n---\n# Your Support, Our Motivation\n\nPlease join [Discord community](https://discord.gg/X4Qp9u6Vz) for pre release announcements and discussions. This will prevent us to release breaking changes.\n\n\n\n<!-- ## Try out our New Thoughts\n\n- WishIn - You need it if negative thoughts take over all the time <br>\n<a href=\"https://play.google.com/store/apps/details?id=com.solothought.wishin\"> <img src=\"https://solothought.com/products/assets/images/wishin/YouTubeThumbnail.png\" width=\"500px\"/> </a>\n- **Flowgger**: 90% less logs size and 90% less debugging time<br>\n<a href=\"https://github.com/solothought/flowgger\"> <img src=\"static/img/flowgger_h.webp\" alt=\"Flowgger Logging Framework\" width=\"300px\"/></a>\n- [Text2Chart](https://solothought.com/text2chart/flow): interactive flow chart out of simple text. -->\n\n## Financial Support\n\nSponsor this project\n\n<a href=\"https://github.com/sponsors/NaturalIntelligence\"> \n  <img src=\"https://raw.githubusercontent.com/NaturalIntelligence/ThankYouBackers/main/github_sponsor.png\" width=\"180\" />\n</a>\n<a href=\"https://opencollective.com/fast-xml-parser/donate\" target=\"_blank\">\n  <img src=\"https://opencollective.com/fast-xml-parser/donate/button@2x.png?color=blue\" width=180 />\n</a>\n<br>\n<br>\n<br>\n\n> This is a donation. No goods or services are expected in return. Any requests for refunds for those purposes will be rejected.\n\n## Users\n\n<a href=\"https://github.com/renovatebot/renovate\" title=\"renovate\" ><img src=\"https://avatars1.githubusercontent.com/u/38656520\" width=\"60px\" ></a>\n<a href=\"https://vmware.com/\" title=\"vmware\" > <img src=\"https://avatars0.githubusercontent.com/u/473334\" width=\"60px\" ></a>\n<a href=\"https://opensource.microsoft.com/\" title=\"microsoft\" > <img src=\"https://avatars0.githubusercontent.com/u/6154722\" width=\"60px\" ></a>\n<a href=\"http://ibm.github.io/\" title=\"IBM\" > <img src=\"https://avatars2.githubusercontent.com/u/1459110\" width=\"60px\" ></a>\n<a href=\"http://www.smartbear.com\" title=\"SmartBear Software\" > <img src=\"https://avatars2.githubusercontent.com/u/1644671\" width=\"60px\" ></a>\n<a href=\"http://nasa.github.io/\" title=\"NASA\" > <img src=\"https://avatars0.githubusercontent.com/u/848102\" width=\"60px\" ></a>\n<a href=\"https://github.com/prettier\" title=\"Prettier\" > <img src=\"https://avatars0.githubusercontent.com/u/25822731\" width=\"60px\" ></a>\n<a href=\"http://brain.js.org/\" title=\"brain.js\" > <img src=\"https://avatars2.githubusercontent.com/u/23732838\" width=\"60px\" ></a>\n<a href=\"https://github.com/aws\" title=\"AWS SDK\" > <img src=\"https://avatars.githubusercontent.com/u/2232217\" width=\"60px\" ></a>\n<a href=\"http://www.fda.gov/\" title=\"Food and Drug Administration \" > <img src=\"https://avatars2.githubusercontent.com/u/6471964\" width=\"60px\" ></a>\n<a href=\"http://www.magento.com/\" title=\"Magento\" > <img src=\"https://avatars2.githubusercontent.com/u/168457\" width=\"60px\" ></a>\n<a href=\"https://github.com/SAP\" title=\"SAP\" > <img src=\"https://user-images.githubusercontent.com/7692328/204835214-d9d25b58-e3df-408d-87a3-c7d36b578ee4.png\" width=\"60px\" ></a>\n<a href=\"https://github.com/postmanlabs\" title=\"postman\" > <img src=\"https://user-images.githubusercontent.com/7692328/204835529-e9e290ad-696a-49ad-9d34-08e955704715.png\" width=\"60px\" ></a>\n<a href=\"https://github.com/react-native-community\" title=\"React Native Community\" > <img src=\"https://avatars.githubusercontent.com/u/20269980?v=4\" width=\"60px\" ></a>\n<a href=\"https://github.com/googleapis\" title=\"Google APIs\" > <img src=\"https://avatars.githubusercontent.com/u/16785467?v=4\" width=\"60px\" ></a>\n<a href=\"https://github.com/langchain-ai\" title=\"Langchain AI\" > <img src=\"https://avatars.githubusercontent.com/u/126733545?v=4\" width=\"60px\" ></a>\n<a href=\"https://github.com/withastro\" title=\"Astro websie builder\" > <img src=\"https://avatars.githubusercontent.com/u/44914786?v=4\" width=\"60px\" ></a>\n<a href=\"https://github.com/baidu\" title=\"Baidu\" > <img src=\"https://avatars.githubusercontent.com/u/13245940?v=4\" width=\"60px\" ></a>\n[more](./USERs.md)\n\n<small>The list of users are mostly published by Github or communicated directly. Feel free to contact if you find any information wrong.</small>\n\n---\n\n# More about this library\n\n## How to use\n\nTo use as package dependency\n`$ npm install fast-xml-parser` \nor \n`$ yarn add fast-xml-parser`\n\nTo use as system command\n`$ npm install fast-xml-parser -g` \n\nTo use it on a **webpage** include it from a [CDN](https://cdnjs.com/libraries/fast-xml-parser)\n\n**Example**\n\nAs CLI command\n```bash\n$ fxparser some.xml\n```\n\nIn a node js project\n```js\nconst { XMLParser, XMLBuilder, XMLValidator} = require(\"fast-xml-parser\");\n\nconst parser = new XMLParser();\nlet jObj = parser.parse(XMLdata);\n\nconst builder = new XMLBuilder();\nconst xmlContent = builder.build(jObj);\n```\n\nIn a HTML page\n```html\n<script src=\"path/to/fxp.min.js\"></script>\n:\n<script>\n  const parser = new fxparser.XMLParser();\n  parser.parse(xmlContent);\n</script>\n```\n\nBundle size\n\n| Bundle Name        | Size |\n| ------------------ | ---- |\n| fxbuilder.min.js   | 6.5K |\n| fxparser.min.js    | 20K  |\n| fxp.min.js         | 26K  |\n| fxvalidator.min.js | 5.7K |\n\n## Documents\n<table>\n  <tr><td>v3</td><td>v4 and v5</td><td>v6</td></tr>\n  <tr>\n    <td>\n      <a href=\"./docs/v3/docs.md\">documents</a>\n    </td>\n    <td><ol>\n      <li><a href=\"./docs/v4,v5/1.GettingStarted.md\">Getting Started</a></li>\n      <li><a href=\"./docs/v4,v5/2.XMLparseOptions.md\">XML Parser</a></li>\n      <li><a href=\"./docs/v4,v5/3.XMLBuilder.md\">XML Builder</a></li>\n      <li><a href=\"./docs/v4,v5/4.XMLValidator.md\">XML Validator</a></li>\n      <li><a href=\"./docs/v4,v5/5.Entities.md\">Entities</a></li>\n      <li><a href=\"./docs/v4,v5/6.HTMLParsing.md\">HTML Document Parsing</a></li>\n      <li><a href=\"./docs/v4,v5/7.PITags.md\">PI Tag processing</a></li>\n      <li><a href=\"./docs/v4,v5/8.PathExpression.md\">Path Expression</a></li>\n    </ol></td>\n    <td><ol>\n      <li></li><a href=\"./docs/v6/1.GettingStarted.md\">Getting Started</a></li>\n    </ol></td>\n  </tr>\n</table>\n\n**note**: \n- Version 6 is released with version 4 for experimental use. Based on its demand, it'll be developed and the features can be different in final release.\n- Version 5 has the same functionalities as version 4.\n\n## Performance\n<small>negative means error</small>\n\n### XML Parser\n\n<img align=\"left\" src=\"./docs/imgs/XMLParser_v4.png\" width=\"45%\" />\n<img src=\"./docs/imgs/XMLParser_large_v4.png\" width=\"47%\" />\n\n* Y-axis: requests per second\n* X-axis: File size\n\n### XML Builder\n\n<img src=\"./docs/imgs/XMLBuilder_v4.png\" width=\"50%\" />\n* Y-axis: requests per second\n\n<!-- [![](static/img/ni_ads_ads.gif)](https://github.com/NaturalIntelligence/ads/) -->\n\n---\n\n## Usage Trend\n\n[Usage Trend of fast-xml-parser](https://npm-compare.com/fast-xml-parser#timeRange=THREE_YEARS)\n  \n<a href=\"https://npm-compare.com/fast-xml-parser#timeRange=THREE_YEARS\" target=\"_blank\">\n  <img src=\"https://npm-compare.com/img/npm-trend/THREE_YEARS/fast-xml-parser.png\" width=\"50%\" alt=\"NPM Usage Trend of fast-xml-parser\" />\n</a>\n\n# Supporters\n#### Contributors\n\nThis project exists thanks to [all](graphs/contributors) the people who contribute. [[Contribute](docs/CONTRIBUTING.md)].\n\n<a href=\"graphs/contributors\"><img src=\"https://opencollective.com/fast-xml-parser/contributors.svg?width=890&button=false\" /></a>\n\n\n#### Backers from Open collective\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/fast-xml-parser#backer)]\n\n<a href=\"https://opencollective.com/fast-xml-parser#backers\" target=\"_blank\"><img src=\"https://opencollective.com/fast-xml-parser/backers.svg?width=890\"></a>\n\n\n\n# License\n* MIT License\n\n![Donate $5](static/img/donation_quote.png)",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{0e/4a/f9ee925d60c68df4d5afb05b662e6a3f1a7d57ef4e0e6c2091d3137cce07dbf72768d7f215d9b72e4ad72bf9cb4ba83ee992074cda591fe0e94a13270645 → 99/1a/0223dbe24ac21814c3ad5ea76d541c2b14434fa40aff00d21fc801cb1080f1eb4447bcb462310c5dead90984e966481c78ec7699713b0bbd7fb85bee3708}

@@ -10535,7 +10535,7 @@
     "latest": "0.7.6",
     "next": "0.8.0-beta.0"
   },
-  "_rev": "7156-1c965ce9e84579a7",
+  "_rev": "7173-10ba19d27e885028",
   "_id": "source-map",
   "readme": "# Source Map\n\n[![NPM](https://nodei.co/npm/source-map.png?downloads=true&downloadRank=true)](https://www.npmjs.com/package/source-map)\n\nThis is a library to generate and consume the source map format\n[described here][format].\n\n[format]: https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit\n\n## Use with Node\n\n    $ npm install source-map\n\n## Use on the Web\n\n```html\n<script src=\"https://unpkg.com/source-map@0.7.3/dist/source-map.js\"></script>\n<script>\n  sourceMap.SourceMapConsumer.initialize({\n    \"lib/mappings.wasm\": \"https://unpkg.com/source-map@0.7.3/lib/mappings.wasm\",\n  });\n</script>\n```\n\n---\n\n## Table of Contents\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n\n- [Examples](#examples)\n  - [Consuming a source map](#consuming-a-source-map)\n  - [Generating a source map](#generating-a-source-map)\n    - [With SourceNode (high level API)](#with-sourcenode-high-level-api)\n    - [With SourceMapGenerator (low level API)](#with-sourcemapgenerator-low-level-api)\n- [API](#api)\n  - [SourceMapConsumer](#sourcemapconsumer)\n    - [SourceMapConsumer.initialize(options)](#sourcemapconsumerinitializeoptions)\n    - [new SourceMapConsumer(rawSourceMap)](#new-sourcemapconsumerrawsourcemap)\n    - [SourceMapConsumer.with](#sourcemapconsumerwith)\n    - [SourceMapConsumer.prototype.destroy()](#sourcemapconsumerprototypedestroy)\n    - [SourceMapConsumer.prototype.computeColumnSpans()](#sourcemapconsumerprototypecomputecolumnspans)\n    - [SourceMapConsumer.prototype.originalPositionFor(generatedPosition)](#sourcemapconsumerprototypeoriginalpositionforgeneratedposition)\n    - [SourceMapConsumer.prototype.generatedPositionFor(originalPosition)](#sourcemapconsumerprototypegeneratedpositionfororiginalposition)\n    - [SourceMapConsumer.prototype.allGeneratedPositionsFor(originalPosition)](#sourcemapconsumerprototypeallgeneratedpositionsfororiginalposition)\n    - [SourceMapConsumer.prototype.hasContentsOfAllSources()](#sourcemapconsumerprototypehascontentsofallsources)\n    - [SourceMapConsumer.prototype.sourceContentFor(source[, returnNullOnMissing])](#sourcemapconsumerprototypesourcecontentforsource-returnnullonmissing)\n    - [SourceMapConsumer.prototype.eachMapping(callback, context, order)](#sourcemapconsumerprototypeeachmappingcallback-context-order)\n  - [SourceMapGenerator](#sourcemapgenerator)\n    - [new SourceMapGenerator([startOfSourceMap])](#new-sourcemapgeneratorstartofsourcemap)\n    - [SourceMapGenerator.fromSourceMap(sourceMapConsumer)](#sourcemapgeneratorfromsourcemapsourcemapconsumer)\n    - [SourceMapGenerator.prototype.addMapping(mapping)](#sourcemapgeneratorprototypeaddmappingmapping)\n    - [SourceMapGenerator.prototype.setSourceContent(sourceFile, sourceContent)](#sourcemapgeneratorprototypesetsourcecontentsourcefile-sourcecontent)\n    - [SourceMapGenerator.prototype.applySourceMap(sourceMapConsumer[, sourceFile[, sourceMapPath]])](#sourcemapgeneratorprototypeapplysourcemapsourcemapconsumer-sourcefile-sourcemappath)\n    - [SourceMapGenerator.prototype.toString()](#sourcemapgeneratorprototypetostring)\n  - [SourceNode](#sourcenode)\n    - [new SourceNode([line, column, source[, chunk[, name]]])](#new-sourcenodeline-column-source-chunk-name)\n    - [SourceNode.fromStringWithSourceMap(code, sourceMapConsumer[, relativePath])](#sourcenodefromstringwithsourcemapcode-sourcemapconsumer-relativepath)\n    - [SourceNode.prototype.add(chunk)](#sourcenodeprototypeaddchunk)\n    - [SourceNode.prototype.prepend(chunk)](#sourcenodeprototypeprependchunk)\n    - [SourceNode.prototype.setSourceContent(sourceFile, sourceContent)](#sourcenodeprototypesetsourcecontentsourcefile-sourcecontent)\n    - [SourceNode.prototype.walk(fn)](#sourcenodeprototypewalkfn)\n    - [SourceNode.prototype.walkSourceContents(fn)](#sourcenodeprototypewalksourcecontentsfn)\n    - [SourceNode.prototype.join(sep)](#sourcenodeprototypejoinsep)\n    - [SourceNode.prototype.replaceRight(pattern, replacement)](#sourcenodeprototypereplacerightpattern-replacement)\n    - [SourceNode.prototype.toString()](#sourcenodeprototypetostring)\n    - [SourceNode.prototype.toStringWithSourceMap([startOfSourceMap])](#sourcenodeprototypetostringwithsourcemapstartofsourcemap)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n## Examples\n\n### Consuming a source map\n\n```js\nconst rawSourceMap = {\n  version: 3,\n  file: \"min.js\",\n  names: [\"bar\", \"baz\", \"n\"],\n  sources: [\"one.js\", \"two.js\"],\n  sourceRoot: \"http://example.com/www/js/\",\n  mappings:\n    \"CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA\",\n};\n\nconst whatever = await SourceMapConsumer.with(rawSourceMap, null, consumer => {\n  console.log(consumer.sources);\n  // [ 'http://example.com/www/js/one.js',\n  //   'http://example.com/www/js/two.js' ]\n\n  console.log(\n    consumer.originalPositionFor({\n      line: 2,\n      column: 28,\n    })\n  );\n  // { source: 'http://example.com/www/js/two.js',\n  //   line: 2,\n  //   column: 10,\n  //   name: 'n' }\n\n  console.log(\n    consumer.generatedPositionFor({\n      source: \"http://example.com/www/js/two.js\",\n      line: 2,\n      column: 10,\n    })\n  );\n  // { line: 2, column: 28 }\n\n  consumer.eachMapping(function (m) {\n    // ...\n  });\n\n  return computeWhatever();\n});\n```\n\n### Generating a source map\n\nIn depth guide:\n[**Compiling to JavaScript, and Debugging with Source Maps**](https://hacks.mozilla.org/2013/05/compiling-to-javascript-and-debugging-with-source-maps/)\n\n#### With SourceNode (high level API)\n\n```js\nfunction compile(ast) {\n  switch (ast.type) {\n    case \"BinaryExpression\":\n      return new SourceNode(\n        ast.location.line,\n        ast.location.column,\n        ast.location.source,\n        [compile(ast.left), \" + \", compile(ast.right)]\n      );\n    case \"Literal\":\n      return new SourceNode(\n        ast.location.line,\n        ast.location.column,\n        ast.location.source,\n        String(ast.value)\n      );\n    // ...\n    default:\n      throw new Error(\"Bad AST\");\n  }\n}\n\nvar ast = parse(\"40 + 2\", \"add.js\");\nconsole.log(\n  compile(ast).toStringWithSourceMap({\n    file: \"add.js\",\n  })\n);\n// { code: '40 + 2',\n//   map: [object SourceMapGenerator] }\n```\n\n#### With SourceMapGenerator (low level API)\n\n```js\nvar map = new SourceMapGenerator({\n  file: \"source-mapped.js\",\n});\n\nmap.addMapping({\n  generated: {\n    line: 10,\n    column: 35,\n  },\n  source: \"foo.js\",\n  original: {\n    line: 33,\n    column: 2,\n  },\n  name: \"christopher\",\n});\n\nconsole.log(map.toString());\n// '{\"version\":3,\"file\":\"source-mapped.js\",\"sources\":[\"foo.js\"],\"names\":[\"christopher\"],\"mappings\":\";;;;;;;;;mCAgCEA\"}'\n```\n\n## API\n\nGet a reference to the module:\n\n```js\n// Node.js\nvar sourceMap = require(\"source-map\");\n\n// Browser builds\nvar sourceMap = window.sourceMap;\n\n// Inside Firefox\nconst sourceMap = require(\"devtools/toolkit/sourcemap/source-map.js\");\n```\n\n### SourceMapConsumer\n\nA `SourceMapConsumer` instance represents a parsed source map which we can query\nfor information about the original file positions by giving it a file position\nin the generated source.\n\n#### SourceMapConsumer.initialize(options)\n\nWhen using `SourceMapConsumer` outside of node.js, for example on the Web, it\nneeds to know from what URL to load `lib/mappings.wasm`. You must inform it by\ncalling `initialize` before constructing any `SourceMapConsumer`s.\n\nThe options object has the following properties:\n\n- `\"lib/mappings.wasm\"`: A `String` containing the URL of the\n  `lib/mappings.wasm` file, or an `ArrayBuffer` with the contents of `lib/mappings.wasm`.\n\n```js\nsourceMap.SourceMapConsumer.initialize({\n  \"lib/mappings.wasm\": \"https://example.com/source-map/lib/mappings.wasm\",\n});\n```\n\n#### new SourceMapConsumer(rawSourceMap)\n\nThe only parameter is the raw source map (either as a string which can be\n`JSON.parse`'d, or an object). According to the spec, source maps have the\nfollowing attributes:\n\n- `version`: Which version of the source map spec this map is following.\n\n- `sources`: An array of URLs to the original source files.\n\n- `names`: An array of identifiers which can be referenced by individual\n  mappings.\n\n- `sourceRoot`: Optional. The URL root from which all sources are relative.\n\n- `sourcesContent`: Optional. An array of contents of the original source files.\n\n- `mappings`: A string of base64 VLQs which contain the actual mappings.\n\n- `file`: Optional. The generated filename this source map is associated with.\n\n- `x_google_ignoreList`: Optional. An additional extension field which is an array\n  of indices refering to urls in the sources array. This is used to identify third-party\n  sources, that the developer might want to avoid when debugging. [Read more](https://developer.chrome.com/articles/x-google-ignore-list/)\n\nThe promise of the constructed souce map consumer is returned.\n\nWhen the `SourceMapConsumer` will no longer be used anymore, you must call its\n`destroy` method.\n\n```js\nconst consumer = await new sourceMap.SourceMapConsumer(rawSourceMapJsonData);\ndoStuffWith(consumer);\nconsumer.destroy();\n```\n\nAlternatively, you can use `SourceMapConsumer.with` to avoid needing to remember\nto call `destroy`.\n\n#### SourceMapConsumer.with\n\nConstruct a new `SourceMapConsumer` from `rawSourceMap` and `sourceMapUrl`\n(see the `SourceMapConsumer` constructor for details. Then, invoke the `async function f(SourceMapConsumer) -> T` with the newly constructed consumer, wait\nfor `f` to complete, call `destroy` on the consumer, and return `f`'s return\nvalue.\n\nYou must not use the consumer after `f` completes!\n\nBy using `with`, you do not have to remember to manually call `destroy` on\nthe consumer, since it will be called automatically once `f` completes.\n\n```js\nconst xSquared = await SourceMapConsumer.with(\n  myRawSourceMap,\n  null,\n  async function (consumer) {\n    // Use `consumer` inside here and don't worry about remembering\n    // to call `destroy`.\n\n    const x = await whatever(consumer);\n    return x * x;\n  }\n);\n\n// You may not use that `consumer` anymore out here; it has\n// been destroyed. But you can use `xSquared`.\nconsole.log(xSquared);\n```\n\n#### SourceMapConsumer.prototype.destroy()\n\nFree this source map consumer's associated wasm data that is manually-managed.\n\n```js\nconsumer.destroy();\n```\n\nAlternatively, you can use `SourceMapConsumer.with` to avoid needing to remember\nto call `destroy`.\n\n#### SourceMapConsumer.prototype.computeColumnSpans()\n\nCompute the last column for each generated mapping. The last column is\ninclusive.\n\n```js\n// Before:\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" });\n// [ { line: 2,\n//     column: 1 },\n//   { line: 2,\n//     column: 10 },\n//   { line: 2,\n//     column: 20 } ]\n\nconsumer.computeColumnSpans();\n\n// After:\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" });\n// [ { line: 2,\n//     column: 1,\n//     lastColumn: 9 },\n//   { line: 2,\n//     column: 10,\n//     lastColumn: 19 },\n//   { line: 2,\n//     column: 20,\n//     lastColumn: Infinity } ]\n```\n\n#### SourceMapConsumer.prototype.originalPositionFor(generatedPosition)\n\nReturns the original source, line, and column information for the generated\nsource's line and column positions provided. The only argument is an object with\nthe following properties:\n\n- `line`: The line number in the generated source. Line numbers in\n  this library are 1-based (note that the underlying source map\n  specification uses 0-based line numbers -- this library handles the\n  translation).\n\n- `column`: The column number in the generated source. Column numbers\n  in this library are 0-based.\n\n- `bias`: Either `SourceMapConsumer.GREATEST_LOWER_BOUND` or\n  `SourceMapConsumer.LEAST_UPPER_BOUND`. Specifies whether to return the closest\n  element that is smaller than or greater than the one we are searching for,\n  respectively, if the exact element cannot be found. Defaults to\n  `SourceMapConsumer.GREATEST_LOWER_BOUND`.\n\nand an object is returned with the following properties:\n\n- `source`: The original source file, or null if this information is not\n  available.\n\n- `line`: The line number in the original source, or null if this information is\n  not available. The line number is 1-based.\n\n- `column`: The column number in the original source, or null if this\n  information is not available. The column number is 0-based.\n\n- `name`: The original identifier, or null if this information is not available.\n\n```js\nconsumer.originalPositionFor({ line: 2, column: 10 });\n// { source: 'foo.coffee',\n//   line: 2,\n//   column: 2,\n//   name: null }\n\nconsumer.originalPositionFor({\n  line: 99999999999999999,\n  column: 999999999999999,\n});\n// { source: null,\n//   line: null,\n//   column: null,\n//   name: null }\n```\n\n#### SourceMapConsumer.prototype.generatedPositionFor(originalPosition)\n\nReturns the generated line and column information for the original source,\nline, and column positions provided. The only argument is an object with\nthe following properties:\n\n- `source`: The filename of the original source.\n\n- `line`: The line number in the original source. The line number is\n  1-based.\n\n- `column`: The column number in the original source. The column\n  number is 0-based.\n\nand an object is returned with the following properties:\n\n- `line`: The line number in the generated source, or null. The line\n  number is 1-based.\n\n- `column`: The column number in the generated source, or null. The\n  column number is 0-based.\n\n```js\nconsumer.generatedPositionFor({ source: \"example.js\", line: 2, column: 10 });\n// { line: 1,\n//   column: 56 }\n```\n\n#### SourceMapConsumer.prototype.allGeneratedPositionsFor(originalPosition)\n\nReturns all generated line and column information for the original source, line,\nand column provided. If no column is provided, returns all mappings\ncorresponding to a either the line we are searching for or the next closest line\nthat has any mappings. Otherwise, returns all mappings corresponding to the\ngiven line and either the column we are searching for or the next closest column\nthat has any offsets.\n\nThe only argument is an object with the following properties:\n\n- `source`: The filename of the original source.\n\n- `line`: The line number in the original source. The line number is\n  1-based.\n\n- `column`: Optional. The column number in the original source. The\n  column number is 0-based.\n\nand an array of objects is returned, each with the following properties:\n\n- `line`: The line number in the generated source, or null. The line\n  number is 1-based.\n\n- `column`: The column number in the generated source, or null. The\n  column number is 0-based.\n\n```js\nconsumer.allGeneratedPositionsFor({ line: 2, source: \"foo.coffee\" });\n// [ { line: 2,\n//     column: 1 },\n//   { line: 2,\n//     column: 10 },\n//   { line: 2,\n//     column: 20 } ]\n```\n\n#### SourceMapConsumer.prototype.hasContentsOfAllSources()\n\nReturn true if we have the embedded source content for every source listed in\nthe source map, false otherwise.\n\nIn other words, if this method returns `true`, then\n`consumer.sourceContentFor(s)` will succeed for every source `s` in\n`consumer.sources`.\n\n```js\n// ...\nif (consumer.hasContentsOfAllSources()) {\n  consumerReadyCallback(consumer);\n} else {\n  fetchSources(consumer, consumerReadyCallback);\n}\n// ...\n```\n\n#### SourceMapConsumer.prototype.sourceContentFor(source[, returnNullOnMissing])\n\nReturns the original source content for the source provided. The only\nargument is the URL of the original source file.\n\nIf the source content for the given source is not found, then an error is\nthrown. Optionally, pass `true` as the second param to have `null` returned\ninstead.\n\n```js\nconsumer.sources;\n// [ \"my-cool-lib.clj\" ]\n\nconsumer.sourceContentFor(\"my-cool-lib.clj\");\n// \"...\"\n\nconsumer.sourceContentFor(\"this is not in the source map\");\n// Error: \"this is not in the source map\" is not in the source map\n\nconsumer.sourceContentFor(\"this is not in the source map\", true);\n// null\n```\n\n#### SourceMapConsumer.prototype.eachMapping(callback, context, order)\n\nIterate over each mapping between an original source/line/column and a\ngenerated line/column in this source map.\n\n- `callback`: The function that is called with each mapping. Mappings have the\n  form `{ source, generatedLine, generatedColumn, originalLine, originalColumn, name }`\n\n- `context`: Optional. If specified, this object will be the value of `this`\n  every time that `callback` is called.\n\n- `order`: Either `SourceMapConsumer.GENERATED_ORDER` or\n  `SourceMapConsumer.ORIGINAL_ORDER`. Specifies whether you want to iterate over\n  the mappings sorted by the generated file's line/column order or the\n  original's source/line/column order, respectively. Defaults to\n  `SourceMapConsumer.GENERATED_ORDER`.\n\n```js\nconsumer.eachMapping(function (m) {\n  console.log(m);\n});\n// ...\n// { source: 'illmatic.js',\n//   generatedLine: 1,\n//   generatedColumn: 0,\n//   originalLine: 1,\n//   originalColumn: 0,\n//   name: null }\n// { source: 'illmatic.js',\n//   generatedLine: 2,\n//   generatedColumn: 0,\n//   originalLine: 2,\n//   originalColumn: 0,\n//   name: null }\n// ...\n```\n\n### SourceMapGenerator\n\nAn instance of the SourceMapGenerator represents a source map which is being\nbuilt incrementally.\n\n#### new SourceMapGenerator([startOfSourceMap])\n\nYou may pass an object with the following properties:\n\n- `file`: The filename of the generated source that this source map is\n  associated with.\n\n- `sourceRoot`: A root for all relative URLs in this source map.\n\n- `skipValidation`: Optional. When `true`, disables validation of mappings as\n  they are added. This can improve performance but should be used with\n  discretion, as a last resort. Even then, one should avoid using this flag when\n  running tests, if possible.\n\n```js\nvar generator = new sourceMap.SourceMapGenerator({\n  file: \"my-generated-javascript-file.js\",\n  sourceRoot: \"http://example.com/app/js/\",\n});\n```\n\n#### SourceMapGenerator.fromSourceMap(sourceMapConsumer)\n\nCreates a new `SourceMapGenerator` from an existing `SourceMapConsumer` instance.\n\n- `sourceMapConsumer` The SourceMap.\n\n```js\nvar generator = sourceMap.SourceMapGenerator.fromSourceMap(consumer);\n```\n\n#### SourceMapGenerator.prototype.addMapping(mapping)\n\nAdd a single mapping from original source line and column to the generated\nsource's line and column for this source map being created. The mapping object\nshould have the following properties:\n\n- `generated`: An object with the generated line and column positions.\n\n- `original`: An object with the original line and column positions.\n\n- `source`: The original source file (relative to the sourceRoot).\n\n- `name`: An optional original token name for this mapping.\n\n```js\ngenerator.addMapping({\n  source: \"module-one.scm\",\n  original: { line: 128, column: 0 },\n  generated: { line: 3, column: 456 },\n});\n```\n\n#### SourceMapGenerator.prototype.setSourceContent(sourceFile, sourceContent)\n\nSet the source content for an original source file.\n\n- `sourceFile` the URL of the original source file.\n\n- `sourceContent` the content of the source file.\n\n```js\ngenerator.setSourceContent(\n  \"module-one.scm\",\n  fs.readFileSync(\"path/to/module-one.scm\")\n);\n```\n\n#### SourceMapGenerator.prototype.applySourceMap(sourceMapConsumer[, sourceFile[, sourceMapPath]])\n\nApplies a SourceMap for a source file to the SourceMap.\nEach mapping to the supplied source file is rewritten using the\nsupplied SourceMap. Note: The resolution for the resulting mappings\nis the minimum of this map and the supplied map.\n\n- `sourceMapConsumer`: The SourceMap to be applied.\n\n- `sourceFile`: Optional. The filename of the source file.\n  If omitted, sourceMapConsumer.file will be used, if it exists.\n  Otherwise an error will be thrown.\n\n- `sourceMapPath`: Optional. The dirname of the path to the SourceMap\n  to be applied. If relative, it is relative to the SourceMap.\n\n  This parameter is needed when the two SourceMaps aren't in the same\n  directory, and the SourceMap to be applied contains relative source\n  paths. If so, those relative source paths need to be rewritten\n  relative to the SourceMap.\n\n  If omitted, it is assumed that both SourceMaps are in the same directory,\n  thus not needing any rewriting. (Supplying `'.'` has the same effect.)\n\n#### SourceMapGenerator.prototype.toString()\n\nRenders the source map being generated to a string.\n\n```js\ngenerator.toString();\n// '{\"version\":3,\"sources\":[\"module-one.scm\"],\"names\":[],\"mappings\":\"...snip...\",\"file\":\"my-generated-javascript-file.js\",\"sourceRoot\":\"http://example.com/app/js/\"}'\n```\n\n### SourceNode\n\nSourceNodes provide a way to abstract over interpolating and/or concatenating\nsnippets of generated JavaScript source code, while maintaining the line and\ncolumn information associated between those snippets and the original source\ncode. This is useful as the final intermediate representation a compiler might\nuse before outputting the generated JS and source map.\n\n#### new SourceNode([line, column, source[, chunk[, name]]])\n\n- `line`: The original line number associated with this source node, or null if\n  it isn't associated with an original line. The line number is 1-based.\n\n- `column`: The original column number associated with this source node, or null\n  if it isn't associated with an original column. The column number\n  is 0-based.\n\n- `source`: The original source's filename; null if no filename is provided.\n\n- `chunk`: Optional. Is immediately passed to `SourceNode.prototype.add`, see\n  below.\n\n- `name`: Optional. The original identifier.\n\n```js\nvar node = new SourceNode(1, 2, \"a.cpp\", [\n  new SourceNode(3, 4, \"b.cpp\", \"extern int status;\\n\"),\n  new SourceNode(5, 6, \"c.cpp\", \"std::string* make_string(size_t n);\\n\"),\n  new SourceNode(7, 8, \"d.cpp\", \"int main(int argc, char** argv) {}\\n\"),\n]);\n```\n\n#### SourceNode.fromStringWithSourceMap(code, sourceMapConsumer[, relativePath])\n\nCreates a SourceNode from generated code and a SourceMapConsumer.\n\n- `code`: The generated code\n\n- `sourceMapConsumer` The SourceMap for the generated code\n\n- `relativePath` The optional path that relative sources in `sourceMapConsumer`\n  should be relative to.\n\n```js\nconst consumer = await new SourceMapConsumer(\n  fs.readFileSync(\"path/to/my-file.js.map\", \"utf8\")\n);\nconst node = SourceNode.fromStringWithSourceMap(\n  fs.readFileSync(\"path/to/my-file.js\"),\n  consumer\n);\n```\n\n#### SourceNode.prototype.add(chunk)\n\nAdd a chunk of generated JS to this source node.\n\n- `chunk`: A string snippet of generated JS code, another instance of\n  `SourceNode`, or an array where each member is one of those things.\n\n```js\nnode.add(\" + \");\nnode.add(otherNode);\nnode.add([leftHandOperandNode, \" + \", rightHandOperandNode]);\n```\n\n#### SourceNode.prototype.prepend(chunk)\n\nPrepend a chunk of generated JS to this source node.\n\n- `chunk`: A string snippet of generated JS code, another instance of\n  `SourceNode`, or an array where each member is one of those things.\n\n```js\nnode.prepend(\"/** Build Id: f783haef86324gf **/\\n\\n\");\n```\n\n#### SourceNode.prototype.setSourceContent(sourceFile, sourceContent)\n\nSet the source content for a source file. This will be added to the\n`SourceMap` in the `sourcesContent` field.\n\n- `sourceFile`: The filename of the source file\n\n- `sourceContent`: The content of the source file\n\n```js\nnode.setSourceContent(\n  \"module-one.scm\",\n  fs.readFileSync(\"path/to/module-one.scm\")\n);\n```\n\n#### SourceNode.prototype.walk(fn)\n\nWalk over the tree of JS snippets in this node and its children. The walking\nfunction is called once for each snippet of JS and is passed that snippet and\nthe its original associated source's line/column location.\n\n- `fn`: The traversal function.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n  new SourceNode(3, 4, \"b.js\", \"uno\"),\n  \"dos\",\n  [\"tres\", new SourceNode(5, 6, \"c.js\", \"quatro\")],\n]);\n\nnode.walk(function (code, loc) {\n  console.log(\"WALK:\", code, loc);\n});\n// WALK: uno { source: 'b.js', line: 3, column: 4, name: null }\n// WALK: dos { source: 'a.js', line: 1, column: 2, name: null }\n// WALK: tres { source: 'a.js', line: 1, column: 2, name: null }\n// WALK: quatro { source: 'c.js', line: 5, column: 6, name: null }\n```\n\n#### SourceNode.prototype.walkSourceContents(fn)\n\nWalk over the tree of SourceNodes. The walking function is called for each\nsource file content and is passed the filename and source content.\n\n- `fn`: The traversal function.\n\n```js\nvar a = new SourceNode(1, 2, \"a.js\", \"generated from a\");\na.setSourceContent(\"a.js\", \"original a\");\nvar b = new SourceNode(1, 2, \"b.js\", \"generated from b\");\nb.setSourceContent(\"b.js\", \"original b\");\nvar c = new SourceNode(1, 2, \"c.js\", \"generated from c\");\nc.setSourceContent(\"c.js\", \"original c\");\n\nvar node = new SourceNode(null, null, null, [a, b, c]);\nnode.walkSourceContents(function (source, contents) {\n  console.log(\"WALK:\", source, \":\", contents);\n});\n// WALK: a.js : original a\n// WALK: b.js : original b\n// WALK: c.js : original c\n```\n\n#### SourceNode.prototype.join(sep)\n\nLike `Array.prototype.join` except for SourceNodes. Inserts the separator\nbetween each of this source node's children.\n\n- `sep`: The separator.\n\n```js\nvar lhs = new SourceNode(1, 2, \"a.rs\", \"my_copy\");\nvar operand = new SourceNode(3, 4, \"a.rs\", \"=\");\nvar rhs = new SourceNode(5, 6, \"a.rs\", \"orig.clone()\");\n\nvar node = new SourceNode(null, null, null, [lhs, operand, rhs]);\nvar joinedNode = node.join(\" \");\n```\n\n#### SourceNode.prototype.replaceRight(pattern, replacement)\n\nCall `String.prototype.replace` on the very right-most source snippet. Useful\nfor trimming white space from the end of a source node, etc.\n\n- `pattern`: The pattern to replace.\n\n- `replacement`: The thing to replace the pattern with.\n\n```js\n// Trim trailing white space.\nnode.replaceRight(/\\s*$/, \"\");\n```\n\n#### SourceNode.prototype.toString()\n\nReturn the string representation of this source node. Walks over the tree and\nconcatenates all the various snippets together to one string.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n  new SourceNode(3, 4, \"b.js\", \"uno\"),\n  \"dos\",\n  [\"tres\", new SourceNode(5, 6, \"c.js\", \"quatro\")],\n]);\n\nnode.toString();\n// 'unodostresquatro'\n```\n\n#### SourceNode.prototype.toStringWithSourceMap([startOfSourceMap])\n\nReturns the string representation of this tree of source nodes, plus a\nSourceMapGenerator which contains all the mappings between the generated and\noriginal sources.\n\nThe arguments are the same as those to `new SourceMapGenerator`.\n\n```js\nvar node = new SourceNode(1, 2, \"a.js\", [\n  new SourceNode(3, 4, \"b.js\", \"uno\"),\n  \"dos\",\n  [\"tres\", new SourceNode(5, 6, \"c.js\", \"quatro\")],\n]);\n\nnode.toStringWithSourceMap({ file: \"my-output-file.js\" });\n// { code: 'unodostresquatro',\n//   map: [object SourceMapGenerator] }\n```",
   "_attachments": {}

package/npm-cache/_cacache/content-v2/sha512/{2b/00/15c1d6fbe1012e188ee9c921c68a030ef3f407fe89c2cb58af946ab0f5a195cd48d575969a2ee68707bcf7e24f6ae0489f9563fa3f0f46c3da5d978ca37b → 99/3a/20984cdec2f0994fabea827f10b13be6e34aa98ea4ac8ed4a565cb7d4fdc07249da6b77bd0797586945cbc5ccb4256c366c78b9cc518b6f22b3e40ddc326}

@@ -7325,7 +7325,7 @@
   "dist-tags": {
     "latest": "4.7.2"
   },
-  "_rev": "912-fc3b26680e05211d",
+  "_rev": "922-aa2f4f8390137785",
   "_id": "bare-fs",
   "readme": "# bare-fs\n\nNative file system operations for Bare. The API closely follows that of the Node.js `fs` module.\n\n```\nnpm i bare-fs\n```\n\n## Usage\n\n```js\nconst fs = require('bare-fs')\n\nconst fd = await fs.open('hello.txt')\n\nconst buffer = Buffer.alloc(1024)\n\ntry {\n  const length = await fs.read(fd, buffer)\n\n  console.log('Read', length, 'bytes')\n} finally {\n  await fs.close(fd)\n}\n```\n\n## API\n\n#### `const fd = await fs.open(filepath[, flags[, mode]])`\n\nOpen a file, returning a file descriptor. `flags` defaults to `'r'` and `mode` defaults to `0o666`. `flags` may be a string such as `'r'`, `'w'`, `'a'`, `'r+'`, etc., or a numeric combination of `fs.constants` flags.\n\n#### `fs.open(filepath[, flags[, mode]], callback)`\n\nCallback version of `fs.open()`.\n\n#### `const fd = fs.openSync(filepath[, flags[, mode]])`\n\nSynchronous version of `fs.open()`.\n\n#### `await fs.close(fd)`\n\nClose a file descriptor.\n\n#### `fs.close(fd, callback)`\n\nCallback version of `fs.close()`.\n\n#### `fs.closeSync(fd)`\n\nSynchronous version of `fs.close()`.\n\n#### `await fs.access(filepath[, mode])`\n\nCheck whether the file at `filepath` is accessible. `mode` defaults to `fs.constants.F_OK`.\n\n#### `fs.access(filepath[, mode], callback)`\n\nCallback version of `fs.access()`.\n\n#### `fs.accessSync(filepath[, mode])`\n\nSynchronous version of `fs.access()`.\n\n#### `const exists = await fs.exists(filepath)`\n\nCheck whether a file exists at `filepath`. Returns `true` if the file is accessible, `false` otherwise.\n\n#### `fs.exists(filepath, callback)`\n\nCallback version of `fs.exists()`.\n\n#### `const exists = fs.existsSync(filepath)`\n\nSynchronous version of `fs.exists()`.\n\n#### `const bytesRead = await fs.read(fd, buffer[, offset[, len[, pos]]])`\n\nRead from a file descriptor into `buffer`. `offset` defaults to `0`, `len` defaults to `buffer.byteLength - offset`, and `pos` defaults to `-1` (current position). Returns the number of bytes read.\n\n#### `fs.read(fd, buffer[, offset[, len[, pos]]], callback)`\n\nCallback version of `fs.read()`.\n\n#### `const bytesRead = fs.readSync(fd, buffer[, offset[, len[, pos]]])`\n\nSynchronous version of `fs.read()`.\n\n#### `const bytesRead = await fs.readv(fd, buffers[, pos])`\n\nRead from a file descriptor into an array of `buffers`. `pos` defaults to `-1`.\n\n#### `fs.readv(fd, buffers[, pos], callback)`\n\nCallback version of `fs.readv()`.\n\n#### `const bytesRead = fs.readvSync(fd, buffers[, pos])`\n\nSynchronous version of `fs.readv()`.\n\n#### `const bytesWritten = await fs.write(fd, data[, offset[, len[, pos]]])`\n\nWrite `data` to a file descriptor. When `data` is a string, the signature is `fs.write(fd, data[, pos[, encoding]])` where `encoding` defaults to `'utf8'`. Returns the number of bytes written.\n\n#### `fs.write(fd, data[, offset[, len[, pos]]], callback)`\n\nCallback version of `fs.write()`.\n\n#### `const bytesWritten = fs.writeSync(fd, data[, offset[, len[, pos]]])`\n\nSynchronous version of `fs.write()`.\n\n#### `const bytesWritten = await fs.writev(fd, buffers[, pos])`\n\nWrite an array of `buffers` to a file descriptor. `pos` defaults to `-1`.\n\n#### `fs.writev(fd, buffers[, pos], callback)`\n\nCallback version of `fs.writev()`.\n\n#### `const bytesWritten = fs.writevSync(fd, buffers[, pos])`\n\nSynchronous version of `fs.writev()`.\n\n#### `const stats = await fs.stat(filepath)`\n\nGet the status of a file. Returns a `Stats` object.\n\n#### `fs.stat(filepath, callback)`\n\nCallback version of `fs.stat()`.\n\n#### `const stats = fs.statSync(filepath)`\n\nSynchronous version of `fs.stat()`.\n\n#### `const stats = await fs.lstat(filepath)`\n\nLike `fs.stat()`, but if `filepath` is a symbolic link, the link itself is statted, not the file it refers to.\n\n#### `fs.lstat(filepath, callback)`\n\nCallback version of `fs.lstat()`.\n\n#### `const stats = fs.lstatSync(filepath)`\n\nSynchronous version of `fs.lstat()`.\n\n#### `const stats = await fs.fstat(fd)`\n\nGet the status of a file by its file descriptor. Returns a `Stats` object.\n\n#### `fs.fstat(fd, callback)`\n\nCallback version of `fs.fstat()`.\n\n#### `const stats = fs.fstatSync(fd)`\n\nSynchronous version of `fs.fstat()`.\n\n#### `const stats = await fs.statfs(filepath)`\n\nGet filesystem statistics. Returns a `StatFs` object.\n\n#### `fs.statfs(filepath, callback)`\n\nCallback version of `fs.statfs()`.\n\n#### `const stats = fs.statfsSync(filepath)`\n\nSynchronous version of `fs.statfs()`.\n\n#### `await fs.ftruncate(fd[, len])`\n\nTruncate a file to `len` bytes. `len` defaults to `0`.\n\n#### `fs.ftruncate(fd[, len], callback)`\n\nCallback version of `fs.ftruncate()`.\n\n#### `fs.ftruncateSync(fd[, len])`\n\nSynchronous version of `fs.ftruncate()`.\n\n#### `await fs.chmod(filepath, mode)`\n\nChange the permissions of a file. `mode` may be a numeric mode or a string that will be parsed as octal.\n\n#### `fs.chmod(filepath, mode, callback)`\n\nCallback version of `fs.chmod()`.\n\n#### `fs.chmodSync(filepath, mode)`\n\nSynchronous version of `fs.chmod()`.\n\n#### `await fs.fchmod(fd, mode)`\n\nChange the permissions of a file by its file descriptor.\n\n#### `fs.fchmod(fd, mode, callback)`\n\nCallback version of `fs.fchmod()`.\n\n#### `fs.fchmodSync(fd, mode)`\n\nSynchronous version of `fs.fchmod()`.\n\n#### `await fs.chown(filepath, uid, gid)`\n\nChange the owner and group of a file.\n\n**NOTE**: The `chown` functions are not implemented on Windows.\n\n#### `fs.chown(filepath,  uid, gid, callback)`\n\nCallback version of `fs.chown()`.\n\n#### `await fs.chownSync(filepath, uid, gid)`\n\nSynchronous version of `fs.chown()`.\n\n#### `await fs.lchown(filepath, uid, gid)`\n\nChange the owner and group of a file, but if `filepath` is a symbolic link, the changes are applied only to the link, not the file it refers to.\n\n#### `fs.lchown(filepath,  uid, gid, callback)`\n\nCallback version of `fs.lchown()`.\n\n#### `fs.lchownSync(filepath, uid, gid)`\n\nSynchronous version of `fs.lchown()`.\n\n#### `await fs.fchown(filepath, uid, gid)`\n\nChange the owner and group of a file by its file descriptor.\n\n#### `fs.fchown(filepath,  uid, gid, callback)`\n\nCallback version of `fs.fchown()`.\n\n#### `fs.fchownSync(filepath, uid, gid)`\n\nSynchronous version of `fs.fchown()`.\n\n#### `await fs.utimes(filepath, atime, mtime)`\n\nChange the access and modification times of a file. Times may be numbers (seconds since epoch) or `Date` objects.\n\n#### `fs.utimes(filepath, atime, mtime, callback)`\n\nCallback version of `fs.utimes()`.\n\n#### `fs.utimesSync(filepath, atime, mtime)`\n\nSynchronous version of `fs.utimes()`.\n\n#### `await fs.lutimes(filepath, atime, mtime)`\n\nLike `fs.utimes()`, but if `filepath` is a symbolic link, the timestamps of the link is changed, not the file it refers to.\n\n#### `fs.lutimes(filepath, atime, mtime, callback)`\n\nCallback version of `fs.lutimes()`.\n\n#### `fs.lutimesSync(filepath, atime, mtime)`\n\nSynchronous version of `fs.lutimes()`.\n\n#### `await fs.futimes(fd, atime, mtime)`\n\nChange the access and modification times of a file by its file descriptor. Times may be numbers (seconds since epoch) or `Date` objects.\n\n#### `fs.futimes(fd, atime, mtime, callback)`\n\nCallback version of `fs.futimes()`.\n\n#### `fs.futimesSync(fd, atime, mtime)`\n\nSynchronous version of `fs.futimes()`.\n\n#### `await fs.link(src, dst)`\n\nCreates a new link (also known as a hard link) to an existing file.\n\n#### `fs.link(src, dst, callback)`\n\nCallback version of `fs.link()`.\n\n#### `fs.linkSync(src, dst)`\n\nSynchronous version of `fs.link()`.\n\n#### `await fs.mkdir(filepath[, opts])`\n\nCreate a directory at `filepath`.\n\nOptions include:\n\n```js\noptions = {\n  mode: 0o777,\n  recursive: false\n}\n```\n\nIf `opts` is a number, it is treated as the `mode`. When `recursive` is `true`, parent directories are created as needed.\n\n#### `fs.mkdir(filepath[, opts], callback)`\n\nCallback version of `fs.mkdir()`.\n\n#### `fs.mkdirSync(filepath[, opts])`\n\nSynchronous version of `fs.mkdir()`.\n\n#### `const path = await fs.mkdtemp(prefix)`\n\nCreate a unique temporary directory.\n\n#### `fs.mkdtemp(prefix, callback)`\n\nCallback version of `fs.mkdtemp()`.\n\n#### `const path = fs.mkdtempSync(prefix)`\n\nSynchronous version of `fs.mkdtemp()`.\n\n#### `await fs.rmdir(filepath)`\n\nRemove an empty directory.\n\n#### `fs.rmdir(filepath, callback)`\n\nCallback version of `fs.rmdir()`.\n\n#### `fs.rmdirSync(filepath)`\n\nSynchronous version of `fs.rmdir()`.\n\n#### `await fs.rm(filepath[, opts])`\n\nRemove a file or directory at `filepath`.\n\nOptions include:\n\n```js\noptions = {\n  force: false,\n  recursive: false\n}\n```\n\nWhen `recursive` is `true`, directories are removed along with their contents. When `force` is `true`, no error is thrown if `filepath` does not exist.\n\n#### `fs.rm(filepath[, opts], callback)`\n\nCallback version of `fs.rm()`.\n\n#### `fs.rmSync(filepath[, opts])`\n\nSynchronous version of `fs.rm()`.\n\n#### `await fs.unlink(filepath)`\n\nRemove a file.\n\n#### `fs.unlink(filepath, callback)`\n\nCallback version of `fs.unlink()`.\n\n#### `fs.unlinkSync(filepath)`\n\nSynchronous version of `fs.unlink()`.\n\n#### `await fs.rename(src, dst)`\n\nRename a file from `src` to `dst`.\n\n#### `fs.rename(src, dst, callback)`\n\nCallback version of `fs.rename()`.\n\n#### `fs.renameSync(src, dst)`\n\nSynchronous version of `fs.rename()`.\n\n#### `await fs.copyFile(src, dst[, mode])`\n\nCopy a file from `src` to `dst`. `mode` is an optional bitmask created from `fs.constants.COPYFILE_EXCL`, `fs.constants.COPYFILE_FICLONE`, or `fs.constants.COPYFILE_FICLONE_FORCE`.\n\n#### `fs.copyFile(src, dst[, mode], callback)`\n\nCallback version of `fs.copyFile()`.\n\n#### `fs.copyFileSync(src, dst[, mode])`\n\nSynchronous version of `fs.copyFile()`.\n\n#### `await fs.cp(src, dst[, opts])`\n\nCopy a file or directory from `src` to `dst`.\n\nOptions include:\n\n```js\noptions = {\n  recursive: false\n}\n```\n\nSet `recursive` to `true` to copy directories and their contents. Files are copied preserving their permissions.\n\n#### `fs.cp(src, dst[, opts], callback)`\n\nCallback version of `fs.cp()`.\n\n#### `fs.cpSync(src, dst[, opts])`\n\nSynchronous version of `fs.cp()`.\n\n#### `const resolved = await fs.realpath(filepath[, opts])`\n\nResolve the real path of `filepath`, expanding all symbolic links.\n\nOptions include:\n\n```js\noptions = {\n  encoding: 'utf8'\n}\n```\n\nSet `encoding` to `'buffer'` to receive the result as a `Buffer`.\n\n#### `fs.realpath(filepath[, opts], callback)`\n\nCallback version of `fs.realpath()`.\n\n#### `const resolved = fs.realpathSync(filepath[, opts])`\n\nSynchronous version of `fs.realpath()`.\n\n#### `const target = await fs.readlink(filepath[, opts])`\n\nRead the target of a symbolic link.\n\nOptions include:\n\n```js\noptions = {\n  encoding: 'utf8'\n}\n```\n\n#### `fs.readlink(filepath[, opts], callback)`\n\nCallback version of `fs.readlink()`.\n\n#### `const target = fs.readlinkSync(filepath[, opts])`\n\nSynchronous version of `fs.readlink()`.\n\n#### `await fs.truncate(filename[, len])`\n\nTruncate the file at `filename` to `len` bytes. `len` defaults to `0`.\n\n#### `fs.truncate(filename[, len], callback)`\n\nCallback version of `fs.truncate()`.\n\n#### `fs.truncateSync(filename[, len])`\n\nSynchronous version of `fs.truncate()`.\n\n#### `await fs.symlink(target, filepath[, type])`\n\nCreate a symbolic link at `filepath` pointing to `target`. `type` may be `'file'`, `'dir'`, or `'junction'` (Windows only) or a numeric flag. On Windows, if `type` is not provided, it is inferred from the target.\n\n#### `fs.symlink(target, filepath[, type], callback)`\n\nCallback version of `fs.symlink()`.\n\n#### `fs.symlinkSync(target, filepath[, type])`\n\nSynchronous version of `fs.symlink()`.\n\n#### `await fs.fsync(fd)`\n\nFlush all modified in-core data of the file referred by its file descriptor to the disk device.\n\n#### `fs.fsync(fs, callback)`\n\nCallback version of `fs.fsync()`.\n\n#### `fs.fsyncSync(fd)`\n\nSynchronous version of `fs.fsync()`.\n\n#### `await fs.fdatasync(fd)`\n\nSimilar to `fsync`, but does not flush modified metadata unless necessary.\n\n#### `fs.fdatasync(fs, callback)`\n\nCallback version of `fs.fdatasync()`.\n\n#### `fs.fdatasyncSync(fd)`\n\nSynchronous version of `fs.fdatasync()`.\n\n#### `const dir = await fs.opendir(filepath[, opts])`\n\nOpen a directory for iteration. Returns a `Dir` object.\n\nOptions include:\n\n```js\noptions = {\n  encoding: 'utf8',\n  bufferSize: 32\n}\n```\n\n#### `fs.opendir(filepath[, opts], callback)`\n\nCallback version of `fs.opendir()`.\n\n#### `const dir = fs.opendirSync(filepath[, opts])`\n\nSynchronous version of `fs.opendir()`.\n\n#### `const entries = await fs.readdir(filepath[, opts])`\n\nRead the contents of a directory. Returns an array of filenames or, if `withFileTypes` is `true`, an array of `Dirent` objects.\n\nOptions include:\n\n```js\noptions = {\n  encoding: 'utf8',\n  withFileTypes: false,\n  recursive: false\n}\n```\n\n#### `fs.readdir(filepath[, opts], callback)`\n\nCallback version of `fs.readdir()`.\n\n#### `const entries = fs.readdirSync(filepath[, opts])`\n\nSynchronous version of `fs.readdir()`.\n\n#### `const data = await fs.readFile(filepath[, opts])`\n\nRead the entire contents of a file. Returns a `Buffer` by default, or a string if an `encoding` is specified.\n\nOptions include:\n\n```js\noptions = {\n  encoding: 'buffer',\n  flag: 'r'\n}\n```\n\n#### `fs.readFile(filepath[, opts], callback)`\n\nCallback version of `fs.readFile()`.\n\n#### `const data = fs.readFileSync(filepath[, opts])`\n\nSynchronous version of `fs.readFile()`.\n\n#### `await fs.writeFile(filepath, data[, opts])`\n\nWrite `data` to a file, replacing it if it already exists.\n\nOptions include:\n\n```js\noptions = {\n  encoding: 'utf8',\n  flag: 'w',\n  mode: 0o666\n}\n```\n\n#### `fs.writeFile(filepath, data[, opts], callback)`\n\nCallback version of `fs.writeFile()`.\n\n#### `fs.writeFileSync(filepath, data[, opts])`\n\nSynchronous version of `fs.writeFile()`.\n\n#### `await fs.appendFile(filepath, data[, opts])`\n\nAppend `data` to a file, creating it if it does not exist. Accepts the same options as `fs.writeFile()` but defaults to the `'a'` flag.\n\n#### `fs.appendFile(filepath, data[, opts], callback)`\n\nCallback version of `fs.appendFile()`.\n\n#### `fs.appendFileSync(filepath, data[, opts])`\n\nSynchronous version of `fs.appendFile()`.\n\n#### `const watcher = fs.watch(filepath[, opts], callback)`\n\nWatch a file or directory for changes. Returns a `Watcher` object. The `callback`, if provided, is called with `(eventType, filename)` on each change.\n\nOptions include:\n\n```js\noptions = {\n  persistent: true,\n  recursive: false,\n  encoding: 'utf8'\n}\n```\n\n#### `const stream = fs.createReadStream(path[, opts])`\n\nCreate a readable stream for a file. Returns a `ReadStream`.\n\nOptions include:\n\n```js\noptions = {\n  fd: -1,\n  flags: 'r',\n  mode: 0o666,\n  start: 0,\n  end: Infinity\n}\n```\n\nIf `fd` is provided, `path` may be `null` and the stream reads from the given file descriptor.\n\n#### `const stream = fs.createWriteStream(path[, opts])`\n\nCreate a writable stream for a file. Returns a `WriteStream`.\n\nOptions include:\n\n```js\noptions = {\n  fd: -1,\n  flags: 'w',\n  mode: 0o666\n}\n```\n\nIf `fd` is provided, `path` may be `null` and the stream writes to the given file descriptor.\n\n#### `fs.constants`\n\nAn object containing file system constants. See `fs/constants` for the full list. Commonly used constants include:\n\n- `fs.constants.O_RDONLY`, `fs.constants.O_WRONLY`, `fs.constants.O_RDWR` — file access flags\n- `fs.constants.O_CREAT`, `fs.constants.O_TRUNC`, `fs.constants.O_APPEND` — file creation flags\n- `fs.constants.F_OK`, `fs.constants.R_OK`, `fs.constants.W_OK`, `fs.constants.X_OK` — file accessibility flags\n- `fs.constants.S_IFMT`, `fs.constants.S_IFREG`, `fs.constants.S_IFDIR`, `fs.constants.S_IFLNK` — file type flags\n- `fs.constants.COPYFILE_EXCL`, `fs.constants.COPYFILE_FICLONE`, `fs.constants.COPYFILE_FICLONE_FORCE` — copy flags\n\n### `Stats`\n\nReturned by `fs.stat()`, `fs.lstat()`, and `fs.fstat()`.\n\n#### `stats.dev`\n\nThe device identifier.\n\n#### `stats.mode`\n\nThe file mode (type and permissions).\n\n#### `stats.nlink`\n\nThe number of hard links.\n\n#### `stats.uid`\n\nThe user identifier of the file owner.\n\n#### `stats.gid`\n\nThe group identifier of the file owner.\n\n#### `stats.rdev`\n\nThe device identifier for special files.\n\n#### `stats.blksize`\n\nThe file system block size for I/O operations.\n\n#### `stats.ino`\n\nThe inode number.\n\n#### `stats.size`\n\nThe size of the file in bytes.\n\n#### `stats.blocks`\n\nThe number of 512-byte blocks allocated.\n\n#### `stats.atimeMs`\n\nThe access time in milliseconds since the epoch.\n\n#### `stats.mtimeMs`\n\nThe modification time in milliseconds since the epoch.\n\n#### `stats.ctimeMs`\n\nThe change time in milliseconds since the epoch.\n\n#### `stats.birthtimeMs`\n\nThe creation time in milliseconds since the epoch.\n\n#### `stats.atime`\n\nThe access time as a `Date` object.\n\n#### `stats.mtime`\n\nThe modification time as a `Date` object.\n\n#### `stats.ctime`\n\nThe change time as a `Date` object.\n\n#### `stats.birthtime`\n\nThe creation time as a `Date` object.\n\n#### `stats.isDirectory()`\n\nReturns `true` if the file is a directory.\n\n#### `stats.isFile()`\n\nReturns `true` if the file is a regular file.\n\n#### `stats.isBlockDevice()`\n\nReturns `true` if the file is a block device.\n\n#### `stats.isCharacterDevice()`\n\nReturns `true` if the file is a character device.\n\n#### `stats.isFIFO()`\n\nReturns `true` if the file is a FIFO (named pipe).\n\n#### `stats.isSymbolicLink()`\n\nReturns `true` if the file is a symbolic link. Only meaningful when using `fs.lstat()`.\n\n#### `stats.isSocket()`\n\nReturns `true` if the file is a socket.\n\n### `Dir`\n\nReturned by `fs.opendir()`. Supports both synchronous and asynchronous iteration.\n\n#### `dir.path`\n\nThe path of the directory.\n\n#### `const dirent = await dir.read()`\n\nRead the next directory entry. Returns a `Dirent` or `null` when all entries have been read.\n\n#### `dir.read(callback)`\n\nCallback version of `dir.read()`.\n\n#### `const dirent = dir.readSync()`\n\nSynchronous version of `dir.read()`.\n\n#### `await dir.close()`\n\nClose the directory handle.\n\n#### `dir.close(callback)`\n\nCallback version of `dir.close()`.\n\n#### `dir.closeSync()`\n\nSynchronous version of `dir.close()`.\n\n### `Dirent`\n\nRepresents a directory entry, returned when iterating a `Dir` or using `fs.readdir()` with `withFileTypes: true`.\n\n#### `dirent.parentPath`\n\nThe path of the parent directory.\n\n#### `dirent.name`\n\nThe name of the directory entry, as a string or `Buffer` depending on the encoding.\n\n#### `dirent.type`\n\nThe numeric type of the directory entry.\n\n#### `dirent.isFile()`\n\nReturns `true` if the entry is a regular file.\n\n#### `dirent.isDirectory()`\n\nReturns `true` if the entry is a directory.\n\n#### `dirent.isSymbolicLink()`\n\nReturns `true` if the entry is a symbolic link.\n\n#### `dirent.isFIFO()`\n\nReturns `true` if the entry is a FIFO.\n\n#### `dirent.isSocket()`\n\nReturns `true` if the entry is a socket.\n\n#### `dirent.isCharacterDevice()`\n\nReturns `true` if the entry is a character device.\n\n#### `dirent.isBlockDevice()`\n\nReturns `true` if the entry is a block device.\n\n### `ReadStream`\n\nA readable stream for file data, created by `fs.createReadStream()`. Extends `Readable` from <https://github.com/holepunchto/bare-stream>.\n\n#### `stream.path`\n\nThe file path, or `null` if opened by file descriptor.\n\n#### `stream.fd`\n\nThe underlying file descriptor.\n\n#### `stream.flags`\n\nThe flags the file was opened with.\n\n#### `stream.mode`\n\nThe mode the file was opened with.\n\n### `WriteStream`\n\nA writable stream for file data, created by `fs.createWriteStream()`. Extends `Writable` from <https://github.com/holepunchto/bare-stream>.\n\n#### `stream.path`\n\nThe file path, or `null` if opened by file descriptor.\n\n#### `stream.fd`\n\nThe underlying file descriptor.\n\n#### `stream.flags`\n\nThe flags the file was opened with.\n\n#### `stream.mode`\n\nThe mode the file was opened with.\n\n### `Watcher`\n\nWatches for file system changes, created by `fs.watch()`. Extends `EventEmitter` from <https://github.com/holepunchto/bare-events>.\n\n#### `watcher.close()`\n\nStop watching for changes.\n\n#### `watcher.ref()`\n\nPrevent the event loop from exiting while the watcher is active.\n\n#### `watcher.unref()`\n\nAllow the event loop to exit even if the watcher is still active.\n\n#### `event: 'change'`\n\nEmitted with `(eventType, filename)` when a change is detected. `eventType` is either `'rename'` or `'change'`.\n\n#### `event: 'error'`\n\nEmitted with `(err)` when an error occurs.\n\n#### `event: 'close'`\n\nEmitted when the watcher is closed.\n\n### `FileHandle`\n\nReturned by `require('bare-fs/promises').open()`. Provides an object-oriented API for working with file descriptors.\n\n#### `await handle.close()`\n\nClose the file handle.\n\n#### `const { bytesRead, buffer } = await handle.read(buffer[, offset[, len[, pos]]])`\n\nRead from the file into `buffer`.\n\n#### `const { bytesRead, buffers } = await handle.readv(buffers[, pos])`\n\nRead from the file into an array of `buffers`.\n\n#### `const { bytesWritten, buffer } = await handle.write(data[, offset[, len[, pos]]])`\n\nWrite `data` to the file.\n\n#### `const { bytesWritten, buffers } = await handle.writev(buffers[, pos])`\n\nWrite an array of `buffers` to the file.\n\n#### `const stats = await handle.stat()`\n\nGet the status of the file.\n\n#### `await handle.chmod(mode)`\n\nChange the permissions of the file.\n\n#### `await handle.chown(uid, gid)`\n\nChange the owner and group of the file.\n\n**NOTE**: This function is not implemented on Windows.\n\n#### `await handle.datasync()`\n\nSimilar to `fsync`, but does not flush modified metadata unless necessary.\n\n#### `await handle.sync()`\n\nFlush all modified in-core data of the file.\n\n#### `await handle.truncate(len)`\n\nTruncate the file.\n\n#### `await handle.utimes(mode)`\n\nChange the access and modification times of the file.\n\n#### `const stream = handle.createReadStream([opts])`\n\nCreate a readable stream for the file.\n\n#### `const stream = handle.createWriteStream([opts])`\n\nCreate a writable stream for the file.\n\n#### `handle.fd`\n\nThe file descriptor number.\n\n#### `event: 'close'`\n\nEmitted when the file handle is closed.\n\n## License\n\nApache-2.0",
   "_attachments": {}