SinchError | sinch-rtc
Description: Documentation for sinch-rtc

# Class SinchError

#### Hierarchy

- ErrorBase
  - SinchError

##### Index

### Constructors

constructor

### Properties

cause?
code
domain
isFatal?
message
name
stack?
stackTraceLimit

### Methods

captureStackTrace
isError
prepareStackTrace

## Constructors

### constructor

- new SinchError(
  message: string,
  code?: number,
  domain?: ErrorType,
  isFatal?: boolean,
  ): SinchError

  #### Parameters

  - message: string
  - code: number = 500
  - domain: ErrorType = ErrorType.Generic
  - `Optional`isFatal: boolean

  #### Returns SinchError

  Overrides ErrorBase.constructor

## Properties

### `Optional`cause

cause?: unknown

Inherited from ErrorBase.cause

### code

code: number = 500

### domain

domain: ErrorType = ErrorType.Generic

### `Optional`isFatal

isFatal?: boolean

### message

message: string

Inherited from ErrorBase.message

### name

name: string

Inherited from ErrorBase.name

### `Optional`stack

stack?: string

Inherited from ErrorBase.stack

### `Static`stackTraceLimit

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.

Inherited from ErrorBase.stackTraceLimit

## Methods

### `Static`captureStackTrace

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

  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
  - `Optional`constructorOpt: Function

  #### Returns void

  Inherited from ErrorBase.captureStackTrace

### `Static`isError

- isError(error: unknown): error is Error

  Indicates whether the argument provided is a built-in Error instance or not.

  #### Parameters

  - error: unknown

  #### Returns error is Error

  Inherited from ErrorBase.isError

### `Static`prepareStackTrace

- prepareStackTrace(err: Error, stackTraces: CallSite[]): any

  #### Parameters

  - err: Error
  - stackTraces: CallSite[]

  #### Returns any

  #### See

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

  Inherited from ErrorBase.prepareStackTrace