# @hazae41/signals

> Utilities to deal with AbortSignal

Latest version **1.1.0** (published 2025-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hazae41/signals
pnpm add @hazae41/signals
yarn add @hazae41/signals
bun add @hazae41/signals
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2025-05-25 |
| First published | 2024-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 12 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | hazae41 |
| Maintainers | hazae41 |
| Keywords | abortsignal, abortsignals, abortcontroller, abortcontrollers, signal, signals, controller, controllers, merge, promise, typescript, esmodules, tested, unit-tested |

## Links

- npm: https://www.npmjs.com/package/@hazae41/signals
- Repository: https://github.com/hazae41/decibel
- Homepage: https://github.com/hazae41/signals
- Issues: https://github.com/hazae41/decibel/issues
- npm.io page: https://npm.io/package/@hazae41/signals

## Dependencies (2)

- [@hazae41/box](https://npm.io/package/@hazae41/box.md) ^3.0.1
- [@hazae41/future](https://npm.io/package/@hazae41/future.md) ^2.0.1

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2025-05-25
- 1.0.3 — 2025-04-06
- 1.0.2 — 2024-09-01
- 1.0.1 — 2024-03-27
- 1.0.0 — 2024-03-27

## README

# Signals

Utilities to deal with AbortSignal

```bash
npm i @hazae41/signals
```

[**Node Package 📦**](https://www.npmjs.com/package/@hazae41/signals)

## Features

### Current features
- 100% TypeScript and ESM
- No external dependencies
- Merge signals
- Optional signals
- Promisify signals

## Usage

### Never

```tsx
Signals.never()
```

This can be useful when you want to accept an optional AbortSignal without branching or doing weird merging

```tsx
function run(signal: AbortSignal);

// GOOD EXAMPLE
function f(signal = Signals.never()) {
  run(signal)
}

// BAD EXAMPLE
function g(signal?: AbortSignal) {
  if (signal == null)
    run(new AbortController().signal)
  else
    run(signal)
}
```

### Merge

```tsx
Signals.merge(a, b?)
```

This can be useful when you have signals with different scopes

```tsx
const global = AbortSignal.timeout(10 * 1000)

async function f(parent?: AbortSignal) {
  const signal = Signals.merge(global, parent)

  await fetch("...", { signal })
}
```

### resolveOnAbort / rejectOnAbort

```tsx
Signals.rejectOnAbort(signal)
```

This is very useful when you want to race a signal with a promise

```tsx
async function run();

async function runWithTimeout(delay: number) {
  const signal = AbortSignal.timeout(delay)
  using timeout = Signals.rejectOnAbort(signal)

  await Promise.race([run(), timeout.get()])
}
```

This converts any event-based signal into a disposable promise

You can also use `resolveOnAbort` to avoid storing unhandled promises

```tsx
async function run();

const global = AbortSignal.timeout(10 * 1000)
using timeout = Signals.resolveOnAbort(global)

async function runWithTimeout() {
  const rejectOnAbort = timeout.get().then(() => { throw new Error("Aborted") })

  await Promise.race([run(), rejectOnAbort])
}
```

---
_Source: https://npm.io/package/@hazae41/signals · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._