Class AbortApiPublic

Hierarchy

AbortApi
AbortApi
- AbortApiPublic

Implements

Implemented by

AbortApiPublic

Index

Constructors

constructor

Properties

state

Methods

Constructors

constructor

new AbortApiPublic(internal: AbortApiInternal): AbortApiPublic

Inherited from AbortApi.constructor

Overrides AbortApi.constructor
- Defined in src/AbortApi.ts:30
Parameters
- internal: AbortApiInternal
Returns AbortApiPublic

Properties

state

state: ABORT_STATE

Methods

abort

abort(): PromiseLike<void>

- Defined in src/AbortApiPublic.ts:5
Returns PromiseLike<void>

off

off(handle: OnAbortHandle, ignoreNotFound?: boolean): void

Inherited from AbortApi.off

Overrides AbortApi.off
- Defined in src/AbortApi.ts:13
Parameters
- handle: OnAbortHandle
- Optional ignoreNotFound: boolean
Returns void

on

on(cb: OnAbortCallback): OnAbortHandle

Inherited from AbortApi.on

Overrides AbortApi.on
- Defined in src/AbortApi.ts:12
Parameters
- cb: OnAbortCallback
Returns OnAbortHandle

withHandler

withHandler<T>(callback: (aapi: AbortApi) => T | PromiseLike<T>, handler: OnAbortCallback): PromiseLike<T>

Inherited from AbortApi.withHandler

Overrides AbortApi.withHandler
- Defined in src/AbortApi.ts:17
Type parameters
- T
Parameters
- callback: (aapi: AbortApi) => T | PromiseLike<T>
  - - (aapi: AbortApi): T | PromiseLike<T>
    - Parameters
      - aapi: AbortApi
      Returns T | PromiseLike<T>
- handler: OnAbortCallback
Returns PromiseLike<T>

Generated using TypeDoc