Class AxiosExtend

AxiosExtend class

Returns

Promise

Hierarchy

AxiosExtend

Index

Constructors

Properties

axiosInstance onCancel orderly retries unique waiting

Methods

add clear create init wait

Constructors

constructor

new AxiosExtend(__namedParameters): AxiosExtend
Parameters
- __namedParameters: AxiosExtendConfig<any>
Returns AxiosExtend
- Defined in src/index.ts:183

Properties

axiosInstance

axiosInstance: AxiosInstance = ...

onCancel

onCancel: undefined | null | ((error) => void) = null

Type declaration

- (error): void
- Parameters
  - error: any
  Returns void

orderly

orderly: undefined | boolean = true

retries

retries: number

unique

unique: undefined | boolean = false

waiting

waiting: WaitingList = {}

Methods

`Private` add

add(key, item): void
set item to waiting list
Parameters
- key: string
  
  the key of waiting line, usually to be the request url
- item: WaitingItem
  
  waiting object
Returns void
- Defined in src/index.ts:380

clear

clear(key?): void
Drop all un-need requests
Parameters
- Optional key: string
  
  the key of waiting line, usually to be the request url
Returns void
- Defined in src/index.ts:331

create

create<T, R, D>(config): Promise<R>
Create request
Type Parameters
- T = any
- R = AxiosResponse<T, any>
- D = any
Parameters
- config: AxiosExtendRequestOptions<D>
Returns Promise<R>
- Defined in src/index.ts:278

init

init(defaultOptions): void
Initialization
Parameters
- defaultOptions: AxiosExtendConfig<any>
Returns void
- Defined in src/index.ts:196

`Private` wait

wait(key, promiseKey): Promise<void>
Waiting to resolve the item before this request
Parameters
- key: string
  
  the key of waiting line, usually to be the request url
- promiseKey: symbol
  
  the unique promise key
Returns Promise<void>
- Promise
- Defined in src/index.ts:353

Generated using TypeDoc