Creates a new SerialError instance.
The error code identifying the type of error
A human-readable error message
OptionaloriginalError: Error
The original error that caused this SerialError, if any.
Optionalcontext: SerialErrorContextMap[TCode]
Structured metadata for the error code. For cause-bearing
codes, pass { cause } here. When omitted, cause-bearing codes derive
{ cause } from the legacy originalError argument.
Prefer passing { cause } via context. When omitted,
cause-bearing codes derive { cause } from this argument for backward
compatibility.
ReadonlycodeThe error code identifying the type of error that occurred.
Use this code to programmatically handle specific error conditions.
SerialErrorCode for all available error codes
ReadonlycontextStructured metadata associated with code.
When is returns true, TypeScript narrows this property to the
context shape defined in SerialErrorContextMap for that code.
Optional ReadonlyoriginalThe original error that caused this SerialError, if available.
This property contains the underlying error (e.g., DOMException, TypeError) that was wrapped in this SerialError. It may be undefined if no original error exists.
Prefer context for cause-bearing codes. This property is retained for backward compatibility and is kept in sync when a cause is provided.
OptionalstackStaticstackThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Check if the error matches a specific error code.
This is a convenience method for checking the error code without directly
comparing the code property. When this method returns true, TypeScript
narrows this.code and this.context to the shapes defined for the
provided code argument.
The error code to check against
Type predicate: true if this error's code matches the provided
code (and this.code / this.context are narrowed), false otherwise
StaticcaptureCreates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
OptionalconstructorOpt: FunctionStaticprepare
Custom error class for serial port operations.
This error class extends the standard Error class and includes additional information about the type of error that occurred. It provides an error code for programmatic error handling and may include the original error that caused the failure.
Example