es-toolkit 1.50.0: AbortError

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify es-toolkit.AbortError in pkg:npm/es-toolkit@1.50.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/es-toolkit@1.50.0
Demonstrate these symbols/APIs:
  - es-toolkit.AbortError

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:ceb146ecbbc218d72104102140f20b92ac1cbe4fd0860219efbb82b2af39648a","contract":["AbortError is exported from es-toolkit root and es-toolkit/error subpath as the identical class constructor","AbortError default instance inherits from DOMException and Error with message 'The operation was aborted'","AbortError instance accepts a custom error message","isAbortError correctly validates AbortError instances and rejects standard Error or non-error objects","delay rejects with an instance of AbortError when an AbortSignal is aborted"],"goal":"verify es-toolkit.AbortError in pkg:npm/es-toolkit@1.50.0","kind":"HOW","packages":["pkg:npm/es-toolkit@1.50.0"],"schemaVersion":1,"symbols":["es-toolkit.AbortError"]},"contractCommand":["node","test/contract.js"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/es-toolkit@1.50.0"],"schemaVersion":1,"subject":"pkg:npm/es-toolkit@1.50.0","symbols":["es-toolkit.AbortError"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-es-toolkit-abort-error",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-es-toolkit-abort-error",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "es-toolkit": "1.50.0"
      }
    },
    "node_modules/es-toolkit": {
      "version": "1.50.0",
      "resolved": "https://registry.npmjs.org/es-toolkit/-/es-toolkit-1.50.0.tgz",
      "integrity": "sha512-OyZKhUVvEep9ITEiwHn8GKnMRQIVqoSIX7WnRbkWgJkllCujilqP2rD0u979tkl8wqyc8ICwlc1UBVv/Sl1G6w==",
      "license": "MIT",
      "workspaces": [
        "docs",
        "benchmarks",
        "tests/types"
      ]
    }
  }
}

{
  "name": "sample-es-toolkit-abort-error",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "description": "Clean-room verification for es-toolkit AbortError",
  "main": "src/index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "es-toolkit": "1.50.0"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify es-toolkit.AbortError in pkg:npm/es-toolkit@1.50.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/es-toolkit@1.50.0"
  ],
  "symbols": [
    "es-toolkit.AbortError"
  ]
}

import { AbortError, delay } from 'es-toolkit';
import { AbortError as AbortErrorFromSubpath } from 'es-toolkit/error';

/**
 * Creates an instance of AbortError with an optional message.
 * @param {string} [message]
 * @returns {AbortError}
 */
export function createAbortError(message) {
  return message !== undefined ? new AbortError(message) : new AbortError();
}

/**
 * Checks if a given error is an AbortError.
 * @param {unknown} err
 * @returns {boolean}
 */
export function isAbortError(err) {
  return err instanceof AbortError;
}

/**
 * Pauses execution for the specified milliseconds, abortable via AbortSignal.
 * Rejects with AbortError if the signal is aborted.
 * @param {number} ms
 * @param {AbortSignal} [signal]
 * @returns {Promise<void>}
 */
export async function delayWithAbort(ms, signal) {
  return delay(ms, { signal });
}

export { AbortError, AbortErrorFromSubpath };

import assert from 'node:assert/strict';
import {
  AbortError,
  AbortErrorFromSubpath,
  createAbortError,
  isAbortError,
  delayWithAbort,
} from '../src/index.js';

// 1. AbortError is exported from es-toolkit root and es-toolkit/error subpath as the identical class constructor
assert.equal(typeof AbortError, 'function', 'AbortError must be a constructor function/class');
assert.equal(AbortError, AbortErrorFromSubpath, 'Root and subpath exports must be identical');

// 2. AbortError default instance inherits from DOMException and Error with message "The operation was aborted"
const defaultErr = createAbortError();
assert.ok(defaultErr instanceof AbortError, 'defaultErr must be instance of AbortError');
assert.ok(defaultErr instanceof DOMException, 'defaultErr must be instance of DOMException');
assert.ok(defaultErr instanceof Error, 'defaultErr must be instance of Error');
assert.equal(defaultErr.message, 'The operation was aborted', 'default message must match');
assert.equal(defaultErr.constructor.name, 'AbortError', 'constructor name must be AbortError');

// 3. AbortError instance accepts a custom error message
const customMessage = 'Request cancelled by user';
const customErr = createAbortError(customMessage);
assert.ok(customErr instanceof AbortError, 'customErr must be instance of AbortError');
assert.equal(customErr.message, customMessage, 'custom message must match');

// 4. isAbortError correctly validates AbortError instances and rejects standard Error or non-error objects
assert.equal(isAbortError(defaultErr), true, 'isAbortError must return true for default AbortError');
assert.equal(isAbortError(customErr), true, 'isAbortError must return true for custom AbortError');
assert.equal(isAbortError(new Error('general error')), false, 'isAbortError must return false for generic Error');
assert.equal(isAbortError(null), false, 'isAbortError must return false for null');
assert.equal(isAbortError(undefined), false, 'isAbortError must return false for undefined');
assert.equal(isAbortError({ message: 'fake error' }), false, 'isAbortError must return false for plain object');

// 5. delay rejects with an instance of AbortError when an AbortSignal is aborted
const controller = new AbortController();
controller.abort();

let caughtError = null;
try {
  await delayWithAbort(50, controller.signal);
} catch (err) {
  caughtError = err;
}

assert.ok(caughtError !== null, 'delayWithAbort must throw when signal is aborted');
assert.ok(isAbortError(caughtError), 'thrown error must be an AbortError');
assert.equal(caughtError.message, 'The operation was aborted');

console.log('All contract assertions passed successfully.');