~~Class: EncryptionNotImplementedError~~

SIP Protocol API Reference v0.7.0

---

SIP Protocol API Reference / EncryptionNotImplementedError

Class: EncryptionNotImplementedError

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:176

Error thrown when encryption functions are called but not yet implemented

Deprecated

Use CryptoError with ErrorCode.NOT_IMPLEMENTED instead

Extends

• CryptoError

Constructors

Constructor

new EncryptionNotImplementedError(operation, specReference): EncryptionNotImplementedError

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:181

Parameters

operation

"encrypt" | "decrypt"

specReference

string

Returns

EncryptionNotImplementedError

Overrides

CryptoError.constructor

Properties

code

readonly code: ErrorCode

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:108

Machine-readable error code

Inherited from

CryptoError.code

---

context?

readonly optional context: Record<string, unknown>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:110

Additional debugging context

Inherited from

CryptoError.context

---

timestamp

readonly timestamp: Date

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:112

Timestamp when error was created

Inherited from

CryptoError.timestamp

---

operation?

readonly optional operation: string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:164

The cryptographic operation that failed

Inherited from

CryptoError.operation

---

operationType

readonly operationType: "encrypt" | "decrypt"

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:178

The type of encryption operation

---

specReference

readonly specReference: string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:180

Reference to the specification document

---

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

CryptoError.stackTraceLimit

---

name

name: string

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

Inherited from

CryptoError.name

---

message

message: string

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

Inherited from

CryptoError.message

---

stack?

optional stack: string

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

Inherited from

CryptoError.stack

Methods

toJSON()

toJSON(): SerializedError

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:120

Serialize error for logging or transmission

Returns

SerializedError

Inherited from

CryptoError.toJSON

---

toString()

toString(): string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:124

Create a string representation for logging

Returns

string

Inherited from

CryptoError.toString

---

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

CryptoError.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

CryptoError.prepareStackTrace