Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-pubsub / refs/heads/dublin
commitebec31d19d829d93e5e0a96db3e54036c5bd1450[log] [tgz]
authorIdan Amit <idan.amit@intl.att.com>Sun Jan 06 13:07:18 2019 +0200
committerIdan Amit <idan.amit@intl.att.com>Mon Jan 07 17:34:23 2019 +0200
treec48e474198d15b062a73e238de7cfd4505b82b54
parentbbeb590aaff56ff3364b852f6149b220581b58a1 [diff]
Fixed readme issue

Change-Id: I27c560f081daca8129534cc32bc869a24ec73b88
Issue-ID: SDC-2032
Signed-off-by: Idan Amit <idan.amit@intl.att.com>
4 files changed
tree: c48e474198d15b062a73e238de7cfd4505b82b54
  1. src/
  2. .gitattributes
  3. .gitignore
  4. .gitreview
  5. .npmignore
  6. index.ts
  7. INFO.yaml
  8. jest.config.js
  9. LICENSE.TXT
  10. package-lock.json
  11. package.json
  12. pom.xml
  13. README.md
  14. tsconfig.json
  15. tslint.json
  16. version.properties
  17. 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