Skip to content

Main Navigation jin-frame OpenAPI generators OpenAPI core Packages ChangeNote Support

English

English

Appearance

Sidebar Navigation

Start here

Introduction

Installation and first request

HTTP Methods

URL templates

Factory and Builder

Inheritance and defaults

Request fields

Path parameters

Query parameters

Headers

Cookies

Body fields

Object bodies

Formatters

Forms and files

Responses and execution

Status unions and errors

Zod validation

Authentication

Retry and timeout

Request deduplication

Lifecycle hooks

Testing with MSW

Naming conventions

OpenAPI generators

Overview

CLI installation

CLI commands

CLI configuration

Core installation

Generation pipeline

Core configuration

Diagnostics

Reference

Package versions

Migrate to v6

Changenote

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

Trace

Variables

Trace

Unlink

Variables

Unlink

exceptions

JinCreateError

Classes

JinCreateError

JinRespError

Classes

JinRespError

JinValidationError

Classes

JinValidationError

frames

AbstractJinFrame

Classes

AbstractJinFrame

builder.test-d

defaultJinFrameTimeout

Variables

defaultJinFrameTimeout

JinFile

Classes

JinFile

JinFrame

Classes

JinFrame

RequestDedupeManager

Classes

RequestDedupeManager

resolveSecurityKey

Functions

resolveSecurityKey

interfaces

BufferedResponse

Interfaces

BufferedResponse

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

FieldEntry

Type Aliases

FieldEntry

HeaderFieldOption

Interfaces

HeaderFieldOption

IRequestFieldRecord

Interfaces

IRequestFieldRecord

ParamFieldOption

Interfaces

ParamFieldOption

QueryFieldOption

Interfaces

QueryFieldOption

QueryParamHeaderCommonFieldOption

Interfaces

QueryParamHeaderCommonFieldOption

GetError

Type Aliases

GetError

IGetCachePathParams

Interfaces

IGetCachePathParams

JinBasicAuth

Interfaces

JinBasicAuth

JinHttpClient

Type Aliases

JinHttpClient

JinRequestConfig

Interfaces

JinRequestConfig

JinResp

Type Aliases

JinResp

JinResponse

JinRespBase

Interfaces

JinRespBase

options

FieldRecords

Type Aliases

FieldRecords

Formatter

Interfaces

Formatter

FrameInternal

Interfaces

FrameInternal

FrameOption

Interfaces

FrameOption

FrameRetry

Interfaces

FrameRetry

JinFrameCreateConfig

Interfaces

JinFrameCreateConfig

JinFrameFunction

Interfaces

JinFrameFunction

JinFrameRequestConfig

Interfaces

JinFrameRequestConfig

Method

Type Aliases

Method

MethodEntry

Type Aliases

MethodEntry

Milliseconds

Type Aliases

Milliseconds

PostHook

Type Aliases

PostHook

PreHook

Type Aliases

PreHook

RetryFailHook

Type Aliases

RetryFailHook

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

Type Aliases

ProviderKey

BasicAuthProvider

Classes

BasicAuthProvider

BearerTokenProvider

Classes

BearerTokenProvider

providerKeys.test-d

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

absoluteUrlPattern

Variables

absoluteUrlPattern

getUrl

Functions

getUrl

hostUrlPattern

Variables

hostUrlPattern

pathUrlPattern

Variables

pathUrlPattern

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

AllowedNames

Type Aliases

AllowedNames

AnyFn

Type Aliases

AnyFn

BuilderFor

Interfaces

BuilderFor

ConstructorFunction

Type Aliases

ConstructorFunction

ConstructorType

Type Aliases

ConstructorType

FieldsOf

Type Aliases

FieldsOf

FlagExcludedType

Type Aliases

FlagExcludedType

FunctionKeys

Type Aliases

FunctionKeys

NonFunctionProps

Type Aliases

NonFunctionProps

OmitConstructorType

Type Aliases

OmitConstructorType

OmitType

Type Aliases

OmitType

PublicFieldsOf

Type Aliases

PublicFieldsOf

SupportArrayType

Type Aliases

SupportArrayType

SupportPrimitiveType

Type Aliases

SupportPrimitiveType

WithBuilder

Interfaces

WithBuilder

WithDefaultValues

Interfaces

WithDefaultValues

validateStatus

Type Aliases

StatusValidator

SuccessResponse

ValidatedResponse

Functions

validateStatus

validators

BaseValidator

Classes

BaseValidator

Interfaces

ResponseValidator

Type Aliases

ValidationInput

generator-core API

generators

base-frame

createBaseFrameData

Functions

createBaseFrameData

createBaseFrameFromData

Functions

createBaseFrameFromData

getBaseFrameJsDoc

Functions

getBaseFrameJsDoc

getFrameDecoratorArgument

Functions

getFrameDecoratorArgument

getServerVariableDefaultMethods

Functions

getServerVariableDefaultMethods

getServerVariableDefaults

Functions

getServerVariableDefaults

getServerVariableDocs

Functions

getServerVariableDocs

getServerVariableName

Functions

getServerVariableName

getServerVariableProperties

Functions

getServerVariableProperties

getServerVariableType

Functions

getServerVariableType

interfaces

IBaseFrameData

Interfaces

ICreateBaseFrameProps

Interfaces

ICreateBaseFrameResult

Interfaces

content-type

applicationJsonContentType

Variables

applicationJsonContentType

getFirstContentType

Functions

getFirstContentType

getFrameResponseTypes

Functions

getFrameResponseTypes

getMethodDecorator

Functions

getMethodDecorator

getRequestContentType

Functions

getRequestContentType

interfaces

IGetFrameResponseTypesProps

Interfaces

IGetMethodDecoratorProps

Interfaces

preferredContentTypes

Variables

preferredContentTypes

createBaseFrame

Functions

createBaseFrame

createFrame

Functions

createFrame

createFrames

Functions

createFrames

frame

createFrameData

Functions

createFrameData

createFrameFromData

Functions

createFrameFromData

getParameterAliasName

Functions

getParameterAliasName

interfaces

ICreateFrameProps

Interfaces

ICreateFrameResult

Interfaces

IFrameData

Interfaces

IFrameDataImport

Interfaces

parameterAliasMap

Variables

parameterAliasMap

frames

createFrameGenerationContext

Functions

createFrameGenerationContext

createFramePipeline

Functions

createFramePipeline

extractFrameEndpoints

Functions

extractFrameEndpoints

getInlineHost

Functions

getInlineHost

getServerFrameEndpoint

Functions

getServerFrameEndpoint

interfaces

ICreateFramePipelineParams

Interfaces

ICreateFramesProps

Interfaces

ICreateFramesResult

Interfaces

IExtractFrameEndpointsParams

Interfaces

IFrameEndpoint

Type Aliases

IFrameGenerationContext

Interfaces

IFrameOverrideRetry

Interfaces

IFrameOverrides

Interfaces

IServerFrameEndpoint

Interfaces

mergeParameters

Functions

mergeParameters

splitServerUrl

Functions

splitServerUrl

getClassJsDoc

Functions

getClassJsDoc

getFrameName

Functions

getFrameName

hosts

buildServerMappingFromServers

Functions

buildServerMappingFromServers

generateEnvFunction

Functions

generateEnvFunction

generateHostValue

Functions

generateHostValue

getBaseHost

Functions

getBaseHost

getHost

Functions

getHost

getServerUrl

Functions

getServerUrl

interfaces

IGenerateHostValueParams

Interfaces

IGetBaseHostParams

Interfaces

IGetHostParams

Interfaces

IGetServerParams

Interfaces

IGetServerUrlParams

Interfaces

IGetServerUrlReturn

Interfaces

IHostStrategyOptions

Interfaces

interfaces

IGeneratorObserverOptions

Interfaces

IGeneratorObserverOptions

Type Aliases

GeneratorEvent

GeneratorStage

IGetClassJsDocProps

Interfaces

IGetClassJsDocProps

IGetFrameNameProps

Interfaces

IGetFrameNameProps

IPropertyData

Interfaces

IPropertyData

IPropertyDecoratorData

Interfaces

IPropertyDecoratorData

json

getJsonArgument

Functions

getJsonArgument

interface

IGetJsonArgumentProps

Interfaces

IJsonLiteralValue

Interfaces

octet-stream

getFileUploadKeyMap

Functions

getFileUploadKeyMap

interfaces

IFileKey

Interfaces

IIsFileSchemaResult

Interfaces

isFileSchema

Functions

isFileSchema

parameters

getBodyDecorator

Functions

getBodyDecorator

getBodyParameter

Functions

getBodyParameter

getExampleValue

Functions

getExampleValue

getParameter

Functions

getParameter

getParameterDecorator

Functions

getParameterDecorator

getParameterDecoratorArguments

Functions

getParameterDecoratorArguments

getParameterJsDoc

Functions

getParameterJsDoc

getParameterJsDocExamplesContent

Functions

getParameterJsDocExamplesContent

interfaces

IGetBodyParameterProps

Interfaces

IGetBodyParameterResult

Interfaces

IGetParameterJsDocExamplesContentProps

Interfaces

IGetParameterProps

Interfaces

IGetParameterResult

Interfaces

security

builtinProviderClassNames

Variables

builtinProviderClassNames

createGeneratedProviderData

Functions

createGeneratedProviderData

createSecurityProviderData

Functions

createSecurityProviderData

createSecurityProviderFromData

Functions

createSecurityProviderFromData

defaultSecurityProviderDir

Variables

defaultSecurityProviderDir

getDefaultProviderClassName

Functions

getDefaultProviderClassName

getFrameSecurityProviders

Functions

getFrameSecurityProviders

getProviderReference

Functions

getProviderReference

interfaces

ISecurityProviderData

Interfaces

ISecurityProviderOptions

Interfaces

ISecurityProviderOverride

Interfaces

ISecurityProviderReference

Interfaces

quote

Functions

quote

https

method

Type Aliases

THttpMethod

models

generators

IBaseUrl

Interfaces

IBaseUrl

IJinFrameData

Interfaces

IJinFrameData

options

IBodyFieldOption

Type Aliases

IFrameOption

Type Aliases

IHeaderFieldOption

Type Aliases

IObjectBodyFieldOption

Type Aliases

IParamFieldOption

Type Aliases

IQueryFieldOption

Type Aliases

openapi

convertor

Functions

convertor

createOpenapiTs

Functions

createOpenapiTs

createOpenapiTsOptions

Functions

createOpenapiTsOptions

dereference

Functions

dereference

interfaces

ICreateOpenapiTsOptions

Interfaces

ICreateOpenapiTsOptions

ILoadResult

Interfaces

ILoadResult

TValidateResult

Type Aliases

TValidateResult

isInt64IntegerSchema

Functions

isInt64IntegerSchema

isNullableSchema

Functions

isNullableSchema

load

Functions

load

OpenapiSchemaValidator

Variables

OpenapiSchemaValidator

validate

Functions

validate

renderers

eta

Variables

default

renderBaseFrameSource

Functions

renderBaseFrameSource

renderDecorator

Functions

renderDecorator

renderDoc

Functions

renderDoc

renderFrameSource

Functions

renderFrameSource

renderHostFunc

Functions

renderHostFunc

renderImports

Functions

renderImports

renderProperty

Functions

renderProperty

renderSecurityProviderSource

Functions

renderSecurityProviderSource

renderTemplate

Functions

renderTemplate

templates

Interfaces

ITemplateSet

Variables

defaultTemplates

Functions

loadTemplates

tools

const-enum

CE_URL_TEMP_KEY

Variables

CE_URL_TEMP_KEY

TCE_URL_TEMP_KEY

Type Aliases

TCE_URL_TEMP_KEY

dotRelative

Functions

dotRelative

enhanceSafeUrl

Functions

enhanceSafeUrl

interfaces

IMultiParse

Interfaces

IMultiParse

multiParse

Functions

multiParse

randomFilename

Functions

randomFilename

removeExt

Functions

removeExt

safeParse

Functions

safeParse

safePathJoin

Functions

safePathJoin

safeStringify

Functions

safeStringify

safeUrl

Functions

safeUrl

safeYamlParse

Functions

safeYamlParse

Support

On this page

@jin-frame/generator-core / generators/frames/createFramePipeline

generators/frames/createFramePipeline

Functions

createFramePipeline

Pager

Previous pagecreateFrameGenerationContext

Next pagecreateFramePipeline