Function resolveHttpFromFunctionConfig

resolveHttpFromFunctionConfig<
    EventSchema extends
        | undefined
        | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
    ResponseSchema extends
        | undefined
        | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
    GlobalParams extends Record<string, unknown>,
    StageParams extends Record<string, unknown>,
    EventTypeMap extends
        {
            alb: ALBEvent;
            cloudfront: CloudFrontRequestEvent;
            "cloudwatch-logs": CloudWatchLogsEvent;
            "cognito-userpool": CognitoUserPoolTriggerEvent;
            dynamodb: DynamoDBStreamEvent;
            eventbridge: EventBridgeEvent<string, unknown>;
            firehose: FirehoseTransformationEvent;
            http: APIGatewayProxyEventV2;
            kinesis: KinesisStreamEvent;
            rest: APIGatewayProxyEvent;
            s3: S3Event;
            ses: SESEvent;
            sns: SNSEvent;
            sqs: SQSEvent;
            step: { Payload?: unknown; [key: string]: unknown };
        },
    EventType extends string
    | number
    | symbol,
>(
    functionConfig: FunctionConfig<
        EventSchema,
        ResponseSchema,
        GlobalParams,
        StageParams,
        EventTypeMap,
        EventType,
    >,
    callerModuleUrl: string,
    endpointsRootAbs: string,
): {
    basePath: string;
    contexts: readonly HttpContext[];
    method:
        | "options"
        | "head"
        | "trace"
        | "get"
        | "put"
        | "post"
        | "delete"
        | "patch"
        | `x-${string}`
        | "$ref"
        | "summary"
        | "description"
        | "servers"
        | "parameters";
}
Resolve (method, basePath, contexts) for an HTTP function definition.
Type Parameters
- EventSchema extends undefined | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
  optional event Zod schema
- ResponseSchema extends undefined | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
  optional response Zod schema
- GlobalParams extends Record<string, unknown>
  app global params type
- StageParams extends Record<string, unknown>
  app stage params type
- EventTypeMap extends {
      alb: ALBEvent;
      cloudfront: CloudFrontRequestEvent;
      "cloudwatch-logs": CloudWatchLogsEvent;
      "cognito-userpool": CognitoUserPoolTriggerEvent;
      dynamodb: DynamoDBStreamEvent;
      eventbridge: EventBridgeEvent<string, unknown>;
      firehose: FirehoseTransformationEvent;
      http: APIGatewayProxyEventV2;
      kinesis: KinesisStreamEvent;
      rest: APIGatewayProxyEvent;
      s3: S3Event;
      ses: SESEvent;
      sns: SNSEvent;
      sqs: SQSEvent;
      step: { Payload?: unknown; [key: string]: unknown };
  }
  event type token map
- EventType extends string | number | symbol
  selected event token
Parameters
- functionConfig: FunctionConfig<
      EventSchema,
      ResponseSchema,
      GlobalParams,
      StageParams,
      EventTypeMap,
      EventType,
  >
  the per‑function config (may omit method/basePath)
- callerModuleUrl: string
  import.meta.url of the registering module
- endpointsRootAbs: string
  absolute root of endpoints
Returns {
    basePath: string;
    contexts: readonly HttpContext[];
    method:
        | "options"
        | "head"
        | "trace"
        | "get"
        | "put"
        | "post"
        | "delete"
        | "patch"
        | `x-${string}`
        | "$ref"
        | "summary"
        | "description"
        | "servers"
        | "parameters";
}
HTTP method key, basePath, and unique contexts list

Throws
Error if method/basePath cannot be inferred under endpoints root
- Defined in src/http/resolveHttpFromFunctionConfig.ts:39

Function resolveHttpFromFunctionConfig

Type Parameters

Parameters

Returns { basePath: string; contexts: readonly HttpContext[]; method: | "options" | "head" | "trace" | "get" | "put" | "post" | "delete" | "patch" | `x-${string}` | "$ref" | "summary" | "description" | "servers" | "parameters";}

Throws

Settings

Returns {
basePath: string;
contexts: readonly HttpContext[];
method:
| "options"
| "head"
| "trace"
| "get"
| "put"
| "post"
| "delete"
| "patch"
| `x-${string}`
| "$ref"
| "summary"
| "description"
| "servers"
| "parameters";
}