feat(client): Event listeners for both operation modes

[enisdenjo]

Closes #77

Distinct connections mode

Use the on option during client setup for all events. Use the on argument for each subscription (in subscribe and iterate) for focused events.

const client = createClient({
  singleConnection: false,
  on: {
    connecting(reconnecting) {
      if (reconnecting) {
        // reconnection pending
        // ⚠️ event will be repeated for each subscription
      }
    },
    connected(reconnected) {
      if (reconnected) {
        // successful reconnection
        // ⚠️ event will be repeated for each subscription
      }
    },
  },
});

client.subscribe(request, sink, {
  connecting(reconnecting) {
    if (reconnecting) {
      // reconnection pending for this specific subscription
    }
  },
  connected(reconnected) {
    if (reconnected) {
      // successful reconnection for this specific subscription
    }
  },
});

// or

const iterable = client.iterate(request, {
  connecting(reconnecting) {
    if (reconnecting) {
      // reconnection pending for this specific subscription
    }
  },
  connected(reconnected) {
    if (reconnected) {
      // successful reconnection for this specific subscription
    }
  },
});

Single connection mode

Use the on option during client setup.

createClient({
  singleConnection: true,
  on: {
    connecting(reconnecting) {
      if (reconnecting) {
        // reconnection pending
      }
    },
    connected(reconnected) {
      if (reconnected) {
        // successful reconnection
      }
    },
  },
});

client.subscribe(request, sink, {
  connecting() {
    // ⚠️ will NOT be called in "single connection mode"
  },
  connected() {
    // ⚠️ will NOT be called in "single connection mode"
  },
});

// or

const interable = client.iterate(request, {
  connecting() {
    // ⚠️ will NOT be called in "single connection mode"
  },
  connected() {
    // ⚠️ will NOT be called in "single connection mode"
  },
});

[enisdenjo]

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀