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

Export return type for GetStaticPaths #16580

Merged

Conversation

arthurjdam
Copy link
Contributor

@arthurjdam arthurjdam commented Aug 26, 2020

Makes getStaticPaths typing consistent with other types (getStaticProps and getServerSideProps). This would allow getStaticPaths to be typed as a function in addition to a const. For example:

import { ParsedUrlQuery } from 'querystring';

interface StaticPathParams extends ParsedUrlQuery {
  // …
}

export async function getStaticPaths(): Promise<GetStaticPathsResult<StaticPathParams>> {
  // …
}

Closes #16551

@ijjk
Copy link
Member

ijjk commented Aug 26, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
buildDuration 14.3s 13.8s -467ms
nodeModulesSize 57.5 MB 57.5 MB ⚠️ +5 B
Page Load Tests Overall increase ✓
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
/ failed reqs 0 0
/ total time (seconds) 2.8 2.632 -0.17
/ avg req/sec 892.78 949.9 +57.12
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.599 1.594 0
/error-in-render avg req/sec 1563 1568.56 +5.56
Client Bundles (main, webpack, commons)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..7f47.js gzip 10.3 kB 10.3 kB
framework.HASH.js gzip 39 kB 39 kB
main-d4bab31..824e.js gzip 7.34 kB 7.34 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.4 kB 57.4 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..dule.js gzip 6.15 kB 6.15 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-438d30a..dule.js gzip 6.39 kB 6.39 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.3 kB 52.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-000f151..65d4.js gzip 1.29 kB 1.29 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.69 kB 7.69 kB
Client Pages Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.35 kB 5.35 kB
Client Build Manifests
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_buildManifest.js gzip 322 B 322 B
_buildManife..dule.js gzip 330 B 330 B
Overall change 652 B 652 B
Rendered Page Sizes
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
index.html gzip 948 B 948 B
link.html gzip 954 B 954 B
withRouter.html gzip 940 B 940 B
Overall change 2.84 kB 2.84 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
buildDuration 15.3s 15.8s ⚠️ +490ms
nodeModulesSize 57.5 MB 57.5 MB ⚠️ +5 B
Client Bundles (main, webpack, commons)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..7f47.js gzip 10.3 kB 10.3 kB
framework.HASH.js gzip 39 kB 39 kB
main-d4bab31..824e.js gzip 7.34 kB 7.34 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.4 kB 57.4 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..dule.js gzip 6.15 kB 6.15 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-438d30a..dule.js gzip 6.39 kB 6.39 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.3 kB 52.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-000f151..65d4.js gzip 1.29 kB 1.29 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.69 kB 7.69 kB
Client Pages Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.35 kB 5.35 kB
Client Build Manifests
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_buildManifest.js gzip 322 B 322 B
_buildManife..dule.js gzip 330 B 330 B
Overall change 652 B 652 B
Serverless bundles
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_error.js 1.03 MB 1.03 MB
404.html 4.18 kB 4.18 kB
hooks.html 3.82 kB 3.82 kB
index.js 1.03 MB 1.03 MB
link.js 1.07 MB 1.07 MB
routerDirect.js 1.07 MB 1.07 MB
withRouter.js 1.07 MB 1.07 MB
Overall change 5.28 MB 5.28 MB
Commit: 2bb7d50

@ijjk
Copy link
Member

ijjk commented Aug 26, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
buildDuration 12.3s 12.2s -64ms
nodeModulesSize 57.5 MB 57.5 MB ⚠️ +45 B
Page Load Tests Overall increase ✓
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
/ failed reqs 0 0
/ total time (seconds) 2.27 2.284 ⚠️ +0.01
/ avg req/sec 1101.43 1094.74 ⚠️ -6.69
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.245 1.234 -0.01
/error-in-render avg req/sec 2008.57 2026.74 +18.17
Client Bundles (main, webpack, commons)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..7f47.js gzip 10.3 kB 10.3 kB
framework.HASH.js gzip 39 kB 39 kB
main-da593e2..abf1.js gzip 7.32 kB 7.32 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.3 kB 57.3 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..dule.js gzip 6.15 kB 6.15 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-34d17c2..dule.js gzip 6.39 kB 6.39 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.3 kB 52.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-000f151..65d4.js gzip 1.29 kB 1.29 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.69 kB 7.69 kB
Client Pages Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.35 kB 5.35 kB
Client Build Manifests
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_buildManifest.js gzip 322 B 322 B
_buildManife..dule.js gzip 330 B 330 B
Overall change 652 B 652 B
Rendered Page Sizes
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
index.html gzip 972 B 972 B
link.html gzip 979 B 979 B
withRouter.html gzip 964 B 964 B
Overall change 2.92 kB 2.92 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
buildDuration 14.2s 13.8s -407ms
nodeModulesSize 57.5 MB 57.5 MB ⚠️ +45 B
Client Bundles (main, webpack, commons)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..7f47.js gzip 10.3 kB 10.3 kB
framework.HASH.js gzip 39 kB 39 kB
main-da593e2..abf1.js gzip 7.32 kB 7.32 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.3 kB 57.3 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..dule.js gzip 6.15 kB 6.15 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-34d17c2..dule.js gzip 6.39 kB 6.39 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.3 kB 52.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-000f151..65d4.js gzip 1.29 kB 1.29 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.69 kB 7.69 kB
Client Pages Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.35 kB 5.35 kB
Client Build Manifests
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_buildManifest.js gzip 322 B 322 B
_buildManife..dule.js gzip 330 B 330 B
Overall change 652 B 652 B
Serverless bundles
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_error.js 1.03 MB 1.03 MB
404.html 4.22 kB 4.22 kB
hooks.html 3.86 kB 3.86 kB
index.js 1.03 MB 1.03 MB
link.js 1.07 MB 1.07 MB
routerDirect.js 1.07 MB 1.07 MB
withRouter.js 1.07 MB 1.07 MB
Overall change 5.28 MB 5.28 MB
Commit: dc89353

Copy link
Member

@lfades lfades left a comment

Choose a reason for hiding this comment

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

@arthurjdam Good work. Thank you!

@ijjk
Copy link
Member

ijjk commented Sep 1, 2020

Stats from current PR

Default Server Mode (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
buildDuration 11.4s 11.6s ⚠️ +263ms
nodeModulesSize 55.9 MB 55.9 MB ⚠️ +45 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
/ failed reqs 0 0
/ total time (seconds) 2.158 2.168 ⚠️ +0.01
/ avg req/sec 1158.22 1153.17 ⚠️ -5.05
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.291 1.337 ⚠️ +0.05
/error-in-render avg req/sec 1935.82 1869.69 ⚠️ -66.13
Client Bundles (main, webpack, commons)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..9ff9.js gzip 10.3 kB 10.3 kB
framework.HASH.js gzip 39 kB 39 kB
main-2db3d72..5955.js gzip 7.35 kB 7.35 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.3 kB 57.3 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-d7fe688..dule.js gzip 6.41 kB 6.41 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.3 kB 52.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-ed1b0..8fbd.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-ae98065..267e.js gzip 1.29 kB 1.29 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.69 kB 7.69 kB
Client Pages Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-4469a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-cb244c4..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.35 kB 5.35 kB
Client Build Manifests
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_buildManifest.js gzip 323 B 323 B
_buildManife..dule.js gzip 329 B 329 B
Overall change 652 B 652 B
Rendered Page Sizes
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
index.html gzip 971 B 971 B
link.html gzip 976 B 976 B
withRouter.html gzip 964 B 964 B
Overall change 2.91 kB 2.91 kB

Serverless Mode
General Overall increase ⚠️
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
buildDuration 12.8s 12.8s ⚠️ +3ms
nodeModulesSize 55.9 MB 55.9 MB ⚠️ +45 B
Client Bundles (main, webpack, commons)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..9ff9.js gzip 10.3 kB 10.3 kB
framework.HASH.js gzip 39 kB 39 kB
main-2db3d72..5955.js gzip 7.35 kB 7.35 kB
webpack-e067..f178.js gzip 751 B 751 B
Overall change 57.3 kB 57.3 kB
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB
framework.HA..dule.js gzip 39 kB 39 kB
main-d7fe688..dule.js gzip 6.41 kB 6.41 kB
webpack-07c5..dule.js gzip 751 B 751 B
Overall change 52.3 kB 52.3 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
polyfills-4b..e242.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB
_error-ed1b0..8fbd.js gzip 3.44 kB 3.44 kB
hooks-89731c..c609.js gzip 887 B 887 B
index-17468f..5d83.js gzip 227 B 227 B
link-ae98065..267e.js gzip 1.29 kB 1.29 kB
routerDirect..924c.js gzip 284 B 284 B
withRouter-7..c13d.js gzip 284 B 284 B
Overall change 7.69 kB 7.69 kB
Client Pages Modern
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_app-75d3a82..dule.js gzip 625 B 625 B
_error-4469a..dule.js gzip 2.29 kB 2.29 kB
hooks-cbf13f..dule.js gzip 387 B 387 B
index-b9a643..dule.js gzip 226 B 226 B
link-cb244c4..dule.js gzip 1.26 kB 1.26 kB
routerDirect..dule.js gzip 284 B 284 B
withRouter-f..dule.js gzip 282 B 282 B
Overall change 5.35 kB 5.35 kB
Client Build Manifests
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_buildManifest.js gzip 323 B 323 B
_buildManife..dule.js gzip 329 B 329 B
Overall change 652 B 652 B
Serverless bundles
vercel/next.js canary arthurjdam/next.js feature/add-get-static-paths-result Change
_error.js 1.03 MB 1.03 MB
404.html 4.22 kB 4.22 kB
hooks.html 3.86 kB 3.86 kB
index.js 1.03 MB 1.03 MB
link.js 1.07 MB 1.07 MB
routerDirect.js 1.07 MB 1.07 MB
withRouter.js 1.07 MB 1.07 MB
Overall change 5.28 MB 5.28 MB
Commit: e54f2d2

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: Export a "GetStaticPathsResult" Typescript type
3 participants