docs: clean up README and add a lazy-loading example - #303
Open
Artur (arturovt) wants to merge 1 commit into
Open
docs: clean up README and add a lazy-loading example#303Artur (arturovt) wants to merge 1 commit into
Artur (arturovt) wants to merge 1 commit into
Conversation
Tidies up the README: modernizes the code snippets (no more var, consistent formatting, ts fences instead of js since the examples use TS-only syntax, inject() instead of constructor injection), adds a table of contents, fixes the broken npm badge link, and cleans up a few typos and duplicated lines. Adds a Lazy Loading section showing how to defer loading the SDK behind a dynamic import() and still run everything outside NgZone, plus two config options worth knowing about (enableAutoRouteTracking: false when the router is already wired to the plugin, and disablePageUnloadEvents to quiet Chrome's 'unload' deprecation warning). Every new ApplicationInsights()/loadAppInsights() example now wraps in runOutsideAngular by default, not just a special hydration callout - there's no real downside even outside SSR apps (it also avoids unnecessary change-detection ticks from the SDK's background timers), so it should just be how every example is written. Basic Usage carries a short "why" note explaining this instead of a separate, nearly-identical snippet.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Tidies up the README: modernizes the code snippets (no more var, consistent formatting, ts fences instead of js since the examples use TS-only syntax, inject() instead of constructor injection), adds a table of contents, fixes the broken npm badge link, and cleans up a few typos and duplicated lines.
Adds a Lazy Loading section showing how to defer loading the SDK behind a dynamic import() and still run everything outside NgZone, plus two config options worth knowing about (enableAutoRouteTracking: false when the router is already wired to the plugin, and disablePageUnloadEvents to quiet Chrome's 'unload' deprecation warning).
Every new ApplicationInsights()/loadAppInsights() example now wraps in runOutsideAngular by default, not just a special hydration callout - there's no real downside even outside SSR apps (it also avoids unnecessary change-detection ticks from the SDK's background timers), so it should just be how every example is written. Basic Usage carries a short "why" note explaining this instead of a separate, nearly-identical snippet.