{"id":13780248,"url":"https://github.com/compwright/feathers-bee-queue","last_synced_at":"2025-04-14T00:26:07.788Z","repository":{"id":34981331,"uuid":"193955654","full_name":"compwright/feathers-bee-queue","owner":"compwright","description":"A Feathers service adapter for Bee-Queue jobs","archived":false,"fork":false,"pushed_at":"2023-03-04T03:59:41.000Z","size":521,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T14:47:38.642Z","etag":null,"topics":["bee-queue","feathers-service-adapter","feathersjs","queue"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/feathers-bee-queue","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/compwright.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"compwright"}},"created_at":"2019-06-26T18:12:13.000Z","updated_at":"2024-01-13T19:16:51.000Z","dependencies_parsed_at":"2024-01-17T00:55:07.258Z","dependency_job_id":"c97845a8-0cd8-4cc8-9685-d1e59f6a97ca","html_url":"https://github.com/compwright/feathers-bee-queue","commit_stats":{"total_commits":38,"total_committers":2,"mean_commits":19.0,"dds":"0.13157894736842102","last_synced_commit":"945c97c628ebe721070353e0c299e08d33ea9d8a"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compwright%2Ffeathers-bee-queue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compwright%2Ffeathers-bee-queue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compwright%2Ffeathers-bee-queue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compwright%2Ffeathers-bee-queue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compwright","download_url":"https://codeload.github.com/compwright/feathers-bee-queue/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248800112,"owners_count":21163404,"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":["bee-queue","feathers-service-adapter","feathersjs","queue"],"created_at":"2024-08-03T18:01:13.752Z","updated_at":"2025-04-14T00:26:07.766Z","avatar_url":"https://github.com/compwright.png","language":"JavaScript","funding_links":["https://github.com/sponsors/compwright"],"categories":["Plugins"],"sub_categories":["Database"],"readme":"# feathers-bee-queue\n\n[![Build Status](https://travis-ci.org/compwright/feathers-bee-queue.png?branch=master)](https://travis-ci.org/compwright/feathers-bee-queue)\n[![Code Climate](https://codeclimate.com/github/compwright/feathers-bee-queue/badges/gpa.svg)](https://codeclimate.com/github/compwright/feathers-bee-queue)\n[![Test Coverage](https://codeclimate.com/github/compwright/feathers-bee-queue/badges/coverage.svg)](https://codeclimate.com/github/compwright/feathers-bee-queue/coverage)\n[![Dependency Status](https://img.shields.io/david/compwright/feathers-bee-queue.svg?style=flat-square)](https://david-dm.org/compwright/feathers-bee-queue)\n[![Download Status](https://img.shields.io/npm/dm/feathers-bee-queue.svg?style=flat-square)](https://www.npmjs.com/package/feathers-bee-queue)\n[![Sponsor on GitHub](https://img.shields.io/static/v1?label=Sponsor\u0026message=❤\u0026logo=GitHub\u0026link=https://github.com/sponsors/compwright)](https://github.com/sponsors/compwright)\n\nA [Feathers](https://feathersjs.com) service adapter for [Bee-Queue](https://www.npmjs.com/package/bee-queue) jobs.\n\n## Installation\n\n```\nnpm install --save feathers-bee-queue bee-queue\n```\n\n## Documentation\n\n### `service([options])`\n\nReturns a new service instance initialized with the given options.\n\n\u003e __Important:__ `feathers-bee-queue` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).\n\n```js\nconst queueService = require('feathers-bee-queue');\napp.use('/jobs', queueService({ queue, events, paginate, multi }));\n```\n\n__Options:__\n\n- `queue` - A Bee-Queue queue instance\n- `events` (*optional*) - A list of [custom service events](https://docs.feathersjs.com/api/events.html#custom-events) sent by this service. Must be one or more of the following:\n  - `succeeded`\n  - `retrying`\n  - `failed`\n  - `progress`\n- `paginate` (*optional*) - A [pagination object](https://docs.feathersjs.com/api/databases/common.html#pagination) containing a `default` and `max` page size\n- `multi` (*optional*) - Allow `create` with arrays and `remove` with `id` `null` to change multiple items. Can be `true` for all methods or an array of allowed methods (e.g. `[ 'remove', 'create' ]`)\n\n\n## Complete Example\n\nHere's an example of a Feathers server that uses `feathers-bee-queue`. \n\n```js\nconst feathers = require('@feathersjs/feathers');\nconst queueService = require('feathers-bee-queue');\nconst Queue = require('bee-queue');\n\n// Initialize the application\nconst app = feathers();\n\n// Initialize the plugin\napp.use('/my-queue', queueService({\n  queue: new Queue('my-queue')\n}));\n```\n\n## License\n\nCopyright (c) 2018\n\nLicensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompwright%2Ffeathers-bee-queue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompwright%2Ffeathers-bee-queue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompwright%2Ffeathers-bee-queue/lists"}