This is a Node.js client SDK for service-microfrontends microservice. It provides an easy to use abstraction over communication protocols:
- Direct client
- HTTP client
- Seneca client (see http://www.senecajs.org)
- AWS Lambda client (see https://aws.amazon.com/lambda)
Add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"client-microfrontends-node": "^1.0.*",
...
}
}
Then install the dependency using npm tool
# Install new dependencies
npm install
# Update already installed dependencies
npm update
Inside your code get the reference to the client SDK
let sdk = new require('client-microfrontends-node');
Define client configuration parameters that match configuration of the microservice external API
// Client configuration
let config = {
connection: {
protocol: 'http',
host: 'localhost',
port: 8080
}
};
Instantiate the client and open connection to the microservice
// Create the client instance
let client = sdk.MicrofrontendsHttpClientV1(config);
// Connect to the microservice
await client.open(null);
// Work with the microservice
...
Now the client is ready to perform operations
// Create a new microfrontend
let microfrontend = {
id: 'my_app',
name: 'My Microfrontend',
product: 'My Samples'
};
let microfrontend = await client.createMicrofrontend(
null,
microfrontend
);
// Get the list of microfrontends for 'My Samples' product
let page = await client.getMicrofrontends(
null,
{
product: 'My Samples'
},
{
total: true,
skip: 0,
take: 10
}
);
This client SDK was created and currently maintained by Sergey Seroukhov.