Class: Configuration

Configuration

Represents the configuration of a Stormancer client. Use the static method Configuration.forAccount for creating a Configuration with an account ID and an application name.

Constructor

new Configuration()

Creates a Configuration. Prefer the Configuration.forAccount method instead of this constructor.

Source:

Members

account :string

A string containing the account name of the application.

Type:
  • string
Source:

application :string

A string containing the name of the application.

Type:
  • string
Source:

dispatcher :object

Gets or Sets the dispatcher to be used by the client.

Type:
  • object
Source:

serializers :Array.<object>

List of available serializers for the client. When negotiating which serializer should be used for a given remote peer, the first compatible serializer in the list is the one prefered.

Type:
  • Array.<object>
Source:

serverEndpoint :string

A string containing the target server endpoint. This value overrides the apiEndpoint property.

Type:
  • string
Source:

transport :object

Gets or sets the transport to be used by the client.

Type:
  • object
Source:

Methods

forAccount(accountId, applicationName) → {Stormancer.Configuration}

Creates a Configuration object targeting the public online platform.

Parameters:
Name Type Description
accountId string

Account ID

applicationName string

Application name

Source:
Returns:

The configuration object

Type
Stormancer.Configuration