Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-05-25 14:23:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(scope): add $destroy event docs

Browse source
This commit is contained in:
Igor Minar 2012-03-16 15:32:03 -07:00
parent 53b6f522a5
commit 78a6291666
1 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/service/scope.js
View file

@ -437,6 +437,17 @@ function $RootScopeProvider(){
this.$root.$$phase = null; this.$root.$$phase = null;
}, },
/**
* @ngdoc event
* @name angular.module.$rootScope.Scope#$destroy
* @eventOf angular.module.ng.$rootScope.Scope
* @eventType broadcast on scope being destroyed
*
* @description
* Broadcasted when a scope and its children are being destroyed.
*/
/** /**
* @ngdoc function * @ngdoc function
* @name angular.module.ng.$rootScope.Scope#$destroy * @name angular.module.ng.$rootScope.Scope#$destroy
@ -445,13 +456,17 @@ function $RootScopeProvider(){
* *
* @description * @description
* Remove the current scope (and all of its children) from the parent scope. Removal implies * Remove the current scope (and all of its children) from the parent scope. Removal implies
* that calls to {@link angular.module.ng.$rootScope.Scope#$digest $digest()} will no longer propagate to the current * that calls to {@link angular.module.ng.$rootScope.Scope#$digest $digest()} will no longer
* scope and its children. Removal also implies that the current scope is eligible for garbage * propagate to the current scope and its children. Removal also implies that the current
* collection. * scope is eligible for garbage collection.
* *
* The `$destroy()` is usually used by directives such as * The `$destroy()` is usually used by directives such as
* {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat} for managing the unrolling of the loop. * {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat} for managing the
* unrolling of the loop.
* *
* Just before a scope is destroyed a `$destroy` event is broadcasted on this scope.
* Application code can register a `$destroy` event handler that will give it chance to
* perform any necessary cleanup.
*/ */
$destroy: function() { $destroy: function() {
if (this.$root == this) return; // we can't remove the root node; if (this.$root == this) return; // we can't remove the root node;