Skip to content

Commit ee8900d

Browse files
author
Eugene Leonovich
committed
Tweak README.md
1 parent d1d16ca commit ee8900d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ $queue->put(['foo' => ['bar' => ['baz' => null]]]);
7878

7979
### Tasks
8080

81-
Almost every method of the [Queue API](src/Queue.php) (except for `kick()` and `statistics()`) returns back
82-
a lightweight [Task](src/Task.php) object containing the following getters:
81+
Almost every method of the [Queue API](src/Queue.php) (except for `kick()` and `statistics()`)
82+
returns back a [Task](src/Task.php) object containing the following getters:
8383

8484
```php
85-
Task::getId() // The task id
86-
Task::getState() // The task state (States::READY, States::TAKEN, States::DONE, States::BURY or States::DELAYED)
87-
Task::getData() // The task payload
85+
Task::getId()
86+
Task::getState() // States::READY, States::TAKEN, States::DONE, States::BURY or States::DELAYED
87+
Task::getData()
8888
```
8989

9090
And some sugar methods:
@@ -100,10 +100,10 @@ Task::isDelayed()
100100

101101
#### Producer API
102102

103-
As you've already seen, to insert a task into a queue you need to call `put()` method, which accepts two arguments:
104-
the data you want to process and optional array of task options, which this particular queue supports.
105-
For example, `fifottl` queue (which we defined earlier in our Lua config file), supports `delay`,
106-
`ttl`, `ttr`, `pri` and `temporary` options:
103+
As you've already seen, to insert a task into a queue you need to call `put()` method, which accepts
104+
two arguments: the data you want to process and optional array of task options, which this particular
105+
queue supports. For example, `fifottl` queue (which we defined earlier in our Lua config file),
106+
supports `delay`, `ttl`, `ttr`, `pri` and `temporary` options:
107107

108108
```php
109109
$queue->put('foo', ['delay' => 30]);
@@ -205,7 +205,7 @@ The result of this call might look like this:
205205
]
206206
```
207207

208-
In addition, you can specify a key (or keys) to select only a subset of the resulting array:
208+
In addition, you can specify a key (or keys) to return only a subset of the array:
209209

210210
```php
211211
$calls = $queue->statistics('calls');

0 commit comments

Comments
 (0)