.. role:: ts-api-decorator

#################
CommunicatorError
#################

.. container:: ts-api-section

   .. js:class:: CommunicatorError

      Base error class for all Communicator errors. Extends base Error class as documented [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error).

      :preferred:



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~CommunicatorError.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~CommunicatorError.message`
   * :js:attr:`~CommunicatorError.name`
   * :js:attr:`~CommunicatorError.stack`
   * :js:attr:`~CommunicatorError.prepareStackTrace`
   * :js:attr:`~CommunicatorError.stackTraceLimit`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~CommunicatorError.captureStackTrace`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: CommunicatorError.constructor( message)

      :param message: None
      :type message: string


      Creates a new CommunicatorError


      :rtype: CommunicatorError



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: CommunicatorError.message

      :type: string





.. container:: ts-api-section

   .. js:attribute:: CommunicatorError.name

      :type: string





.. container:: ts-api-section

   .. js:attribute:: CommunicatorError.stack

      :type: string :ts-api-decorator:`optional`





.. container:: ts-api-section

   .. js:attribute:: CommunicatorError.prepareStackTrace

      :type: function :ts-api-decorator:`optional`

      Optional override for formatting stack traces

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


      .. js:function:: prepareStackTrace( err, stackTraces)
         :noindex:

         :param err: None
         :type err: Error
         :param stackTraces: None
         :type stackTraces: [CallSite]


         :rtype: any





.. container:: ts-api-section

   .. js:attribute:: CommunicatorError.stackTraceLimit

      :type: number





Methods
=======

.. rst-class:: ts-api-section

:ts-api-decorator:`static` captureStackTrace
--------------------------------------------

.. js:method:: CommunicatorError.captureStackTrace( targetObject[, constructorOpt])

   :param targetObject: None
   :type targetObject: object
   :param constructorOpt: :ts-api-decorator:`optional` None
   :type constructorOpt: Function


   Create .stack property on a target object


   :rtype: void

