Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 2.78 KB

README.md

File metadata and controls

82 lines (61 loc) · 2.78 KB

ember-concurrency

Build Status NPM Ember Observer Score Ember Version

Improved concurrency primitives for Ember.js. Documentation can be found here.

Installation

ember-concurrency is an ember-cli addon. You can install it via:

ember install ember-concurrency

Configure Babel Transform

Ember Concurrency requires the use of a Babel Transform to convert tasks in the "async-arrow" notation (e.g. fooTask = task(async () => { /*...*/ }) into generator functions. Since Ember Concurrency 4.0.0+ is an Embroider V2 Addon, this Babel transform needs to be configured on the consuming application or addon.

// in app ember-cli-build.js

const app = new EmberApp(defaults, {
  // ...
  babel: {
    plugins: [
      // ... any other plugins
      require.resolve("ember-concurrency/async-arrow-task-transform"),

      // NOTE: put any code coverage plugins last, after the transform.
    ],
  }
});

// in V1 addon index.js

// ...
options: {
  babel: {
    plugins: [
      require.resolve('ember-concurrency/async-arrow-task-transform'),
    ],
  },
},

// in V2 addon babel.config.json
{
  "plugins": [
    [
      // ... any other plugins
    "ember-concurrency/async-arrow-task-transform"
  ]
}

See the test application for an example.

Documentation

The ember-concurrency documentation site is an ember-cli app with interactive examples powered by ember-concurrency. It runs from ember-concurrency's test app.

Problems?

Contributing

See the Contributing guide for details.