otplib API Documentation / @otplib/core / errors / AlgorithmUnsupportedError

Class: AlgorithmUnsupportedError

Defined in: packages/core/src/errors.ts:227

Error thrown when a hash algorithm is not recognised or is outside a plugin's declared supported set

The message identifies the declared supported algorithms and, when applicable, the plugin that rejected the request. It deliberately does not render the caller-supplied value; callers should retain that input in their own error context.

Example

try {
  crypto.hmac('md5', key, data);
} catch (error) {
  if (error instanceof AlgorithmUnsupportedError) {
    console.log(error.message);
    // Unsupported hash algorithm. Expected one of: sha1, sha256, sha512
  }
}

Extends

• AlgorithmError

Constructors

Constructor

new AlgorithmUnsupportedError(_value, context?): AlgorithmUnsupportedError

Defined in: packages/core/src/errors.ts:228

Parameters

_value

unknown

context?

AlgorithmUnsupportedContext = {}

Returns

AlgorithmUnsupportedError

Overrides

AlgorithmError.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

AlgorithmError.cause

---

message

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

AlgorithmError.message

---

name

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

AlgorithmError.name

---

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

AlgorithmError.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:67

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

AlgorithmError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:51

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

AlgorithmError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

AlgorithmError.prepareStackTrace