Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ember-lifeline/ember-lifeline
An Ember addon for managing the lifecyle of asynchronous behavior in your objects
https://github.com/ember-lifeline/ember-lifeline
ember ember-addon ember-lifeline runloop
Last synced: 22 days ago
JSON representation
An Ember addon for managing the lifecyle of asynchronous behavior in your objects
- Host: GitHub
- URL: https://github.com/ember-lifeline/ember-lifeline
- Owner: ember-lifeline
- License: mit
- Created: 2016-10-31T02:22:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T13:48:57.000Z (8 months ago)
- Last Synced: 2024-10-01T08:42:41.190Z (about 1 month ago)
- Topics: ember, ember-addon, ember-lifeline, runloop
- Language: JavaScript
- Homepage: https://github.com/ember-lifeline/ember-lifeline/wiki
- Size: 15.3 MB
- Stars: 239
- Watchers: 9
- Forks: 54
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-lifeline - An ember addon for managing the life cycle of asynchronous behavior in your objects. (Packages / Job queues)
README
# ember-lifeline
[](https://emberobserver.com/addons/ember-lifeline)
[](https://badge.fury.io/js/ember-lifeline)
[](https://www.npmjs.com/package/ember-lifeline)
[](#badge)
Ember applications have long life-cycles. A user may navigate to several pages
and use many different features before they leave the application. This
makes JavaScript and Ember development unlike Rails development, where the
lifecycle of a request is short and the environment disposed of after
each request. It makes Ember development much more like iOS or video game
development than traditional server-side web development.
This addon introduces several functional utility methods to help manage async, object
lifecycles, and the Ember runloop. These tools should provide a simple developer
experience that allows engineers to focus on the business domain, and think less
about the weird parts of working in a long-lived app.
The [documentation wiki](https://github.com/ember-lifeline/ember-lifeline/wiki) contains more examples and API information.
## Compatibility
* Ember.js v3.28 or above
* Ember CLI v3.28 or above
* Node.js v16 or above
## Installation
ember install ember-lifeline
## Usage
Ember Lifeline supports a functional API that enables entanglement - _the association of async behavior to object instances_. This allows you to write async code in your classes that can be automatically cleaned up for you when the object is destroyed.
Ember's runloop functions, like the example below, don't ensure that an object's async is cleaned up.
```js
import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { run } from '@ember/runloop';
export default class Example extends Component {
@tracked date;
constructor() {
super(...arguments);
run.later(() => {
this.date = new Date();
}, 500);
}
}
```
Using ember-lifeline's equivalent, in this case `runTask`, can help ensure that any active async is cleaned up once the object is destroyed.
```js
import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { runTask } from 'ember-lifeline';
export default class Example extends Component {
@tracked date;
constructor() {
super(...arguments);
runTask(
this,
() => {
this.date = new Date();
},
500
);
}
}
```
For more information and examples, please visit the [documentation wiki](https://github.com/ember-lifeline/ember-lifeline/wiki).
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## Credit
This addon was developed internally at Twitch, written originally by [@mixonic](https://github.com/mixonic) and [@rwjblue](https://github.com/rwjblue). It's since been further developed and maintained by [scalvert](https://github.com/scalvert).
The name `ember-lifeline` was suggested by [@nathanhammod](https://github.com/nathanhammond).