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

Adds the private TS annotation to _methods() #2120

Merged
merged 2 commits into from
Jul 17, 2019
Merged

Conversation

jeffposnick
Copy link
Contributor

R: @philipwalton

When testing out the TypeScript functionality, I noticed that there were a bunch of methods on workbox-window that started with _ and were @private in JSDoc, but weren't marked private in TypeScript.

I wonder if this is something we could catch via linting or some sort of post-TypeScript-compilation test?

@coveralls
Copy link

coveralls commented Jul 17, 2019

Coverage Status

Coverage remained the same at 77.688% when pulling 874645e on wb-window-private into bd6edce on master.

Copy link
Member

@philipwalton philipwalton left a comment

Choose a reason for hiding this comment

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

Hmmm, good catch. I don't think I did this in any package, so we'll probably have to do another PR to address it.

I'm also planning to add linting soon, so that may help as well.

@jeffposnick
Copy link
Contributor Author

Want me to push more changes to this PR that cleans up other instances?

@philipwalton
Copy link
Member

If you want, but it'll like be a ton of files, so if you want to do it in a separate PR, that's fine too.

@jeffposnick
Copy link
Contributor Author

I did a quick search for the general pattern and found a few more obvious ones. We can include them in this PR, and then if I missed any, feel free to pick them up later.

@workbox-pr-bot
Copy link
Collaborator

PR-Bot Size Plugin

Changed File Sizes

File Before After Change GZipped
packages/workbox-window/build/workbox-window.dev.umd.js 31.88 KB 31.88 KB +0% 8.10 KB

New Files

No new files have been added.

All File Sizes

View Table
File Before After Change GZipped
packages/workbox-background-sync/build/workbox-background-sync.prod.js 3.86 KB 3.86 KB 0% 1.59 KB
packages/workbox-broadcast-update/build/workbox-broadcast-update.prod.js 1.92 KB 1.92 KB 0% 959 B
packages/workbox-build/build/_types.js 41 B 41 B 0% 61 B
packages/workbox-build/build/index.js 3.30 KB 3.30 KB 0% 1.31 KB
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js 594 B 594 B 0% 354 B
packages/workbox-cli/build/app.js 4.15 KB 4.15 KB 0% 1.64 KB
packages/workbox-cli/build/bin.js 940 B 940 B 0% 502 B
packages/workbox-core/build/workbox-core.prod.js 5.94 KB 5.94 KB 0% 2.46 KB
packages/workbox-expiration/build/workbox-expiration.prod.js 2.94 KB 2.94 KB 0% 1.27 KB
packages/workbox-google-analytics/build/workbox-offline-ga.prod.js 1.95 KB 1.95 KB 0% 913 B
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js 660 B 660 B 0% 324 B
packages/workbox-precaching/build/workbox-precaching.prod.js 4.25 KB 4.25 KB 0% 1.70 KB
packages/workbox-range-requests/build/workbox-range-requests.prod.js 1.57 KB 1.57 KB 0% 797 B
packages/workbox-routing/build/workbox-routing.prod.js 3.41 KB 3.41 KB 0% 1.47 KB
packages/workbox-strategies/build/workbox-strategies.prod.js 4.78 KB 4.78 KB 0% 1.20 KB
packages/workbox-streams/build/workbox-streams.prod.js 1.46 KB 1.46 KB 0% 720 B
packages/workbox-sw/build/workbox-sw.js 1.34 KB 1.34 KB 0% 747 B
packages/workbox-webpack-plugin/build/generate-sw.js 3.13 KB 3.13 KB 0% 1.22 KB
packages/workbox-webpack-plugin/build/index.js 349 B 349 B 0% 255 B
packages/workbox-webpack-plugin/build/inject-manifest.js 4.67 KB 4.67 KB 0% 1.59 KB
packages/workbox-window/build/workbox-window.dev.umd.js 31.88 KB 31.88 KB +0% 8.10 KB
packages/workbox-window/build/workbox-window.prod.umd.js 4.46 KB 4.46 KB 0% 1.84 KB

Workbox Aggregate Size Plugin

3.49KB gzip'ed (23% of limit)
7.8KB uncompressed

@jeffposnick jeffposnick merged commit 55b7cbf into master Jul 17, 2019
@jeffposnick jeffposnick deleted the wb-window-private branch July 17, 2019 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants