docs(zone.js): update zone.js bundle doc since the APF change #37919
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhevery
suggested changes
Jul 10, 2020
packages/zone.js/README.md
Outdated
| @@ -73,17 +82,18 @@ And here are the additional optional patches not included in the main zone.js bu | |||
| |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-error.js|patch for `Error Global Object`, supports removing `Zone StackTrace`| | |||
There was a problem hiding this comment.
is it removing Error support or adding? I would think it would add error support, so the text is confusing.
There was a problem hiding this comment.
Yeah, it is confusing, I have updated the text to
|`zone-error.js`|patch for `Error Global Object`, supports adding zone information to stack frame, and also removing unrelated stack frames from `zone.js` internally|
mhevery
approved these changes
Jul 10, 2020
packages/zone.js/README.md
Outdated
| |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.js|the default bundle, contains the most used APIs such as `setTimeout/Promise/EventTarget...`, it also supports differential loading by importing this bundle using `import zone.js`, that means in legacy browsers it includes some additional patches| |
There was a problem hiding this comment.
what additional patches does it include in legacy?
There was a problem hiding this comment.
Now there are two patches in legacy bundle.
- the old Web Components
registerElementpatch. - some old browsers not support
EventTargetinterface, so we have to patch all the APIs such asHTMLElementone by one.
69c771a to
3331585
Compare
Since the PR angular#36540 change the zone.js bundles to Angular Package Format, the bundle name/location are changed, so this PR updated the `README.md` doc for the zone bundles. Also add the recent added new bundles `zone-patch-message-port` doc.
3331585 to
f45fa5b
Compare
Splaktar
pushed a commit
to angular-hispano/angular
that referenced
this pull request
Aug 8, 2020
…r#37919) Since the PR angular#36540 change the zone.js bundles to Angular Package Format, the bundle name/location are changed, so this PR updated the `README.md` doc for the zone bundles. Also add the recent added new bundles `zone-patch-message-port` doc. PR Close angular#37919
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
profanis
pushed a commit
to profanis/angular
that referenced
this pull request
Sep 5, 2020
…r#37919) Since the PR angular#36540 change the zone.js bundles to Angular Package Format, the bundle name/location are changed, so this PR updated the `README.md` doc for the zone bundles. Also add the recent added new bundles `zone-patch-message-port` doc. PR Close angular#37919
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the PR #36540 change the zone.js bundles to Angular Package Format, the
bundle name/location are changed, so this PR updated the
README.mddoc for thezone bundles.
Also add the recent added new bundles
zone-patch-message-portdoc.PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?