Update comments for clarity & grammar in router.ts #25947
Merged
Conversation
This file contains 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
Grammar changes in comment blocks and error messaging in router.ts
bits-by-brandon
requested review from
divmain,
ijjk,
lfades,
shuding and
timneutkens
as code owners
Stats from current PRDefault Server Mode (Decrease detected ✓)General Overall decrease ✓
Page Load Tests Overall increase ✓
Client Bundles (main, webpack, commons) Overall decrease ✓
Legacy Client Bundles (polyfills)
Client Pages
Client Build Manifests
Rendered Page Sizes Overall decrease ✓
DiffsDiff for main-HASH.js@@ -2767,7 +2767,7 @@
}
});
urlPropertyFields.forEach(function(field) {
- // Here we need to use Object.defineProperty because, we need to return
+ // Here we need to use Object.defineProperty because we need to return
// the property assigned to the actual router
// The value might get changed as we change routes and this is the
// proper way to access it
@@ -2811,7 +2811,7 @@
if (!singletonRouter.router) {
var message =
"No router instance found.\n" +
- 'You should only use "next/router" inside the client side of your app.\n';
+ 'You should only use "next/router" on the client side of your app.\n';
throw new Error(message);
}
@@ -2829,7 +2829,7 @@
// (do not use following exports inside the app)
// Create a router and assign it as the singleton instance.
// This is used in client side when we are initilizing the app.
- // This should **not** use inside the server.
+ // This should **not** be used inside the server.
var createRouter = function createRouter() {
for (Diff for index.html@@ -17,7 +17,7 @@
/>
<link
rel="preload"
- href="/_next/static/chunks/main-d467577b17529be33d58.js"
+ href="/_next/static/chunks/main-ba58125b62206f1554e5.js"
as="script"
/>
<link
@@ -57,7 +57,7 @@
async=""
></script>
<script
- src="/_next/static/chunks/main-d467577b17529be33d58.js"
+ src="/_next/static/chunks/main-ba58125b62206f1554e5.js"
async=""
></script>
<scriptDiff for link.html@@ -17,7 +17,7 @@
/>
<link
rel="preload"
- href="/_next/static/chunks/main-d467577b17529be33d58.js"
+ href="/_next/static/chunks/main-ba58125b62206f1554e5.js"
as="script"
/>
<link
@@ -62,7 +62,7 @@
async=""
></script>
<script
- src="/_next/static/chunks/main-d467577b17529be33d58.js"
+ src="/_next/static/chunks/main-ba58125b62206f1554e5.js"
async=""
></script>
<scriptDiff for withRouter.html@@ -17,7 +17,7 @@
/>
<link
rel="preload"
- href="/_next/static/chunks/main-d467577b17529be33d58.js"
+ href="/_next/static/chunks/main-ba58125b62206f1554e5.js"
as="script"
/>
<link
@@ -57,7 +57,7 @@
async=""
></script>
<script
- src="/_next/static/chunks/main-d467577b17529be33d58.js"
+ src="/_next/static/chunks/main-ba58125b62206f1554e5.js"
async=""
></script>
<scriptServerless Mode (Decrease detected ✓)General Overall decrease ✓
Client Bundles (main, webpack, commons) Overall decrease ✓
Legacy Client Bundles (polyfills)
Client Pages
Client Build Manifests
Serverless bundles
Webpack 4 Mode (Decrease detected ✓)General Overall decrease ✓
Page Load Tests Overall decrease
|
| vercel/next.js canary | brandondc741/next.js patch-1 | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 2.928 | 2.977 | |
| / avg req/sec | 853.85 | 839.76 | |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.624 | 1.912 | |
| /error-in-render avg req/sec | 1539.37 | 1307.71 |
Client Bundles (main, webpack, commons) Overall increase ⚠️
| vercel/next.js canary | brandondc741/next.js patch-1 | Change | |
|---|---|---|---|
| 677f882d2ed8..HASH.js gzip | 13.4 kB | 13.4 kB | |
| framework.HASH.js gzip | 39 kB | 39 kB | ✓ |
| main-HASH.js gzip | 7.99 kB | 7.99 kB | ✓ |
| webpack-HASH.js gzip | 751 B | 751 B | ✓ |
| Overall change | 61.1 kB | 61.1 kB |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | brandondc741/next.js patch-1 | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.3 kB | 31.3 kB | ✓ |
| Overall change | 31.3 kB | 31.3 kB | ✓ |
Client Pages
| vercel/next.js canary | brandondc741/next.js patch-1 | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.07 kB | 1.07 kB | ✓ |
| _error-HASH.js gzip | 3.74 kB | 3.74 kB | ✓ |
| amp-HASH.js gzip | 536 B | 536 B | ✓ |
| css-HASH.js gzip | 339 B | 339 B | ✓ |
| hooks-HASH.js gzip | 887 B | 887 B | ✓ |
| index-HASH.js gzip | 227 B | 227 B | ✓ |
| link-HASH.js gzip | 1.63 kB | 1.63 kB | ✓ |
| routerDirect..HASH.js gzip | 303 B | 303 B | ✓ |
| withRouter-HASH.js gzip | 302 B | 302 B | ✓ |
| e025d2764813..52f.css gzip | 125 B | 125 B | ✓ |
| Overall change | 9.17 kB | 9.17 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | brandondc741/next.js patch-1 | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 420 B | 420 B | ✓ |
| Overall change | 420 B | 420 B | ✓ |
Rendered Page Sizes Overall decrease ✓
| vercel/next.js canary | brandondc741/next.js patch-1 | Change | |
|---|---|---|---|
| index.html gzip | 627 B | 626 B | -1 B |
| link.html gzip | 633 B | 633 B | ✓ |
| withRouter.html gzip | 620 B | 620 B | ✓ |
| Overall change | 1.88 kB | 1.88 kB | -1 B |
Diffs
Diff for 677f882d2ed8..c4df.HASH.js
@@ -4540,7 +4540,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
}
});
urlPropertyFields.forEach(function(field) {
- // Here we need to use Object.defineProperty because, we need to return
+ // Here we need to use Object.defineProperty because we need to return
// the property assigned to the actual router
// The value might get changed as we change routes and this is the
// proper way to access it
@@ -4584,7 +4584,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
if (!singletonRouter.router) {
var message =
"No router instance found.\n" +
- 'You should only use "next/router" inside the client side of your app.\n';
+ 'You should only use "next/router" on the client side of your app.\n';
throw new Error(message);
}
@@ -4602,7 +4602,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
// (do not use following exports inside the app)
// Create a router and assign it as the singleton instance.
// This is used in client side when we are initilizing the app.
- // This should **not** use inside the server.
+ // This should **not** be used inside the server.
var createRouter = function createRouter() {
for (Diff for index.html
@@ -17,7 +17,7 @@
/>
<link
rel="preload"
- href="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.5ec3e9ad1acca1028feb.js"
+ href="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.20a22da5dd60e15fb078.js"
as="script"
/>
<link
@@ -62,7 +62,7 @@
async=""
></script>
<script
- src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.5ec3e9ad1acca1028feb.js"
+ src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.20a22da5dd60e15fb078.js"
async=""
></script>
<scriptDiff for link.html
@@ -17,7 +17,7 @@
/>
<link
rel="preload"
- href="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.5ec3e9ad1acca1028feb.js"
+ href="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.20a22da5dd60e15fb078.js"
as="script"
/>
<link
@@ -67,7 +67,7 @@
async=""
></script>
<script
- src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.5ec3e9ad1acca1028feb.js"
+ src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.20a22da5dd60e15fb078.js"
async=""
></script>
<scriptDiff for withRouter.html
@@ -17,7 +17,7 @@
/>
<link
rel="preload"
- href="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.5ec3e9ad1acca1028feb.js"
+ href="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.20a22da5dd60e15fb078.js"
as="script"
/>
<link
@@ -62,7 +62,7 @@
async=""
></script>
<script
- src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.5ec3e9ad1acca1028feb.js"
+ src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.20a22da5dd60e15fb078.js"
async=""
></script>
<script
This comment has been minimized.
This comment has been minimized.
janicklas-ralph
pushed a commit
to janicklas-ralph/next.js
that referenced
this pull request
Jun 11, 2021
flybayer
pushed a commit
to blitz-js/next.js
that referenced
this pull request
Jun 16, 2021
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.
Grammar changes in comment blocks and error messaging in router.ts
Documentation / Examples