Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / sdc-pubsub / refs/heads/guilin
commitdfe9a52f707983854d7c9e76cc13ce78704b963b[log] [tgz]
authorChrisC <christophe.closset@intl.att.com>Tue Sep 01 09:47:18 2020 +0200
committerChrisC <christophe.closset@intl.att.com>Tue Sep 01 09:47:18 2020 +0200
tree9990c46249cf23712f46a6acc509752e6c09d7fa
parenta148c94bfc2d7fc5f8ac2f62b617dca27672b2e0 [diff]
Update INFO.yaml

Update PTL and move lifecycle to Mature as approved by TSC

Issue-ID: SDC-3243
Signed-off-by: ChrisC <christophe.closset@intl.att.com>
Change-Id: I6349e5be6440149b7eb21f5d09f01f92bc873b45
1 file changed
tree: 9990c46249cf23712f46a6acc509752e6c09d7fa
  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