Naive Puppets Marching

    @onap-project/sdc-pubsub
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.30 • Public • Published

    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

    Install

    npm i @onap-project/sdc-pubsub

    DownloadsWeekly Downloads

    3

    Version

    1.0.30

    License

    Apache-2.0

    Unpacked Size

    60.3 kB

    Total Files

    17

    Last publish

    Collaborators

    • onap-sdc
    • onapci