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

Validation

Dedupe

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_AUTHORIZATION_DECORATOR

Variables

REQUEST_DEDUPE_DECORATOR

Variables

REQUEST_METHOD_DECORATOR

Variables

REQUEST_RETRY_DECORATOR

Variables

REQUEST_SECURITY_DECORATOR

Variables

REQUEST_TIMEOUT_DECORATOR

Variables

REQUEST_VALIDATOR_DECORATOR

Variables

Head

Variables

Head

Link

Variables

Link

Options

Variables

Options

options

Authorization

Functions

Dedupe

Functions

Retry

Functions

Security

Functions

Timeout

Functions

Validator

Functions

Patch

Variables

Patch

Post

Variables

Post

Purge

Variables

Purge

Put

Variables

Put

Search

Variables

Search

Unlink

Variables

Unlink

exceptions

JinCreateError

Classes

JinCreateError

JinRequestError

Classes

JinRequestError

JinValidationtError

Classes

JinValidationtError

frames

AbstractJinFrame

Classes

AbstractJinFrame

defaultJinFrameTimeout

Variables

defaultJinFrameTimeout

JinEitherFrame

Classes

JinEitherFrame

JinFile

Classes

JinFile

JinFrame

Classes

JinFrame

RequestDedupeManager

Classes

RequestDedupeManager

interfaces

DedupeResult

Interfaces

DedupeResult

field

body

IBodyFieldOption

Interfaces

IObjectBodyFieldOption

Interfaces

TMultipleBodyFormatter

Type Aliases

TSingleBodyFormatter

Type Aliases

ICommonCacheKeyExcludeOption

Interfaces

ICommonCacheKeyExcludeOption

ICommonCacheKeyExcludePathOption

Interfaces

ICommonCacheKeyExcludePathOption

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

TMilliseconds

Type Aliases

TMilliseconds

security

AuthorizationData

Type Aliases

AuthorizationData

ISecurityContext

Interfaces

ISecurityContext

ISecurityProvider

Interfaces

ISecurityProvider

TGetError

Type Aliases

TGetError

TJinFrameResponse

Type Aliases

TJinFrameResponse

TJinRequestConfig

TPassJinEitherFrame

Type Aliases

TJinPass

TPassJinEitherFrame

TValidationResult

Type Aliases

TValidationResult

TValidationResultType

processors

default-option

getDefaultBodyFieldOption

Functions

getDefaultBodyFieldOption

getDefaultHeaderFieldOption

Functions

getDefaultHeaderFieldOption

getDefaultObjectBodyFieldOption

Functions

getDefaultObjectBodyFieldOption

getDefaultParamFieldOption

Functions

getDefaultParamFieldOption

getDefaultQueryFieldOption

Functions

getDefaultQueryFieldOption

flatStringMap

Functions

flatStringMap

getBodyField

Functions

getBodyField

getBodyMap

Functions

getBodyMap

getObjectBodyField

Functions

getObjectBodyField

getQuerystringKey

Functions

getQuerystringKey

getQuerystringKeyFormat

Functions

getQuerystringKeyFormat

getQuerystringMap

Functions

getQuerystringMap

providers

security

ApiKeyProvider

Classes

ApiKeyProvider

BasicAuthProvider

Classes

BasicAuthProvider

BearerTokenProvider

Classes

BearerTokenProvider

OAuth2Provider

Classes

OAuth2Provider

tools

auth

applySecurityProviders

Functions

applySecurityProviders

getAuthorization

Functions

getAuthorization

bitwised

Functions

bitwised

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

getCachePath

Functions

getCachePath

getDuration

Functions

getDuration

getError

Functions

getError

getRetryAfter

Functions

getRetryAfter

isValidateStatusDefault

Functions

isValidateStatusDefault

json

safeStringify

Functions

safeStringify

mergeFrameOption

Functions

mergeFrameOption

mergeRetryOption

Functions

mergeRetryOption

responses

getRetryInterval

Functions

getRetryInterval

getStatusFromAxiosError

Functions

getStatusFromAxiosError

runAndUnwrap

Functions

runAndUnwrap

setFrameOption

Functions

setFrameOption

slash-utils

getUrl

Functions

getUrl

removeBothSlash

Functions

removeBothSlash

removeEndSlash

Functions

removeEndSlash

removeStartSlash

Functions

removeStartSlash

startWithSlash

Functions

startWithSlash

sleep

Functions

sleep

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

validators

BaseValidator

Classes

BaseValidator

On this page

jin-frame / processors/default-option/getDefaultHeaderFieldOption

processors/default-option/getDefaultHeaderFieldOption

Functions

getDefaultHeaderFieldOption

Pager

Previous pagegetDefaultBodyFieldOption

Next pagegetDefaultHeaderFieldOption