Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-pubsub / 740e99a30601420077e4fffd6698f59761eb37f4
commit740e99a30601420077e4fffd6698f59761eb37f4[log] [tgz]
authorIdan Amit <ia096e@intl.att.com>Wed Aug 01 09:29:34 2018 +0300
committerIdan Amit <ia096e@intl.att.com>Wed Aug 01 09:31:27 2018 +0300
treeb3455dc578dd7644eeb26f47ccd8fc36dc4b0524
parent8a0aacc16f016480914c3e0799719f726b4c54b8 [diff]
sdc-pubsub maven integration

Added pom.xml file and defined maven clean and install stages

Change-Id: I31c6997e55bf0d39fd56220a82d1d8ca2f6d5583
Issue-ID: SDC-1540
Signed-off-by: Idan Amit <ia096e@intl.att.com>
6 files changed
tree: b3455dc578dd7644eeb26f47ccd8fc36dc4b0524
  1. lib/
  2. .gitattributes
  3. .gitignore
  4. .gitreview
  5. .npmignore
  6. index.ts
  7. INFO.yaml
  8. LICENSE.TXT
  9. package.json
  10. pom.xml
  11. README.md
  12. tsconfig.json
  13. version.properties
  14. webpack.config.js
README.md

sdc-pubsub

sdc-pubsub npm package.

Installation

Installing using npm:

npm install sdc-pubsub

Loading It Up

CommonJS

import {PluginPubSub} from 'sdc-pubsub'

Global Variable

<!-- index.html -->
<script src="./node_Modules/sdc-pubsub/dist/sdc-pubsub.js"></script>

// script.js
var pubsub = window.sdcPubSub.PluginPubSub;

Usage

Initialize a pubsub client

// eventsClientId = client id to be used by the event bus, received from query params
// parentUrl = event bus location url for communication, received from query params
// eventsToWaitFor = list of events names that the event hub should wait for their completion.
//                   the client should send an "ACTION_COMPLETED" event to the hub in order to notify the event hub to continue with the flow.
//                   For example: [ “CHECK_IN” ]

var client = new PluginPubSub('eventsClientId, parentUrl, eventsToWaitFor')

Notify about events

client.notify(“READY”)

Register for an event

// When lisetning to event we have to specify the specific event we want to act once it being received.
// eventData.type will hold the event name that was notified by someone else
client.on((eventData,event) => {
      if(eventData.type == ”WINDOW_OUT”) {
		             //do logic
       }
   }
)

Dependencies

None.

Tests

None.

Authors

Links

License

Copyright 2018 AT&T, Inc.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0