New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

fh-wfm-result

Package Overview
Dependencies
Maintainers
4
Versions
43
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fh-wfm-result

A result module for WFM, for working with the results of pushing a workorder through a workflow

  • 0.2.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
18
decreased by-41.94%
Maintainers
4
Weekly downloads
 
Created
Source

FeedHenry WFM Result

A result module for WFM, for working with the results of pushing a workorder through a workflow.

Client-side usage

Setup

This module can be initialised by

var resultModule = require('fh-wfm-result');

//Initialising the result module with a mediator. This will set up all of the subscribers for the result module.
resultModule(mediator);

//The result mediator topics are now subscribed.
mediator.subscribe("done:wfm:results:list", function(arrayOfResults) {
  ...
  console.log("All Results", arrayOfResults);
  ...
});

mediator.publish("wfm:results:list");
Integration

Topic Subscriptions

wfm:result:create
Description

Creating a new Result

Example
var parameters = {
  resultToCreate: {
    //A Valid JSON Object
  },
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}

mediator.publish("wfm:result:create", parameters);
wfm:result:read
Description

Read a single Result

Example
var parameters = {
  id: "resultId",
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}

mediator.publish("wfm:result:read", parameters);
wfm:result:update
Description

Update a single Result

Example
var parameters = {
  resultToUpdate: {
    ...
    id: "resultId"
    ...
  },
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}

mediator.publish("wfm:result:update", parameters);
wfm:result:remove
Description

Remove a single Result

Example
var parameters = {
  id: "resultId",
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}

mediator.publish("wfm:result:remove", parameters);
wfm:result:list
Description

List All Results

Example
var parameters = {
  //Optional topic unique identifier.
  topicUid: "uniquetopicid"
}

mediator.publish("wfm:result:list", parameters);

Published Topics

The following topics are published by this module. Developers are free to implement these topics subscribers, or use a module that already has these subscribers implement (E.g. the raincatcher-sync module).

TopicDescription
wfm:sync:results:createCreate a new item in the sync results collection
wfm:sync:results:updateUpdate an existing item in the sync results collection
wfm:sync:results:listList all items in the sync results collection
wfm:sync:results:removeRemove an existing item from the sync results collection
wfm:sync:results:readRead a single item from the sync results collection
wfm:sync:results:startStart the sync process for sync results collection
wfm:sync:results:stopStop the sync process for sync results collection
wfm:sync:results:force_syncForce a sync cycle from client to cloud for sync results collection

Topic Subscriptions

TopicDescription
done:wfm:sync:results:createA result was created in the results dataset
error:wfm:sync:results:createAn error occurred when creating an item in the results dataset.
done:wfm:sync:results:updateA result was updated in the results dataset
error:wfm:sync:results:updateAn error occurred when updating an item in the results dataset.
done:wfm:sync:results:listA list of the items in the results dataset completed
error:wfm:sync:results:listAn error occurred when listing items in the results dataset.
done:wfm:sync:results:removeA result was removed from the results dataset
error:wfm:sync:results:removeAn error occurred when removing an item in the results dataset.
done:wfm:sync:results:readA item was read correctly from the results dataset
error:wfm:sync:results:readAn error occurred when reading an item in the results dataset.
done:wfm:sync:results:startThe sync process started for the results dataset.
error:wfm:sync:results:startAn error occurred when starting the results dataset.
done:wfm:sync:results:stopThe sync process stopped for the results dataset.
error:wfm:sync:results:stopAn error occurred when stopping the results dataset sync process.
done:wfm:sync:results:force_syncA force sync process completed for the results dataset.
error:wfm:sync:results:force_syncAn error occurred when forcing the sync process for the results dataset.

Usage in an express backend

Setup

The server-side component of this WFM module exports a function that takes express and mediator instances as parameters, as in:

var express = require('express')
  , app = express()
  , mbaasExpress = mbaasApi.mbaasExpress()
  , mediator = require('fh-wfm-mediator/lib/mediator')
  ;

// configure the express app
...

// setup the wfm result sync server
require('fh-wfm-result/lib/server')(mediator, app, mbaasApi);

Integration

Check this demo cloud application

Keywords

FAQs

Package last updated on 05 May 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc