Web Socket Driver for PhotonIQ EDS

JavaScript/TypeScript Driver for the PhotonIQ Event Delivery Service (EDS). Runs under Web Socket connection.

Create a bundle

Development

npm run build

Release

npm run release

Example

let connection = PhotoniqEdsWs.connect({
    host: "nbapoc.photoniq.macrometa.io",
    customerId: "<your_customer_id>",
    apiKey: "<your_api_key>",
    fabric: "dev_courtside",
    }, function(event) {
        if (event.type === "open") {
            console.log('EDS connection established: ', event);
        } else if (event.type === "connection-id") {
            console.log("EDS assigned connection's ID: " + event.data);
        } else if (event.type === "server-global-error") {
            console.log(`EDS replied with an Error: `, event);
        }else if (event.type === "server-query-error") {
            console.log(`EDS replied with an Error for query '${event.query}': `, event);
        } else if (event.type === "client-global-error") {
            console.log(`Client global error: `, event);
        } else if (event.type === "client-query-error") {
            console.log(`Client error for query '${event.query}': `, event);
        } else if (event.type === "close") {
            console.log('EDS connection closed: ', event);
        }
    });
    
    let qs = connection.querySet();
     
    // default usage
    qs.retrieve("SELECT linescore FROM game_live WHERE _key='0012307019'", (event) => {
        console.log(`Linescore event: `, event);
    })
    
    // use as batch
    qs.batch()
    .retrieveAndSubscribe("SELECT clock FROM game_live WHERE _key='0012307019'", (event) => {
        console.log(`Clock event: `, event);
    })
    .retrieveAndSubscribe("SELECT htm FROM game_live WHERE _key='0012307019'", (event) => {
        console.log(`Htm event: `, event);
    })       
    .assemble(); 

Use as a module

1. Run the next command to create js files and declarations

npx tsc

2. Link the module in another project by the next command:

npm link ../photoniq-eds-ws

3. Add dependency in the project:

• Vue Example:

<script>
import { connect } from 'photoniq-eds-ws';

export default {
  name: 'App',
  mounted() {
    this.initializeWebSocket();
  },
  methods: {
    initializeWebSocket() {
      try {

        let connection = connect({
          host: "<HOST",
          customerId: "<CUSTOMER-ID>",
          apiKey: "<API-KEY>",
          fabric: "<FABRIC>",
        }, function(event) {
          if (event.type === "open") {
              console.log('EDS connection established: ', event);
          } else if (event.type === "connection-id") {
              console.log("EDS assigned connection's ID: " + event.data);
          } else if (event.type === "server-global-error") {
              console.log(`EDS replied with an Error: `, event);
          }else if (event.type === "server-query-error") {
              console.log(`EDS replied with an Error for query '${event}': `, event);
          } else if (event.type === "client-global-error") {
              console.log(`Client global error: `, event);
          } else if (event.type === "client-query-error") {
              console.log(`Client error for query '${event}': `, event);
          } else if (event.type === "close") {
              console.log('EDS connection closed: ', event);
          }
        });
        let qs = connection.querySet();

        // default usage
        qs.retrieve("SELECT linescore FROM game_live WHERE _key='0012307019'", (event) => {
            console.log(`Linescore event: `, event);
        })

      } catch (error) {
        console.error('Error initializing WebSocket:', error);
      }
    }
  }
}
</script>

Docs

Generated in /docs folder

Build docs

typedoc