JavaScript / TypeScript API reference
Import public symbols from @swmmrs/swmmrs. These references are generated from
the TypeScript declarations and their source comments. For workflows, start with
the user guide.
| Area | Reference |
|---|---|
| Ownership, execution, files, and scenarios | Simulation |
| Model declarations and scheduling | Simulation options |
| Hydraulic and runoff objects | Node, Link, Subcatchment, Rain gage |
| Object lookup and family snapshots | Collections |
| Identity handles, aquifers, and snowmelt | Model definitions |
| AMM, RTK, and assignments | RDII |
| LID controls, usages, and results | LID |
| System totals and aligned result shapes | Snapshots and statistics |
| Standalone output reader and series | Binary output |
| Runtime options, metadata, and categorical unions | Types and enums |
| Simulation errors and diagnostics | Exceptions |