Skip to content

Commit

Permalink
docs(README): add @destructor
Browse files Browse the repository at this point in the history
  • Loading branch information
buschtoens committed Aug 6, 2020
1 parent bfcce9b commit 3865d2c
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ ember install ember-lifeline-decorators ember-lifeline
| **[`@schedule`](#schedule)** | [`scheduleTask`][scheduletask] | Schedule this method on a run loop queue |
| **[`@debounce`](#debounce)** | [`debounceTask`][debouncetask] | Debounce this method |
| **[`@throttle`](#throttle)** | [`throttleTask`][throttletask] | Throttle this method |
| **[`@disposable`](#disposable)** | [`registerDisposable`][registerdisposable] | Automatically execute this method during `willDestroy` |
| **[`@destructor`](#destructor)** | [`registerDisposable`][registerdisposable] | Automatically execute this method during `willDestroy` |
| **[`@eventListener`](#eventListener)** | [`addEventListener`][addeventlistener] | Execute this method when a DOM event is fired |

[runtask]: https://github.com/ember-lifeline/ember-lifeline#runtask
Expand Down Expand Up @@ -157,6 +157,36 @@ export default class ExampleComponent extends Component {
}
```

#### `@destructor`

[`registerDisposable`][registerdisposable] / [`import { registerDestructor } from '@ember/destroyable';`](https://emberjs.github.io/rfcs/0580-destroyables.html#registerdestructor)

Calls this method during destruction of the object.

```js
import { action } from '@ember/object';
import Component from '@glimemr/component';
import { destructor } from 'ember-lifeline-decorators';

export default class ExampleComponent extends Component {
constructor(owner, args) {
super(owner, args);

window.addEventListener('resize', this.onResize);
}

@destructor
unregister() {
window.removeEventListener('resize', this.onResize);
}

@action
onResize(event) {
// ...
}
}
```

#### `@eventListener`

- **`target`**:
Expand Down

0 comments on commit 3865d2c

Please sign in to comment.