jin-frame

Classes

• AbstractJinFrame
• JinCreateError
• JinEitherFrame
• JinFile
• JinFrame
• JinRequestError

Interfaces

• IBodyField
• IBodyFieldOption
• ICommonFieldOption
• IDebugInfo
• IFailExceptionJinEitherFrame
• IFailJinEitherFrame
• IFailReplyJinEitherFrame
• IFormatter
• IHeaderField
• IHeaderFieldOption
• IJinFrameCreateConfig
• IJinFrameFunction
• IJinFrameRequestConfig
• IObjectBodyFieldOption
• IParamFieldOption
• IQueryFieldOption
• IQueryParamCommonFieldOption

Type Aliases

ConstructorType

Ƭ ConstructorType<T>: OmitType<T, Function>

Type parameters

Name
T

Defined in

jin-frame/src/tools/ConstructorType.ts:19

---

JinConstructorType

Ƭ JinConstructorType<T>: Omit<ConstructorType<T>, "host" | "path" | "method" | "contentType" | "customBody">

Type parameters

Name	Type
T	extends AbstractJinFrame

Defined in

jin-frame/src/tools/ConstructorType.ts:23

---

JinOmitConstructorType

Ƭ JinOmitConstructorType<T, M>: Omit<ConstructorType<T>, "host" | "path" | "method" | "contentType" | "customBody" | M>

Type parameters

Name	Type
T	extends AbstractJinFrame
M	extends keyof ConstructorType<T>

Defined in

jin-frame/src/tools/ConstructorType.ts:28

---

OmitConstructorType

Ƭ OmitConstructorType<T, M>: Omit<ConstructorType<T>, M>

Type parameters

Name	Type
T	T
M	extends keyof ConstructorType<T>

Defined in

jin-frame/src/tools/ConstructorType.ts:21

---

TFieldRecords

Ƭ TFieldRecords: Record<IParamFieldOption["type"], { key: string ; option: IParamFieldOption }[]> & Record<IQueryFieldOption["type"], { key: string ; option: IQueryFieldOption }[]> & Record<IBodyFieldOption["type"], { key: string ; option: IBodyFieldOption }[]> & Record<IHeaderFieldOption["type"], { key: string ; option: IHeaderFieldOption }[]>

Defined in

jin-frame/src/interfaces/TFieldRecords.ts:6

---

TJinFail

Ƭ TJinFail<T>: IFail<IFailExceptionJinEitherFrame<T> | IFailReplyJinEitherFrame<T>>

Type parameters

Name
T

Defined in

jin-frame/src/interfaces/IFailJinEitherFrame.ts:29

---

TJinPass

Ƭ TJinPass<T>: IPass<TPassJinEitherFrame<T>>

Type parameters

Name
T

Defined in

jin-frame/src/interfaces/TPassJinEitherFrame.ts:12

---

TMultipleBodyFormatter

Ƭ TMultipleBodyFormatter: { findFrom?: string } & IFormatter[]

Defined in

jin-frame/src/interfaces/body/IBodyFieldOption.ts:9

---

TMultipleObjectBodyFormatter

Ƭ TMultipleObjectBodyFormatter: { findFrom: string } & IFormatter[]

Defined in

jin-frame/src/interfaces/body/IObjectBodyFieldOption.ts:9

---

TPassJinEitherFrame

Ƭ TPassJinEitherFrame<T>: AxiosResponse<T> & { $debug: IDebugInfo ; $frame: JinEitherFrame<T, any> ; $progress: "pass" }

Type parameters

Name
T

Defined in

jin-frame/src/interfaces/TPassJinEitherFrame.ts:6

---

TRequestPart

Ƭ TRequestPart: IQueryFieldOption["type"] | IParamFieldOption["type"] | IBodyFieldOption["type"] | IHeaderFieldOption["type"]

Defined in

jin-frame/src/interfaces/TRequestPart.ts:6

---

TSingleBodyFormatter

Ƭ TSingleBodyFormatter: { findFrom?: string } & IFormatter

Defined in

jin-frame/src/interfaces/body/IBodyFieldOption.ts:4

---

TSingleObjectBodyFormatter

Ƭ TSingleObjectBodyFormatter: { findFrom: string } & IFormatter

Defined in

jin-frame/src/interfaces/body/IObjectBodyFieldOption.ts:4

Variables

defaultJinFrameTimeout

• Const defaultJinFrameTimeout: 120000

Defined in

jin-frame/src/frames/defaultJinFrameTimeout.ts:1

Functions

applyFormatters

▸ applyFormatters(initialValue, formatter): string

Parameters

Name	Type
initialValue	string | number | boolean | Date
formatter	IFormatter

Returns

string

Defined in

jin-frame/src/tools/applyFormatters.ts:38

▸ applyFormatters(initialValue, formatter): string[]

Parameters

Name	Type
initialValue	string[] | Date[] | number[] | boolean[]
formatter	IFormatter

Returns

string[]

Defined in

jin-frame/src/tools/applyFormatters.ts:39

---

bitwised

▸ bitwised(values): number

Parameters

Name	Type
values	number[]

Returns

number

Defined in

jin-frame/src/tools/bitwised.ts:1

---

encode

▸ encode(enable, value): string | number

Parameters

Name	Type
enable	undefined | null | boolean
value	string | number

Returns

string | number

Defined in

jin-frame/src/tools/encode.ts:1

---

encodes

▸ encodes(enable, values): string

Parameters

Name	Type
enable	undefined | null | boolean
values	string | number

Returns

string

Defined in

jin-frame/src/tools/encode.ts:9

▸ encodes(enable, values): string[]

Parameters

Name	Type
enable	undefined | null | boolean
values	string[] | number[]

Returns

string[]

Defined in

jin-frame/src/tools/encode.ts:10

---

getBodyInfo

▸ getBodyInfo<T>(thisFrame, fields, strict?): any

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
thisFrame	T
fields	IBodyField[]
strict?	boolean

Returns

any

Defined in

jin-frame/src/processors/getBodyInfo.ts:11

---

getDefaultBodyFieldOption

▸ getDefaultBodyFieldOption(option?): IBodyFieldOption

Parameters

Name	Type
option?	Partial<IBodyFieldOption> | Except<Partial<IBodyFieldOption>, "type">

Returns

IBodyFieldOption

Defined in

jin-frame/src/processors/getDefaultOption.ts:38

---

getDefaultHeaderFieldOption

▸ getDefaultHeaderFieldOption(option?): IHeaderFieldOption

Parameters

Name	Type
option?	Partial<IHeaderFieldOption> | Omit<Partial<IHeaderFieldOption>, "type">

Returns

IHeaderFieldOption

Defined in

jin-frame/src/processors/getDefaultOption.ts:92

---

getDefaultObjectBodyFieldOption

▸ getDefaultObjectBodyFieldOption(option?): IObjectBodyFieldOption

Parameters

Name	Type
option?	Partial<IObjectBodyFieldOption> | Except<Partial<IObjectBodyFieldOption>, "type">

Returns

IObjectBodyFieldOption

Defined in

jin-frame/src/processors/getDefaultOption.ts:65

---

getDefaultParamFieldOption

▸ getDefaultParamFieldOption(option?): IParamFieldOption

Parameters

Name	Type
option?	Partial<IParamFieldOption> | Omit<Partial<IParamFieldOption>, "type">

Returns

IParamFieldOption

Defined in

jin-frame/src/processors/getDefaultOption.ts:23

---

getDefaultQueryFieldOption

▸ getDefaultQueryFieldOption(option?): IQueryFieldOption

Parameters

Name	Type
option?	Partial<IQueryFieldOption> | Omit<Partial<IQueryFieldOption>, "type">

Returns

IQueryFieldOption

Defined in

jin-frame/src/processors/getDefaultOption.ts:8

---

getDuration

▸ getDuration(start, end): number

Parameters

Name	Type
start	Date
end	Date

Returns

number

Defined in

jin-frame/src/tools/getDuration.ts:4

---

getHeaderInfo

▸ getHeaderInfo<T>(thisFrame, fields, strict?): Record<string, any>

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
thisFrame	T
fields	IHeaderField[]
strict?	boolean

Returns

Record<string, any>

Defined in

jin-frame/src/processors/getHeaderInfo.ts:7

---

getQueryParamInfo

▸ getQueryParamInfo<T>(origin, fields): Record<string, any>

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
origin	T
fields	{ key: string ; option: IParamFieldOption | IQueryFieldOption }[]

Returns

Record<string, any>

Defined in

jin-frame/src/processors/getQueryParamInfo.ts:8

---

isValidArrayType

▸ isValidArrayType(value): value is string[] | Date[] | number[] | boolean[]

Parameters

Name	Type
value	unknown

Returns

value is string[] | Date[] | number[] | boolean[]

Defined in

jin-frame/src/tools/typeAssert.ts:16

---

isValidPrimitiveType

▸ isValidPrimitiveType(value): value is string | number | boolean | Date

Parameters

Name	Type
value	unknown

Returns

value is string | number | boolean | Date

Defined in

jin-frame/src/tools/typeAssert.ts:3

---

isValidateStatusDefault

▸ isValidateStatusDefault(status): boolean

Parameters

Name	Type
status	number

Returns

boolean

Defined in

jin-frame/src/tools/isValidateStatusDefault.ts:3

---

processBodyFormatters

▸ processBodyFormatters<T>(strict, thisFrame, field, formatterArgs): any

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
strict	boolean
thisFrame	T
field	Object
field.key	string
field.option	IBodyFieldOption
formatterArgs	TSingleBodyFormatter | TMultipleBodyFormatter

Returns

any

Defined in

jin-frame/src/processors/processBodyFormatters.ts:8

---

processHeaderFormatters

▸ processHeaderFormatters<T>(thisFrame, field, formatters): Record<string, any>

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
thisFrame	T
field	IHeaderField
formatters	IFormatter[]

Returns

Record<string, any>

Defined in

jin-frame/src/processors/processHeaderFormatters.ts:7

---

processObjectBodyFormatters

▸ processObjectBodyFormatters<T>(strict, thisFrame, field, formatterArgs): any

Type parameters

Name	Type
T	extends Record<string, any>

Parameters

Name	Type
strict	boolean
thisFrame	T
field	Object
field.key	string
field.option	IObjectBodyFieldOption
formatterArgs	TSingleObjectBodyFormatter | TMultipleObjectBodyFormatter

Returns

any

Defined in

jin-frame/src/processors/processObjectBodyFormatters.ts:8

---

removeBothSlash

▸ removeBothSlash(value): string

Parameters

Name	Type
value	string

Returns

string

Defined in

jin-frame/src/tools/slashUtils.ts:9

---

removeEndSlash

▸ removeEndSlash(value): string

Parameters

Name	Type
value	string

Returns

string

Defined in

jin-frame/src/tools/slashUtils.ts:1

---

removeStartSlash

▸ removeStartSlash(value): string

Parameters

Name	Type
value	string

Returns

string

Defined in

jin-frame/src/tools/slashUtils.ts:5

---

startWithSlash

▸ startWithSlash(value): string

Parameters

Name	Type
value	string

Returns

string

Defined in

jin-frame/src/tools/slashUtils.ts:13

---

typeAssert

▸ typeAssert(strict, value): boolean

Parameters

Name	Type
strict	boolean
value	unknown

Returns

boolean

Defined in

jin-frame/src/tools/typeAssert.ts:33