{"id":22486778,"url":"https://github.com/kessler/qool","last_synced_at":"2025-08-02T19:33:04.814Z","repository":{"id":57145428,"uuid":"62980214","full_name":"kessler/qool","owner":"kessler","description":"Qool, a leveldb backed Queue","archived":true,"fork":false,"pushed_at":"2016-08-09T19:29:44.000Z","size":52,"stargazers_count":42,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-01T00:31:58.535Z","etag":null,"topics":["database","javascript","leveldb","node-js","nodejs","queue"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kessler.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-10T03:41:40.000Z","updated_at":"2023-01-28T00:49:12.000Z","dependencies_parsed_at":"2022-09-06T05:51:45.017Z","dependency_job_id":null,"html_url":"https://github.com/kessler/qool","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kessler%2Fqool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kessler%2Fqool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kessler%2Fqool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kessler%2Fqool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kessler","download_url":"https://codeload.github.com/kessler/qool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228500200,"owners_count":17930007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","javascript","leveldb","node-js","nodejs","queue"],"created_at":"2024-12-06T17:15:21.939Z","updated_at":"2024-12-06T17:16:09.853Z","avatar_url":"https://github.com/kessler.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# qool\n\n**a leveldb backed [Queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type))**\n\n[![npm status](http://img.shields.io/npm/v/qool.svg?style=flat-square)](https://www.npmjs.org/package/qool) \n\n- durable\n- strict FIFO ordering\n- dequeus with timeouts (called lease())\n- embeddable\n\n## Example\n\n### Simple\n```javascript\nconst Qool = require('qool')\nconst level = require('level-bytewise')\n\nconst db = level('db')\nconst queue = Qool.create(db)\n\nqueue.enqueue('a')\nqueue.enqueue('b', (err) =\u003e {})\n\nqueue.dequeue()\nqueue.dequeue((err, value) =\u003e {})\n```\n##### notes\nEnqueue and Dequeue are batched under the hood, so callbacks are invoked synchronously. This means that you can only include a last callback and forgo all the others for Enqueues and Dequeues that happen in the same tick\n\n### Lease\n```javascript\nconst Qool = require('qool')\nconst level = require('level-bytewise')\n\nconst db = level('db')\nconst queue = Qool.create(db, 1000 * 10)\n\nqueue.enqueue('a')\nqueue.enqueue('b', (err) =\u003e {})\n\nqueue.lease((err, leaseKey, value) =\u003e {\n    // do something with the data\n\n    // delete the item permanently from the queue\n    queue.delete(leaseKey, (err) =\u003e {\n\n    })\n})\n\n// TBD\n// lease with a non default timeout\n//queue.leaseWithTimeout(1000 * 2, (err, leaseKey, value) =\u003e {})\n```\n\n### Peek\n```javascript\nconst Qool = require('qool')\nconst level = require('level-bytewise')\n\nconst db = level('db')\nconst queue = Qool.create(db)\n\nqueue.enqueue('a')\nqueue.enqueue('b', (err) =\u003e {})\n\nqueue.peek((err, value) =\u003e {\n    // value === 'a'\n})\n\nqueue.peekMany((err, results) =\u003e {\n    // results === [{ key: ..., value: 'a' }, { key: ..., value: 'b' }]\n})\n```\n\nSome ramblings on internal design are [here](./notes.md)\n\n## license\n\n### TODO\n- enhance tests\n- implement length property\n- should we have a version of dequeue that \"waits\" if the queue is empty\n- expiry for enqueued items\n\n[MIT](http://opensource.org/licenses/MIT) © yaniv kessler\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkessler%2Fqool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkessler%2Fqool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkessler%2Fqool/lists"}