Custom very fast AbortController implementation and interface with the possibility of converting/connecting with the standard AbortController (version of NodeJS 18). This is about 100 times faster than built-ins implementations.

Interface

1class AbortError extends Error {
2  readonly reason?: TAbortReason
3  constructor(message?: string, reason?: TAbortReason) {
4    
5  }
6}
7
8type IUnsubscribe = () => void
9
10interface IAbortSignalFast {
11  readonly aborted: boolean
12  readonly reason: any
13
14  /**
15   * just throws reason if aborted.
16   */
17  throwIfAborted()
18
19  /**
20   * It will immediately run the callback if it was aborted.
21   * It will prevent re-subscribing if it has not been aborted.
22   */
23  subscribe(callback: (this: this, reason: any) => void): IUnsubscribe
24}
25
26interface IAbortControllerFast<TSignal extends IAbortSignalFast = IAbortSignalFast> {
27  readonly signal: TSignal
28
29  /**
30   * The reason will be converted to AbortError if it is not undefined.
31   */
32  abort(reason: any): void
33}

Usage

1import { AbortControllerFast } from '@flemist/abort-controller-fast'
2
3const abortControllerFast = new AbortControllerFast()
4const unsubscribe = abortControllerFast.signal.subscribe(function (reason) {
5  console.log(this) // this === abortControllerFast.signal
6  console.log(reason) // reason === abortControllerFast.signal.reason
7})
8unsubscribe() // there is no point to unsubscribe if abortControllerFast was aborted
9abortControllerFast.abort('some reason')
10abortControllerFast.signal.throwIfAborted()

Convert / Connecting with the standard AbortController

1import {
2  toAbortSignal,
3  toAbortSignalFast,
4  toAbortController,
5  toAbortControllerFast,
6} from '@flemist/abort-controller-fast'
7import {AbortControllerImpl} from '@flemist/abort-controller'
8import {IAbortControllerFast} from './contracts'
9
10let abortSignalFast: IAbortSignalFast
11let abortControllerFast: IAbortControllerFast
12let abortSignal: AbortSignal
13let abortController: AbortController
14
15// convert to a built-in implementation of AbortController/AbortSignal
16abortController = toAbortController(abortControllerFast, new AbortControllerImpl())
17abortSignal = toAbortSignal(abortSignalFast, new AbortControllerImpl())
18
19// convert to a custom implementation of the standard AbortController/AbortSignal intetface
20abortController = toAbortController(abortControllerFast, new AbortController())
21abortSignal = toAbortSignal(abortSignalFast, new AbortController())
22
23// convert standard AbortController/AbortSignal to the fast abort controller
24abortControllerFast = toAbortControllerFast(abortController, new AbortControllerFast())
25abortSignalFast = toAbortSignalFast(abortSignal, new AbortControllerFast())