Skip to content

Exceptions

Source-generated reference for simulation failures and configuration diagnostics. See Errors and recovery for handling patterns. The standalone reader uses OutputError.

SwmmError

Base runtime exception for binding and solver failures; supports instanceof. Ordinary Error message, name, and stack are retained. Standalone output failures use OutputError, not this hierarchy.

Extends

  • Error

Extended by

Constructors

Constructor

new SwmmError(details: ErrorDetails): SwmmError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

SwmmError

Overrides
Error.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

operation

readonly operation: string | undefined;

Failed public operation, when available.

detail

readonly detail: string | undefined;

Additional native failure detail.

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

category

readonly category: string | undefined;

Native error category.

report

readonly report: string | undefined;

Partial report text, when available.

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

cause?

optional cause?: unknown;
Inherited from
Error.cause

name

name: string;
Inherited from
Error.name

message

message: string;
Inherited from
Error.message

stack?

optional stack?: string;
Inherited from
Error.stack

SolverError

Native failure without a more specific binding category, including unmapped future codes.

Extends

Constructors

Constructor

new SolverError(details: ErrorDetails): SolverError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

SolverError

Inherited from

SwmmError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

SwmmError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

SwmmError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

SwmmError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

SwmmError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

SwmmError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

SwmmError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

SwmmError.cleanupError

cause?

optional cause?: unknown;
Inherited from

SwmmError.cause

name

name: string;
Inherited from

SwmmError.name

message

message: string;
Inherited from

SwmmError.message

stack?

optional stack?: string;
Inherited from

SwmmError.stack

LifecycleError

Invalid phase, closed owner, or competing advancement. Native codes: 501, 502, 503, 2001, 2002, 2013.

Extends

Extended by

Constructors

Constructor

new LifecycleError(details: ErrorDetails): LifecycleError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

LifecycleError

Inherited from

SwmmError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

SwmmError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

SwmmError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

SwmmError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

SwmmError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

SwmmError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

SwmmError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

SwmmError.cleanupError

cause?

optional cause?: unknown;
Inherited from

SwmmError.cause

name

name: string;
Inherited from

SwmmError.name

message

message: string;
Inherited from

SwmmError.message

stack?

optional stack?: string;
Inherited from

SwmmError.stack

StaleViewError

Retained owner-bound view no longer matches the live owner.

Extends

Constructors

Constructor

new StaleViewError(details: ErrorDetails): StaleViewError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

StaleViewError

Inherited from

LifecycleError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

LifecycleError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

LifecycleError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

LifecycleError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

LifecycleError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

LifecycleError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

LifecycleError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

LifecycleError.cleanupError

cause?

optional cause?: unknown;
Inherited from

LifecycleError.cause

name

name: string;
Inherited from

LifecycleError.name

message

message: string;
Inherited from

LifecycleError.message

stack?

optional stack?: string;
Inherited from

LifecycleError.stack

ValidationError

Invalid value or read. Native codes: 504, 507, 508, 509, 2003, 2006, 2010, 2012.

Extends

Extended by

Constructors

Constructor

new ValidationError(details: ErrorDetails): ValidationError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

ValidationError

Inherited from

SwmmError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

SwmmError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

SwmmError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

SwmmError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

SwmmError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

SwmmError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

SwmmError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

SwmmError.cleanupError

cause?

optional cause?: unknown;
Inherited from

SwmmError.cause

name

name: string;
Inherited from

SwmmError.name

message

message: string;
Inherited from

SwmmError.message

stack?

optional stack?: string;
Inherited from

SwmmError.stack

ConfigurationError

Configuration rejected with object-level diagnostics; takes precedence over code-based categorization.

Extends

Constructors

Constructor

new ConfigurationError(details: ErrorDetails): ConfigurationError;

Construct a configuration failure and defensively freeze its diagnostics.

Parameters
Parameter Type Description
details ErrorDetails Error metadata and optional diagnostic list (defaults to empty).
Returns

ConfigurationError

Overrides

ValidationError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

ValidationError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

ValidationError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

ValidationError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

ValidationError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

ValidationError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

ValidationError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

ValidationError.cleanupError

diagnostics

readonly diagnostics: readonly ConfigurationDiagnostic[];

Frozen diagnostic array with frozen object identities.

cause?

optional cause?: unknown;
Inherited from

ValidationError.cause

name

name: string;
Inherited from

ValidationError.name

message

message: string;
Inherited from

ValidationError.message

stack?

optional stack?: string;
Inherited from

ValidationError.stack

ObjectNotFoundError

Unknown object/definition ID. Native codes: 505, 506, 2000, 2004, 2005, 2007, 2008, 2009.

Extends

Constructors

Constructor

new ObjectNotFoundError(details: ErrorDetails): ObjectNotFoundError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

ObjectNotFoundError

Inherited from

SwmmError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

SwmmError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

SwmmError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

SwmmError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

SwmmError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

SwmmError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

SwmmError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

SwmmError.cleanupError

cause?

optional cause?: unknown;
Inherited from

SwmmError.cause

name

name: string;
Inherited from

SwmmError.name

message

message: string;
Inherited from

SwmmError.message

stack?

optional stack?: string;
Inherited from

SwmmError.stack

WorkerError

Worker startup, communication, or runtime prerequisite failure.

Extends

Extended by

Constructors

Constructor

new WorkerError(details: ErrorDetails): WorkerError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

WorkerError

Inherited from

SwmmError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

SwmmError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

SwmmError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

SwmmError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

SwmmError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

SwmmError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

SwmmError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

SwmmError.cleanupError

cause?

optional cause?: unknown;
Inherited from

SwmmError.cause

name

name: string;
Inherited from

SwmmError.name

message

message: string;
Inherited from

SwmmError.message

stack?

optional stack?: string;
Inherited from

SwmmError.stack

InternalSimulationError

Internal native simulation failure, mapped from code 9999.

Extends

Constructors

Constructor

new InternalSimulationError(details: ErrorDetails): InternalSimulationError;

Construct an error with serialized or caller-supplied details.

Parameters
Parameter Type Description
details ErrorDetails Message and optional structured failure metadata.
Returns

InternalSimulationError

Inherited from

WorkerError.constructor

Properties

code

readonly code: number | undefined;

Native numeric failure code, when available.

Inherited from

WorkerError.code

operation

readonly operation: string | undefined;

Failed public operation, when available.

Inherited from

WorkerError.operation

detail

readonly detail: string | undefined;

Additional native failure detail.

Inherited from

WorkerError.detail

semanticCode

readonly semanticCode: string | undefined;

Preserves unknown future categories rather than discarding them.

Inherited from

WorkerError.semanticCode

category

readonly category: string | undefined;

Native error category.

Inherited from

WorkerError.category

report

readonly report: string | undefined;

Partial report text, when available.

Inherited from

WorkerError.report

cleanupError

cleanupError: unknown;

Secondary cleanup failure retained after a primary run failure.

Inherited from

WorkerError.cleanupError

cause?

optional cause?: unknown;
Inherited from

WorkerError.cause

name

name: string;
Inherited from

WorkerError.name

message

message: string;
Inherited from

WorkerError.message

stack?

optional stack?: string;
Inherited from

WorkerError.stack

ConfigurationObjectIdentity

Native identity attached to a configuration diagnostic, not a lookup handle.

Properties

Property Modifier Type Description
objectType readonly string Native object-family name.
id readonly string Canonical object ID.
index readonly number Native configured-order index for diagnostics.

ConfigurationDiagnostic

One rejected configuration rule; the complete patch remains unapplied.

Properties

Property Modifier Type Description
object readonly ConfigurationObjectIdentity Object whose declaration failed validation.
propertyPath readonly string Property path identifying the rejected value.
ruleCode readonly string Stable native validation-rule identifier.
message readonly string Human-readable explanation.
conflictingObject readonly ConfigurationObjectIdentity | null Other object involved in the conflict, or null.

ErrorDetails

Details retained when an error crosses the worker boundary.

Properties

Property Type Description
message string Required human-readable error text.
code? number Native numeric code, when supplied.
operation? string Operation that failed.
detail? string Additional native detail.
semanticCode? string Semantic category, preserving unknown future values.
category? string Native failure category.
diagnostics? readonly ConfigurationDiagnostic[] Configuration diagnostics; presence takes precedence over numeric-code mapping.
report? string Partial report text, when available.
cleanupError? string Serialized secondary cleanup failure, when supplied by the worker.