Interface Address

Generator to generate addresses and locations.

interface Address {
    address(): Record<string, unknown>;
    city(): string;
    country(): string;
    countryAbbreviation(): string;
    latitude(): number;
    latitudeRange(min: number, max: number): number;
    longitude(): number;
    longitudeRange(min: number, max: number): number;
    state(): string;
    stateAbbreviation(): string;
    street(): string;
    streetName(): string;
    streetNumber(): string;
    streetPrefix(): string;
    streetSuffix(): string;
    zip(): string;
}

Methods

address city country countryAbbreviation latitude latitudeRange longitude longitudeRange state stateAbbreviation street streetName streetNumber streetPrefix streetSuffix zip

Methods

address

  • address(): Record<string, unknown>

  • Residential location including street, city, state, country and postal code.

    Returns Record<string, unknown>

    a random address

    Example

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

    let faker = new Faker(11)

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

    Output (formatted as JSON value)

    {"Address":"53883 Villageborough, San Bernardino, Kentucky 56992","Street":"53883 Villageborough","City":"San Bernardino","State":"Kentucky","Zip":"56992","Country":"United States of America","Latitude":11.29359,"Longitude":-145.577493}

city

  • city(): string

  • Part of a country with significant population, often a central hub for culture and commerce.

    Returns string

    a random city

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.city())
    }

    Output (formatted as JSON value)

    "Hialeah"

country

  • country(): string

  • Nation with its own government and defined territory.

    Returns string

    a random country

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.country())
    }

    Output (formatted as JSON value)

    "Togo"

countryAbbreviation

  • countryAbbreviation(): string

  • Shortened 2-letter form of a country's name.

    Returns string

    a random country abbreviation

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.countryAbbreviation())
    }

    Output (formatted as JSON value)

    "TG"

latitude

  • latitude(): number

  • Geographic coordinate specifying north-south position on Earth's surface.

    Returns number

    a random latitude

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.latitude())
    }

    Output (formatted as JSON value)

    11.394086

latitudeRange

  • latitudeRange(min, max): number

  • Latitude number between the given range (default min=0, max=90).

    Parameters

    • min: number

      Min

    • max: number

      Max

    Returns number

    a random latitude range

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.latitudeRange(0,90))
    }

    Output (formatted as JSON value)

    50.697043

longitude

  • longitude(): number

  • Geographic coordinate indicating east-west position on Earth's surface.

    Returns number

    a random longitude

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.longitude())
    }

    Output (formatted as JSON value)

    22.788172

longitudeRange

  • longitudeRange(min, max): number

  • Longitude number between the given range (default min=0, max=180).

    Parameters

    • min: number

      Min

    • max: number

      Max

    Returns number

    a random longitude range

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.longitudeRange(0,180))
    }

    Output (formatted as JSON value)

    101.394086

state

  • state(): string

  • Governmental division within a country, often having its own laws and government.

    Returns string

    a random state

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.state())
    }

    Output (formatted as JSON value)

    "Massachusetts"

stateAbbreviation

  • stateAbbreviation(): string

  • Shortened 2-letter form of a country's state.

    Returns string

    a random state abbreviation

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.stateAbbreviation())
    }

    Output (formatted as JSON value)

    "AA"

street

  • street(): string

  • Public road in a city or town, typically with houses and buildings on each side.

    Returns string

    a random street

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.street())
    }

    Output (formatted as JSON value)

    "53883 Villageborough"

streetName

  • streetName(): string

  • Name given to a specific road or street.

    Returns string

    a random street name

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.streetName())
    }

    Output (formatted as JSON value)

    "Fall"

streetNumber

  • streetNumber(): string

  • Numerical identifier assigned to a street.

    Returns string

    a random street number

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.streetNumber())
    }

    Output (formatted as JSON value)

    "25388"

streetPrefix

  • streetPrefix(): string

  • Directional or descriptive term preceding a street name, like 'East' or 'Main'.

    Returns string

    a random street prefix

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.streetPrefix())
    }

    Output (formatted as JSON value)

    "West"

streetSuffix

  • streetSuffix(): string

  • Designation at the end of a street name indicating type, like 'Avenue' or 'Street'.

    Returns string

    a random street suffix

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.streetSuffix())
    }

    Output (formatted as JSON value)

    "ville"

zip

  • zip(): string

  • Numerical code for postal address sorting, specific to a geographic area.

    Returns string

    a random zip

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.address.zip())
    }

    Output (formatted as JSON value)

    "25388"

Settings

On This Page

Methods