tread
tread
read
a line of input from the user and store as a user defined typed variable (deprecated)
Description
A readline function to allow a line of data inputted from the terminal and then store that as a typed variable.
This builtin is now deprecated. Please use read --datatype ...
instead
Usage
tread data-type "prompt" var_name
<stdin> -> tread data-type var_name
Examples
tread qs "Please paste a URL: " url
out "The query string values included were:"
$url -> format json
out Please paste a URL: -> tread qs url
out "The query string values included were:"
$url -> format json
Detail
If tread
is called as a method then the prompt string is taken from stdin. Otherwise the prompt string will be the first parameter. However if no prompt string is given then tread
will not write a prompt.
The last parameter will be the variable name to store the string read by tread
. This variable cannot be prefixed by dollar, $
, otherwise the shell will write the output of that variable as the last parameter rather than the name of the variable.
See Also
%(Brace Quote)
: Initiates or terminates a string (variables expanded)cast
: Alters the data-type of the previous function without altering its outputerr
: Print a line to the stderrformat
: Reformat one data-type into another data-typeout
: Print a string to the stdout with a trailing new line characterpretty
: Prettifies JSON to make it human readableread
:read
a line of input from the user and store as a variabletout
: Print a string to the stdout and set it's data-type
This document was generated from builtins/core/io/read_doc.yaml.