Members
BIServiceSDK constructor
Type:
function
Constructor
- services
- Type:
Object - <serviceName>
- Type:
Object index name = name of the service
- <scope>
- Type:
Object index name not constrained, could be anything... eg.: specific service application name (in case multiple applications are listening under one service) or access level type eg.: "public" or "s2s"
- npm
- Type:
String npm package name which exports object that inherits BIServiceSDK
- host
- Type:
String - ssl
- Type:
Boolean
A factory for BIServiceSDK instances
(see affiliated bi-service-sdk plugin)
and SDKs integration
Parameters:
Methods
- key
- Type:
String format
<serviceName>:<scope>- sdk
- Type:
BIServiceSDK - self
- key
- Type:
String format:
<serviceName>:<scope>:<version>- options optional
- Type:
Object BIServiceSDKconstructor options-
Error - key
- Type:
String format
<serviceName>:<scope>:<version>- key
- Type:
String format
<serviceName>:<scope>:<version>(scope|version key segments are optional)
RemoteServiceManager
registers BIServiceSDK instance
Parameters:
RemoteServiceManager
BIServiceSDK
constructs specific BIServiceSDK from configuration provided to the constructor
the specific BIServiceSDK is supposed to be auto generated by bi-service-sdk plugin
and published as a npm package
Parameters:
Throws:
BIServiceSDK
Example:
//config.json5:
{
services: {
user: {
public: {
ssl: true,
host: "127.0.0.1:4001",
npm: "bi-user-public-sdk"
}
}
}
}
//method usage
remoteServiceManager.buildRemoteService('user:public:v1.0');
BIServiceSDK
Parameters:
BIServiceSDK
Boolean
Parameters:
Boolean