Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-pubsub / 3cd900684dc33d5ca07e977df724a0c179a91fa9
commit3cd900684dc33d5ca07e977df724a0c179a91fa9[log] [tgz]
authorJessica Wagantall <jwagantall@linuxfoundation.org>Tue Dec 04 12:17:02 2018 -0800
committerJessica Wagantall <jwagantall@linuxfoundation.org>Tue Dec 04 20:35:16 2018 +0000
tree0c7c8b3bbed1096693f3d4d050964c1c2beba050
parent891c2687abdb9f276f4198ff1c92a577a1880088 [diff]
Update INFO.yaml file

Remove Michael Lando. Add Ofir Sonsino as PTL

Change-Id: I781afdbc64c2f6b83fe86497dffb48af9bc794b4
Issue-ID: CIMAN-134
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
1 file changed
tree: 0c7c8b3bbed1096693f3d4d050964c1c2beba050
  1. lib/
  2. .gitattributes
  3. .gitignore
  4. .gitreview
  5. .npmignore
  6. index.ts
  7. INFO.yaml
  8. jest.config.js
  9. LICENSE.TXT
  10. package.json
  11. pom.xml
  12. README.md
  13. tsconfig.json
  14. tslint.json
  15. version.properties
  16. 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