Basic types

Duration

A duration type represents a length of time with millisecond precision. Duration literals contain integers and unit specifiers, with support for the following unit specifiers:

  • ms millisecond

  • s second

  • m minute

  • h hour

  • d day

  • w week

  • mo calendar month

  • y calendar year

Examples

"1ms" // 1 millisecond
"1s"  // 1 second
"1m"  // 1 minute
"1h"  // 1 hour
"1d"  // 1 day
"1w"  // 1 week
"1mo" // 1 calendar month
"1y"  // 1 calendar year

"3d12h4m25s" // 3 days, 12 hours, 4 minutes, and 25 seconds
"-1d" // past 1 day

ISO 8601

A ISO 8601 type represents a date and time format string that complies with ISO 8601. ISO 8601 is a string in the format yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fff'Z' with millisecond precision.

Examples

"2020-01-01T00:00:00Z"     // Wed, 01 Jan 2020 00:00:00.000 GMT
"2020-01-01T00:00:00.100Z" // Wed, 01 Jan 2020 00:00:00.100 GMT

Location

Location is a geographic coordinate that specifies the position of a point on the surface of the Earth. Latitude, longitude and altitude are defined on the reference ellipsoid World Geodetic System 1984 (WGS 84).

type

object

properties

  • lat

Latitude

type

number

  • lon

Longitude

type

number

  • alt

Altitude

type

number

  • pdop

Position (3D) dilution of precision

type

number

  • hdop

Horizontal dilution of precision

type

number

  • vdop

Vertical dilution of precision

type

number

  • sats

Number of satellites in use

type

number

Notes

  1. Positive latitudes are in the Northern hemisphere, and negative ones are in the Southern hemisphere.

  2. Positive longitudes are east of the prime meridian, and negative ones are west.

Examples

{
        "lat": 53.2049943,
        "lon": 5.983111
}

Unix time

Unix time is defined as the number of non-leap seconds which have passed since 00:00:00 UTC on Thursday, 1 January 1970, which is referred to as the Unix epoch. Unix time is a decimal number that represents seconds with millisecond precision. Request Unix time may also be an integer number that represents milliseconds.

Examples

1577836800    // Wed, 01 Jan 2020 00:00:00.000 GMT
1577836800.1  // Wed, 01 Jan 2020 00:00:00.100 GMT
1577836800100 // Wed, 01 Jan 2020 00:00:00.100 GMT

UUID

A UUID type represents a universally unique identifier. A UUID is a 128-bit integer (16 bytes) that can be used across all computers and networks wherever a unique identifier is required. Such an identifier has a very low probability of being duplicated.

Examples

"00000000-0000-0000-0000-000000000000"