InvalidProofError

SIP Protocol API Reference v0.7.4

SIP Protocol API Reference / InvalidProofError

Class: InvalidProofError

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2437

Error for invalid input proofs

Extends

ProofConversionError

Constructors

Constructor

new InvalidProofError(sourceSystem, targetSystem, validationErrors): InvalidProofError

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2439

Parameters

Returns

InvalidProofError

Overrides

ProofConversionError.constructor

Properties

code

readonly code: ConversionErrorCode

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2428

Inherited from

ProofConversionError.code

sourceSystem

readonly sourceSystem: ProofSystem

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2429

Inherited from

ProofConversionError.sourceSystem

targetSystem

readonly targetSystem: ProofSystem | "sip"

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2430

Inherited from

ProofConversionError.targetSystem

cause?

readonly optional cause: Error

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2431

Inherited from

ProofConversionError.cause

validationErrors

readonly validationErrors: ConverterValidationError[]

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:2438

stackTraceLimit

static stackTraceLimit: number

Defined in: @types/node/globals.d.ts:68

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

ProofConversionError.stackTraceLimit

name

name: string

Defined in: typescript/lib/lib.es5.d.ts:1076

Inherited from

ProofConversionError.name

message

message: string

Defined in: typescript/lib/lib.es5.d.ts:1077

Inherited from

ProofConversionError.message

stack?

optional stack: string

Defined in: typescript/lib/lib.es5.d.ts:1078

Inherited from

ProofConversionError.stack

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: @types/node/globals.d.ts:52

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

constructorOpt?

Function

Returns

void

Inherited from

ProofConversionError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: @types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ProofConversionError.prepareStackTrace