Overview

Create a Project object by instancing the Project class with a Workspace object.

import { Workspace, Project } from "epanet-js";

const ws = new Workspace();
await ws.loadModule();
const model = new Project(ws);

Every function below is labelled with a version badge indicating which EPANET engine variants expose it. See Workspace for how to load a specific engine (or one with MSX support enabled).

Class Methods

Functions	Description
Project Functions	These functions are used to manage a project
Hydraulic Analysis Functions	These functions are used to perform a hydraulic analysis
Water Quality Analysis Functions	These functions are used to perform a water quality analysis
MSX Functions	Multi-species water-quality functions (require an -msx engine variant)
Reporting Functions	These functions are used to report simulation results
Analysis Options Functions	These functions are used to get and set analysis options
Network Node Functions	These functions are used for working with network nodes
Nodal Demand Functions	These functions are used for managing nodal demands
Network Link Functions	These functions are used for working with network links
Time Pattern Functions	These functions are used for working with time patterns
Data Curve Functions	These functions are used for working with data curves
Simple Control Functions	These functions are used for working with simple conditional controls
Rule-Based Control Functions	These functions are used for working with rule-based controls
Enumerated Types	Constants used as arguments and return values of the toolkit methods