oceanum-js

@oceanum/datamesh

@oceanum/datamesh / index / date2num

Function: date2num()

Call Signature

date2num(dates, units, calendar?): number

Defined in: packages/datamesh/src/lib/cftime.ts:285

Convert JavaScript Date object(s) to numeric time value(s).

Parameters

dates

Date

Date object or array of Date objects

units

string

CF time units string (e.g., “days since 1970-01-01”)

calendar?

CFCalendar

Calendar type (default: “standard”)

Returns

number

Numeric time value or array of values

Throws

Error if calendar is not supported

Example

// Single value
const num = date2num(new Date("1970-01-02"), "days since 1970-01-01");
// 1

// Array of values
const nums = date2num([new Date("1970-01-01"), new Date("1970-01-02")], "days since 1970-01-01");
// [0, 1]