@verifyhash/wind-scale 0.1.0 → 0.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 <OWNER-NAME PLACEHOLDER>
+Copyright (c) 2026 verifyhash
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,5 @@
 # wind-scale
 
-<!-- publish-prep -->
-> **TODO (owner): pick the final npm name/scope before publishing.**
-> The npm package name is **not** finalized by this project. Convention used here:
-> `package.json` keeps the working slug `wind-scale` as a placeholder — replace it
-> (and the `npm install` line below) with the real published name/scope before
-> running `npm publish`.
-
 Zero-dependency, pure-JavaScript wind utilities: convert speeds between the five
 units meteorologists actually use, and classify a wind on the three scales the
 public sees on forecasts — the Beaufort force scale, the Saffir-Simpson
@@ -153,6 +146,14 @@ windChill(20, 2);  //  20        (V <= 3 mph -> out of range, returns tempF)
 Throws `TypeError` if either argument is not a finite number, and `RangeError`
 for negative wind speed.
 
+### Constants (exported tables)
+
+- `UNITS` — the five supported unit codes: `['ms', 'kmh', 'mph', 'kn', 'fts']`.
+- `FACTORS` — units-per-one-m/s conversion factors keyed by unit code
+  (e.g. `FACTORS.kmh === 3.6`); `convert()` is built on this table.
+- `BEAUFORT` — the 13-row Beaufort table of `{ force, minMs, description }`
+  (force 0 "Calm" through force 12 "Hurricane force") used by `beaufort()`.
+
 ## Running the tests
 
 One command, no install step (uses only `node:assert`):
@@ -183,15 +184,12 @@ MIT.
 
 ## Install
 
-> Placeholder name: the `wind-scale` below is the working slug, not a finalized
-> npm name — see the owner TODO near the top of this README.
-
 ```sh
-npm install wind-scale
+npm install @verifyhash/wind-scale
 ```
 
 ```js
-const { convert, beaufort, saffirSimpson, windChill } = require('wind-scale');
+const { convert, beaufort, saffirSimpson, windChill } = require('@verifyhash/wind-scale');
 
 convert(10, 'ms', 'kmh'); // 36
 beaufort(9.0);            // { force: 5, description: 'Fresh breeze', minMs: 8, maxMs: 10.8 }

package/index.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Type declarations for @verifyhash/wind-scale — zero-dependency wind speed
+ * conversions plus Beaufort, Saffir-Simpson, and the official 2001 NWS
+ * wind-chill formula.
+ */
+
+/** Supported wind-speed units: m/s, km/h, mph, knots, ft/s. */
+export type WindUnit = 'ms' | 'kmh' | 'mph' | 'kn' | 'fts';
+
+/**
+ * Convert a wind speed between any two supported units. Throws TypeError for
+ * a non-finite value and RangeError for an unknown unit.
+ *
+ * @example convert(10, 'ms', 'kmh') // => 36
+ */
+export function convert(value: number, fromUnit: WindUnit, toUnit: WindUnit): number;
+
+/** Result of beaufort(): the force band containing the given speed. */
+export interface BeaufortResult {
+  /** Beaufort force, 0..12. */
+  force: number;
+  /** Standard WMO description, e.g. 'Fresh breeze'. */
+  description: string;
+  /** Inclusive lower bound of the band, m/s. */
+  minMs: number;
+  /** Exclusive upper bound of the band, m/s (Infinity for Force 12). */
+  maxMs: number;
+}
+
+/**
+ * Classify a wind speed (m/s, finite, >= 0) on the Beaufort scale. Force 0 is
+ * below 0.5 m/s; Force 12 (hurricane force) begins at 32.7 m/s.
+ */
+export function beaufort(speedMs: number): BeaufortResult;
+
+/** Saffir-Simpson category: NHC sub-hurricane designations or category 1-5. */
+export type SaffirSimpsonCategory = 'TD' | 'TS' | 1 | 2 | 3 | 4 | 5;
+
+/** Result of saffirSimpson(). */
+export interface SaffirSimpsonResult {
+  category: SaffirSimpsonCategory;
+  /** e.g. 'Tropical Storm' or 'Category 3 Hurricane'. */
+  label: string;
+}
+
+/**
+ * Classify a tropical cyclone by its 1-minute sustained wind in mph (finite,
+ * >= 0): TD < 39, TS 39-73, Cat 1 74-95, Cat 2 96-110, Cat 3 111-129,
+ * Cat 4 130-156, Cat 5 >= 157.
+ */
+export function saffirSimpson(sustainedMph: number): SaffirSimpsonResult;
+
+/**
+ * 2001 NWS/Environment Canada wind chill, °F, from air temperature (°F) and
+ * wind speed (mph). Outside the NWS validity domain (tempF > 50 or
+ * windMph <= 3) returns tempF unchanged. Result is not rounded.
+ */
+export function windChill(tempF: number, windMph: number): number;
+
+/** Conversion factors: how many of each unit equal 1 m/s (frozen). */
+export const FACTORS: Readonly<Record<WindUnit, number>>;
+
+/** The Beaufort force table (frozen): inclusive lower bounds in m/s. */
+export const BEAUFORT: ReadonlyArray<{
+  force: number;
+  minMs: number;
+  description: string;
+}>;
+
+/** The supported unit names, in FACTORS order. */
+export const UNITS: readonly string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verifyhash/wind-scale",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Zero-dependency wind speed conversions plus Beaufort, Saffir-Simpson, and the official 2001 NWS wind-chill formula.",
   "keywords": [
     "wind",
@@ -13,13 +13,15 @@
     "conversion"
   ],
   "main": "src/wind-scale.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "node test/wind-scale.test.js"
   },
   "license": "MIT",
   "files": [
     "src/wind-scale.js",
-    "README.md"
+    "README.md",
+    "index.d.ts"
   ],
   "publishConfig": {
     "access": "public"