Skip to content

Main Navigation Home Document Github

English

English

Appearance

Sidebar Navigation

Document

What is jin-frame?

Getting To Start

Method

Naming Convention

URL Template

Authorization

Inheritance

Retry

Mocking

Form

Validation

Dedupe

Hook

Builder

Field

Query

Param

Body

ObjectBody

Header

Formatters

API

decorators

fields

Body

Functions

Body

Cookie

Functions

Cookie

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

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

JinRespError

Classes

JinRespError

JinValidationError

Classes

JinValidationError

frames

AbstractJinFrame

Classes

AbstractJinFrame

defaultJinFrameTimeout

Variables

defaultJinFrameTimeout

JinFile

Classes

JinFile

JinFrame

Classes

JinFrame

RequestDedupeManager

Classes

RequestDedupeManager

interfaces

DebugInfo

Interfaces

DebugInfo

DedupeResult

Interfaces

DedupeResult

field

body

BodyFieldOption

Interfaces

MultipleBodyFormatter

Type Aliases

ObjectBodyFieldOption

Interfaces

SingleBodyFormatter

Type Aliases

CommonCacheKeyExcludeOption

Interfaces

CommonCacheKeyExcludeOption

CommonCacheKeyExcludePathOption

Interfaces

CommonCacheKeyExcludePathOption

CommonFieldOption

Interfaces

CommonFieldOption

CookieFieldOption

Interfaces

CookieFieldOption

HeaderFieldOption

Interfaces

HeaderFieldOption

ParamFieldOption

Interfaces

ParamFieldOption

QueryFieldOption

Interfaces

QueryFieldOption

QueryParamHeaderCommonFieldOption

Interfaces

QueryParamHeaderCommonFieldOption

GetError

Type Aliases

GetError

JinBasicAuth

Interfaces

JinBasicAuth

JinFailResp

Interfaces

JinFailResp

JinHttpClient

Type Aliases

JinHttpClient

JinPassResp

Interfaces

JinPassResp

JinRequestConfig

Interfaces

JinRequestConfig

JinResp

Type Aliases

JinResp

JinRespBase

Interfaces

JinRespBase

options

FieldRecords

Type Aliases

FieldRecords

Formatter

Interfaces

Formatter

FrameInternal

Interfaces

FrameInternal

FrameOption

Interfaces

FrameOption

FrameRetry

Interfaces

FrameRetry

Hooks

Type Aliases

PostHook

PreHook

RetryFailHook

JinFrameCreateConfig

Interfaces

JinFrameCreateConfig

JinFrameFunction

Interfaces

JinFrameFunction

JinFrameRequestConfig

Interfaces

JinFrameRequestConfig

Method

Type Aliases

Method

MethodEntry

Type Aliases

MethodEntry

Milliseconds

Type Aliases

Milliseconds

security

AuthorizationData

Type Aliases

AuthorizationData

SecurityContext

Interfaces

SecurityContext

SecurityKey

Type Aliases

SecurityKey

SecurityProvider

Interfaces

SecurityProvider

ValidationResult

Type Aliases

ValidationResult

ValidationResultType

Type Aliases

ValidationResultType

processors

default-option

getDefaultBodyFieldOption

Functions

getDefaultBodyFieldOption

getDefaultCookieFieldOption

Functions

getDefaultCookieFieldOption

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

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

getHeaderObject

Functions

getHeaderObject

getRetryAfter

Functions

getRetryAfter

getUrlValue

Functions

getUrlValue

isValidateStatusDefault

Functions

isValidateStatusDefault

json

safeParse

Functions

safeParse

safeStringify

Functions

safeStringify

mergeFrameOption

Functions

mergeFrameOption

mergeRetryOption

Functions

mergeRetryOption

responses

getRetryInterval

Functions

getRetryInterval

getStatusFromError

Functions

getStatusFromError

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

AbstractConstructorFunction

Type Aliases

AbstractConstructorFunction

BuilderFor

Interfaces

BuilderFor

ConstructorFunction

Type Aliases

ConstructorFunction

ConstructorType

Type Aliases

ConstructorType

FieldsOf

Type Aliases

FieldsOf

PublicFieldsOf

OmitConstructorType

Type Aliases

OmitConstructorType

SupportArrayType

Type Aliases

SupportArrayType

SupportPrimitiveType

Type Aliases

SupportPrimitiveType

WithBuilder

Interfaces

WithBuilder

WithDefaultValues

Interfaces

WithDefaultValues

validators

BaseValidator

Classes

BaseValidator

On this page

jin-frame / interfaces/field/QueryFieldOption

interfaces/field/QueryFieldOption

Interfaces

QueryFieldOption

Pager

Previous pageParamFieldOption

Next pageQueryFieldOption