Class ESPProvError

Represents an error related to provisioning issues.

This class extends ESPBaseError and is used to handle errors that occur during the provisioning process, such as device setup or user-device association.

Hierarchy (View Summary)

Constructors

constructor

Properties

cause? code label message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new ESPProvError(
        code:
            | "MISSING_NODE_ID"
            | "MISSING_PROV_ADAPTER"
            | "MISSING_ID_TOKEN"
            | "FAILED_PROV"
            | "FAILED_USER_DEVICE_ASSOCIATION"
            | "FAILED_USER_NODE_MAPPING_REQUEST_CREATION"
            | "FAILED_USER_NODE_MAPPING_CLOUD_TIMEOUT"
            | "INVALID_PROVISION_TYPE"
            | "INVALID_MAPPING_RESPONSE"
            | "INVALID_CHALLENGE_RESPONSE_FORMAT"
            | "VERIFY_NODE_MAPPING_FAILED"
            | "SET_NETWORK_CREDENTIALS_FAILED"
            | "CHALLENGE_RESPONSE_NOT_SUPPORTED",
    ): ESPProvError

  • Creates an instance of ESPProvError.

    Parameters

    • code:
          | "MISSING_NODE_ID"
          | "MISSING_PROV_ADAPTER"
          | "MISSING_ID_TOKEN"
          | "FAILED_PROV"
          | "FAILED_USER_DEVICE_ASSOCIATION"
          | "FAILED_USER_NODE_MAPPING_REQUEST_CREATION"
          | "FAILED_USER_NODE_MAPPING_CLOUD_TIMEOUT"
          | "INVALID_PROVISION_TYPE"
          | "INVALID_MAPPING_RESPONSE"
          | "INVALID_CHALLENGE_RESPONSE_FORMAT"
          | "VERIFY_NODE_MAPPING_FAILED"
          | "SET_NETWORK_CREDENTIALS_FAILED"
          | "CHALLENGE_RESPONSE_NOT_SUPPORTED"

      The error code corresponding to a specific provisioning error message from provErrorMessages.

    Returns ESPProvError

Properties

Optionalcause

cause?: unknown

code

code: string

The specific error code associated with the error.

label

label: string

A label to classify the error type.

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods