Class AzureFunctionsAdapter

Azure Functions Adapter for Stone.js.

The AzureFunctionsAdapter provides seamless integration between Stone.js applications and the Azure Functions environment. It processes incoming events from Azure Functions, transforms them into IncomingEvent instances, and returns a RawResponse.

This adapter ensures compatibility with Azure Functions's execution model and abstracts the event handling process for Stone.js developers.

Template: AzureFunctionsEvent

The type of the raw event received from Azure Functions.

Template: RawResponse

The type of the response to send back to Azure Functions.

Template: AzureFunctionsContext

The Azure Functions execution context type.

Template: IncomingEvent

The type of the processed incoming event.

Template: IncomingEventOptions

Options used to create an incoming event.

Template: OutgoingResponse

The type of the outgoing response after processing.

Template: AzureFunctionsAdapterContext

Context type specific to the adapter.

Example

import { AzureFunctionsAdapter } from '@stone-js/azure-functions-adapter';

const adapter = AzureFunctionsAdapter.create({...});

const handler = await adapter.run();

export { handler };

See

Hierarchy

Adapter<
    AzureFunctionsEvent,
    RawResponse,
    AzureFunctionsContext,
    IncomingEvent,
    IncomingEventOptions,
    OutgoingResponse,
    AzureFunctionsAdapterContext,
>
- AzureFunctionsAdapter

Constructors

`Protected`constructor

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

Inherited from Adapter< AzureFunctionsEvent, RawResponse, AzureFunctionsContext, IncomingEvent, IncomingEventOptions, OutgoingResponse, AzureFunctionsAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<AzureFunctionsAdapterContext, RawResponse>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<AzureFunctionsAdapterContext, RawResponse>[]

`Protected` `Readonly`resolvedErrorHandlers

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

Methods

`Protected`buildRawResponse

buildRawResponse(
context: AzureFunctionsAdapterContext,
eventHandler?: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<RawResponse>
Build the raw response.
Parameters
- context: AzureFunctionsAdapterContext
  The event context.
- OptionaleventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<RawResponse>
The raw response wrapper.

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
rawEvent: unknown,
executionContext: AzureFunctionsContext,
): Promise<RawResponse>
Processes an incoming Azure Functions event.

This method transforms the raw Azure Functions event into a Stone.js IncomingEvent, processes it through the pipeline, and generates a RawResponse to send back.
Parameters
- rawEvent: unknown
  The raw Azure Functions event to be processed.
- executionContext: AzureFunctionsContext
  The Azure Functions execution context for the event.
Returns Promise<RawResponse>
A promise resolving to the processed RawResponse.

`Protected`executeEventHandlerHooks

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

Inherited from Adapter.executeEventHandlerHooks

`Protected`executeHooks

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

Inherited from Adapter.executeHooks

`Protected`handleError

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

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: AzureFunctionsAdapterContext,
    eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponse>,
    >,
>
Handle the event.
Parameters
- context: AzureFunctionsAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponse>,
    >,
>
The raw response wrapper.

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
    AzureFunctionsAdapterContext,
    AdapterEventBuilderType<RawResponse>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    AzureFunctionsAdapterContext,
    AdapterEventBuilderType<RawResponse>,
>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Initializes the adapter and validates its execution context.

Ensures the adapter is running in an Azure Functions environment. If not, it throws an error to prevent misuse.

Returns Promise<void>

Throws
If executed outside an Azure Functions context (e.g., browser).

`Protected`resolveErrorHandler

resolveErrorHandler(
error: Error,
): IAdapterErrorHandler<unknown, RawResponse, AzureFunctionsContext>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<unknown, RawResponse, AzureFunctionsContext>
The error handler.

Throws
IntegrationError

Inherited from Adapter.resolveErrorHandler

`Protected`resolveEventHandler

resolveEventHandler(): AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Get the event handler for the adapter.

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
The event handler for the adapter.

Throws
If the event handler is missing.

Inherited from Adapter.resolveEventHandler

run

run<ExecutionResultType = AzureFunctionsEventHandlerFunction>(): Promise<
ExecutionResultType,
>
Executes the adapter and provides an Azure Functions-compatible handler function.

The run method initializes the adapter and returns a handler function that Azure Functions can invoke. This handler processes events, manages context, and returns the appropriate response.
Type Parameters
- ExecutionResultType = AzureFunctionsEventHandlerFunction
  The type representing the Azure Functions event handler function.
Returns Promise<ExecutionResultType>
A promise resolving to the Azure Functions handler function.

Throws
If used outside the Azure Functions environment.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
context: AzureFunctionsAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<RawResponse>
Send the raw event through the destination.
Parameters
- context: AzureFunctionsAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<RawResponse>
Platform-specific response.

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
context: AzureFunctionsAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): void
Validate the context and event handler.
Parameters
- context: AzureFunctionsAdapterContext
  The context to validate.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to validate.
Returns void

Throws
IntegrationError

Inherited from Adapter.validateContextAndEventHandler

`Static`create

create(blueprint: IBlueprint): AzureFunctionsAdapter
Creates an instance of the AzureFunctionsAdapter.
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns AzureFunctionsAdapter
A new instance of AzureFunctionsAdapter.
Example
```
const adapter = AzureFunctionsAdapter.create(blueprint);
await adapter.run();
```

Class AzureFunctionsAdapter

Template: AzureFunctionsEvent

Template: RawResponse

Template: AzureFunctionsContext

Template: IncomingEvent

Template: IncomingEventOptions

Template: OutgoingResponse

Template: AzureFunctionsAdapterContext

Example

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns AzureFunctionsAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<RawResponse>

ProtectedeventListener

Parameters

Returns Promise<RawResponse>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<RawResponse>>

ProtectedhandleEvent

Parameters

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

ProtectedmakePipelineOptions

Returns PipelineOptions< AzureFunctionsAdapterContext, AdapterEventBuilderType<RawResponse>,>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler<unknown, RawResponse, AzureFunctionsContext>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

Throws

ProtectedsendEventThroughDestination

Parameters

Returns Promise<RawResponse>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns AzureFunctionsAdapter

Example

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<RawResponse>,
>,
>

`Protected`makePipelineOptions

Returns PipelineOptions<
AzureFunctionsAdapterContext,
AdapterEventBuilderType<RawResponse>,
>

`Protected`onStart

`Protected`resolveErrorHandler

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create