dmltdev/mongo-error-codes

A minimal JavaScript library of MongoDB error codes, names, and helper utilities

MongoDB Error Codes Library

A minimal library of MongoDB error codes, names, and helper utilities. Useful for error handling, logging, and building developer tools that interact with MongoDB.

Features

• All official MongoDB error codes and names
• Human-friendly descriptions (where available)
• Fast lookup helpers: code ↔ name, code → description
• TypeScript types for safety and autocompletion
• 100% test coverage of helper utilities
• Raw 28kB, gzipped 7kB

Installation

Install with your favorite package manager:

npm install mongo-error-codes

yarn add mongo-error-codes

pnpm add mongo-error-codes

Usage

import {
  getErrorName,
  getErrorCode,
  getErrorDescription,
  isKnownErrorCode,
  getErrorDetails,
  toError,
  MongoErrorList,
} from "mongo-error-codes";

console.log(getErrorName(11000)); // "DuplicateKey"
console.log(getErrorCode("DuplicateKey")); // 11000
console.log(getErrorDescription(11000)); // description or undefined
console.log(isKnownErrorCode(11000)); // true

// Get full error details
const errorDetails = getErrorDetails(11000);
console.log(errorDetails); // { code: 11000, name: "DuplicateKey", ... }

// Convert to JavaScript Error
if (errorDetails) {
  const jsError = toError(errorDetails);
  console.log(jsError.message); // "[11000] DuplicateKey: Duplicate key error collection"
}

// List all error codes
console.log(MongoErrorList);

API Reference

Functions

getErrorName(code: number): string | undefined

Returns the error name for a given code.

import { getErrorName } from "mongo-error-codes";
console.log(getErrorName(11000)); // "DuplicateKey"

getErrorCode(name: string): number | undefined

Returns the error code for a given name.

import { getErrorCode } from "mongo-error-codes";
console.log(getErrorCode("DuplicateKey")); // 11000

getErrorDescription(code: number): string | undefined

Returns the human-friendly description for a given code, if available.

import { getErrorDescription } from "mongo-error-codes";
console.log(getErrorDescription(11000)); // e.g. "Duplicate key error collection"

isKnownErrorCode(code: number): boolean

Returns true if the code is a known MongoDB error code.

import { isKnownErrorCode } from "mongo-error-codes";
console.log(isKnownErrorCode(11000)); // true

getErrorDetails(input: number | string): { code: number; name: string; description?: string } | undefined

Returns the full error object (code, name, description) for a given error code or name.

import { getErrorDetails } from "mongo-error-codes";
console.log(getErrorDetails(11000));
// { code: 11000, name: "DuplicateKey", description: "Duplicate key error collection" }
console.log(getErrorDetails("DuplicateKey"));
// { code: 11000, name: "DuplicateKey", description: "Duplicate key error collection" }

toError(mongoError: MongoError, formatter?: (error: MongoError) => string): Error

Converts a MongoDB error object to a JavaScript Error with a formatted message. Optionally accepts a custom formatter function.

import { toError, getErrorDetails } from "mongo-error-codes";

const mongoError = getErrorDetails(11000);
if (mongoError) {
  // Default formatting
  const jsError = toError(mongoError);
  console.log(jsError.message); // "[11000] DuplicateKey: Duplicate key error collection"
  console.log(jsError.cause); // Original MongoError object
}

// With categories
const errorWithCategories = {
  code: 6,
  name: "HostUnreachable",
  description: "The host is unreachable.",
  categories: ["NetworkError", "RetriableError"]
};
const jsError = toError(errorWithCategories);
console.log(jsError.message); 
// "[6] HostUnreachable: The host is unreachable. | NetworkError, RetriableError"

// Custom formatter
const customError = toError(errorWithCategories, (error) => 
  `MongoDB ${error.name} (${error.code}): ${error.description}`
);
console.log(customError.message);
// "MongoDB HostUnreachable (6): The host is unreachable."

// Simple custom formatter
const simpleError = toError(mongoError, (error) => `Error ${error.code}`);
console.log(simpleError.message); // "Error 11000"

Data Structures

MongoErrorCodes (const object)

Const object containing all MongoDB error codes, mapping error names to their numeric values.

import { MongoErrorCodes } from "mongo-error-codes";
console.log(MongoErrorCodes.DuplicateKey); // 11000

ErrorCategory (type)

Represents an error category

import { ErrorCategory } from "mongo-error-codes";

const errorCategory: ErrorCategory = "NotPrimaryError";

MongoError (interface)

Represents a MongoDB error code object.

export interface MongoError {
  code: number;
  name: string;
  description?: string;
  categories?: ErrorCategory;
}

MongoErrorList: MongoError[]

An array of all error code objects:

import { MongoErrorList } from "mongo-error-codes";
console.log(MongoErrorList[0]);
// { code: 1, name: "InternalError", description: "An unspecified internal error occurred." }

getMongoCodeErrorMap(): Map<number, MongoError>

Get a map from error code to error object:

import { getMongoCodeErrorMap } from "mongo-error-codes";
console.log(getMongoCodeErrorMap().get(11000));
// { code: 11000, name: "DuplicateKey" }

getMongoNameErrorMap(): Map<string, MongoError>

Get a map from error name to error object:

import { getMongoNameErrorMap } from "mongo-error-codes";
console.log(getMongoNameErrorMap().get("DuplicateKey"));
// { code: 11000, name: "DuplicateKey" }

MongoCodeErrorMap: Map<number, MongoError> (deprecated)

⚠️ Deprecated: Use getMongoCodeErrorMap() instead for better bundle size optimization.

MongoNameErrorMap: Map<string, MongoError> (deprecated)

⚠️ Deprecated: Use getMongoNameErrorMap() instead for better bundle size optimization.

Types

export interface MongoError {
  code: number;
  name: string;
  description?: string;
}

Contributing

1. Fork the repo and create your branch.
2. Add or update error codes, descriptions, or helpers.
3. Run tests and build.
4. Open a pull request.

License

MIT