jin-frame / frames/AbstractJinFrame / AbstractJinFrame

Abstract Class: AbstractJinFrame<TPASS>

Defined in: src/frames/AbstractJinFrame.ts:33

Extended by

• JinEitherFrame
• JinFrame

Type Parameters

TPASS

TPASS

Constructors

Constructor

new AbstractJinFrame<TPASS>(): AbstractJinFrame<TPASS>

Defined in: src/frames/AbstractJinFrame.ts:98

Returns

AbstractJinFrame<TPASS>

Properties

$_data

protected $_data: IFrameInternal

Defined in: src/frames/AbstractJinFrame.ts:96

---

$_option

protected $_option: IFrameOption

Defined in: src/frames/AbstractJinFrame.ts:94

Methods

$_retryFail()

protected $_retryFail(_req, _res): void

Defined in: src/frames/AbstractJinFrame.ts:92

Parameters

_req

AxiosRequestConfig

_res

AxiosResponse<TPASS>

Returns

void

---

getData()

getData<K>(kind): Pick<IFrameInternal, "body" | "header" | "param" | "query" | "retry" | "instance">[K]

Defined in: src/frames/AbstractJinFrame.ts:105

Type Parameters

K

K extends "body" | "header" | "param" | "query" | "retry" | "instance"

Parameters

kind

K

Returns

Pick<IFrameInternal, "body" | "header" | "param" | "query" | "retry" | "instance">[K]

---

getFormData()

getFormData(bodies): unknown

Defined in: src/frames/AbstractJinFrame.ts:140

Parameters

bodies

unknown

Returns

unknown

---

getOption()

getOption<K>(kind): IFrameOption[K]

Defined in: src/frames/AbstractJinFrame.ts:111

Type Parameters

K

K extends keyof IFrameOption

Parameters

kind

K

Returns

IFrameOption[K]

---

getTransformRequest()

getTransformRequest(): undefined | AxiosRequestTransformer | AxiosRequestTransformer[]

Defined in: src/frames/AbstractJinFrame.ts:121

Returns

undefined | AxiosRequestTransformer | AxiosRequestTransformer[]

---

request()

request(option?): AxiosRequestConfig

Defined in: src/frames/AbstractJinFrame.ts:182

AxiosRequestConfig create using by class member variable.

Parameters

option?

IJinFrameRequestConfig & IJinFrameCreateConfig

same with AxiosRequestConfig, bug exclude some filed ignored

Returns

AxiosRequestConfig

created AxiosRequestConfig

---

retry()

retry(req, isValidateStatus): Promise<AxiosResponse<TPASS, any>>

Defined in: src/frames/AbstractJinFrame.ts:290

Parameters

req

AxiosRequestConfig

isValidateStatus

(status) => boolean

Returns

Promise<AxiosResponse<TPASS, any>>

---

setFields()

setFields(args): void

Defined in: src/frames/AbstractJinFrame.ts:115

Parameters

args

AbstractJinFrame<TPASS>

Returns

void

---

builder()

static builder<T, C>(this): TBuilderFor<T, C>

Defined in: src/frames/AbstractJinFrame.ts:45

Type Parameters

T

T

C

C extends TConstructorFunction<T>

Parameters

this

C

Returns

TBuilderFor<T, C>

---

getDefaultValues()

protected static getDefaultValues(): Partial<TFieldsOf<InstanceType<typeof this>>>

Defined in: src/frames/AbstractJinFrame.ts:40

Returns

Partial<TFieldsOf<InstanceType<typeof this>>>

---

getEndpoint()

static getEndpoint(): URL

Defined in: src/frames/AbstractJinFrame.ts:34

Returns

URL

---

of()

static of<T, C>(this, args): InstanceType<C>

Defined in: src/frames/AbstractJinFrame.ts:71

Type Parameters

T

T

C

C extends TConstructorFunction<T>

Parameters

this

C

args

Readonly<NonFunctionProps<InstanceType<C>>> | (b) => unknown

Returns

InstanceType<C>