mostlyright

Interfaces

CatalogEntry

One entry in the per-domain catalog manifest (generated from the Python registry; committed at @mostlyrightmd/weather/catalog). The injected source of truth for the kind: "source" discover rows.

Properties

availability

readonly availability: ManifestAvailability

columns?

readonly optional columns: readonly string[]

domain

readonly domain: string

entity?

readonly optional entity: string

id

readonly id: string

kind

readonly kind: string

license?

readonly optional license: string

note?

readonly optional note: string

pit_fidelity?

readonly optional pit_fidelity: string

point_in_time_fidelity?

readonly optional point_in_time_fidelity: string

units?

readonly optional units: Readonly<Record<string, string>>

usage?

readonly optional usage: CatalogUsage

---

CatalogUsage

Language-tagged usage snippet carried by a catalog entry.

Properties

py?

readonly optional py: string

ts?

readonly optional ts: string

---

DiscoverFilters

Structured filters — none of them change the return type.

Properties

availability?

readonly optional availability: "python" | "typescript"

catalog?

readonly optional catalog: readonly CatalogEntry[]

The catalog manifest entries for the source rows (inject or loadWeatherCatalog()).

domain?

readonly optional domain: string

kind?

readonly optional kind: "source" | "station"

---

DiscoverSourceRow

A registered data-source hit.

Properties

availability

readonly availability: readonly string[]

domain

readonly domain: string

id

readonly id: string

kind

readonly kind: "source"

name

readonly name: string

note

readonly note: string

point_in_time_fidelity

readonly point_in_time_fidelity: null | string

usage_ts

readonly usage_ts: string

The TS-facing usage snippet (never a bare Python snippet).

---

DiscoverStationRow

A bundled-catalog station hit.

Properties

country

readonly country: null | string

domain

readonly domain: string

id

readonly id: string

kind

readonly kind: "station"

latitude

readonly latitude: null | number

longitude

readonly longitude: null | number

name

readonly name: string

note

readonly note: string

timezone

readonly timezone: null | string

---

TrainingTableOptions

The capped option surface for trainingTable. Only label — no transport/cache/clock seams.

Properties

label?

readonly optional label: Label

The settlement label recipe — "cli" (default, Kalshi NHIGH/NLOW) or "daily_extremes" (Polymarket WU/NOAA-WRH).

---

TrainingTableRow

One supervised row: the settlement label columns beside the observation feature aggregates, keyed by (station, local_standard_date), with the three MACH-05 temporal columns. snake_case keys serialize identically to the Python schema.core.training_table.v1 frame.

Properties

daily_summary_report_type

readonly daily_summary_report_type: null | string

daily_summary_temp_high_f

readonly daily_summary_temp_high_f: null | number

daily_summary_temp_low_f

readonly daily_summary_temp_low_f: null | number

decision_time_utc

readonly decision_time_utc: string

The settlement decision cutoff (a model would have acted “as of” this instant).

knowable_at_utc

readonly knowable_at_utc: string

max(decision_time_utc, label_available_time_utc) — when the row first became computable.

label_available_time_utc

readonly label_available_time_utc: string

When the settlement label was published/available.

local_standard_date

readonly local_standard_date: string

observation_count

readonly observation_count: number

observed_dewpoint_mean_f

readonly observed_dewpoint_mean_f: null | number

observed_precipitation_total_in

readonly observed_precipitation_total_in: null | number

observed_temp_high_f

readonly observed_temp_high_f: null | number

observed_temp_low_f

readonly observed_temp_low_f: null | number

observed_temp_mean_f

readonly observed_temp_mean_f: null | number

observed_wind_gust_max_kt

readonly observed_wind_gust_max_kt: null | number

observed_wind_max_kt

readonly observed_wind_max_kt: null | number

station

readonly station: string

Type Aliases

DiscoverRow

DiscoverRow: DiscoverStationRow | DiscoverSourceRow

One discover row — a discriminated union on kind.

---

Label

Label: "cli" | "daily_extremes"

The settlement-label recipe selector — mirrors Python weather.training_table’s Label.

---

ManifestAvailability

ManifestAvailability: string | ReadonlyArray<string>

A manifest availability value: the language-name list or a legacy comma-string.

Variables

version

const version: "1.9.9" = "1.9.9"

Public package version; kept in lockstep with package.json.

Functions

discover()

discover(query, filters): DataResult<DiscoverRow>

Discover stations and data sources in ONE discriminated envelope.

Parameters

query

string

filters

DiscoverFilters = {}

Returns

DataResult<DiscoverRow>

Example

const { rows } = discover("nyc");                       // station hits
  const { rows } = discover("temp", { catalog, kind: "source" }); // source hits
  for (const row of rows) {
    if (row.kind === "station") { row.timezone; }         // narrows to station geo
    else { row.availability; }                            // narrows to source meta
  }

---

loadWeatherCatalog()

loadWeatherCatalog(url): Promise<readonly CatalogEntry[]>

Lazily fetch a per-domain catalog manifest (browser-safe: fetch + JSON). Point url at the committed @mostlyrightmd/weather/catalog asset. Kept out of the barrel’s top level so the manifest never enters the size-budgeted meta bundle.

Parameters

url

string

Returns

Promise<readonly CatalogEntry[]>

---

trainingTable()

trainingTable(station, fromDate, toDate, opts): Promise<DataResult<TrainingTableRow>>

A built-in supervised-table example: features -> label rows for a station + date window, one per station local standard day. It preserves the recipe’s temporal columns and applies the timing metadata available from its sources.

trainingTable() is a built-in supervised-table example (the twin of Python weather.training_table()). An OMITTED label returns the "cli" settlement target (Kalshi NHIGH/NLOW ground truth) beside the observation feature aggregates — the EXPLICIT, contractually-stable default (no deprecation path). Pass label: "daily_extremes" to swap in the Polymarket WU/NOAA-WRH target.

Parameters

station

string

the station id (e.g. "KNYC").

fromDate

string

YYYY-MM-DD inclusive start.

toDate

string

YYYY-MM-DD inclusive end.

opts

TrainingTableOptions = {}

the capped option surface — only label.

Returns

Promise<DataResult<TrainingTableRow>>

a DataResult of TrainingTableRow plus its provenance envelope.

Example

const { rows, provenance } = await trainingTable("KNYC", fromDate, toDate);