Skip to content
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.

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

Sanitized options #504

Merged
merged 14 commits into from Apr 23, 2017
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -79,9 +79,9 @@ Quick Guide
var Queue = require('bull');

var videoQueue = Queue('video transcoding', {redis: {port: 6379, host: '127.0.0.1'}});
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be clearer to use the redis string version here, eg redis://127.0.0.1:6379, since the documentation lists the redisConnectionString as the second option (albeit optional - but some people might not notice that)

var audioQueue = Queue('audio transcoding');
var audioQueue = Queue('audio transcoding', 'redis://127.0.0.1:6379');
var imageQueue = Queue('image transcoding');
var pdfQueue = Queue('pdf transcoding');
var pdfQueue = new Queue('pdf transcoding');
Copy link
Contributor

Choose a reason for hiding this comment

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

for the examples above too, for consistency.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok. My idea was to show different ways to instantiate in the examples. I could clarify with a comment instead. I like to be able to instantiate without new, but maybe this is not a best practice anymore.


videoQueue.process(function(job, done){

Expand Down