https://github.com/ember-polyfills/ember-destroyable-polyfill

Polyfill for RFC 580: Destroyables
https://github.com/ember-polyfills/ember-destroyable-polyfill

ember ember-addon emberjs lifecycle lifecycle-management polyfill

Last synced: 3 months ago
JSON representation

Polyfill for RFC 580: Destroyables

• Host: GitHub
• URL: https://github.com/ember-polyfills/ember-destroyable-polyfill
• Owner: ember-polyfills
• License: mit
• Created: 2020-04-12T13:03:42.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T04:10:08.000Z (about 2 years ago)
• Last Synced: 2024-10-31T11:41:33.022Z (3 months ago)
• Topics: ember, ember-addon, emberjs, lifecycle, lifecycle-management, polyfill
• Language: JavaScript
• Size: 2.36 MB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ember-destroyable-polyfill

[![CI](https://github.com/ember-polyfills/ember-destroyable-polyfill/workflows/CI/badge.svg)](https://github.com/ember-polyfills/ember-destroyable-polyfill/actions)

[![npm version](https://badge.fury.io/js/ember-destroyable-polyfill.svg)](http://badge.fury.io/js/ember-destroyable-polyfill)

[![Download Total](https://img.shields.io/npm/dt/ember-destroyable-polyfill.svg)](http://badge.fury.io/js/ember-destroyable-polyfill)

[![Ember Observer Score](https://emberobserver.com/badges/ember-destroyable-polyfill.svg)](https://emberobserver.com/addons/ember-destroyable-polyfill)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)  

[![Dependabot enabled](https://img.shields.io/badge/dependabot-enabled-blue.svg?logo=dependabot)](https://dependabot.com/)

[![dependencies Status](https://david-dm.org/ember-polyfills/ember-destroyable-polyfill/status.svg)](https://david-dm.org/ember-polyfills/ember-destroyable-polyfill)

[![devDependencies Status](https://david-dm.org/ember-polyfills/ember-destroyable-polyfill/dev-status.svg)](https://david-dm.org/ember-polyfills/ember-destroyable-polyfill?type=dev)

Polyfill for [RFC 580 "Destroyables"][rfc-580].

[rfc-580]: https://github.com/emberjs/rfcs/pull/580

## Installation

```bash

ember install ember-destroyable-polyfill

```

For addons, pass the `-S` flag.

## Compatibility

* Ember.js v3.4 or above; completely inert for v3.22.0-alpha.1 and above

* `ember-cli-babel` v7.22.1 or above

* Ember CLI v2.13 or above

* Node.js v10 or above

## Summary

Adds an API for registering destroyables and destructors with Ember's built in

destruction hierarchy.

```js

import { registerDestructor } from '@ember/destroyable';

class MyComponent extends Component {

  constructor() {

    let timeoutId = setTimeout(() => console.log('hello'), 1000);

    registerDestructor(this, () => clearTimeout(timeoutId));

  }

}

```

The API will also enable users to create and manage their own destroyables, and

associate them with a parent destroyable.

```js

import {

  associateDestroyableChild,

  registerDestructor

} from '@ember/destroyable';

class TimeoutManager {

  constructor(parent, fn, timeout = 1000) {

    let timeoutId = setTimeout(fn, timeout);

    associateDestroyableChild(parent, this);

    registerDestructor(this, () => clearTimeout(timeoutId));

  }

}

class MyComponent extends Component {

  manager = new TimeoutManager(this, () => console.log('hello'));

}

```

For detailed usage instructions, refer to the

[RFC 580 "Destroyables"][rfc-580].

## TypeScript Usage

TypeScript's normal type resolution for an import from `@ember/destroyable`

will **not** find this the types provided by this package (since TypeScript

would attempt to resolve it as `node_modules/@ember/destroyable` or under

the Definitely Typed location for `@ember/destroyable`). Once the

`@ember/destroyable` API is a documented part of Ember's API, the

Definitely Typed folks will gladly accept adding that API, but in the

meantime users will need to modify their `tsconfig.json` to tell TypeScript

where these types are.

Add the following to your `tsconfig.json`:

```js

{

  // ...snip...

  "paths": {

    // ...snip...

    "@ember/destroyable": ["node_modules/ember-destroyable-polyfill"],

  }

}

```