Skip to content

Update readme #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 8, 2014
Merged

Update readme #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc81830
update readme
Dec 8, 2014
0fff705
typo
Dec 8, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -61,14 +63,13 @@ POST <your_hydrater_server_url>/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). One child process per concurrency will spawn.
* `opbeat`: an object used for opbeat notifications. It must have `organizationId`, `appId` and `secretToken` keys.
Copy link
Member

@Neamar Neamar Dec 8, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we leave it blank?

Copy link
Member

@Neamar Neamar Dec 8, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, "optional". Sorry


Errors
------
Expand Down