Skip to main content

httpApiHandler

Callable

  • httpApiHandler<D, Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, Authorizer>(definition: D & HTTPHandler<Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, http, Authorizer>, __namedParameters?: { _kernel?: <Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, GV, Authorizer>(handler: HTTPHandler<Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, GV, Authorizer>, event: APIGatewayProxyEventV2Schema | APIGatewayProxyEventSchema, context: LambdaContext<Configuration, Service, Profile>) => Promise<Try<APIGatewayProxyResult | APIGatewayProxyResultV2>> }): D & EventHandlerFn<Configuration, Service, Profile, Result>

  • Type parameters

    • D
    • Configuration = undefined
    • Service: undefined | DefaultServices = undefined
    • Profile: MaybeGenericParser = undefined
    • Body: MaybeGenericParser = undefined
    • Path: MaybeGenericParser = undefined
    • Query: MaybeGenericParser = undefined
    • Headers: MaybeGenericParser = undefined
    • Result: Responses = Responses
    • Security: undefined | SecurityRequirements = undefined
    • Authorizer: { lambda: true | GenericParser } | { iam?: true } = { lambda: true | GenericParser } | { iam?: true }

    Parameters

    • definition: D & HTTPHandler<Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, http, Authorizer>
    • __namedParameters: { _kernel?: <Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, GV, Authorizer>(handler: HTTPHandler<Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, GV, Authorizer>, event: APIGatewayProxyEventV2Schema | APIGatewayProxyEventSchema, context: LambdaContext<Configuration, Service, Profile>) => Promise<Try<APIGatewayProxyResult | APIGatewayProxyResultV2>> } = {}
      • optional_kernel: <Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, GV, Authorizer>(handler: HTTPHandler<Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, GV, Authorizer>, event: APIGatewayProxyEventV2Schema | APIGatewayProxyEventSchema, context: LambdaContext<Configuration, Service, Profile>) => Promise<Try<APIGatewayProxyResult | APIGatewayProxyResultV2>> = handleHTTPEvent

    Returns D & EventHandlerFn<Configuration, Service, Profile, Result>