Class: CliMiami::S

Inherits:
Object
  • Object
show all
Defined in:
lib/cli_miami/say.rb

Overview

class CliMiami::S.ay

Class Method Summary collapse

Class Method Details

.ay(text = '', options = {}) ⇒ Object

S.ay API method

By preset [Symbol[…

symbol

Uses defined preset name

By options [Hash]… color: => [symbol] See README for ansi color codes bgcolor: => [symbol] See README for ansi color codes style: => [symbol] See README for ansi style codes justify: => [center|left|right] The type of justification to use padding: => [integer] The maximum string size to justify text in indent: => [integer] The number of characters to indent newline: => [boolean] True if you want a newline after the output overwrite: => [boolean] True if you want the next line to overwrite the current line

Parameters:

  • options (Symbol or Hash) (defaults to: {})

    options can be preset symbol, or a hash of options.

Returns:


31
32
33
34
35
# File 'lib/cli_miami/say.rb', line 31

def self.ay text = '', options = {}
  # set default options
  options = CliMiami.get_options options
  new text, options
end