steveo

Steveo - Kafka Task Framework for Node.js

Steveo is a task management library for Kafka

On a highlevel, it works as below, Steveo has 3 main factory components

          +-----------+                  +-----------+
          |           |                  |           |
          |   TASK    |                  | REGISTRY  |
          |           |                  |           |
          |           |                  |           |
          +-----------+                  +-----------+

                          +-----------+
                          |           |
                          |   RUNNER  |
              SEND  <-----|           |<----- RECEIVE
                          |           |
                          +-----------+

Task

Holds the information about the type of task. It has below methods,

• publish
• subscribe
• events

Registry

Responsible for keeping the inventory of tasks. Whenever a new task is created, an entry will be added in the registry

Runner

Responsible for consuming messages,

• process method initialize group consumers and start to consume the messages. It will then call the subscribe callback set on the task

Example

(async () => {
  const steveo = new Steveo({
    kafkaConnection: process.env.KAFKA_CONNECTION,
    clientId: '1234-123',
  });

  const example = steveo.task('example-task', (hello) => {
  console.log(`hello ${hello}`);
  });

  await example.publish('tommo');
  await example.publish('bazza');

  await steveo.runner().process();
})();

For more details, see example