模板语法
服务端渲染
API / @angular/core

NgZone

An injectable service for executing work inside or outside of the Angular zone.

class NgZone { static isInAngularZone(): boolean static assertInAngularZone(): void static assertNotInAngularZone(): void constructor(__0) get hasPendingMicrotasks: boolean get hasPendingMacrotasks: boolean get isStable: boolean get onUnstable: EventEmitter<any> get onMicrotaskEmpty: EventEmitter<any> get onStable: EventEmitter<any> get onError: EventEmitter<any> run<T>(fn: (...args: any[]) => T, applyThis?: any, applyArgs?: any[]): T runTask<T>(fn: (...args: any[]) => T, applyThis?: any, applyArgs?: any[], name?: string): T runGuarded<T>(fn: (...args: any[]) => T, applyThis?: any, applyArgs?: any[]): T runOutsideAngular<T>(fn: (...args: any[]) => T): T }

说明

The most common use of this service is to optimize performance when starting a work consisting of one or more asynchronous tasks that don't require UI updates or error handling to be handled by Angular. Such tasks can be kicked off via runOutsideAngular and if needed, these tasks can reenter the Angular zone via run.

静态方法

isInAngularZone()

static isInAngularZone(): boolean

参数

没有参数。

返回值

boolean

assertInAngularZone()

static assertInAngularZone(): void

参数

没有参数。

返回值

void

assertNotInAngularZone()

static assertNotInAngularZone(): void

参数

没有参数。

返回值

void

构造函数

constructor(__0)

参数

__0

属性

属性名类型说明
hasPendingMicrotasks只读
hasPendingMacrotasks只读
isStable只读

Whether there are no outstanding microtasks or macrotasks.

onUnstable只读

Notifies when code enters Angular Zone. This gets fired first on VM Turn.

onMicrotaskEmpty只读

Notifies when there is no more microtasks enqueued in the current VM Turn. This is a hint for Angular to do change detection, which may enqueue more microtasks. For this reason this event can fire multiple times per VM Turn.

onStable只读

Notifies when the last onMicrotaskEmpty has run and there are no more microtasks, which implies we are about to relinquish VM turn. This event gets called just once.

onError只读

Notifies that an error has been delivered.

方法

run()

Executes the fn function synchronously within the Angular zone and returns value returned by the function.

run<T>(fn: (...args: any[]) => T, applyThis?: any, applyArgs?: any[]): T

参数

fn

Type: (...args: any[]) => T.

applyThis

Type: any.

可选. 默认值是 undefined.

applyArgs

Type: any[].

可选. 默认值是 undefined.

返回值

T

Running functions via run allows you to reenter Angular zone from a task that was executed outside of the Angular zone (typically started via runOutsideAngular).

Any future tasks or microtasks scheduled from within this function will continue executing from within the Angular zone.

If a synchronous error happens it will be rethrown and not reported via onError.

runTask()

Executes the fn function synchronously within the Angular zone as a task and returns value returned by the function.

runTask<T>(fn: (...args: any[]) => T, applyThis?: any, applyArgs?: any[], name?: string): T

参数

fn

Type: (...args: any[]) => T.

applyThis

Type: any.

可选. 默认值是 undefined.

applyArgs

Type: any[].

可选. 默认值是 undefined.

name

Type: string.

可选. 默认值是 undefined.

返回值

T

Running functions via run allows you to reenter Angular zone from a task that was executed outside of the Angular zone (typically started via runOutsideAngular).

Any future tasks or microtasks scheduled from within this function will continue executing from within the Angular zone.

If a synchronous error happens it will be rethrown and not reported via onError.

runGuarded()

Same as run, except that synchronous errors are caught and forwarded via onError and not rethrown.

runGuarded<T>(fn: (...args: any[]) => T, applyThis?: any, applyArgs?: any[]): T

参数

fn

Type: (...args: any[]) => T.

applyThis

Type: any.

可选. 默认值是 undefined.

applyArgs

Type: any[].

可选. 默认值是 undefined.

返回值

T

runOutsideAngular()

Executes the fn function synchronously in Angular's parent zone and returns value returned by the function.

runOutsideAngular<T>(fn: (...args: any[]) => T): T

参数

fn

Type: (...args: any[]) => T.

返回值

T

Running functions via runOutsideAngular allows you to escape Angular's zone and do work that doesn't trigger Angular change-detection or is subject to Angular's error handling.

Any future tasks or microtasks scheduled from within this function will continue executing from outside of the Angular zone.

Use run to reenter the Angular zone and do work that updates the application model.

使用说明

Example

import {Component, NgZone} from '@angular/core'; import {NgIf} from '@angular/common'; @Component({ selector: 'ng-zone-demo', template: ` <h2>Demo: NgZone</h2> <p>Progress: {{progress}}%</p> <p *ngIf="progress >= 100">Done processing {{label}} of Angular zone!</p> <button (click)="processWithinAngularZone()">Process within Angular zone</button> <button (click)="processOutsideOfAngularZone()">Process outside of Angular zone</button> `, }) export class NgZoneDemo { progress: number = 0; label: string; constructor(private _ngZone: NgZone) {} // Loop inside the Angular zone // so the UI DOES refresh after each setTimeout cycle processWithinAngularZone() { this.label = 'inside'; this.progress = 0; this._increaseProgress(() => console.log('Inside Done!')); } // Loop outside of the Angular zone // so the UI DOES NOT refresh after each setTimeout cycle processOutsideOfAngularZone() { this.label = 'outside'; this.progress = 0; this._ngZone.runOutsideAngular(() => { this._increaseProgress(() => { // reenter the Angular zone and display done this._ngZone.run(() => { console.log('Outside Done!'); }); }); }); } _increaseProgress(doneCallback: () => void) { this.progress += 1; console.log(`Current progress: ${this.progress}%`); if (this.progress < 100) { window.setTimeout(() => this._increaseProgress(doneCallback), 10); } else { doneCallback(); } } }