jin-frame / frames/JinFrame / JinFrame

Class: JinFrame<Pass, Fail>

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

Definition HTTP Request

Extends

• AbstractJinFrame

Type Parameters

Pass

Pass = unknown

response data type for valid status — returned as JinPassResp<Pass>

Fail

Fail = Pass

response data type for invalid status — returned as JinFailResp<Fail>

Implements

• JinFrameFunction<Pass, Fail>

Constructors

Constructor

new JinFrame<Pass, Fail>(): JinFrame<Pass, Fail>

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

Returns

JinFrame<Pass, Fail>

Inherited from

AbstractJinFrame.constructor

Accessors

_option

Get Signature

get protected _option(): FrameOption

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

Returns

FrameOption

Inherited from

AbstractJinFrame._option

---

_startAt

Get Signature

get protected _startAt(): Date

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

Returns

Date

Inherited from

AbstractJinFrame._startAt

Methods

_create()

_create<TSelf>(this, option?): () => Promise<JinResp<Pass, Fail> & object>

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

Generate a request config and return a function that invokes HTTP APIs

Type Parameters

TSelf

TSelf extends JinFrame<Pass, Fail> = JinFrame<Pass, Fail>

Parameters

this

this

option?

JinFrameRequestConfig & JinFrameCreateConfig & object

request configuration options

Returns

Function that invokes HTTP APIs

(): Promise<JinResp<Pass, Fail> & object>

Returns

Promise<JinResp<Pass, Fail> & object>

Implementation of

JinFrameFunction._create

---

_execute()

_execute<TSelf>(this, option?): Promise<JinResp<Pass, Fail>>

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

Generate a request config and invoke HTTP APIs.

Function-based SecurityKey values (set via @Security(provider, () => key)) are resolved here before building the request. Use this method when the authorization key is dynamic.

Type Parameters

TSelf

TSelf extends JinFrame<Pass, Fail> = JinFrame<Pass, Fail>

Parameters

this

TSelf

option?

JinFrameRequestConfig & JinFrameCreateConfig & object

request configuration options

Returns

Promise<JinResp<Pass, Fail>>

JinResp with pass or fail discriminated union

Implementation of

JinFrameFunction._execute

---

_getBaseUrlString()

_getBaseUrlString(paths, override?): string

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

Parameters

paths

Record<string, string>

override?

host?

string

path?

string

pathPrefix?

string

Returns

string

Inherited from

AbstractJinFrame._getBaseUrlString

---

_getBodyInit()

_getBodyInit(bodies): BodyInit | undefined

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

Parameters

bodies

unknown

Returns

BodyInit | undefined

Inherited from

AbstractJinFrame._getBodyInit

---

_getCacheKey()

_getCacheKey(): string | undefined

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

Returns

string | undefined

Inherited from

AbstractJinFrame._getCacheKey

---

_getData()

_getData<K>(kind): Pick<FrameInternal, "retry" | "body" | "header" | "param" | "query">[K]

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

Type Parameters

K

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

Parameters

kind

K

Returns

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

Inherited from

AbstractJinFrame._getData

---

_getOption()

_getOption<K>(kind): FrameOption[K]

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

Type Parameters

K

K extends keyof FrameOption

Parameters

kind

K

Returns

FrameOption[K]

Inherited from

AbstractJinFrame._getOption

---

_postHook()

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

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

Execute after request.

Parameters

_req

JinRequestConfig

_reply

JinResp<Pass, Fail>

_debugInfo

DebugInfo

Returns

void | Promise<void>

---

_preHook()

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

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

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

Parameters

_req

JinRequestConfig

Returns

void | Promise<void>

---

_request()

_request(option?): JinRequestConfig

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

JinRequestConfig create using by class member variable.

Parameters

option?

JinFrameRequestConfig & JinFrameCreateConfig

same with JinRequestConfig, bug exclude some filed ignored

Returns

JinRequestConfig

created JinRequestConfig

Inherited from

AbstractJinFrame._request

---

_requestWrap()

_requestWrap(option?): JinRequestConfig

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

Parameters

option?

JinFrameRequestConfig & JinFrameCreateConfig

Returns

JinRequestConfig

---

_retry()

_retry(req, isValidateStatus): Promise<DedupeResult>

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

Parameters

req

JinRequestConfig

isValidateStatus

(ok, status) => boolean

Returns

Promise<DedupeResult>

Inherited from

AbstractJinFrame._retry

---

_retryException()

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

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

Parameters

_req

JinRequestConfig

_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:112

Parameters

_req

JinRequestConfig

_res

Response

Returns

void | Promise<void>

Inherited from

AbstractJinFrame._retryFail

---

_setData()

protected _setData<K>(kind, value): void

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

Type Parameters

K

K extends "retry"

Parameters

kind

K

value

FrameInternal[K]

Returns

void

Inherited from

AbstractJinFrame._setData

---

_setFields()

_setFields(args): void

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

Parameters

args

JinFrame<Pass, Fail>

Returns

void

Inherited from

AbstractJinFrame._setFields

---

builder()

static builder<C>(this, ...ctorArgs): BuilderFor<C>

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

Type Parameters

C

C extends ConstructorFunction<unknown>

Parameters

this

C

ctorArgs

...ConstructorParameters<C>

Returns

BuilderFor<C>

Inherited from

AbstractJinFrame.builder

---

getDefaultValues()

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

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

Returns

Partial<PublicFieldsOf<InstanceType<typeof this>>>

Inherited from

AbstractJinFrame.getDefaultValues

---

getEndpoint()

static getEndpoint(): URL

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

Returns

URL

Inherited from

AbstractJinFrame.getEndpoint

---

of()

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

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

Type Parameters

C

C extends ConstructorFunction<unknown>

Parameters

this

C

args

PublicFieldsOf<InstanceType<C>> | (b) => unknown

ctorArgs

...ConstructorParameters<C>

Returns

InstanceType<C>

Inherited from

AbstractJinFrame.of