Class TencentScfHttpAdapter

Tencent SCF HTTP Adapter for Stone.js.

The TencentScfHttpAdapter extends the functionality of the Stone.js Adapter to provide seamless integration with Tencent SCF for HTTP-based events. This adapter transforms incoming HTTP events from Tencent SCF into IncomingHttpEvent instances and produces a RawHttpResponse as output.

This adapter simplifies the process of handling HTTP events within Tencent SCF while adhering to the Stone.js framework's event-driven architecture.

Template: TencentScfHttpEvent

The type of the raw HTTP event from Tencent SCF.

Template: RawHttpResponse

The type of the raw HTTP response to send back.

Template: TencentScfContext

The Tencent SCF execution context type.

Template: IncomingHttpEvent

The type of the processed incoming HTTP event.

Template: IncomingHttpEventOptions

Options used to create an incoming HTTP event.

Template: OutgoingHttpResponse

The type of the outgoing HTTP response after processing.

Template: TencentScfHttpAdapterContext

Context type specific to the HTTP adapter.

Example

import { TencentScfHttpAdapter } from '@stone-js/tencent-scf-http-adapter';

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

const handler = await adapter.run();

export { handler };

See

Hierarchy

Adapter<
    TencentScfHttpEvent,
    RawHttpResponse,
    TencentScfContext,
    IncomingHttpEvent,
    IncomingHttpEventOptions,
    OutgoingHttpResponse,
    TencentScfHttpAdapterContext,
>
- TencentScfHttpAdapter

Constructors

`Protected`constructor

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

Inherited from Adapter< TencentScfHttpEvent, RawHttpResponse, TencentScfContext, IncomingHttpEvent, IncomingHttpEventOptions, OutgoingHttpResponse, TencentScfHttpAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<TencentScfHttpAdapterContext, RawHttpResponseOptions>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<
TencentScfHttpAdapterContext,
RawHttpResponseOptions,
>[]

`Protected` `Readonly`resolvedErrorHandlers

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

Methods

`Protected`buildRawResponse

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

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
rawEvent: TencentScfHttpEvent,
executionContext: TencentScfContext,
): Promise<RawHttpResponseOptions>
Processes an incoming Tencent SCF HTTP event.

Converts a raw Tencent SCF HTTP event into an IncomingHttpEvent, processes it through the Stone.js pipeline, and generates a RawHttpResponse to send back.
Parameters
- rawEvent: TencentScfHttpEvent
  The raw HTTP event received from Tencent SCF.
- executionContext: TencentScfContext
  The Tencent SCF execution context associated with the event.
Returns Promise<RawHttpResponseOptions>
A promise resolving to the processed RawHttpResponse.

`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?: TencentScfHttpAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: TencentScfHttpAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

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

Inherited from Adapter.handleError

`Protected`handleEvent

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

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
    TencentScfHttpAdapterContext,
    AdapterEventBuilderType<RawHttpResponseOptions>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    TencentScfHttpAdapterContext,
    AdapterEventBuilderType<RawHttpResponseOptions>,
>
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 that the adapter is running in an Tencent SCF environment. Throws an error if it detects that the adapter is being used in an unsupported environment (e.g., a browser).

Returns Promise<void>

Throws
If executed outside an Tencent SCF environment.

`Protected`resolveErrorHandler

resolveErrorHandler(
    error: Error,
): IAdapterErrorHandler<
    TencentScfHttpEvent,
    RawHttpResponseOptions,
    TencentScfContext,
>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<
    TencentScfHttpEvent,
    RawHttpResponseOptions,
    TencentScfContext,
>
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 = TencentScfEventHandlerFunction<
        RawHttpResponseOptions,
    >,
>(): Promise<ExecutionResultType>
Executes the adapter and provides an Tencent SCF-compatible HTTP handler function.

This method initializes the adapter and returns a handler function that can process HTTP events in Tencent SCF. It transforms raw events into IncomingHttpEvent instances and produces RawHttpResponse objects as output.
Type Parameters
- ExecutionResultType = TencentScfEventHandlerFunction<RawHttpResponseOptions>
  The type representing the Tencent SCF event handler function.
Returns Promise<ExecutionResultType>
A promise resolving to the Tencent SCF HTTP handler function.

Throws
If used outside the Tencent SCF environment.

Overrides Adapter.run

`Protected`sendEventThroughDestination

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

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
    context: TencentScfHttpAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingHttpEvent,
        OutgoingHttpResponse,
    >,
): void
Validate the context and event handler.
Parameters
- context: TencentScfHttpAdapterContext
  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): TencentScfHttpAdapter
Creates an instance of the TencentScfHttpAdapter.
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns TencentScfHttpAdapter
A new instance of TencentScfHttpAdapter.
Example
```
const adapter = TencentScfHttpAdapter.create(blueprint);
await adapter.run();
```

Class TencentScfHttpAdapter

Template: TencentScfHttpEvent

Template: RawHttpResponse

Template: TencentScfContext

Template: IncomingHttpEvent

Template: IncomingHttpEventOptions

Template: OutgoingHttpResponse

Template: TencentScfHttpAdapterContext

Example

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns TencentScfHttpAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<RawHttpResponseOptions>

ProtectedeventListener

Parameters

Returns Promise<RawHttpResponseOptions>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<RawHttpResponseOptions>>

ProtectedhandleEvent

Parameters

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

ProtectedmakePipelineOptions

Returns PipelineOptions< TencentScfHttpAdapterContext, AdapterEventBuilderType<RawHttpResponseOptions>,>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler< TencentScfHttpEvent, RawHttpResponseOptions, TencentScfContext,>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingHttpEvent, OutgoingHttpResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

Throws

ProtectedsendEventThroughDestination

Parameters

Returns Promise<RawHttpResponseOptions>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns TencentScfHttpAdapter

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

`Protected`makePipelineOptions

Returns PipelineOptions<
TencentScfHttpAdapterContext,
AdapterEventBuilderType<RawHttpResponseOptions>,
>

`Protected`onStart

`Protected`resolveErrorHandler

Returns IAdapterErrorHandler<
TencentScfHttpEvent,
RawHttpResponseOptions,
TencentScfContext,
>

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create