angular-docs-cn/packages/zone.js
JiaLiPassion 583a9d38a1 feat(zone.js): upgrade zone.js to angular package format(APF) (#36540)
Close #35157

In the current version of zone.js, zone.js uses it's own package format, and it is not following the rule
of Angualr package format(APF), so it is not easily to be consumed by Angular CLI or other bundle tools.
For example, zone.js npm package has two bundles,

1. zone.js/dist/zone.js, this is a `es5` bundle.
2. zone.js/dist/zone-evergreen.js, this is a `es2015` bundle.

And Angular CLI has to add some hard-coding code to handle this case, o5376a8b139/packages/schematics/angular/application/files/src/polyfills.ts.template (L55-L58)

This PR upgrade zone.js npm package format to follow APF rule, https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/edit#heading=h.k0mh3o8u5hx

The updated points are:

1. in package.json, update all bundle related properties

```
  "main": "./bundles/zone.umd.js",
  "module": "./fesm2015/zone.js",
  "es2015": "./fesm2015/zone.js",
  "fesm2015": "./fesm2015/zone.js",
```

2. re-organize dist folder, for example for `zone.js` bundle, now we have

```
  dist/
      bundles/
             zone.js            // this is the es5 bundle
      fesm2015/
             zone.js            // this is the es2015 bundle (in the old version is `zone-evergreen.js`)
```

3. have several sub-packages.

1. `zone-testing`, provide zone-testing bundles include zone.js and testing libraries
2. `zone-node`, provide zone.js implemention for NodeJS
3. `zone-mix`, provide zone.js patches for both Browser and NodeJS

All those sub-packages will have their own `package.json` and the bundle will reference `bundles(es5)` and `fesm2015(es2015)`.

4. keep backward compatibility, still keep the `zone.js/dist` folder, and all bundles will be redirected to `zone.js/bundles` or `zone.js/fesm2015` folders.

PR Close #36540
2020-06-11 11:08:48 -07:00
..
bundles feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
dist feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
doc build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
example build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
fesm2015 feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
lib feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
mix feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
node feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
scripts build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
test feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
testing feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
BUILD.bazel feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
CHANGELOG.md release: cut the zone.js-0.10.3 release (#34508) 2020-03-16 15:49:07 -07:00
DEVELOPER.md build(zone.js): Update `zone.js` release process to use `google-wombot` (#36110) 2020-03-17 10:40:32 -07:00
MODULE.md feat(zone.js): Monkey patch MessagePort.prototype onproperties (#34610) 2020-03-16 08:59:38 -07:00
NON-STANDARD-APIS.md docs: update zone-bluebird patch document for angular (#34536) 2020-02-03 14:05:22 -08:00
README.md fix(zone.js): update dart zone link (#31646) 2019-07-23 21:12:52 -07:00
SAMPLE.md build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
STANDARD-APIS.md build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
bundles.bzl feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
check-file-size.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
file-size-limit.json build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-base.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-build-jasmine.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-build-jasmine.es2015.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-build-mocha.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-build-sauce-mocha.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-build-sauce-selenium3-mocha.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-build.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-dist-jasmine.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-dist-mocha.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-dist-sauce-jasmine.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-dist-sauce-jasmine.es2015.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-dist-sauce-jasmine3.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-dist-sauce-selenium3-jasmine.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-dist.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-evergreen-dist-jasmine.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
karma-evergreen-dist-sauce-jasmine.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
karma-evergreen-dist.conf.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
package.json feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
presentation.png build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
rollup-es5.config.js fix(zone.js): fix `zone-patch-rxjs` bundle to refer to `rxjs` (rather than include) it. (#35983) 2020-03-11 15:09:03 -07:00
rollup-es5_global-es2015.config.js build: bump year (#34651) 2020-01-13 07:21:43 -08:00
sauce-evergreen.conf.js build: reformat repo to new clang@1.4.0 (#36613) 2020-04-14 12:08:36 -07:00
sauce-selenium3.conf.js build: move zone.js to angular repo (#30962) 2019-06-20 11:27:39 -07:00
sauce.conf.js build: reformat repo to new clang@1.4.0 (#36613) 2020-04-14 12:08:36 -07:00
sauce.es2015.conf.js build: reformat repo to new clang@1.4.0 (#36613) 2020-04-14 12:08:36 -07:00
simple-server.js build: update license headers to reference Google LLC (#37205) 2020-05-26 14:26:58 -04:00
tools.bzl feat(zone.js): upgrade zone.js to angular package format(APF) (#36540) 2020-06-11 11:08:48 -07:00
tsconfig.json build: remove vendored Babel typings (#33226) 2019-10-17 18:45:52 -04:00

README.md

Zone.js

CDNJS

Implements Zones for JavaScript, inspired by Dart.

If you're using zone.js via unpkg (i.e. using https://unpkg.com/zone.js) and you're using any of the following libraries, make sure you import them first

  • 'newrelic' as it patches global.Promise before zone.js does
  • 'async-listener' as it patches global.setTimeout, global.setInterval before zone.js does
  • 'continuation-local-storage' as it uses async-listener

NEW Zone.js POST-v0.6.0

See the new API here.

Read up on Zone Primer.

What's a Zone?

A Zone is an execution context that persists across async tasks. You can think of it as thread-local storage for JavaScript VMs.

See this video from ng-conf 2014 for a detailed explanation:

screenshot of the zone.js presentation and ng-conf 2014

See also

Standard API support

zone.js patched most standard web APIs (such as DOM events, XMLHttpRequest, ...) and nodejs APIs (EventEmitter, fs, ...), for more details, please see STANDARD-APIS.md.

Nonstandard API support

We are adding support to some nonstandard APIs, such as MediaQuery and Notification. Please see NON-STANDARD-APIS.md for more details.

Examples

You can find some samples to describe how to use zone.js in SAMPLE.md.

Modules

zone.js patches the async APIs described above, but those patches will have some overhead. Starting from zone.js v0.8.9, you can choose which web API module you want to patch. For more details, please see MODULE.md.

Bundles

There are several bundles under dist folder.

Bundle Summary
zone.js the default bundle, contains the most used APIs such as setTimeout/Promise/EventTarget..., also this bundle supports all evergreen and legacy (IE/Legacy Firefox/Legacy Safari) Browsers
zone-evergreen.js the bundle for evergreen browsers, doesn't include the patch for legacy browsers such as IE or old versions of Firefox/Safari
zone-legacy.js the patch bundle for legacy browsers, only includes the patch for legacy browsers such as IE or old versions of Firefox/Safari. This bundle must be loaded after zone-evergreen.js, zone.js=zone-evergreen.js + zone-legacy.js
zone-testing.js the bundle for zone testing support, including jasmine/mocha support and async/fakeAsync/sync test utilities
zone-externs.js the API definitions for closure compiler

And here are the additional optional patches not included in the main zone.js bundles

Patch Summary
webapis-media-query.js patch for MediaQuery APIs
webapis-notification.js patch for Notification APIs
webapis-rtc-peer-connection.js patch for RTCPeerConnection APIs
webapis-shadydom.js patch for Shady DOM APIs
zone-bluebird.js patch for Bluebird APIs
zone-error.js patch for Error Global Object, supports remove Zone StackTrace
zone-patch-canvas.js patch for Canvas API
zone-patch-cordova.js patch for Cordova API
zone-patch-electron.js patch for Electron API
zone-patch-fetch.js patch for Fetch API
zone-patch-jsonp.js utility for jsonp API
zone-patch-resize-observer.js patch for ResizeObserver API
zone-patch-rxjs.js patch for rxjs API
zone-patch-rxjs-fake-async.js patch for rxjs fakeasync test
zone-patch-socket-io.js patch for socket-io
zone-patch-user-media.js patch for UserMedia API

Promise A+ test passed

Promises/A+ 1.1 compliant

License

MIT