https://github.com/koopjs/koop-queue
A queuing system for Koop
https://github.com/koopjs/koop-queue
Last synced: about 1 month ago
JSON representation
A queuing system for Koop
- Host: GitHub
- URL: https://github.com/koopjs/koop-queue
- Owner: koopjs
- License: apache-2.0
- Created: 2015-12-30T22:19:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T21:52:46.000Z (over 2 years ago)
- Last Synced: 2025-02-24T23:08:05.182Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Koop-Queue
*A queuing system for Koop*
[![npm][npm-img]][npm-url]
[![travis][travis-image]][travis-url]
## Installation
### As a package
`npm install koop-queue`
### From source
```bash
git clone https://github.com/koopjs/koop-queue.git
cd koop-queue
npm install
npm install -g babel-cli
npm run compile
```
## Usage
### As a Koop Plugin
```javascript
const Koop = require('koop')
const config = require('config')
const koop = Koop(config)
const Queue = require('koop-queue')
// koop will instantiate an instance of Queue
koop.register(Queue)
```
### Standalone
```javascript
const Queue = require('koop-queue')
const connection = {
host: '127.0.0.1',
port: 6379,
prefix: 'koop-jobs'
}
const queue = new Queue()
const options = {
table: '1ef:0',
format: 'csv',
key: 'J2E4QvGLBHgX',
name: 'trees',
path: './output'
}
// returns an event emitter
const job = queue.enqueue('xport', options)
job
.on('error', e => console.log(e))
.on('start', () => console.log('Job started'))
.on('progress', progress => console.log(progress))
.on('finish', () => console.log('Job finished'))
```
## Configuration
In config/:env.json
*Note: all connection configs are optional*
```json
{
"queue": {
"connection": {
"host": "127.0.0.1",
"port": 6379,
"namespace": "koop-jobs",
"database": 0
}
}
}
```
[npm-img]: https://img.shields.io/npm/v/koop-queue.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/koop-queue
[travis-image]: https://img.shields.io/travis/koopjs/koop-queue.svg?style=flat-square
[travis-url]: https://travis-ci.org/koopjs/koop-queue