Follow: CouchDB 变更和数据库更新通知工具

安装指南

要安装 Follow 模块，请在终端中运行以下命令：

npm install follow

项目使用说明

Follow 是一个用于监听 CouchDB 数据库变更的 Node.js 模块。它可以在浏览器中使用（测试版），并且可以通过 NPM 安装。Follow 的主要目标是提供一个简单易用的 API，用于在 CouchDB 数据库发生变更时通知用户。

示例

以下是一个简单的示例，展示了如何使用 Follow 模块监听 CouchDB 数据库的变更：

var follow = require('follow');
follow("https://example.iriscouch.com/boogie", function(error, change) {
  if(!error) {
    console.log("Got change number " + change.seq + ": " + change.id);
  }
});

在这个示例中，Follow 模块会监听 https://example.iriscouch.com/boogie 数据库的变更，并在每次变更时调用回调函数。

项目API使用文档

简单API: follow(options, callback)

follow 函数接受两个参数：

1. options: 一个包含配置选项的对象或字符串。
2. callback: 每次数据库发生变更时调用的回调函数。

选项参数

• db: 数据库的完整 URL（支持基本认证）。
• since: 开始监听的序列号，可以使用 "now" 从最新的变更开始。
• heartbeat: CouchDB 响应的超时时间（默认：30000 毫秒）。
• feed: 可选，但仅支持 "continuous"。
• filter: 过滤器，可以是设计文档的路径或一个返回布尔值的 JavaScript 函数。
• query_params: 可选，用于过滤函数的查询参数。

回调函数

回调函数接受两个参数：

• error: 错误对象，通常为 null。
• change: 包含变更信息的对象。

对象API

Follow 模块还提供了一个基于 EventEmitter 的 API，允许更灵活的监听和处理变更。

var follow = require('follow');

var opts = {}; // 同上
var feed = new follow.Feed(opts);

feed.db = "http://example.iriscouch.com/boogie";
feed.since = 3;
feed.heartbeat = 30 * 1000;
feed.inactivity_ms = 86400 * 1000;

feed.filter = function(doc, req) {
  if(doc.stinky || doc.ugly)
    return false;
  return true;
}

feed.on('change', function(change) {
  console.log('Doc ' + change.id + ' in change ' + change.seq + ' is neither stinky nor ugly.');
});

feed.on('error', function(er) {
  console.error('Since Follow always retries on errors, this must be serious');
  throw er;
});

feed.follow();

事件

Feed 对象是一个 EventEmitter，支持以下事件：

• start: 在任何 I/O 操作之前触发。
• confirm_request: 数据库确认请求发送时触发。
• confirm: 数据库确认时触发。
• change: 数据库发生变更时触发。
• catchup: 数据流追上确认步骤中的 update_seq 时触发。
• wait: Follow 空闲，等待下一个数据块时触发。
• timeout: Follow 未在规定时间内收到心跳时触发。
• retry: 重试计划时触发。
• stop: 数据流停止时触发。
• error: 发生错误时触发。

项目安装方式

Follow 模块可以通过 NPM 安装，安装命令如下：

npm install follow

安装完成后，你可以在 Node.js 项目中使用 require('follow') 来引入模块。