Class: Clack::Warning

Inherits:

Data

• Object
• Data
• Clack::Warning

Defined in:

lib/clack.rb

Overview

Warning result from validation - allows user to proceed with confirmation. Validators can return a Warning to show a yellow message that doesn’t block submission if the user confirms by pressing Enter again.

Examples:

Validator returning a warning

validate: ->(v) { Clack::Warning.new("File exists, overwrite?") if File.exist?(v) }

Instance Attribute Summary

• #message ⇒ Object readonly

  Returns the value of attribute message.

Instance Method Summary

• #to_s ⇒ String

  The warning message.

Instance Attribute Details

#message ⇒ Object (readonly)

Returns the value of attribute message

Returns:

• (Object) —

  the current value of message

# File 'lib/clack.rb', line 71

def message
  @message
end

Instance Method Details

#to_s ⇒ String

Returns the warning message.

Returns:

• (String) —

  the warning message

# File 'lib/clack.rb', line 73

def to_s = message