YukiHelper (YukiHelper v0.2.0) View Source

Documentation for YukiHelper.

Link to this section Summary

Types

Arguments to parse.

Results when arguments failed to parse.

Types when arguments failed to parse.

Any string message.

Parsed results.

Functions

Returns message with red color.

Returns message with green color.

Returns message with yellow color.

Link to this section Types

Specs

arguments() :: [:integer | :string]

Arguments to parse.

Specs

invalid_options() :: {invalid_type(), message()}

Results when arguments failed to parse.

Specs

invalid_type() :: :invalid_arguments | :invalid_option

Types when arguments failed to parse.

Specs

message() :: String.t()

Any string message.

Specs

options() :: {keyword(), list()} | []

Parsed results.

Link to this section Functions

Specs

error(message()) :: message()

Returns message with red color.

Link to this function

parse_options(argv, arguments, switches)

View Source

Specs

parse_options(list(), arguments(), keyword()) :: options() | invalid_options()

Parses common options.

Specs

success(message()) :: message()

Returns message with green color.

Specs

warning(message()) :: message()

Returns message with yellow color.