Op — Is a simple and pretty utility to abort operations 🚏

---

Reason

It can be used to cancel all types of asynchronous operations, since the conventional mechanisms like promises, does not have a way to do it.

The other reason why you can use this small library is, for example p-cancelable is cool, but have a few problems when used in promises that return other promises, or in other espesific contexts. ope-abort, is totally agnostic to the logic of a promise and this makes it simpler to clearer and avoid side effects.

Install

$ npm install ope-abort

Usage

Create a promise that can be canceled

    const opAbort = require('op-abort')
    const display = (each, oa) => new Promise((resolve) => {
        const clear = setInterval(() => console.log('foo'), each)
        oa.onAbort(() => {
            clearInterval(clear)
            resolve()
        })
    })

    const oa = opAbort()
    display(1000, oa)
    setTimeout(oa.abort, 3000)

API

Function contructor of operation abort controller

function createOperationAbort(): OperationAbort // This returns the next methods and properties

Is invoked when u want cancel the operation

function abort(reason?: string): void

Is defined and invoked before of abort any operation

function onAbort(fn: (...args: any[]) => any): void

Shows the state of current operation abort controller

state: {
    aborted: boolean // default false, state of abort operation
    , reason: string // default null, reason of abortion
}