Skip to content

fixing del docs #60

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

Open
arschles wants to merge 2 commits into
base: v3
Choose a base branch
from
Open

fixing del docs #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
806d096
add documentation on batch deletes function
Stephenitis Jul 20, 2015
85ee3fa
fixing del docs
arschles Oct 30, 2015
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
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ queue.post(messages, function(error, body) {});
queue.post("hello IronMQ!", function(error, body) {});
// with options
queue.post({body: "hello IronMQ", delay: 30}, function(error, body) {});
// or multiple messages
// or batch post multiple messages
queue.post(["hello", "IronMQ"], function(error, body) {});
// messages with options
queue.post(
Expand Down Expand Up @@ -186,8 +186,16 @@ Default is 0 seconds. Maximum is 604,800 seconds (7 days).
### Delete a Message from a Queue

```javascript
queue.del(message_id, function(error, body) {});
queue.del(message_id, {}, function(error, body) {});
Copy link
Contributor

@alex-litvak alex-litvak Nov 3, 2015

Choose a reason for hiding this comment

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

I think it is better to create the 'options' variable and mention that it can contain reservation_id and subscriber_name if needed (will be clearer):
var options = {};
queue.del(message_id, options, function(error, body) {});

```
to batch delete multiple messages from a queue pass multiple message ids in an array to the del_multiple function

```javascript
queue.del_multiple([message.id, message.id], function(error, body) {});
// OR
queue.del_multiple(["abdc1234", "abdc12345"], function(error, body) {});
```


Be sure to delete a message from the queue when you're done with it.

Expand All @@ -211,8 +219,8 @@ queue.del_queue(function(error, body) {});

## Push Queues

IronMQ push queues allow you to setup a queue that will push to an endpoint, rather than having to poll the endpoint.
[Here's the announcement for an overview](http://blog.iron.io/2013/01/ironmq-push-queues-reliable-message.html).
IronMQ push queues allow you to setup a queue that will push to an endpoint, rather than having to poll the endpoint.
[Here's the announcement for an overview](http://blog.iron.io/2013/01/ironmq-push-queues-reliable-message.html).

### Update a Message Queue

Expand Down