Skip to main content

RecorderError

Electron APIs / Recorder / RecorderError

Recording error information including a specific error code and description. Useful for detailed debugging and error handling during recording operations.

Example​

try {
  await recorder.start();
} catch (error) {
  if (error instanceof RecorderError) {
    console.error(
      `Recording failed with code ${error.codeStr}: ${error.message}`,
    );
  }
}

Extends​

  • Error

Constructors​

Constructor​

new RecorderError(message?: string): RecorderError;

Parameters​

ParameterType
message?string

Returns​

RecorderError

Inherited from​

Error.constructor;

Properties​

code​

code: ErrorCode;

Numeric error code identifying the specific recording error.

See​

ErrorCode

codeStr​

codeStr: string;

Human-readable string that maps to the error code.

internalError?​

optional internalError: Error;

Optional internal error for more detailed debugging.

message​

message: string;

Inherited from​

Error.message;

name​

name: string;

Inherited from​

Error.name;

stack?​

optional stack: string;

Inherited from​

Error.stack;

stackTraceLimit​

static 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​

Error.stackTraceLimit;

Methods​

captureStackTrace()​

static 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​

ParameterType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace;

prepareStackTrace()​

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

Parameters​

ParameterType
errError
stackTracesCallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace;