swgoh-client-stub

Usage example:

const SwgohClientStub = require('swgoh-client-stub');
const client = new SwgohClientStub({
  url: 'http://localhost:3200', // swgoh-client service URL
  accessKey: process.env.ACCESS_KEY,
  secretKey: process.env.SECRET_KEY,
  compression: process.env.COMPRESSION,
  updateUrl: 'http://localhost:3210' // swgoh-client-version service URL
});

const init = async () => {
  const response = await client.getMetaData();

  try {
    const initialVersion = await client.updateHook((newVersion) => {
      // callback should only be invoked with new version strings
      // will not be invoked on the initial connection
    });
  } catch(error) {
    // do error handling if no version can be retrieved when registering the update hook
  }

  // turn off socket.io / polling for version updates
  client.destroyHook();
});
init();

Parameters

• url: the base URL (protocol, URI, and port) where the swgoh-client service is hosted. Defaults to http://localhost:3000
• accessKey: The "public" portion of the shared key used in HMAC request signing. Defaults to '' which disables HMAC signing of requests.
• secretKey: The "private" portion of the key used in HMAC request signing. Defaults to '' which disables HMAC signing of requests
• compression: Indicates whether the client will accept compressed responses and decompress them. Defaults to true
• updateUrl: the URL for the swgoh-client-version service. The version service polls for game data updates and notifies listeners via socket.io when there's a version update. This allows multiple services to be notified of version updates without each needing to poll for updates. If the version service is unavailable or goes down, it will fall back to polling the /metadata endpoint.
• updateInterval: time in minutes between /metadata checks. If not using the swgoh-client-version service, polling is enabled. Default is 5 minutes.
• statsUrl: the url of the swgoh-stats service, such as http://localhost:3223