Class JsonRpcError

src/jrpc/errors/error-classes.ts:37–112

 * Permits any integer error code.
 */
export class JsonRpcError<Data extends OptionalDataWithOptionalCause> extends Error {
  // The `cause` definition can be removed when tsconfig lib and/or target have changed to >=es2022
  public cause?: unknown;

  public code: number;

  public data?: Data;

  constructor(code: number, message: string, data?: Data) {
    if (!Number.isInteger(code)) {
      throw new Error('"code" must be an integer.');
    }

    if (!message || typeof message !== "string") {
      throw new Error('"message" must be a non-empty string.');
    }

    if (dataHasCause(data)) {
      super(message, { cause: data.cause });

      // Browser backwards-compatibility fallback
      if (!Object.hasOwn(this, "cause")) {
        Object.assign(this, { cause: data.cause });
      }
    } else {
      super(message);
    }

    if (data !== undefined) {
      this.data = data;
    }

    this.code = code;
    this.cause = (data as { cause?: unknown })?.cause;
  }

  /**
   * Get the error as JSON-serializable object.
   *
   * @returns A plain object with all public class properties.
   */
  serialize(): SerializedJRPCError {
    const serialized: SerializedJRPCError = {
      code: this.code,
      message: this.message,
    };

    if (this.data !== undefined) {
      if (isPlainObject(this.data)) {
        // Spread to avoid mutating `this.data` when setting `cause`.
        serialized.data = {
          ...(this.data as { [key: string]: Json }),
          cause: serializeCause((this.data as { cause?: unknown }).cause),
        };
      } else {
        serialized.data = this.data as { [key: string]: Json };
      }
    }