Skip to main content

HTTPEventHandler <Configuration, Service, Profile, Body, Path, Query, Headers, Result, Security, Authorizer, GV>

Index

Properties

Properties

optionalbodyType

bodyType?: binary | json | plaintext

handler

handler: (request: NoInfer<HTTPRequest<Body, Path, Query, Headers, Security, Authorizer, GV>>, context: LambdaContext<Configuration, Service, Profile>) => Promisable<Try<{ [ KeyType in string | number | symbol ]: IfEmptyObject<NoInfer<Result>, HTTPResponse<number, unknown, HTTPHeaders>, _HTTPResponses<NoInfer<Result>>>[KeyType] }>>

Type declaration

    • (request: NoInfer<HTTPRequest<Body, Path, Query, Headers, Security, Authorizer, GV>>, context: LambdaContext<Configuration, Service, Profile>): Promisable<Try<{ [ KeyType in string | number | symbol ]: IfEmptyObject<NoInfer<Result>, HTTPResponse<number, unknown, HTTPHeaders>, _HTTPResponses<NoInfer<Result>>>[KeyType] }>>

    • Parameters

      • request: NoInfer<HTTPRequest<Body, Path, Query, Headers, Security, Authorizer, GV>>
      • context: LambdaContext<Configuration, Service, Profile>

      Returns Promisable<Try<{ [ KeyType in string | number | symbol ]: IfEmptyObject<NoInfer<Result>, HTTPResponse<number, unknown, HTTPHeaders>, _HTTPResponses<NoInfer<Result>>>[KeyType] }>>

optionalmethod

method?: HTTPMethod

optionalpath

path?: `/${string}`

schema

schema: { authorizer?: Authorizer; body?: Schema<Body>; headers?: Schema<Headers>; path?: Schema<Path>; query?: Schema<Query>; responses: Result }

Type declaration

  • optionalauthorizer?: Authorizer
  • optionalbody?: Schema<Body>
  • optionalheaders?: Schema<Headers>
  • optionalpath?: Schema<Path>
  • optionalquery?: Schema<Query>
  • responses: Result

optionalsecurity

security?: Security