jin-frame / frames/AbstractJinFrame / AbstractJinFrame

Abstract Class: AbstractJinFrame

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

Extended by

• JinFrame

Constructors

Constructor

new AbstractJinFrame(): AbstractJinFrame

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

Returns

AbstractJinFrame

Accessors

_option

Get Signature

get protected _option(): FrameOption

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

Returns

FrameOption

---

_startAt

Get Signature

get protected _startAt(): Date

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

Returns

Date

Methods

_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

---

_getBodyInit()

_getBodyInit(bodies): BodyInit | undefined

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

Parameters

bodies

unknown

Returns

BodyInit | undefined

---

_getCacheKey()

_getCacheKey(): string | undefined

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

Returns

string | undefined

---

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

---

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

---

_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

---

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

---

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

---

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

---

_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

---

_setFields()

_setFields(args): void

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

Parameters

args

AbstractJinFrame

Returns

void

---

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>

---

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

---

getEndpoint()

static getEndpoint(): URL

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

Returns

URL

---

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>