Package Exports

@flemist/abort-controller-fast
@flemist/abort-controller-fast/dist/lib/index.cjs
@flemist/abort-controller-fast/dist/lib/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@flemist/abort-controller-fast) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

class AbortError extends Error {
  readonly reason?: TAbortReason
  constructor(message?: string, reason?: TAbortReason) {
    
  }
}

type IUnsubscribe = () => void

interface IAbortSignalFast {
  readonly aborted: boolean
  readonly reason: any

  /**
   * just throws reason if aborted.
   */
  throwIfAborted()

  /**
   * It will immediately run the callback if it was aborted.
   * It will prevent re-subscribing if it has not been aborted.
   */
  subscribe(callback: (this: this, reason: any) => void): IUnsubscribe
}

interface IAbortControllerFast<TSignal extends IAbortSignalFast = IAbortSignalFast> {
  readonly signal: TSignal

  /**
   * The reason will be converted to AbortError if it is not undefined.
   */
  abort(reason: any): void
}

Usage

import { AbortControllerFast } from '@flemist/abort-controller-fast'

const abortControllerFast = new AbortControllerFast()
const unsubscribe = abortControllerFast.signal.subscribe(function (reason) {
  console.log(this) // this === abortControllerFast.signal
  console.log(reason) // reason === abortControllerFast.signal.reason
})
unsubscribe() // there is no point to unsubscribe if abortControllerFast was aborted
abortControllerFast.abort('some reason')
abortControllerFast.signal.throwIfAborted()

Convert / Connecting with the standard AbortController

import {
  toAbortSignal,
  toAbortSignalFast,
  toAbortController,
  toAbortControllerFast,
} from '@flemist/abort-controller-fast'
import {AbortControllerImpl} from '@flemist/abort-controller'
import {IAbortControllerFast} from './contracts'

let abortSignalFast: IAbortSignalFast
let abortControllerFast: IAbortControllerFast
let abortSignal: AbortSignal
let abortController: AbortController

// convert to a built-in implementation of AbortController/AbortSignal
abortController = toAbortController(abortControllerFast, new AbortControllerImpl())
abortSignal = toAbortSignal(abortSignalFast, new AbortControllerImpl())

// convert to a custom implementation of the standard AbortController/AbortSignal intetface
abortController = toAbortController(abortControllerFast, new AbortController())
abortSignal = toAbortSignal(abortSignalFast, new AbortController())

// convert standard AbortController/AbortSignal to the fast abort controller
abortControllerFast = toAbortControllerFast(abortController, new AbortControllerFast())
abortSignalFast = toAbortSignalFast(abortSignal, new AbortControllerFast())