Skip to main content

API reference (in-site pilot)

A new home for the API reference, rendered inside the site from the TypeScript source: docstring first, centered on the core primitives rather than alphabetical declaration lists. Everything here is extracted at build time (typedoc --json → curated model → site components), so it cannot drift from the code — and referenced type names in the type chips carry hover cards with their definition and doc.

pond-ts (core)

Temporal keysTime, TimeRange, Interval — and Event, the key + payload pair.

GridsSequence, BoundedSequence.

Batch seriesTimeSeries, PartitionedTimeSeries, ValueSeries.

Live seriesLiveSeries, LiveView, LivePartitionedSeries, LivePartitionedView.

@pond-ts/charts

Every React component, docstring first then props — referenced types carry hover cards.

Structure<ChartContainer>, <ChartRow>, <Layers>, <XAxis>, <YAxis>, <Canvas>, <TimeAxis>, <CategoryAxis>.

Draw layers<LineChart>, <AreaChart>, <BandChart>, <BarChart>, <ScatterChart>, <BoxPlot>, <Candlestick>.

Annotations<Baseline>, <Marker>, <Region>, <YAxisIndicator>.

Not yet covered here: data adapters, hooks, and scales (they are functions, not components — a different page shape). The generated reference still covers the full surface.