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

Jump to bottom

Add TypeScript docs for SSG #10865

Merged
merged 3 commits into from Mar 6, 2020
Merged

Add TypeScript docs for SSG #10865

merged 3 commits into from Mar 6, 2020

Conversation

chibicode
Copy link
Member

@chibicode chibicode commented Mar 6, 2020 •
edited

NEXT-113

  • Adds TypeScript documentation for getStaticProps, getStaticPaths, and getServerSideProps on the data fetching documentation and the typescript documentation
  • Adds a message at the top of the getInitialProps API reference (located here) to use getStaticProps or getServerSideProps instead
  • Move the typescript documentation for getInitialProps to the getInitialProps API reference so it's less visible
  • I used export const getStaticProps: GetStaticProps ... etc instead of using function so you can assign the types easily.

@chibicode chibicode requested a review from Timer as a code owner March 6, 2020 06:50
@ijjk
Copy link
Member

ijjk commented Mar 6, 2020

Stats from current PR

Default Server Mode
General
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
buildDuration 9.4s 9.6s ⚠️ +186ms
nodeModulesSize 56.5 MB 56.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs Change
index.html gzip 914 B 914 B ✓
link.html gzip 922 B 922 B ✓
withRouter.html gzip 910 B 910 B ✓
Overall change 2.75 kB 2.75 kB ✓
Serverless Mode (Increase detected ⚠️)
General
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
buildDuration 10.2s 10.3s ⚠️ +148ms
nodeModulesSize 56.5 MB 56.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 increase ⚠️
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
_error.js gzip 292 kB 293 kB ⚠️ +234 B
404.html gzip 1.32 kB 1.32 kB ✓
hooks.html gzip 955 B 955 B ✓
index.js gzip 292 kB 293 kB ⚠️ +214 B
link.js gzip 299 kB 300 kB ⚠️ +892 B
routerDirect.js gzip 298 kB 299 kB ⚠️ +975 B
withRouter.js gzip 298 kB 299 kB ⚠️ +714 B
Overall change 1.48 MB 1.49 MB ⚠️ +3.03 kB

@ijjk
Copy link
Member

ijjk commented Mar 6, 2020

Stats from current PR

Default Server Mode
General
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
buildDuration 9.6s 9.5s -111ms
nodeModulesSize 56.5 MB 56.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs Change
index.html gzip 914 B 914 B ✓
link.html gzip 922 B 922 B ✓
withRouter.html gzip 910 B 910 B ✓
Overall change 2.75 kB 2.75 kB ✓
Serverless Mode (Increase detected ⚠️)
General
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
buildDuration 10.1s 10.3s ⚠️ +199ms
nodeModulesSize 56.5 MB 56.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 increase ⚠️
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
_error.js gzip 292 kB 292 kB ⚠️ +22 B
404.html gzip 1.32 kB 1.32 kB ✓
hooks.html gzip 955 B 955 B ✓
index.js gzip 292 kB 292 kB ⚠️ +54 B
link.js gzip 299 kB 300 kB ⚠️ +899 B
routerDirect.js gzip 298 kB 298 kB ⚠️ +491 B
withRouter.js gzip 298 kB 299 kB ⚠️ +1.12 kB
Overall change 1.48 MB 1.48 MB ⚠️ +2.58 kB

@ijjk
Copy link
Member

ijjk commented Mar 6, 2020

Stats from current PR

Default Server Mode
General
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs Change
buildDuration 10.3s 10s -221ms
nodeModulesSize 56.5 MB 56.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs Change
index.html gzip 914 B 914 B ✓
link.html gzip 922 B 922 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 chibicode/next.js NEXT-113/ssg-typescript-docs Change
buildDuration 10.6s 11s ⚠️ +398ms
nodeModulesSize 56.5 MB 56.5 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs 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 chibicode/next.js NEXT-113/ssg-typescript-docs Change
_error.js gzip 292 kB 292 kB ⚠️ +280 B
404.html gzip 1.32 kB 1.32 kB ✓
hooks.html gzip 955 B 955 B ✓
index.js gzip 292 kB 292 kB -58 B
link.js gzip 300 kB 299 kB -761 B
routerDirect.js gzip 298 kB 298 kB ⚠️ +303 B
withRouter.js gzip 299 kB 298 kB -579 B
Overall change 1.48 MB 1.48 MB -815 B

@timneutkens timneutkens merged commit b13892e into vercel:canary Mar 6, 2020
@chibicode chibicode deleted the NEXT-113/ssg-typescript-docs branch March 9, 2020 16:17
@snyk-bot snyk-bot mentioned this pull request Apr 9, 2020
Open
@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.
Reviewers

@timneutkens timneutkens timneutkens approved these changes

@Timer Timer Awaiting requested review from Timer

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@chibicode @ijjk @timneutkens