jin-frame / frames/JinFrame / JinFrame

Class: JinFrame<TPass, TFail>

Defined in: packages/jin-frame/src/frames/JinFrame.ts:34

Definition HTTP Request

Type Param

AxiosResponse type argument case of valid status. eg. AxiosResponse<TPASS>

Type Param

AxiosResponse type argument case of invalid status. eg. AxiosResponse<TFAIL>

Extends

• AbstractJinFrame<TPass>

Type Parameters

TPass

TPass = unknown

TFail

TFail = TPass

Implements

• IJinFrameFunction<TPass, TFail>

Constructors

Constructor

new JinFrame<TPass, TFail>(): JinFrame<TPass, TFail>

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:110

Returns

JinFrame<TPass, TFail>

Inherited from

AbstractJinFrame.constructor

Properties

$_data

protected $_data: IFrameInternal

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:108

Inherited from

AbstractJinFrame.$_data

---

$_option

protected $_option: IFrameOption

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:106

Inherited from

AbstractJinFrame.$_option

Methods

$_postHook()

protected $_postHook(_req, _reply, _debugInfo): void | Promise<void>

Defined in: packages/jin-frame/src/frames/JinFrame.ts:55

Execute after request.

Parameters

_req

TJinRequestConfig

_reply

AxiosResponse<TPass | TFail>

_debugInfo

IDebugInfo

Returns

void | Promise<void>

---

$_preHook()

protected $_preHook(_req): void | Promise<void>

Defined in: packages/jin-frame/src/frames/JinFrame.ts:45

Execute before request. If you can change request object that is affected request.

Parameters

_req

TJinRequestConfig

Returns

void | Promise<void>

---

$_retryException()

protected $_retryException(_req, _err): void | Promise<void>

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:104

Parameters

_req

AxiosRequestConfig

_err

Error

Returns

void | Promise<void>

Inherited from

AbstractJinFrame.$_retryException

---

$_retryFail()

protected $_retryFail(_req, _res): void | Promise<void>

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:101

Parameters

_req

AxiosRequestConfig

_res

AxiosResponse<TPass>

Returns

void | Promise<void>

Inherited from

AbstractJinFrame.$_retryFail

---

create()

create<TSelf>(this, option?): () => Promise<AxiosResponse<TPass, any, { }> & object>

Defined in: packages/jin-frame/src/frames/JinFrame.ts:88

Generate an AxiosRequestConfig value and use it to return a functions that invoke HTTP APIs

Type Parameters

TSelf

TSelf extends JinFrame<TPass, TFail> = JinFrame<TPass, TFail>

Parameters

this

this

option?

IJinFrameRequestConfig & IJinFrameCreateConfig & object

same with AxiosRequestConfig, bug exclude some filed ignored

Returns

Functions that invoke HTTP APIs

(): Promise<AxiosResponse<TPass, any, { }> & object>

Returns

Promise<AxiosResponse<TPass, any, { }> & object>

Implementation of

IJinFrameFunction.create

---

execute()

execute<TSelf>(this, option?): Promise<AxiosResponse<TPass, any, { }>>

Defined in: packages/jin-frame/src/frames/JinFrame.ts:221

Generate an AxiosRequestConfig value and invoke HTTP APIs

Type Parameters

TSelf

TSelf extends JinFrame<TPass, TFail> = JinFrame<TPass, TFail>

Parameters

this

TSelf

option?

IJinFrameRequestConfig & IJinFrameCreateConfig & object

same with AxiosRequestConfig, bug exclude some filed ignored

Returns

Promise<AxiosResponse<TPass, any, { }>>

AxiosResponse With PassFailEither

Implementation of

IJinFrameFunction.execute

---

getCacheKey()

getCacheKey(): undefined | string

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:189

Returns

undefined | string

Inherited from

AbstractJinFrame.getCacheKey

---

getData()

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

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:117

Type Parameters

K

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

Parameters

kind

K

Returns

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

Inherited from

AbstractJinFrame.getData

---

getFormData()

getFormData(bodies): unknown

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:153

Parameters

bodies

unknown

Returns

unknown

Inherited from

AbstractJinFrame.getFormData

---

getOption()

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

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:123

Type Parameters

K

K extends keyof IFrameOption

Parameters

kind

K

Returns

IFrameOption[K]

Inherited from

AbstractJinFrame.getOption

---

getTransformRequest()

getTransformRequest(): undefined | AxiosRequestTransformer | AxiosRequestTransformer[]

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:134

Returns

undefined | AxiosRequestTransformer | AxiosRequestTransformer[]

Inherited from

AbstractJinFrame.getTransformRequest

---

request()

request(option?): AxiosRequestConfig

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:226

AxiosRequestConfig create using by class member variable.

Parameters

option?

IJinFrameRequestConfig & IJinFrameCreateConfig

same with AxiosRequestConfig, bug exclude some filed ignored

Returns

AxiosRequestConfig

created AxiosRequestConfig

Inherited from

AbstractJinFrame.request

---

requestWrap()

requestWrap(option?): AxiosRequestConfig

Defined in: packages/jin-frame/src/frames/JinFrame.ts:61

Parameters

option?

IJinFrameRequestConfig & IJinFrameCreateConfig

Returns

AxiosRequestConfig

---

retry()

retry(req, isValidateStatus): Promise<DedupeResult<TPass>>

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:344

Parameters

req

AxiosRequestConfig

isValidateStatus

(status) => boolean

Returns

Promise<DedupeResult<TPass>>

Inherited from

AbstractJinFrame.retry

---

setFields()

setFields(args): void

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:128

Parameters

args

JinFrame<TPass, TFail>

Returns

void

Inherited from

AbstractJinFrame.setFields

---

builder()

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

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:54

Type Parameters

T

T

C

C extends TConstructorFunction<T>

Parameters

this

C

Returns

TBuilderFor<T, C>

Inherited from

AbstractJinFrame.builder

---

getDefaultValues()

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

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:49

Returns

Partial<TFieldsOf<InstanceType<typeof this>>>

Inherited from

AbstractJinFrame.getDefaultValues

---

getEndpoint()

static getEndpoint(): URL

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:43

Returns

URL

Inherited from

AbstractJinFrame.getEndpoint

---

of()

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

Defined in: packages/jin-frame/src/frames/AbstractJinFrame.ts:80

Type Parameters

T

T

C

C extends TConstructorFunction<T>

Parameters

this

C

args

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

Returns

InstanceType<C>

Inherited from

AbstractJinFrame.of