Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix getStaticPaths example code #10893

Merged
merged 2 commits into from Mar 9, 2020
Merged

Fix getStaticPaths example code #10893

merged 2 commits into from Mar 9, 2020

Conversation

balazsorban44
Copy link
Member

@balazsorban44 balazsorban44 commented Mar 9, 2020

In the upcoming getStaticPaths documentation, there seems to be a contradiction in what should be returned by this function.

In one place, it says it should look something like this:

return {
  paths: [
    { params: { id: 1 } },
    { params: { id: 2 } }
  ],
  fallback: ...
}

So paths contains a list of objects, where each item has a params property, that are objects themselves.

Although, in the example below fallback, paths was equal to posts mapped over to a list of strings (ids).

Closes #10894

@ijjk
Copy link
Member

ijjk commented Mar 9, 2020

Stats from current PR

Default Server Mode
General
zeit/next.js canary balazsorban44/next.js patch-1 Change
buildDuration 10.3s 10.7s ⚠️ +388ms
nodeModulesSize 56.5 MB 56.5 MB
Client Bundles (main, webpack, commons)
zeit/next.js canary balazsorban44/next.js patch-1 Change
main-HASH.js gzip 5.77 kB 5.77 kB
webpack-HASH.js gzip 746 B 746 B
de003c3a9d30..cfaa.js gzip 9.77 kB 9.77 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
Overall change 55.4 kB 55.4 kB
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary balazsorban44/next.js patch-1 Change
main-HASH.module.js gzip 4.78 kB 4.78 kB
webpack-HASH..dule.js gzip 746 B 746 B
de003c3a9d30..dule.js gzip 6.71 kB 6.71 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
Overall change 51.4 kB 51.4 kB
Legacy Client Bundles (polyfills)
zeit/next.js canary balazsorban44/next.js patch-1 Change
polyfills-HASH.js gzip 18.9 kB 18.9 kB
Overall change 18.9 kB 18.9 kB
Client Pages
zeit/next.js canary balazsorban44/next.js patch-1 Change
_app.js gzip 1.09 kB 1.09 kB
_error.js gzip 2.96 kB 2.96 kB
hooks.js gzip 664 B 664 B
index.js gzip 222 B 222 B
link.js gzip 1.89 kB 1.89 kB
routerDirect.js gzip 279 B 279 B
withRouter.js gzip 278 B 278 B
Overall change 7.38 kB 7.38 kB
Client Pages Modern
zeit/next.js canary balazsorban44/next.js patch-1 Change
_app.module.js gzip 594 B 594 B
_error.module.js gzip 2.06 kB 2.06 kB
hooks.module.js gzip 370 B 370 B
index.module.js gzip 212 B 212 B
link.module.js gzip 1.48 kB 1.48 kB
routerDirect..dule.js gzip 271 B 271 B
withRouter.m..dule.js gzip 270 B 270 B
Overall change 5.26 kB 5.26 kB
Client Build Manifests
zeit/next.js canary balazsorban44/next.js patch-1 Change
_buildManifest.js gzip 61 B 61 B
_buildManife..dule.js gzip 61 B 61 B
Overall change 122 B 122 B
Rendered Page Sizes
zeit/next.js canary balazsorban44/next.js patch-1 Change
index.html gzip 915 B 915 B
link.html gzip 924 B 924 B
withRouter.html gzip 910 B 910 B
Overall change 2.75 kB 2.75 kB

Serverless Mode (Decrease detected ✓)
General
zeit/next.js canary balazsorban44/next.js patch-1 Change
buildDuration 11.3s 11.6s ⚠️ +312ms
nodeModulesSize 56.5 MB 56.5 MB
Client Bundles (main, webpack, commons)
zeit/next.js canary balazsorban44/next.js patch-1 Change
main-HASH.js gzip 5.77 kB 5.77 kB
webpack-HASH.js gzip 746 B 746 B
de003c3a9d30..cfaa.js gzip 9.77 kB 9.77 kB
framework.HASH.js gzip 39.1 kB 39.1 kB
Overall change 55.4 kB 55.4 kB
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary balazsorban44/next.js patch-1 Change
main-HASH.module.js gzip 4.78 kB 4.78 kB
webpack-HASH..dule.js gzip 746 B 746 B
de003c3a9d30..dule.js gzip 6.71 kB 6.71 kB
framework.HA..dule.js gzip 39.1 kB 39.1 kB
Overall change 51.4 kB 51.4 kB
Legacy Client Bundles (polyfills)
zeit/next.js canary balazsorban44/next.js patch-1 Change
polyfills-HASH.js gzip 18.9 kB 18.9 kB
Overall change 18.9 kB 18.9 kB
Client Pages
zeit/next.js canary balazsorban44/next.js patch-1 Change
_app.js gzip 1.09 kB 1.09 kB
_error.js gzip 2.96 kB 2.96 kB
hooks.js gzip 664 B 664 B
index.js gzip 222 B 222 B
link.js gzip 1.89 kB 1.89 kB
routerDirect.js gzip 279 B 279 B
withRouter.js gzip 278 B 278 B
Overall change 7.38 kB 7.38 kB
Client Pages Modern
zeit/next.js canary balazsorban44/next.js patch-1 Change
_app.module.js gzip 594 B 594 B
_error.module.js gzip 2.06 kB 2.06 kB
hooks.module.js gzip 370 B 370 B
index.module.js gzip 212 B 212 B
link.module.js gzip 1.48 kB 1.48 kB
routerDirect..dule.js gzip 271 B 271 B
withRouter.m..dule.js gzip 270 B 270 B
Overall change 5.26 kB 5.26 kB
Client Build Manifests
zeit/next.js canary balazsorban44/next.js patch-1 Change
_buildManifest.js gzip 61 B 61 B
_buildManife..dule.js gzip 61 B 61 B
Overall change 122 B 122 B
Serverless bundles Overall decrease ✓
zeit/next.js canary balazsorban44/next.js patch-1 Change
_error.js gzip 292 kB 292 kB -195 B
404.html gzip 1.32 kB 1.32 kB
hooks.html gzip 955 B 955 B
index.js gzip 292 kB 292 kB -441 B
link.js gzip 300 kB 299 kB -557 B
routerDirect.js gzip 298 kB 298 kB -192 B
withRouter.js gzip 298 kB 299 kB ⚠️ +1.13 kB
Overall change 1.48 MB 1.48 MB -251 B

Copy link
Member

@timneutkens timneutkens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the example to correctly show passing of post.id. Both methods are supported btw, you can provide a full url instead of the object. But we're only showing the object in the docs for now, so good catch 💯

@timneutkens timneutkens merged commit 213a4b8 into vercel:canary Mar 9, 2020
@balazsorban44
Copy link
Member Author

That was fast! 🔥

@balazsorban44 balazsorban44 deleted the patch-1 branch March 9, 2020 09:29
@vercel vercel locked as resolved and limited conversation to collaborators Jan 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contradiction in the upcoming getStaticPaths docs
3 participants