Simple ArangoChair

Lightweight change listener for ArangoDB collections.

Installation

npm install simple-arangochair

Usage

import SimpleArangoChair from "simple-arangochair";

const dbChanges = new SimpleArangoChair({
  host: process.env.ARANGODB_ENDPOINT,
  port: process.env.ARANGODB_ENDPOINT_PORT,
  database: process.env.ARANGODB_DATABASE_NAME,
  username: process.env.ARANGODB_USER,
  password: process.env.ARANGODB_PASSWORD,
});

// Subscribe to collection events
dbChanges.subscribe({
  collection: "users",
  events: ["insert/update"],
});

// Listen for changes
dbChanges.on("users", (docIn, type) => {
  try {
    const record = JSON.parse(docIn);
    console.log("users", type, docIn, record);
  } catch (e) {}
});

// Handle errors (auto-reconnect)
dbChanges.on("error", (err, httpStatus, headers, body) => {
  setTimeout(() => dbChanges.start(), 2000);
});

// Start listener
dbChanges.start();

Notes

• events supports: insert, update, delete (based on ArangoDB stream)
• docIn is a JSON string (parse before use)
• auto-reconnect recommended on error
• requires ArangoDB with streaming enabled