Skip to content

Commit 0221f8d

Browse files
committed
documentation: add a description of the "touch" driver API method
1 parent 8c1ecab commit 0221f8d

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,8 @@ Returns the original task with a state changed to 'done'
646646
* `tube:bury(task_id)` - buries a task
647647
* `tube:kick(count)` - digs out `count` tasks
648648
* `tube:peek(task_id)` - return the task state by ID
649+
* `tube:touch(task_id, delta)` - increases `ttr` and `ttl` of the task by delta
650+
seconds. If queue does not support `ttr`, error will be thrown. Returns the task
649651
* `tube:tasks_by_state(task_state)` - return the iterator to tasks in a certain state
650652
* `tube:truncate()` - delete all tasks from the tube. Note that `tube:truncate`
651653
must be called only by the user who created this tube (has space ownership) OR

0 commit comments

Comments
 (0)