<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::PromptInput
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::PromptInput";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">PromptInput</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Doing::PromptInput
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Prompt.html" title="Doing::Prompt (module)">Prompt</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/prompt/input.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Methods for requesting user text input</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public deprecated">
<span class="summary_signature">
<a href="#enter_text-instance_method" title="#enter_text (instance method)">#<strong>enter_text</strong>(prompt, default_response: '') ⇒ String </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'><p>Use <span class='object_link'><a href="#read_line-instance_method" title="Doing::PromptInput#read_line (method)">#read_line</a></span> instead</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read_line-instance_method" title="#read_line (instance method)">#<strong>read_line</strong>(prompt: 'Enter text', completions: [], default_response: '') ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Request single-line input using Readline.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read_lines-instance_method" title="#read_lines (instance method)">#<strong>read_lines</strong>(prompt: 'Enter text', completions: [], default_response: '') ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Request multi-line input using Readline.</p>
</div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#request_lines-instance_method" title="#request_lines (instance method)">#<strong>request_lines</strong>(prompt: 'Enter text', default_response: '') ⇒ Object </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'><p>Use <span class='object_link'><a href="#read_lines-instance_method" title="Doing::PromptInput#read_lines (method)">#read_lines</a></span> instead</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="enter_text-instance_method">
#<strong>enter_text</strong>(prompt, default_response: '') ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'><p>Use <span class='object_link'><a href="#read_line-instance_method" title="Doing::PromptInput#read_line (method)">#read_line</a></span> instead</p>
</div></div>
<p>Request single-line input</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>prompt</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The prompt</p>
</div>
</li>
<li>
<span class='name'>default_response</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>''</tt>)</em>
—
<div class='inline'><p>The default
response returned if
:default_answer is
true</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>The user response</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="read_line-instance_method">
#<strong>read_line</strong>(prompt: 'Enter text', completions: [], default_response: '') ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Request single-line input using Readline. Allows
for control sequences and tab completions</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>prompt</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>'Enter text'</tt>)</em>
—
<div class='inline'><p>The prompt</p>
</div>
</li>
<li>
<span class='name'>completions</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
—
<div class='inline'><p>Array of tab
completions</p>
</div>
</li>
<li>
<span class='name'>default_response</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>''</tt>)</em>
—
<div class='inline'><p>The default
response returned if
:default_answer is
true</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>User input string</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="read_lines-instance_method">
#<strong>read_lines</strong>(prompt: 'Enter text', completions: [], default_response: '') ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Request multi-line input using Readline. Allows for
control sequences and tab completion</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>prompt</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>'Enter text'</tt>)</em>
—
<div class='inline'><p>The prompt</p>
</div>
</li>
<li>
<span class='name'>completions</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
—
<div class='inline'><p>Array of tab
completions</p>
</div>
</li>
<li>
<span class='name'>default_response</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>''</tt>)</em>
—
<div class='inline'><p>The default
response returned if
:default_answer is
true</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>Multi-line result, joined with newlines</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="request_lines-instance_method">
#<strong>request_lines</strong>(prompt: 'Enter text', default_response: '') ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'><p>Use <span class='object_link'><a href="#read_lines-instance_method" title="Doing::PromptInput#read_lines (method)">#read_lines</a></span> instead</p>
</div></div>
<p>Request multi-line input</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>prompt</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>'Enter text'</tt>)</em>
—
<div class='inline'><p>The prompt</p>
</div>
</li>
<li>
<span class='name'>default_response</span>
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>''</tt>)</em>
—
<div class='inline'><p>The default
response, returned if
:default_answer is
true</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Mar 11 05:55:28 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.1).
</div>
</div>
</body>
</html>