jin-frame / frames/JinFrame / JinFrame

Class: JinFrame<TPASS, TFAIL>

Defined in: src/frames/JinFrame.ts:30

Definition HTTP Request

Extends

• AbstractJinFrame<TPASS>

Type Parameters

TPASS

TPASS = unknown

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

TFAIL

TFAIL = TPASS

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

Implements

• IJinFrameFunction<TPASS, TFAIL>

Constructors

Constructor

new JinFrame<TPASS, TFAIL>(): JinFrame<TPASS, TFAIL>

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

Returns

JinFrame<TPASS, TFAIL>

Inherited from

AbstractJinFrame.constructor

Properties

$_data

protected $_data: IFrameInternal

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

Inherited from

AbstractJinFrame.$_data

---

$_option

protected $_option: IFrameOption

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

Inherited from

AbstractJinFrame.$_option

Methods

$_postHook()

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

Defined in: src/frames/JinFrame.ts:51

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: src/frames/JinFrame.ts:41

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

Parameters

_req

TJinRequestConfig

Returns

void | Promise<void>

---

$_retryFail()

protected $_retryFail(_req, _res): void

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

Parameters

_req

AxiosRequestConfig

_res

AxiosResponse<TPASS>

Returns

void

Inherited from

AbstractJinFrame.$_retryFail

---

create()

create(option?): () => Promise<AxiosResponse<TPASS, any>>

Defined in: src/frames/JinFrame.ts:83

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

Parameters

option?

IJinFrameRequestConfig & IJinFrameCreateConfig & object

same with AxiosRequestConfig, bug exclude some filed ignored

Returns

Functions that invoke HTTP APIs

(): Promise<AxiosResponse<TPASS, any>>

Returns

Promise<AxiosResponse<TPASS, any>>

Implementation of

IJinFrameFunction.create

---

execute()

execute(option?): Promise<AxiosResponse<TPASS, any>>

Defined in: src/frames/JinFrame.ts:185

Generate an AxiosRequestConfig value and invoke HTTP APIs

Parameters

option?

IJinFrameRequestConfig & IJinFrameCreateConfig & object

same with AxiosRequestConfig, bug exclude some filed ignored

Returns

Promise<AxiosResponse<TPASS, any>>

AxiosResponse With PassFailEither

Implementation of

IJinFrameFunction.execute

---

executePostHook()

executePostHook(req, reply, debugInfo): Promise<CE_HOOK_APPLY>

Defined in: src/frames/JinFrame.ts:207

Parameters

req

AxiosRequestConfig<unknown>

reply

AxiosResponse<TPASS | TFAIL>

debugInfo

IDebugInfo

Returns

Promise<CE_HOOK_APPLY>

---

executePreHook()

executePreHook(req): Promise<CE_HOOK_APPLY>

Defined in: src/frames/JinFrame.ts:197

Parameters

req

AxiosRequestConfig

Returns

Promise<CE_HOOK_APPLY>

---

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]

Inherited from

AbstractJinFrame.getData

---

getFormData()

getFormData(bodies): unknown

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

Parameters

bodies

unknown

Returns

unknown

Inherited from

AbstractJinFrame.getFormData

---

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]

Inherited from

AbstractJinFrame.getOption

---

getTransformRequest()

getTransformRequest(): undefined | AxiosRequestTransformer | AxiosRequestTransformer[]

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

Returns

undefined | AxiosRequestTransformer | AxiosRequestTransformer[]

Inherited from

AbstractJinFrame.getTransformRequest

---

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

Inherited from

AbstractJinFrame.request

---

requestWrap()

requestWrap(option?): AxiosRequestConfig

Defined in: src/frames/JinFrame.ts:57

Parameters

option?

IJinFrameRequestConfig & IJinFrameCreateConfig

Returns

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>>

Inherited from

AbstractJinFrame.retry

---

setFields()

setFields(args): void

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

Parameters

args

JinFrame<TPASS, TFAIL>

Returns

void

Inherited from

AbstractJinFrame.setFields

---

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>

Inherited from

AbstractJinFrame.builder

---

getDefaultValues()

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

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

Returns

Partial<TFieldsOf<InstanceType<typeof this>>>

Inherited from

AbstractJinFrame.getDefaultValues

---

getEndpoint()

static getEndpoint(): URL

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

Returns

URL

Inherited from

AbstractJinFrame.getEndpoint

---

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>

Inherited from

AbstractJinFrame.of