Class RequestPipeline

Index

Constructors

Methods

addInterceptor execute getHandlerCount getInterceptorCount getMiddlewareCount onEvent registerHandler removeEventHandler removeInterceptor removeMiddleware unregisterHandler useMiddleware

Constructors

constructor

new RequestPipeline(config?: Partial<PipelineConfig>): RequestPipeline
Parameters
- Optionalconfig: Partial<PipelineConfig>
Returns RequestPipeline
- Defined in api/dist/pipeline.d.ts:34

Methods

addInterceptor

addInterceptor(interceptor: Interceptor, order?: number): void
Parameters
- interceptor: Interceptor
- Optionalorder: number
Returns void
- Defined in api/dist/pipeline.d.ts:37

execute

execute(
    operation: OperationDescriptor,
    request: RequestContext,
    parameters: Record<string, unknown>,
): Promise<ApiResponse<unknown>>
Parameters
- operation: OperationDescriptor
- request: RequestContext
- parameters: Record<string, unknown>
Returns Promise<ApiResponse<unknown>>
- Defined in api/dist/pipeline.d.ts:47

getHandlerCount

getHandlerCount(): number
Returns number
- Defined in api/dist/pipeline.d.ts:45

getInterceptorCount

getInterceptorCount(): number
Returns number
- Defined in api/dist/pipeline.d.ts:44

getMiddlewareCount

getMiddlewareCount(): number
Returns number
- Defined in api/dist/pipeline.d.ts:43

onEvent

onEvent(handler: PipelineEventHandler): void
Parameters
- handler: PipelineEventHandler
Returns void
- Defined in api/dist/pipeline.d.ts:41

registerHandler

registerHandler(operationId: string, handler: OperationHandler): void
Parameters
- operationId: string
- handler: OperationHandler
Returns void
- Defined in api/dist/pipeline.d.ts:39

removeEventHandler

removeEventHandler(handler: PipelineEventHandler): boolean
Parameters
- handler: PipelineEventHandler
Returns boolean
- Defined in api/dist/pipeline.d.ts:42

removeInterceptor

removeInterceptor(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in api/dist/pipeline.d.ts:38

removeMiddleware

removeMiddleware(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in api/dist/pipeline.d.ts:36

unregisterHandler

unregisterHandler(operationId: string): boolean
Parameters
- operationId: string
Returns boolean
- Defined in api/dist/pipeline.d.ts:40

useMiddleware

useMiddleware(name: string, fn: MiddlewareFunction, order?: number): void
Parameters
- name: string
- fn: MiddlewareFunction
- Optionalorder: number
Returns void
- Defined in api/dist/pipeline.d.ts:35