web-serial-rxjs API Documentation
    Preparing search index...

    Class SerialError

    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.

    try {
    await client.connect().toPromise();
    } catch (error) {
    if (error instanceof SerialError) {
    console.error(`Error code: ${error.code}`);
    console.error(`Message: ${error.message}`);
    if (error.originalError) {
    console.error(`Original error:`, error.originalError);
    }

    // Check specific error code
    if (error.is(SerialErrorCode.BROWSER_NOT_SUPPORTED)) {
    // Handle browser not supported
    }
    }
    }

    Hierarchy

    • Error
      • SerialError
    Index

    Constructors

    Properties

    The error code identifying the type of error that occurred.

    Use this code to programmatically handle specific error conditions.

    SerialErrorCode for all available error codes

    message: string
    name: string
    originalError?: Error

    The 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.

    stack?: string
    stackTraceLimit: number

    The 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.

    Methods

    • 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.

      Parameters

      Returns boolean

      true if this error's code matches the provided code, false otherwise

      if (error.is(SerialErrorCode.PORT_NOT_OPEN)) {
      // Handle port not open error
      }
    • Creates 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();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any