Options
All
  • Public
  • Public/Protected
  • All
Menu

@plandek-utils/time-utils

Index

Functions

Functions

freezeTime

  • freezeTime<T>(time: Date, fn: () => T): T

  • Executes the given function, freezing the time first to the given time, and resetting the function execution (uses timekeeper)

    // assume now is "2019-03-21T12:21:13.000Z"

function renderTime() {
  const d = new Date()
  console.log(d.toISOString())
}

renderTime() // => logs "2019-03-21T12:21:13.000Z"

const time = new Date("2018-01-02T13:14:15.123Z")
const res = freezeTime(time, () => { renderTime(); return 'blah' }) // => logs "2018-01-02T13:14:15.123Z"
console.log(res) // => logs 'blah' (freezeTime() returns the result of the passed function)

renderTime() // => logs "2019-03-21T12:21:13.010Z" (time is unfrozen, let's say that a 10ms have passed)

    Type parameters

    • T

    Parameters

    • time: Date

      the time that will be the new "now"

    • fn: () => T

      function to execute, on which the time will be frozen as time

        • (): T

        • Returns T

    Returns T

freezeTimeAwait

  • freezeTimeAwait<T>(time: Date, fn: () => Promise<T>): Promise<T>

  • same as freezeTime() but it expects an async function. It will await for the function's return and return it before resetting the time

    TODO: this needs concurrency testing

    see

    freezeTime

    Type parameters

    • T

    Parameters

    • time: Date

      the time that will be the new "now"

    • fn: () => Promise<T>

      async function to execute, on which the time will be frozen as time

        • (): Promise<T>

        • Returns Promise<T>

    Returns Promise<T>

Generated using TypeDoc