Interface Time

Generator to generate time and date.

interface Time {
    date(format: string): string;
    dateRange(startdate: string, enddate: string, format: string): string;
    day(): number;
    futureTime(): string;
    hour(): number;
    minute(): number;
    month(): string;
    monthString(): string;
    nanosecond(): number;
    pastTime(): string;
    second(): number;
    timezone(): string;
    timezoneAbbreviation(): string;
    timezoneFull(): string;
    timezoneOffset(): number;
    timezoneRegion(): string;
    weekday(): string;
    year(): number;
}

Methods

date dateRange day futureTime hour minute month monthString nanosecond pastTime second timezone timezoneAbbreviation timezoneFull timezoneOffset timezoneRegion weekday year

Methods

date

  • date(format): string

  • Representation of a specific day, month, and year, often used for chronological reference.

    Parameters

    • format: string

      Format

    Returns string

    a random date

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.date("RFC3339"))
    }

    Output (formatted as JSON value)

    "2011-10-23T18:10:11Z"

dateRange

  • dateRange(startdate, enddate, format): string

  • Random date between two ranges.

    Parameters

    • startdate: string

      Start Date

    • enddate: string

      End Date

    • format: string

      Format

    Returns string

    a random daterange

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.dateRange("1970-01-01","2024-09-05","yyyy-MM-dd"))
    }

    Output (formatted as JSON value)

    "1988-03-03"

day

  • day(): number

  • 24-hour period equivalent to one rotation of Earth on its axis.

    Returns number

    a random day

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.day())
    }

    Output (formatted as JSON value)

    22

futureTime

  • futureTime(): string

  • Date that has occurred after the current moment in time.

    Returns string

    a random futuretime

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.futureTime())
    }

    Output (formatted as JSON value)

    "2024-09-05T22:35:15.223243185+02:00"

hour

  • hour(): number

  • Unit of time equal to 60 minutes.

    Returns number

    a random hour

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.hour())
    }

    Output (formatted as JSON value)

    21

minute

  • minute(): number

  • Unit of time equal to 60 seconds.

    Returns number

    a random minute

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.minute())
    }

    Output (formatted as JSON value)

    9

month

  • month(): string

  • Division of the year, typically 30 or 31 days long.

    Returns string

    a random month

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.month())
    }

    Output (formatted as JSON value)

    10

monthString

  • monthString(): string

  • String Representation of a month name.

    Returns string

    a random month string

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.monthString())
    }

    Output (formatted as JSON value)

    "October"

nanosecond

  • nanosecond(): number

  • Unit of time equal to One billionth (10^-9) of a second.

    Returns number

    a random nanosecond

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.nanosecond())
    }

    Output (formatted as JSON value)

    953698829

pastTime

  • pastTime(): string

  • Date that has occurred before the current moment in time.

    Returns string

    a random pasttime

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.pastTime())
    }

    Output (formatted as JSON value)

    "2024-09-05T02:35:15.223523755+02:00"

second

  • second(): number

  • Unit of time equal to 1/60th of a minute.

    Returns number

    a random second

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.second())
    }

    Output (formatted as JSON value)

    9

timezone

  • timezone(): string

  • Region where the same standard time is used, based on longitudinal divisions of the Earth.

    Returns string

    a random timezone

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.timezone())
    }

    Output (formatted as JSON value)

    "Tonga Standard Time"

timezoneAbbreviation

  • timezoneAbbreviation(): string

  • Abbreviated 3-letter word of a timezone.

    Returns string

    a random timezone abbreviation

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.timezoneAbbreviation())
    }

    Output (formatted as JSON value)

    "TST"

timezoneFull

  • timezoneFull(): string

  • Full name of a timezone.

    Returns string

    a random timezone full

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.timezoneFull())
    }

    Output (formatted as JSON value)

    "(UTC+13:00) Nuku'alofa"

timezoneOffset

  • timezoneOffset(): number

  • The difference in hours from Coordinated Universal Time (UTC) for a specific region.

    Returns number

    a random timezone offset

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.timezoneOffset())
    }

    Output (formatted as JSON value)

    13

timezoneRegion

  • timezoneRegion(): string

  • Geographic area sharing the same standard time.

    Returns string

    a random timezone region

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.timezoneRegion())
    }

    Output (formatted as JSON value)

    "Asia/Manila"

weekday

  • weekday(): string

  • Day of the week excluding the weekend.

    Returns string

    a random weekday

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.weekday())
    }

    Output (formatted as JSON value)

    "Sunday"

year

  • year(): number

  • Period of 365 days, the time Earth takes to orbit the Sun.

    Returns number

    a random year

    Example

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

    let faker = new Faker(11)

    export default function () {
     console.log(faker.time.year())
    }

    Output (formatted as JSON value)

    1979

Settings

On This Page

Methods