Skip to content
Permalink
Browse files

Docs: update changelog and readme (#851)

* Remove Kue from comparison table since it's deprecated: Automattic/kue#1231
* Update History.md
* Remove non-existing callback from README docs
  • Loading branch information...
simison committed Sep 9, 2019
1 parent 967e653 commit bedec9503c0a5ffc8752d36c4e6fda6957525ae2
Showing with 29 additions and 21 deletions.
  1. +11 −3 History.md
  2. +18 −18 README.md
@@ -2,14 +2,22 @@ Next
====

* https://github.com/agenda/agenda/pulls
* Update dependencies
* Updates to documentation (kudos @dandv!)

2.1.0 / 2019-09-09
==================
* Support async functions in job processing ([#653](https://github.com/agenda/agenda/pull/653)) (thanks @princjef!)
* Allow sorting and limiting jobs when searching ((#665)[https://github.com/agenda/agenda/pull/665]) (thank you @edwin-jones)
* Update MongoClient connection settings with `useNewUrlParser: true` to remove the deprecation warning. ([#806](https://github.com/agenda/agenda/pull/806)) (thanks @dpawson905!)
* Allow valid date strings when scheduling ([#808](https://github.com/agenda/agenda/pull/808)) (Thanks @wingsbob!)
* Update dependencies ([#820](https://github.com/agenda/agenda/pull/820))
* Update documentation (kudos @dandv, @pedruino and many others!)
* Fix linting errors ([#847](https://github.com/agenda/agenda/pull/847)) (thanks @dmbarreiro!)

2.0.2 / 2018-09-15
==================
* Fixes a MongoDB connection string issue with Atlas ([#674](
https://github.com/agenda/agenda/pull/674)

2.0.1 / 2018-08-30
==================
* Fix a bug where `job.touch()` wasn't promise based, as it should've been ([#667](https://github.com/agenda/agenda/pull/667)
@@ -33,21 +33,21 @@ better suits your needs.

Agenda is great if you need something that is simple and backed by MongoDB.

| Feature | Bull | Kue | Bee | Agenda |
| :------------- |:-------------:|:-----:|:---:|:------:|
| Backend | redis | redis |redis| mongo |
| Priorities | ✓ | ✓ | | ✓ |
| Concurrency | ✓ | ✓ | ✓ | ✓ |
| Delayed jobs | ✓ | ✓ | | ✓ |
| Global events | ✓ | ✓ | | |
| Rate Limiter | ✓ | | | |
| Pause/Resume | ✓ | ✓ | | |
| Sandboxed worker| ✓ | | | |
| Repeatable jobs | ✓ | | | ✓ |
| Atomic ops | ✓ | | ✓ | |
| Persistence | ✓ | ✓ | ✓ | ✓ |
| UI | ✓ | ✓ | | ✓ |
| REST API | | | | ✓ |
| Feature | Bull | Bee | Agenda |
| :------------- |:-------------:|:---:|:------:|
| Backend | redis |redis| mongo |
| Priorities | ✓ | | ✓ |
| Concurrency | ✓ | ✓ | ✓ |
| Delayed jobs | ✓ | | ✓ |
| Global events | ✓ | | |
| Rate Limiter | ✓ | | |
| Pause/Resume | ✓ | | |
| Sandboxed worker| ✓ | | |
| Repeatable jobs | ✓ | | ✓ |
| Atomic ops | ✓ | ✓ | |
| Persistence | ✓ | ✓ | ✓ |
| UI | ✓ | | ✓ |
| REST API | | | ✓ |
| Optimized for | Jobs / Messages | Jobs | Messages | Jobs |

_Kudos for making the comparison chart goes to [Bull](https://www.npmjs.com/package/bull#feature-comparison) maintainers._
@@ -400,7 +400,7 @@ agenda.define('say hello', job => {

## Creating Jobs

### every(interval, name, [data], [options], [cb])
### every(interval, name, [data], [options])

Runs job `name` at the given `interval`. Optionally, data and options can be passed in.
Every creates a job of type `single`, which means that it will only create one
@@ -441,7 +441,7 @@ agenda.every('15 minutes', ['printAnalyticsReport', 'sendNotifications', 'update

In this case, `every` returns array of `jobs`.

### schedule(when, name, [data], [cb])
### schedule(when, name, [data])

Schedules a job to run `name` once at a given time. `when` can be a `Date` or a
`String` such as `tomorrow at 5pm`.
@@ -466,7 +466,7 @@ agenda.schedule('tomorrow at noon', ['printAnalyticsReport', 'sendNotifications'

In this case, `schedule` returns array of `jobs`.

### now(name, [data], [cb])
### now(name, [data])

Schedules a job to run `name` once immediately.

0 comments on commit bedec95

Please sign in to comment.
You can’t perform that action at this time.