Class default

Represents a server container that extends the Server class and handles serverless events.

Hierarchy (view full)

default
- default

Index

Constructors

Properties

config proxy routeResolver

Methods

getExport handleServerlessEvent start stop

Constructors

constructor

new default(config): default
Constructs a new instance of the Router class.
Parameters
- config: RouterConfig
  The configuration object for the router.
Returns default
None
Overrides default.constructor
- Defined in src/Server/lib/ContainerServer.ts:21

Properties

`Protected` `Readonly`config

config: RouterConfig

The configuration object for the router.

`Protected` `Readonly`proxy

proxy: default

The proxy object used for handling requests and responses.

`Protected` `Readonly`routeResolver

routeResolver: default

A protected property that holds a RouteResolver object. The RouteResolver is responsible for resolving routes and returning the appropriate response.

Methods

getExport

getExport(): CallableFunction
Returns a callable function that can be used to export data.

Returns CallableFunction
- A callable function that can be used to export data.
Overrides default.getExport
- Defined in src/Server/lib/ContainerServer.ts:31

handleServerlessEvent

handleServerlessEvent(event, context): Promise<void>
Handles a serverless event by executing a transaction and resolving the route based on the event.
Parameters
- event: APIGatewayProxyEvent
  The serverless event object.
- context: Context
  The serverless context object.
Returns Promise<void>
None
Inherited from default.handleServerlessEvent
- Defined in src/Server/lib/Server.ts:52

start

start(): Promise<void>
Starts the application by loading the proxy.

Returns Promise<void>
- A promise that resolves when the proxy is loaded.
- Defined in src/Server/lib/ContainerServer.ts:42

stop

stop(err?): Promise<void>
Stops the execution of the program and unloads the proxy.
Parameters
- Optionalerr: any
  Optional error object to pass to the unload method.
Returns Promise<void>
- A promise that resolves once the proxy is unloaded.
- Defined in src/Server/lib/ContainerServer.ts:51