Class: Faker::Boolean

Inherits:

Base

• Object
• Base
• Faker::Boolean

Defined in:

lib/faker/default/boolean.rb

Constant Summary

Constants inherited from Base

Faker::Base::LLetters, Faker::Base::Letters, Faker::Base::NOT_GIVEN, Faker::Base::Numbers, Faker::Base::ULetters

Class Method Summary

• .boolean(true_ratio: 0.5) ⇒ Boolean

  Produces a boolean.

Methods inherited from Base

bothify, disable_enforce_available_locales, fetch, fetch_all, flexible, letterify, method_missing, numerify, parse, rand, rand_in_range, regexify, resolve, respond_to_missing?, sample, shuffle, translate, unique, with_locale

Class Method Details

.boolean(true_ratio: 0.5) ⇒ Boolean

Produces a boolean

Examples:

Faker::Boolean.boolean #=> true

Faker::Boolean.boolean(true_ratio: 0.2) #=> false

Parameters:

• true_ratio (Float) (defaults to: 0.5) —

  The likelihood (as a float, out of 1.0) for the method to return ‘true`.

Returns:

• (Boolean)

Available since:

• 1.6.2

# File 'lib/faker/default/boolean.rb', line 18

def boolean(true_ratio: 0.5)
  (rand < true_ratio)
end