Interface Animal

Generator to generate animals.

interface Animal {
    animal(): string;
    animalType(): string;
    bird(): string;
    cat(): string;
    dog(): string;
    farmAnimal(): string;
    petName(): string;
}

Methods

animal animalType bird cat dog farmAnimal petName

Methods

animal

  • animal(): string

    Living creature with the ability to move, eat, and interact with its environment.

    Returns string

    a random animal

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.animal())
    }

    Output (formatted as JSON value)

    "crow"

animalType

  • animalType(): string

    Type of animal, such as mammals, birds, reptiles, etc..

    Returns string

    a random animal type

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.animalType())
    }

    Output (formatted as JSON value)

    "amphibians"

bird

  • bird(): string

    Distinct species of birds.

    Returns string

    a random bird

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.bird())
    }

    Output (formatted as JSON value)

    "lovebird"

cat

  • cat(): string

    Various breeds that define different cats.

    Returns string

    a random cat

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.cat())
    }

    Output (formatted as JSON value)

    "Toyger"

dog

  • dog(): string

    Various breeds that define different dogs.

    Returns string

    a random dog

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.dog())
    }

    Output (formatted as JSON value)

    "Staffordshire Bullterrier"

farmAnimal

  • farmAnimal(): string

    Animal name commonly found on a farm.

    Returns string

    a random farm animal

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.farmAnimal())
    }

    Output (formatted as JSON value)

    "Cow"

petName

  • petName(): string

    Affectionate nickname given to a pet.

    Returns string

    a random pet name

    Example

    import { Faker } from "k6/x/faker"

    let faker = new Faker(11)

    export default function () {
     console.log(faker.animal.petName())
    }

    Output (formatted as JSON value)

    "Nacho"

Settings

On This Page

Methods