![](\"/.documentary/section-breaks/0.svg?sanitize=true\")
\n![](\"/.documentary/section-breaks/1.svg?sanitize=true\")
\n| Property | \nType | \nDescription | \nExample | \n
|---|---|---|---|
text* | \n string | \nDisplay text. Required. | \n\n\n```js\nconst q = {\n text: 'What is your name',\n}\n```\n | \n
validation | \n (async) function | \nA function which needs to throw an error if validation does not pass. | \n\n\n```js\nconst q = {\n text: 'What is your name',\n validate(v) {\n if (!v.length) {\n throw new Error('Name required.')\n }\n },\n}\n```\n | \n
postProcess | \n (async) function | \nA function to transform the answer. | \n\n\n```js\nconst q = {\n text: 'What is your name',\n postProcess(v) {\n return `${v.toLowerCase()}`\n },\n}\n```\n | \n
defaultValue | \n string | \n\n\nDefault answer (shown to users in `[default]` brackets). | \n\n\n```js\nconst q = {\n text: 'What is your name',\n defaultValue: 'Visitor',\n}\n```\n | \n
getDefault | \n (async) function | \nA function to execute to obtain the default value. | \n\n\n```js\nconst q = {\n text: 'What is your name',\n async getDefault() {\n await git('config', 'user.name')\n },\n}\n```\n | \n
password | \n boolean | \nHide the inputs behind * when typing the answer. | \n \n\n```js\nconst q = {\n text: 'Please enter the password',\n password: true,\n}\n```\n | \n
\n
\n\n| Name | Type | Description | Default |\n| ------------ | --------------------------------------------------------------- | ----------------------------------------------------------------------- | ------- |\n| __text*__ | string | The text to show to the user. | - |\n| defaultValue | string | The default answer to the question. | - |\n| password | boolean | Hide the inputs behind `*` when typing the answer. | `false` |\n| getDefault | () => (string \\| !Promise<string>) | The function which will get the default value, possibly asynchronously. | - |\n| validation | (answer: string) => void | The validation function which should throw on error. | - |\n| postProcess | (answer: string) => (string \\| !Promise<string>) | The transformation function for the answer. | - |\n
\n\n\n\n## Question extends readline.ReadLineOptions: A question.
\n\n| Name | Type | Description | Default |\n| ------------ | --------------------------------------------------------------- | ----------------------------------------------------------------------- | ------- |\n| __text*__ | string | The text to show to the user. | - |\n| defaultValue | string | The default answer to the question. | - |\n| password | boolean | Hide the inputs behind `*` when typing the answer. | `false` |\n| getDefault | () => (string \\| !Promise<string>) | The function which will get the default value, possibly asynchronously. | - |\n| validation | (answer: string) => void | The validation function which should throw on error. | - |\n| postProcess | (answer: string) => (string \\| !Promise<string>) | The transformation function for the answer. | - |\n![](\"/.documentary/section-breaks/2.svg?sanitize=true\")
\nasync askSingle(`question: (string|!Question),`
`timeout=: number,`
): string\nAsk user a question via the CLI. Returns the answer to the question. \n If a timeout is passed, the promise will expire after the specified \n number of milliseconds if the answer was not given.\n\n - question* (string \\| !Question): The question to present to the user.\n - timeout `number` (optional): How long to wait before rejecting the promise. Waits forever by default.\n\nQuestions can be asked as a simple string.\n\n```js\nimport { askSingle } from 'reloquent'\n\n(async () => {\n try {\n const answer = await askSingle('What brought you her', 10000)\n console.log(`You've answered: ${answer}`)\n } catch (err) {\n console.log()\n console.log(err)\n console.log('Nevermind...')\n }\n})()\n```\n\n```fs\nWhat brought you her: I guess Art is the cause.\n```\n\n```fs\nYou've answered: I guess Art is the cause.\n```\n\nAlternatively, _Reloquent_ can ask a question which is passed as an object of the `Question` type, and return a string.\n\n```js\nimport { askSingle } from 'reloquent'\n\n(async () => {\n const answer = await askSingle({\n text: 'Do you wish me to stay so long?',\n validation(a) {\n if (a.length < 5) {\n throw new Error('The answer is too short')\n }\n },\n defaultValue: 'I desire it much',\n postProcess(a) {\n return `${a}!`\n },\n async getDefault() {\n return 'I desire it much so'\n },\n })\n console.log(answer)\n})()\n```\n\n```fs\nDo you wish me to stay so long? [I desire it much]\n```\n\n```fs\nI desire it much!\n```\n\n\n\n## ![](\"/.documentary/section-breaks/3.svg?sanitize=true\")
\nasync askQuestions(`questions: !Questions,`
`timeout=: number,`
): !Object\nAsk user a series of questions via CLI and transform them into answers.\n Returns an object with keys as questions' texts and values as answers.\n\n - questions* !Questions: A set of questions.\n - timeout `number` (optional): How long to wait before rejecting the promise. Waits forever by default.\n\n!Object<string, (string \\| !Question)> __`Questions`__: A set of questions.\n\n```js\nimport ask from 'reloquent'\n\nconst Ask = async () => {\n const questions = {\n title: {\n text: 'Title',\n validation(a) {\n if (!a) throw new Error('Please enter the title.')\n },\n },\n description: {\n text: 'Description',\n postProcess: s => s.trim(),\n defaultValue: 'A test default value',\n },\n date: {\n text: 'Date',\n async getDefault() {\n await new Promise(r => setTimeout(r, 200))\n return new Date().toLocaleString()\n },\n },\n }\n const res = await ask(questions)\n return res\n}\n```\n\nIf when provided with the following answers (leaving _Date_ as it is), the result will be returned as an object:\n\n```\nTitle: hello\nDescription: [A test default value] world\nDate: [2/22/2020, 21:37:04] \n\nResult: {\n \"title\": \"hello\",\n \"description\": \"world\",\n \"date\": \"2/22/2020, 21:37:04\"\n}\n```\n\n\n\n## ![](\"/.documentary/section-breaks/4.svg?sanitize=true\")
\nasync confirm(`question: (string|!Question),`
`options=: !ConfirmOptions,`
): boolean\nAsk a yes/no question. Returns `true` when answer was `y` and `false` otherwise.\n\n - question* (string \\| !Question): The question, such as \"Add default options\", or \"Continue to delete?\".\n The question mark can added automatically.\n - options !ConfirmOptions (optional): Options for the confirmation question.\n\n__`ConfirmOptions`__: Options for the confirmation question.\n\n\n| Name | Type | Description | Default |\n| ---------- | ---------------- | ------------------------------------------------------------------------ | ------- |\n| defaultYes | boolean | Whether the default value is _yes_. | `true` |\n| timeout | number | How long to wait before rejecting the promise. Waits forever by default. | - |\n\n```js\nimport { confirm } from 'reloquent'\n\nconst Confirm = async (question) => {\n const res = await confirm(question, {\n defaultYes: false,\n })\n return res\n}\n```\n\n```\nDo you wish to continue (y/n): [n] y\n\nResult: true\n```\n\n\n\n\n## Copyright\n\n![](\"/.documentary/section-breaks/5.svg?sanitize=true\")
\n\n \n ![\"Art](\"https://raw.githubusercontent.com/wrote/wrote/master/images/artdeco.png\"\n) \n \n | \n © Art Deco™ 2020 | \n
|---|
![](\"/.documentary/section-breaks/-1.svg?sanitize=true\")
\n