Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-pubsub / refs/heads/master
commit1843d20085f98364577c0fab02467cd4486d54e1[log] [tgz]
authorMichaelMorris <michael.morris@est.tech>Tue Feb 21 11:04:51 2023 +0000
committerMichael Morris <michael.morris@est.tech>Tue Feb 21 11:10:44 2023 +0000
treea1ec5c2d22fa56b2c2915eb7551e076af7e199a9
parent85d693df4061096a93142a0b64ae136d76eae4bc [diff]
Update INFO.yaml

Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-4406
Change-Id: I661ecf7c935a45b08c446762abe1dcf2faf01460
1 file changed
tree: a1ec5c2d22fa56b2c2915eb7551e076af7e199a9
  1. src/
  2. .gitattributes
  3. .gitignore
  4. .gitreview
  5. .npmignore
  6. INFO.yaml
  7. jest.config.js
  8. LICENSE.TXT
  9. package-lock.json
  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