interface-forge - v2.5.0
    Preparing search index...

    Class DatatypeModule

    Module to generate boolean values.

    For a simple random true or false value, use boolean().

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    faker

    Methods

    boolean

    Constructors

    Properties

    faker: SimpleFaker

    Methods

    • Returns the boolean value true or false.

      Note: A probability of 0.75 results in true being returned 75% of the calls; likewise 0.3 => 30%. If the probability is <= 0.0, it will always return false. If the probability is >= 1.0, it will always return true. The probability is limited to two decimal places.

      Parameters

      • Optionaloptions: number | { probability?: number }

        The optional options object or the probability ([0.00, 1.00]) of returning true.

        • number
        • { probability?: number }
          • Optionalprobability?: number

            The probability ([0.00, 1.00]) of returning true.

            0.5

      Returns boolean

      faker.datatype.boolean() // false
      faker.datatype.boolean(0.9) // true
      faker.datatype.boolean({ probability: 0.1 }) // false

      5.5.0

    Settings

    Member Visibility

    On This Page

    Overview
    Constructors
    Properties
    Methods