ts-lambda-api - v2.5.2
Preparing search index...
<internal>
API
Class API
Index
Constructors
constructor
Methods
any
app
delete
finally
get
head
METHOD
options
patch
post
put
register
routes
run
use
Constructors
constructor
new
API
()
:
API
Returns
API
Methods
any
any
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
any
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
app
app
(
namespace
:
string
,
package
:
any
)
:
App
Parameters
namespace
:
string
package
:
any
Returns
App
app
(
packages
:
App
)
:
App
Parameters
packages
:
App
Returns
App
delete
delete
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
delete
(
...
middlewaresAndHandler
:
HandlerFunction
[]
)
:
void
Parameters
...
middlewaresAndHandler
:
HandlerFunction
[]
Returns
void
finally
finally
(
callback
:
FinallyFunction
)
:
void
Parameters
callback
:
FinallyFunction
Returns
void
get
get
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
get
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
head
head
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
head
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
METHOD
METHOD
(
method
:
METHODS
|
METHODS
[]
,
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
method
:
METHODS
|
METHODS
[]
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
METHOD
(
method
:
METHODS
|
METHODS
[]
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
method
:
METHODS
|
METHODS
[]
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
options
options
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
options
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
patch
patch
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
patch
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
post
post
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
post
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
put
put
(
path
:
string
,
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
,
)
:
void
Parameters
path
:
string
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
put
(
...
middlewaresAndHandler
:
(
Middleware
|
HandlerFunction
)
[]
)
:
void
Parameters
...
middlewaresAndHandler
: (
Middleware
|
HandlerFunction
)
[]
Returns
void
register
register
(
routes
:
(
api
:
API
,
options
?:
RegisterOptions
)
=>
void
,
options
?:
RegisterOptions
,
)
:
void
Parameters
routes
:
(
api
:
API
,
options
?:
RegisterOptions
)
=>
void
Optional
options
:
RegisterOptions
Returns
void
routes
routes
(
format
:
true
)
:
void
Parameters
format
:
true
Returns
void
routes
(
format
:
false
)
:
string
[]
[]
Parameters
format
:
false
Returns
string
[]
[]
routes
()
:
string
[]
[]
Returns
string
[]
[]
run
run
(
event
:
APIGatewayProxyEvent
|
APIGatewayProxyEventV2
,
context
:
Context
,
cb
:
(
err
:
Error
,
result
:
any
)
=>
void
,
)
:
void
Parameters
event
:
APIGatewayProxyEvent
|
APIGatewayProxyEventV2
context
:
Context
cb
:
(
err
:
Error
,
result
:
any
)
=>
void
Returns
void
run
(
event
:
APIGatewayProxyEvent
|
APIGatewayProxyEventV2
,
context
:
Context
,
)
:
Promise
<
any
>
Parameters
event
:
APIGatewayProxyEvent
|
APIGatewayProxyEventV2
context
:
Context
Returns
Promise
<
any
>
use
use
(
path
:
string
,
...
middleware
:
Middleware
[]
)
:
void
Parameters
path
:
string
...
middleware
:
Middleware
[]
Returns
void
use
(
paths
:
string
[]
,
...
middleware
:
Middleware
[]
)
:
void
Parameters
paths
:
string
[]
...
middleware
:
Middleware
[]
Returns
void
use
(
...
middleware
:
(
Middleware
|
ErrorHandlingMiddleware
)
[]
)
:
void
Parameters
...
middleware
: (
Middleware
|
ErrorHandlingMiddleware
)
[]
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
any
app
delete
finally
get
head
METHOD
options
patch
post
put
register
routes
run
use
ts-lambda-api - v2.5.2
Loading...