From dc81830af0fc95f7451c868215a7351c5ee0d896 Mon Sep 17 00:00:00 2001 From: Amoki Date: Mon, 8 Dec 2014 14:56:08 +0100 Subject: [PATCH 1/2] update readme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3bc7b25..fc179aa 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,9 @@ And then: var anyfetchHydrater = require('anyfetch-hydrater'); var config = { - 'hydrater_function': 'absolute/path/to/my/function.js' + 'hydrater_function': 'absolute/path/to/my/function.js', + 'appName': 'Name of your application that will be used in the redis queue', + 'redisUrl': 'Url of the redis server. If it is not set, it will use localhost on the default port' }; var hydrationServer = anyfetchHydrater.createServer(config); @@ -61,14 +63,13 @@ POST /hydrate } ``` -> In some cases, you may want to bypass the lib and send the result yourself. The property `cb.callbackUrl` tells you where to send the data back to the client. After having sent the data, call `cb()` *without any error or document*. This will finalize hydration, clean the file and start the next task. +> In some cases, you may want to bypass the lib and send the result yourself. The property `cb.callbackUrl` tells you where to send the data back to the client. After having sent the data, call `cb(null, null)` *without any error or document*. This will finalize hydration, clean the file and start the next task. ### Optional parameters `createServer()` takes an object hash for argument. `hydrater_function` is mandatory, optional values includes: -* `concurrency`: max number of simultaneous calls to your hydrater function (default: 1) -* `logger`: function to use for logging. It will get called with strings when a task is started or ended, default to `console.log`. -* `errLogger`: function to use for logging errors, default to `console.warn`. +* `concurrency`: max number of simultaneous calls to your hydrater function (default: 1). +* `opbeat`: an object usef for opbeat notifications. It must have `organizationId`, `appId`, `secretToken` keys. Errors ------ From 0fff7058cd8a19e58f8f1a5bc34e489955881950 Mon Sep 17 00:00:00 2001 From: Amoki Date: Mon, 8 Dec 2014 14:58:02 +0100 Subject: [PATCH 2/2] typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc179aa..4942720 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,8 @@ POST /hydrate ### Optional parameters `createServer()` takes an object hash for argument. `hydrater_function` is mandatory, optional values includes: -* `concurrency`: max number of simultaneous calls to your hydrater function (default: 1). -* `opbeat`: an object usef for opbeat notifications. It must have `organizationId`, `appId`, `secretToken` keys. +* `concurrency`: max number of simultaneous calls to your hydrater function (default: 1). One child process per concurrency will spawn. +* `opbeat`: an object used for opbeat notifications. It must have `organizationId`, `appId` and `secretToken` keys. Errors ------