flow-cloudboost-component
v0.3.5
Published
CloudBoost components designed to work with Flow SDK
Downloads
23
Readme
Flow Cloudboost component
Cloudboost components designed to work with Flow SDK
To get started, install the package in your NodeJS project
npm i flow-cloudboost-component --save
Use the component as below
// require the component
const Component = require('flow-cloudboost-component');
// create instance of the query component for example
const component = new Component.Query();
Provide cloudboost credentials, app id, client key
component.getProperty('APP_ID').data = 'Your_App_ID';
component.getProperty('CLIENT_KEY').data = 'Your_Client_Key';
Provide collection to query against
// have this created, for example 'Games'
component.getProperty('Table').data = 'Your_Collection';
component.getProperty('Constraints').data = {
name: { equalTo: 'Chess' },
players: { lessThan: 2 }
};
Listen in for port emit events
component.getPort('Success').onEmit(function() {
// query was successfully made
// the documents can be accessed through the 'Data' property of the port
let documents = component.getPort('Success').getProperty('Data')
.data
.map(d => d.document);
});
component.getPort('Error').onEmit(function() {
// an error occured
// the actual error can be accessed through the 'Data' property of the port
let err = component.getPort('Error').getProperty('Data').data;
});
Execute the component
// add the component to a graph before executing it
const Graph = require('flow-platform-sdk').Graph;
new Graph("graph-1").addComponent(component);
component.execute();
Conclusion
That's the Flow Cloudboost Query component. Also check the Cloudboost Save and Cloudboost Delete components
If you are having trouble, ensure that you are using the correct Cloudboost credentials.