@apio/timeframes

Timeframes

Dataframe-like API for timeseries-like data

⚠️ This is still a work in progress

Quickstart

Install through NPM

npm i @apio/timeframes

There are a few examples that you can check out in the examples directory.

TimeSeries

import { TimeSerie } from '@apio/timeframes'

// Pass an array of points
// a point is a tuple [DateLike, PointValue]
// DateLike is value that can be passed to new Date()
// PointValue is any value, but preferably a number (to compute sums averages ecc)
const ts = new TimeSerie([["2022-01-01", 12],["2022-01-02", 13]])
const sum = ts.sum()
const avg = ts.avg()

TimeFrames

import { TimeFrame } from '@apio/timeframes'
// Each item is a row
const rows = [
  {time: "2022-01-01", value1:10, value2:140},
  {time: "2022-01-02", value1:41}, // here value2 is null
  {time: "2022-01-03", value1:78, value2:301},
]
const ts = new TimeFrame(rows)
// column() extracts columns as timeseries
const total1 = ts.column("value1").sum()

Changelog

📦 1.8.0 (26 Feb 2024)

• b9f0f chore(release): 1.8.0
• b6c85 feat: backfill and forwardfill for reindex
• f1fc9 📦 Release 1.7.0 standard-version [skip ci]