ember-destroyable-polyfill
Advanced tools
ember-destroyable-polyfill - npm Package Compare versions
Comparing version 2.0.0 to 2.0.1
@@ -0,1 +1,10 @@ | ||
| ## v2.0.1 (2020-08-02) | ||
| #### :bug: Bug Fix | ||
| * [#84](https://github.com/ember-polyfills/ember-destroyable-polyfill/pull/84) Fix types file (must use declare module). ([@rwjblue](https://github.com/rwjblue)) | ||
| #### Committers: 1 | ||
| - Robert Jackson ([@rwjblue](https://github.com/rwjblue)) | ||
| ## v2.0.0 (2020-08-02) | ||
@@ -2,0 +11,0 @@ |
356
index.d.ts
@@ -1,229 +0,231 @@ | ||
| /** | ||
| This function is used to associate a destroyable object with a parent. When the parent | ||
| is destroyed, all registered children will also be destroyed. | ||
| declare module '@ember/destroyable' { | ||
| /** | ||
| This function is used to associate a destroyable object with a parent. When the parent | ||
| is destroyed, all registered children will also be destroyed. | ||
| ```js | ||
| class CustomSelect extends Component { | ||
| constructor() { | ||
| // obj is now a child of the component. When the component is destroyed, | ||
| // obj will also be destroyed, and have all of its destructors triggered. | ||
| this.obj = associateDestroyableChild(this, {}); | ||
| ```js | ||
| class CustomSelect extends Component { | ||
| constructor() { | ||
| // obj is now a child of the component. When the component is destroyed, | ||
| // obj will also be destroyed, and have all of its destructors triggered. | ||
| this.obj = associateDestroyableChild(this, {}); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ``` | ||
| Returns the associated child for convenience. | ||
| Returns the associated child for convenience. | ||
| @method associateDestroyableChild | ||
| @for @ember/destroyable | ||
| @param {Object|Function} parent the destroyable to entangle the child destroyables lifetime with | ||
| @param {Object|Function} child the destroyable to be entangled with the parents lifetime | ||
| @param {Function} destructor the destructor to run when the destroyable object is destroyed | ||
| @returns {Object|Function} the child argument | ||
| @static | ||
| @public | ||
| */ | ||
| declare function associateDestroyableChild<T extends object>(parent: object, child: T): T; | ||
| @method associateDestroyableChild | ||
| @for @ember/destroyable | ||
| @param {Object|Function} parent the destroyable to entangle the child destroyables lifetime with | ||
| @param {Object|Function} child the destroyable to be entangled with the parents lifetime | ||
| @param {Function} destructor the destructor to run when the destroyable object is destroyed | ||
| @returns {Object|Function} the child argument | ||
| @static | ||
| @public | ||
| */ | ||
| export function associateDestroyableChild<T extends object>(parent: object, child: T): T; | ||
| /** | ||
| Receives a destroyable, and returns true if the destroyable has begun destroying. Otherwise returns | ||
| false. | ||
| /** | ||
| Receives a destroyable, and returns true if the destroyable has begun destroying. Otherwise returns | ||
| false. | ||
| ```js | ||
| let obj = {}; | ||
| isDestroying(obj); // false | ||
| destroy(obj); | ||
| isDestroying(obj); // true | ||
| // ...sometime later, after scheduled destruction | ||
| isDestroyed(obj); // true | ||
| isDestroying(obj); // true | ||
| ``` | ||
| ```js | ||
| let obj = {}; | ||
| isDestroying(obj); // false | ||
| destroy(obj); | ||
| isDestroying(obj); // true | ||
| // ...sometime later, after scheduled destruction | ||
| isDestroyed(obj); // true | ||
| isDestroying(obj); // true | ||
| ``` | ||
| @method isDestroying | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the object to check | ||
| @returns {Boolean} | ||
| @static | ||
| @public | ||
| */ | ||
| declare function isDestroying(destroyable: object): boolean; | ||
| @method isDestroying | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the object to check | ||
| @returns {Boolean} | ||
| @static | ||
| @public | ||
| */ | ||
| export function isDestroying(destroyable: object): boolean; | ||
| /** | ||
| Receives a destroyable, and returns true if the destroyable has finished destroying. Otherwise | ||
| returns false. | ||
| /** | ||
| Receives a destroyable, and returns true if the destroyable has finished destroying. Otherwise | ||
| returns false. | ||
| ```js | ||
| let obj = {}; | ||
| ```js | ||
| let obj = {}; | ||
| isDestroyed(obj); // false | ||
| destroy(obj); | ||
| isDestroyed(obj); // false | ||
| destroy(obj); | ||
| // ...sometime later, after scheduled destruction | ||
| // ...sometime later, after scheduled destruction | ||
| isDestroyed(obj); // true | ||
| ``` | ||
| isDestroyed(obj); // true | ||
| ``` | ||
| @method isDestroyed | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the object to check | ||
| @returns {Boolean} | ||
| @static | ||
| @public | ||
| */ | ||
| declare function isDestroyed(destroyable: object): boolean; | ||
| @method isDestroyed | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the object to check | ||
| @returns {Boolean} | ||
| @static | ||
| @public | ||
| */ | ||
| export function isDestroyed(destroyable: object): boolean; | ||
| /** | ||
| Initiates the destruction of a destroyable object. It runs all associated destructors, and then | ||
| destroys all children recursively. | ||
| /** | ||
| Initiates the destruction of a destroyable object. It runs all associated destructors, and then | ||
| destroys all children recursively. | ||
| ```js | ||
| let obj = {}; | ||
| ```js | ||
| let obj = {}; | ||
| registerDestructor(obj, () => console.log('destroyed!')); | ||
| registerDestructor(obj, () => console.log('destroyed!')); | ||
| destroy(obj); // this will schedule the destructor to be called | ||
| destroy(obj); // this will schedule the destructor to be called | ||
| // ...some time later, during scheduled destruction | ||
| // ...some time later, during scheduled destruction | ||
| // destroyed! | ||
| ``` | ||
| // destroyed! | ||
| ``` | ||
| Destruction via `destroy()` follows these steps: | ||
| Destruction via `destroy()` follows these steps: | ||
| 1, Mark the destroyable such that `isDestroying(destroyable)` returns `true` | ||
| 2, Call `destroy()` on each of the destroyable's associated children | ||
| 3, Schedule calling the destroyable's destructors | ||
| 4, Schedule setting destroyable such that `isDestroyed(destroyable)` returns `true` | ||
| 1. Mark the destroyable such that `isDestroying(destroyable)` returns `true` | ||
| 2. Call `destroy()` on each of the destroyable's associated children | ||
| 3. Schedule calling the destroyable's destructors | ||
| 4. Schedule setting destroyable such that `isDestroyed(destroyable)` returns `true` | ||
| This results in the entire tree of destroyables being first marked as destroying, | ||
| then having all of their destructors called, and finally all being marked as isDestroyed. | ||
| There won't be any in between states where some items are marked as `isDestroying` while | ||
| destroying, while others are not. | ||
| This results in the entire tree of destroyables being first marked as destroying, | ||
| then having all of their destructors called, and finally all being marked as isDestroyed. | ||
| There won't be any in between states where some items are marked as `isDestroying` while | ||
| destroying, while others are not. | ||
| @method destroy | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the object to destroy | ||
| @static | ||
| @public | ||
| */ | ||
| declare function destroy(destroyable: object): void; | ||
| @method destroy | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the object to destroy | ||
| @static | ||
| @public | ||
| */ | ||
| export function destroy(destroyable: object): void; | ||
| /** | ||
| This function asserts that all objects which have associated destructors or associated children | ||
| have been destroyed at the time it is called. It is meant to be a low level hook that testing | ||
| frameworks can use to hook into and validate that all destroyables have in fact been destroyed. | ||
| /** | ||
| This function asserts that all objects which have associated destructors or associated children | ||
| have been destroyed at the time it is called. It is meant to be a low level hook that testing | ||
| frameworks can use to hook into and validate that all destroyables have in fact been destroyed. | ||
| This function requires that `enableDestroyableTracking` was called previously, and is only | ||
| available in non-production builds. | ||
| This function requires that `enableDestroyableTracking` was called previously, and is only | ||
| available in non-production builds. | ||
| @method assertDestroyablesDestroyed | ||
| @for @ember/destroyable | ||
| @static | ||
| @public | ||
| */ | ||
| declare function assertDestroyablesDestroyed(): void; | ||
| @method assertDestroyablesDestroyed | ||
| @for @ember/destroyable | ||
| @static | ||
| @public | ||
| */ | ||
| export function assertDestroyablesDestroyed(): void; | ||
| /** | ||
| This function instructs the destroyable system to keep track of all destroyables (their | ||
| children, destructors, etc). This enables a future usage of `assertDestroyablesDestroyed` | ||
| to be used to ensure that all destroyable tasks (registered destructors and associated children) | ||
| have completed when `assertDestroyablesDestroyed` is called. | ||
| /** | ||
| This function instructs the destroyable system to keep track of all destroyables (their | ||
| children, destructors, etc). This enables a future usage of `assertDestroyablesDestroyed` | ||
| to be used to ensure that all destroyable tasks (registered destructors and associated children) | ||
| have completed when `assertDestroyablesDestroyed` is called. | ||
| @method enableDestroyableTracking | ||
| @for @ember/destroyable | ||
| @static | ||
| @public | ||
| */ | ||
| declare function enableDestroyableTracking(): void; | ||
| @method enableDestroyableTracking | ||
| @for @ember/destroyable | ||
| @static | ||
| @public | ||
| */ | ||
| export function enableDestroyableTracking(): void; | ||
| /** | ||
| Receives a destroyable object and a destructor function, and associates the | ||
| function with it. When the destroyable is destroyed with destroy, or when its | ||
| parent is destroyed, the destructor function will be called. | ||
| /** | ||
| Receives a destroyable object and a destructor function, and associates the | ||
| function with it. When the destroyable is destroyed with destroy, or when its | ||
| parent is destroyed, the destructor function will be called. | ||
| ```js | ||
| import { registerDestructor } from '@ember/destroyable'; | ||
| ```js | ||
| import { registerDestructor } from '@ember/destroyable'; | ||
| class Modal extends Component { | ||
| @service resize; | ||
| class Modal extends Component { | ||
| @service resize; | ||
| constructor() { | ||
| this.resize.register(this, this.layout); | ||
| constructor() { | ||
| this.resize.register(this, this.layout); | ||
| registerDestructor(this, () => this.resize.unregister(this)); | ||
| registerDestructor(this, () => this.resize.unregister(this)); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ``` | ||
| Multiple destructors can be associated with a given destroyable, and they can be | ||
| associated over time, allowing libraries to dynamically add destructors as needed. | ||
| `registerDestructor` also returns the associated destructor function, for convenience. | ||
| Multiple destructors can be associated with a given destroyable, and they can be | ||
| associated over time, allowing libraries to dynamically add destructors as needed. | ||
| `registerDestructor` also returns the associated destructor function, for convenience. | ||
| The destructor function is passed a single argument, which is the destroyable itself. | ||
| This allows the function to be reused multiple times for many destroyables, rather | ||
| than creating a closure function per destroyable. | ||
| The destructor function is passed a single argument, which is the destroyable itself. | ||
| This allows the function to be reused multiple times for many destroyables, rather | ||
| than creating a closure function per destroyable. | ||
| ```js | ||
| import { registerDestructor } from '@ember/destroyable'; | ||
| ```js | ||
| import { registerDestructor } from '@ember/destroyable'; | ||
| function unregisterResize(instance) { | ||
| instance.resize.unregister(instance); | ||
| } | ||
| function unregisterResize(instance) { | ||
| instance.resize.unregister(instance); | ||
| } | ||
| class Modal extends Component { | ||
| @service resize; | ||
| class Modal extends Component { | ||
| @service resize; | ||
| constructor() { | ||
| this.resize.register(this, this.layout); | ||
| constructor() { | ||
| this.resize.register(this, this.layout); | ||
| registerDestructor(this, unregisterResize); | ||
| registerDestructor(this, unregisterResize); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ``` | ||
| @method registerDestructor | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the destroyable to register the destructor function with | ||
| @param {Function} destructor the destructor to run when the destroyable object is destroyed | ||
| @static | ||
| @public | ||
| */ | ||
| declare function registerDestructor<T extends object>( | ||
| destroyable: T, | ||
| destructor: (destroyable: T) => void | ||
| ): (destroyable: T) => void; | ||
| @method registerDestructor | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the destroyable to register the destructor function with | ||
| @param {Function} destructor the destructor to run when the destroyable object is destroyed | ||
| @static | ||
| @public | ||
| */ | ||
| export function registerDestructor<T extends object>( | ||
| destroyable: T, | ||
| destructor: (destroyable: T) => void | ||
| ): (destroyable: T) => void; | ||
| /** | ||
| Receives a destroyable and a destructor function, and de-associates the destructor | ||
| from the destroyable. | ||
| /** | ||
| Receives a destroyable and a destructor function, and de-associates the destructor | ||
| from the destroyable. | ||
| ```js | ||
| import { registerDestructor, unregisterDestructor } from '@ember/destroyable'; | ||
| ```js | ||
| import { registerDestructor, unregisterDestructor } from '@ember/destroyable'; | ||
| class Modal extends Component { | ||
| @service modals; | ||
| class Modal extends Component { | ||
| @service modals; | ||
| constructor() { | ||
| this.modals.add(this); | ||
| constructor() { | ||
| this.modals.add(this); | ||
| this.modalDestructor = registerDestructor(this, () => this.modals.remove(this)); | ||
| } | ||
| this.modalDestructor = registerDestructor(this, () => this.modals.remove(this)); | ||
| } | ||
| @action pinModal() { | ||
| unregisterDestructor(this, this.modalDestructor); | ||
| @action pinModal() { | ||
| unregisterDestructor(this, this.modalDestructor); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| ``` | ||
| @method unregisterDestructor | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the destroyable to unregister the destructor function from | ||
| @param {Function} destructor the destructor to remove from the destroyable | ||
| @static | ||
| @public | ||
| */ | ||
| declare function unregisterDestructor<T extends object>( | ||
| destroyable: T, | ||
| destructor: (destroyable: T) => void | ||
| ): void; | ||
| @method unregisterDestructor | ||
| @for @ember/destroyable | ||
| @param {Object|Function} destroyable the destroyable to unregister the destructor function from | ||
| @param {Function} destructor the destructor to remove from the destroyable | ||
| @static | ||
| @public | ||
| */ | ||
| export function unregisterDestructor<T extends object>( | ||
| destroyable: T, | ||
| destructor: (destroyable: T) => void | ||
| ): void; | ||
| } |
| { | ||
| "name": "ember-destroyable-polyfill", | ||
| "version": "2.0.0", | ||
| "version": "2.0.1", | ||
| "description": "Polyfill for RFC 580: Destroyables", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.18%
31866
- Lines of code
- increased by0.47%
426
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes