Class: AkkaServerless

akkaserverless. AkkaServerless


new AkkaServerless( [options])

Akka Serverless service.

Parameters:
Name Type Argument Description
options module:akkaserverless.AkkaServerlessOptions <optional>

The options for starting the service.

Methods


addComponent(components)

Add one or more components to this AkkaServerless service.

Parameters:
Name Type Argument Description
components module:akkaserverless~Component <repeatable>

The components to add.

Returns:

this AkkaServerless service.

Type
module:akkaserverless.AkkaServerless

shutdown()

Shut down the Akka Serverless service.


start( [binding])

Start the Akka Serverless service.

Parameters:
Name Type Argument Description
binding module:akkaserverless.ServiceBinding <optional>

optional address/port binding to start the service on.

Returns:

A Promise of the bound port for this service.

Type
Promise.<number>

tryShutdown(callback)

Shut down the Akka Serverless service.

Parameters:
Name Type Description
callback module:akkaserverless.AkkaServerless~shutdownCallback

shutdown callback, accepting possible error

Type Definitions


shutdownCallback( [error])

Callback for tryShutdown, accepting possible error.

Parameters:
Name Type Argument Description
error Error <optional>

Error on shutting down the service.