Errors

The error classes exported by asyncmux, and how to switch messages per language with setErrorMessage.

ErrorBase

The base class of asyncmux error classes. It extends Error and supports per-language messages.

import { ErrorBase } from "asyncmux";

class MyError extends ErrorBase<undefined> {
  public constructor(options?: ErrorOptions) {
    super("My error message", options);
  }
}

Messages are resolved when the message property is read. The language is taken by i18n-error-base from the valibot global config (getGlobalConfig().lang), defaulting to "en".

import { setGlobalConfig } from "valibot";
import { LockReleasedError } from "asyncmux";

setGlobalConfig({ lang: "ja" });

new LockReleasedError().message; // "ロックはすでに解放済みです。"

setErrorMessage()

Registers a per-language message on an error class. You can add a new language to a built-in error or override an existing message.

function setErrorMessage(
  reference: typeof ErrorBase,
  message: string | ((meta: unknown) => string),
  lang: string | Iterable<string>,
): void;

reference specifies a class that extends ErrorBase.

import { setErrorMessage, ReentrantLockError } from "asyncmux";

setErrorMessage(ReentrantLockError, "Cannot re-acquire the same lock", "ja");

Passing a function as the second argument lets you build the message from meta. Passing multiple language codes as the third argument registers them at once.

DecoratorSupportError

Thrown when @asyncmux is used in an environment without Stage 3 decorator support.

class DecoratorSupportError extends ErrorBase<undefined> {
  constructor(options?: ErrorOptions);
}

LockReleasedError

Thrown when release() is called on an already-released lock.

class LockReleasedError extends ErrorBase<undefined> {
  constructor(options?: ErrorOptions);
}

ReentrantLockError

Thrown when reentrancy that would deadlock is detected. See Concurrency Model for the detection conditions.

class ReentrantLockError extends ErrorBase<undefined> {
  constructor(options?: ErrorOptions);
}

Built-in messages

asyncmux registers English and Japanese messages for its built-in errors.

Each class accepts ErrorOptions, so you can keep the original error in cause.

throw new ReentrantLockError({ cause: originalError });