Skip to content

Main Navigation Home Document Github

English

English

Appearance

Sidebar Navigation

Document

What is jin-frame?

Getting To Start

Method

Authorization

Inheritance

Retry

Mocking

Form

Field

Query

Param

Body

ObjectBody

Header

Formatters

API

decorators

fields

Body

Functions

Body

handlers

getFieldMetadata

Functions

REQUEST_FIELD_DECORATOR

Variables

Header

Functions

Header

ObjectBody

Functions

ObjectBody

Param

Functions

Param

Query

Functions

Query

getFrameInternalData

Functions

getFrameInternalData

getFrameOption

Functions

getFrameOption

methods

Delete

Variables

Delete

Get

Variables

Get

handlers

getAllMethodMetaInherited

Functions

getRequestMeta

Functions

makeRequestDecorator

Functions

pushRequestMeta

Functions

REQUEST_METHOD_DECORATOR

Variables

Head

Variables

Head

Link

Variables

Link

Options

Variables

Options

Patch

Variables

Patch

Post

Variables

Post

Purge

Variables

Purge

Put

Variables

Put

Search

Variables

Search

Unlink

Variables

Unlink

frames

AbstractJinFrame

Classes

AbstractJinFrame

defaultJinFrameTimeout

Variables

defaultJinFrameTimeout

JinCreateError

Classes

JinCreateError

JinEitherFrame

Classes

JinEitherFrame

JinFile

Classes

JinFile

JinFrame

Classes

JinFrame

JinRequestError

Classes

JinRequestError

interfaces

field

body

IBodyField

Interfaces

IBodyFieldOption

Interfaces

IObjectBodyFieldOption

Interfaces

TMultipleBodyFormatter

Type Aliases

TSingleBodyFormatter

Type Aliases

ICommonFieldOption

Interfaces

ICommonFieldOption

IHeaderFieldOption

Interfaces

IHeaderFieldOption

IParamFieldOption

Interfaces

IParamFieldOption

IQueryFieldOption

Interfaces

IQueryFieldOption

IQueryParamHeaderCommonFieldOption

Interfaces

IQueryParamHeaderCommonFieldOption

IDebugInfo

Interfaces

IDebugInfo

IFailJinEitherFrame

Interfaces

IFailCreateJinEitherFrame

IFailJinEitherFrame

IFailReplyJinEitherFrame

Type Aliases

TJinFail

options

IFormatter

Interfaces

IFormatter

IFrameInternal

Interfaces

IFrameInternal

IFrameOption

Interfaces

IFrameOption

IFrameRetry

Interfaces

IFrameRetry

IJinFrameCreateConfig

Interfaces

IJinFrameCreateConfig

IJinFrameFunction

Interfaces

IJinFrameFunction

IJinFrameRequestConfig

Interfaces

IJinFrameRequestConfig

TFieldRecords

Type Aliases

TFieldRecords

THook

Type Aliases

TPostEitherHook

TPostHook

TPreEitherHook

TPreHook

TRetryFailHook

TMethod

Type Aliases

TMethod

TMethodEntry

Type Aliases

TMethodEntry

TJinFrameResponse

Type Aliases

TJinFrameResponse

TJinRequestConfig

TPassJinEitherFrame

Type Aliases

TJinPass

TPassJinEitherFrame

processors

flatStringMap

Functions

flatStringMap

getBodyField

Functions

getBodyField

getBodyMap

Functions

getBodyMap

getDefaultOption

Functions

getDefaultBodyFieldOption

getDefaultHeaderFieldOption

getDefaultObjectBodyFieldOption

getDefaultParamFieldOption

getDefaultQueryFieldOption

getObjectBodyField

Functions

getObjectBodyField

getQuerystringKey

Functions

getQuerystringKey

getQuerystringKeyFormat

Functions

getQuerystringKeyFormat

getQuerystringMap

Functions

getQuerystringMap

tools

auth

getAuthorization

Functions

getAuthorization

bitwised

Functions

bitwised

CE_HOOK_APPLY

Type Aliases

CE_HOOK_APPLY

Variables

CE_HOOK_APPLY

encodes

encode

Functions

encode

encodes

Functions

encodes

formatters

applyFormat

Functions

applyFormat

bodyFormatEach

Functions

bodyFormatEach

bodyFormatting

Functions

bodyFormatting

bodyFormattings

Functions

bodyFormattings

classifyBodyFormatters

Functions

classifyBodyFormatters

findFromBody

Functions

findFromBody

formatEach

Functions

formatEach

formatting

Functions

formatting

formattings

Functions

formattings

getBodyFormatters

Functions

getBodyFormatters

setToBody

Functions

setToBody

stringifyExceptString

Functions

stringifyExceptString

stringifyQuerystring

Functions

stringifyQuerystring

getDuration

Functions

getDuration

isValidateStatusDefault

Functions

isValidateStatusDefault

mergeOption

Functions

mergeFrameOption

responses

getRetryInterval

Functions

getRetryInterval

getStatusFromAxiosError

Functions

getStatusFromAxiosError

setFrameOption

Functions

setFrameOption

slash-utils

getUrl

Functions

getUrl

removeBothSlash

Functions

removeBothSlash

removeEndSlash

Functions

removeEndSlash

removeStartSlash

Functions

removeStartSlash

startWithSlash

Functions

startWithSlash

type-narrowing

isValidArrayType

Functions

isValidArrayType

isValidNumberArray

Functions

isValidNumberArray

isValidObject

Functions

isValidObject

isValidPrimitiveType

Functions

isValidPrimitiveType

isValidPrimitiveWithDateType

Functions

isValidPrimitiveWithDateType

typeAssert

Functions

typeAssert

type-utilities

ConstructorType

Type Aliases

ConstructorType

OmitConstructorType

Type Aliases

OmitConstructorType

TBuilderFor

Interfaces

TBuilderFor

TConstructorFunction

Type Aliases

TConstructorFunction

TFieldsOf

Type Aliases

TFieldsOf

TSupportArrayType

Type Aliases

TSupportArrayType

TSupportPrimitiveType

Type Aliases

TSupportPrimitiveType

On this page

jin-frame / interfaces/field/ICommonFieldOption

interfaces/field/ICommonFieldOption

Interfaces

ICommonFieldOption

Pager

Previous pageTSingleBodyFormatter

Next pageICommonFieldOption