PHP's gettimeofday in TypeScript

How to use

Install via yarn add locutus and import: import { gettimeofday } from 'locutus/php/datetime/gettimeofday'.

Or with CommonJS: const { gettimeofday } = require('locutus/php/datetime/gettimeofday')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	var $obj = gettimeofday() var $result = ('sec' in $obj && 'usec' in $obj && 'minuteswest' in $obj &&80, 'dsttime' in $obj)	true
2	var $timeStamp = gettimeofday(true) var $result = $timeStamp > 1000000000 && $timeStamp < 2000000000	true

Here's what our current TypeScript equivalent to PHP's gettimeofday looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

type GetTimeOfDayObject = {
  sec: number
  usec: number
  minuteswest: number
  dsttime: number
}

export function gettimeofday(returnFloat?: boolean): number | GetTimeOfDayObject {
  //  discuss at: https://locutus.io/php/gettimeofday/
  // original by: Brett Zamir (https://brett-zamir.me)
  // original by: Josh Fraser (https://onlineaspect.com/2007/06/08/auto-detect-a-time-zone-with-javascript/)
  //    parts by: Breaking Par Consulting Inc (https://www.breakingpar.com/bkp/home.nsf/0/87256B280015193F87256CFB006C45F7)
  //  revised by: Theriault (https://github.com/Theriault)
  //   example 1: var $obj = gettimeofday()
  //   example 1: var $result = ('sec' in $obj && 'usec' in $obj && 'minuteswest' in $obj &&80, 'dsttime' in $obj)
  //   returns 1: true
  //   example 2: var $timeStamp = gettimeofday(true)
  //   example 2: var $result = $timeStamp > 1000000000 && $timeStamp < 2000000000
  //   returns 2: true

  const t = new Date()

  if (returnFloat) {
    return t.getTime() / 1000
  }

  // Store current year.
  const y = t.getFullYear()
  return {
    sec: t.getUTCSeconds(),
    usec: t.getUTCMilliseconds() * 1000,
    minuteswest: t.getTimezoneOffset(),
    // Compare Jan 1 minus Jan 1 UTC to Jul 1 minus Jul 1 UTC to see if DST is observed.
    dsttime: Number(new Date(y, 0).getTime() - Date.UTC(y, 0) !== new Date(y, 6).getTime() - Date.UTC(y, 6)),
  }
}

export function gettimeofday(returnFloat) {
  //  discuss at: https://locutus.io/php/gettimeofday/
  // original by: Brett Zamir (https://brett-zamir.me)
  // original by: Josh Fraser (https://onlineaspect.com/2007/06/08/auto-detect-a-time-zone-with-javascript/)
  //    parts by: Breaking Par Consulting Inc (https://www.breakingpar.com/bkp/home.nsf/0/87256B280015193F87256CFB006C45F7)
  //  revised by: Theriault (https://github.com/Theriault)
  //   example 1: var $obj = gettimeofday()
  //   example 1: var $result = ('sec' in $obj && 'usec' in $obj && 'minuteswest' in $obj &&80, 'dsttime' in $obj)
  //   returns 1: true
  //   example 2: var $timeStamp = gettimeofday(true)
  //   example 2: var $result = $timeStamp > 1000000000 && $timeStamp < 2000000000
  //   returns 2: true

  const t = new Date()

  if (returnFloat) {
    return t.getTime() / 1000
  }

  // Store current year.
  const y = t.getFullYear()
  return {
    sec: t.getUTCSeconds(),
    usec: t.getUTCMilliseconds() * 1000,
    minuteswest: t.getTimezoneOffset(),
    // Compare Jan 1 minus Jan 1 UTC to Jul 1 minus Jul 1 UTC to see if DST is observed.
    dsttime: Number(new Date(y, 0).getTime() - Date.UTC(y, 0) !== new Date(y, 6).getTime() - Date.UTC(y, 6)),
  }
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP datetime functions

Star