Class AzureFunctionsHttpAdapter

Azure Functions v4 HTTP adapter for Stone.js.

Azure Functions v4 invokes an HTTP-triggered function with a Web-standard HttpRequest and expects an HttpResponseInit back. Unlike a server adapter, run() does not start a listener — it returns the handler (request, invocationContext) => Promise<HttpResponseInit> that you register with app.http('name', { handler }) from @azure/functions.

Because the request is Web-standard, the normalizer is the same one the Fetch adapter uses; only the raw response differs (an HttpResponseInit object rather than a Response).

Example

import { app } from '@azure/functions'
const handler = await AzureFunctionsHttpAdapter.create(blueprint).run<AzureFunctionsHttpEventHandlerFunction>()
app.http('stone', { methods: ['GET', 'POST'], authLevel: 'anonymous', handler })

Hierarchy

Adapter<
    AzureHttpRequest,
    AzureHttpResponseInit,
    AzureFunctionsHttpExecutionContext,
    IncomingHttpEvent,
    IncomingHttpEventOptions,
    OutgoingHttpResponse,
    AzureFunctionsHttpAdapterContext,
>
- AzureFunctionsHttpAdapter

Constructors

`Protected`constructor

new AzureFunctionsHttpAdapter(blueprint: IBlueprint): AzureFunctionsHttpAdapter
Create an Adapter.
Parameters
- blueprint: IBlueprint
  The blueprint to create the adapter.
Returns AzureFunctionsHttpAdapter

Inherited from Adapter< AzureHttpRequest, AzureHttpResponseInit, AzureFunctionsHttpExecutionContext, IncomingHttpEvent, IncomingHttpEventOptions, OutgoingHttpResponse, AzureFunctionsHttpAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<AzureFunctionsHttpAdapterContext, AzureHttpResponseInit>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<
AzureFunctionsHttpAdapterContext,
AzureHttpResponseInit,
>[]

`Protected` `Readonly`resolvedErrorHandlers

resolvedErrorHandlers: Record<
string,
IAdapterErrorHandler<RawEventType, RawResponseType, ExecutionContextType>,
>

Methods

`Protected`buildRawResponse

buildRawResponse(
    context: AzureFunctionsHttpAdapterContext,
    eventHandler?: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<AzureHttpResponseInit>
Build the raw response.
Parameters
- context: AzureFunctionsHttpAdapterContext
  The event context.
- OptionaleventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<AzureHttpResponseInit>
The raw response wrapper.

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
rawEvent: AzureHttpRequest,
executionContext: AzureFunctionsHttpExecutionContext,
): Promise<AzureHttpResponseInit>
Handle a single Azure HttpRequest, producing an HttpResponseInit.
Parameters
- rawEvent: AzureHttpRequest
  The incoming request.
- executionContext: AzureFunctionsHttpExecutionContext
  The Azure invocation context.
Returns Promise<AzureHttpResponseInit>
The response init.

`Protected`executeEventHandlerHooks

executeEventHandlerHooks(
    hook: KernelHookName,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<void>
Execute the event handler lifecycle hooks.
Parameters
- hook: KernelHookName
  The hook to execute.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<void>

Inherited from Adapter.executeEventHandlerHooks

`Protected`executeHooks

executeHooks(
    name: AdapterHookName,
    context?: AzureFunctionsHttpAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: AzureFunctionsHttpAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

handleError(
error: Error,
context: AzureFunctionsHttpAdapterContext,
): Promise<AdapterEventBuilderType<AzureHttpResponseInit>>
Handle error.
Parameters
- error: Error
  The error to handle.
- context: AzureFunctionsHttpAdapterContext
  The event context.
Returns Promise<AdapterEventBuilderType<AzureHttpResponseInit>>
The raw response.

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: AzureFunctionsHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<AzureHttpResponseInit>,
    >,
>
Handle the event.
Parameters
- context: AzureFunctionsHttpAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<AzureHttpResponseInit>,
    >,
>
The raw response wrapper.

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
    AzureFunctionsHttpAdapterContext,
    AdapterEventBuilderType<AzureHttpResponseInit>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    AzureFunctionsHttpAdapterContext,
    AdapterEventBuilderType<AzureHttpResponseInit>,
>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Lifecycle hook run once before the first request.

Returns Promise<void>

`Protected`resolveErrorHandler

resolveErrorHandler(
    error: Error,
): IAdapterErrorHandler<
    AzureHttpRequest,
    AzureHttpResponseInit,
    AzureFunctionsHttpExecutionContext,
>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<
    AzureHttpRequest,
    AzureHttpResponseInit,
    AzureFunctionsHttpExecutionContext,
>
The error handler.

Throws
IntegrationError

Inherited from Adapter.resolveErrorHandler

`Protected`resolveEventHandler

resolveEventHandler(): AdapterEventHandlerType<
IncomingHttpEvent,
OutgoingHttpResponse,
>

Get the event handler for the adapter.

Returns AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
The event handler for the adapter.

Throws
If the event handler is missing.

Inherited from Adapter.resolveEventHandler

run

run<ExecutionResultType = AzureFunctionsHttpEventHandlerFunction>(): Promise<
ExecutionResultType,
>
Start the adapter and return the Azure Functions HTTP handler.
Type Parameters
- ExecutionResultType = AzureFunctionsHttpEventHandlerFunction
Returns Promise<ExecutionResultType>
The Azure Functions HTTP handler.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
    context: AzureFunctionsHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): Promise<AzureHttpResponseInit>
Send the raw event through the destination.
Parameters
- context: AzureFunctionsHttpAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to be run.
Returns Promise<AzureHttpResponseInit>
Platform-specific response.

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
    context: AzureFunctionsHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): void
Validate the context and event handler.
Parameters
- context: AzureFunctionsHttpAdapterContext
  The context to validate.
- eventHandler: AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>
  The event handler to validate.
Returns void

Throws
IntegrationError

Inherited from Adapter.validateContextAndEventHandler

`Static`create

create(blueprint: IBlueprint): AzureFunctionsHttpAdapter
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns AzureFunctionsHttpAdapter
A new adapter instance.

Class AzureFunctionsHttpAdapter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns AzureFunctionsHttpAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<AzureHttpResponseInit>

ProtectedeventListener

Parameters

Returns Promise<AzureHttpResponseInit>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<AzureHttpResponseInit>>

ProtectedhandleEvent

Parameters

Returns Promise< IAdapterEventBuilder< RawResponseOptions, IRawResponseWrapper<AzureHttpResponseInit>, >,>

ProtectedmakePipelineOptions

Returns PipelineOptions< AzureFunctionsHttpAdapterContext, AdapterEventBuilderType<AzureHttpResponseInit>,>

ProtectedonStart

Returns Promise<void>

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler< AzureHttpRequest, AzureHttpResponseInit, AzureFunctionsHttpExecutionContext,>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

ProtectedsendEventThroughDestination

Parameters

Returns Promise<AzureHttpResponseInit>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns AzureFunctionsHttpAdapter

Settings

On This Page

`Protected`constructor

`Protected` `Readonly`blueprint

`Protected` `Readonly`hooks

`Protected` `Readonly`middleware

`Protected` `Readonly`resolvedErrorHandlers

`Protected`buildRawResponse

`Protected`eventListener

`Protected`executeEventHandlerHooks

`Protected`executeHooks

`Protected`handleError

`Protected`handleEvent

Returns Promise<
IAdapterEventBuilder<
RawResponseOptions,
IRawResponseWrapper<AzureHttpResponseInit>,
>,
>

`Protected`makePipelineOptions

Returns PipelineOptions<
AzureFunctionsHttpAdapterContext,
AdapterEventBuilderType<AzureHttpResponseInit>,
>

`Protected`onStart

`Protected`resolveErrorHandler

Returns IAdapterErrorHandler<
AzureHttpRequest,
AzureHttpResponseInit,
AzureFunctionsHttpExecutionContext,
>

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create