docs: remove 'import type' declaration in javascript snippet #9180
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.
Pre-flight checklist
Motivation
The
import type {Location} from 'history'
statement in themyClientModule.js
snippet causes JavaScript to throw an error because animport type
declaration works only in TypeScript files—not JavaScript.So, I propose removing the declaration from the doc example to prevent confusing users.
- import type {Location} from 'history'; export function onRouteDidUpdate({location, previousLocation}) { // Don't execute if we are still on the same page; the lifecycle may be fired // because the hash changes (e.g. when navigating between headings) if (location.pathname !== previousLocation?.pathname) { const title = document.getElementsByTagName('h1')[0]; if (title) { title.innerText += '❤️'; } } } export function onRouteUpdate({location, previousLocation}) { if (location.pathname !== previousLocation?.pathname) { const progressBarTimeout = window.setTimeout(() => { nprogress.start(); }, delay); return () => window.clearTimeout(progressBarTimeout); } return undefined; }
Test Plan
N/A (This is a doc update)
Test links
Snippet's Doc Section: Client module lifecycles
Deploy preview: https://deploy-preview-9180--docusaurus-2.netlify.app/
Related issues/PRs
N/A