show_yesno

Shows a yes/no question and returns whether the user selected yes.

It takes a prompt as argument.

local response = human_io.show_yesno("Do the thing? [yn]")
if response == true then
    do_the_thing();
elseif response == false then
    print("okay, won't do the thing")
elseif response == nil then
    -- the user did not answer
    print("...")
end

show_prompt

Prompt for some information.

local response = human_io.show_prompt("What's a good question?")

read_password

Request a (new) password from the user. Asks twice to ensure it was not mistyped.

local password = human_io.read_password()

table

Print data in columns.

local row = human_io.table({ { title = "A", width = 10 }, { title = "B", width = 10 } })
print(row()) -- prints header row
print(row({ "Hello", "World" }))

getchar

Retrieves one character from the console, e.g. the answer to a yes/no question ([yn]).

getline

Retrieves one line from the console.

getpass

Retrieves one line from the console with echo disabled, i.e. what the user types is not shown.

printf

A combination of print() and string.format().

printf("Hello %s", "World") --> Hello World

padleft

Pad a spring with space characters on the left until it is the requested length.

humanio.padleft("foo", 10) --> "       foo"

padright

Pad a spring with space characters on the right until it is the requested length.

humanio.padright("foo", 10) --> "foo       "

term_width

Returns the width of the terminal, or a default number.

local terminal_width = humanio.term_width(80);

ellipsis

Ensures a string is shorter than a given value, or clips away the overflow.

print(human_io.ellipsis("Hello, World", 6)) --> Hello…

parse_duration

Parse a string describing a length of time, e.g. "3w" into seconds.