docs(api.md): expand on puppeteer-core vs puppeteer #3189
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
ebidel
suggested changes
Sep 4, 2018
docs/api.md
Outdated
| - `puppeteer-core` doesn't automatically download Chromium when installed. | ||
| - `puppeteer-core` ignores all `PUPPETEER_*` env variables. | ||
|
|
||
| In most cases, you'll be fine using the `puppeteer` package right away. |
docs/api.md
Outdated
| `puppeteer` is a *product* for browser automation. When installed, it downloads a version of | ||
| Chromium, which it then drives using `puppeteer-core`. Being an end-user product, `puppeteer` supports a bunch of convenient `PUPPETEER_*` env variables to tweak its behavior. | ||
|
|
||
| `puppetee-core` is a *library* to help drive anything that supports devtools protocol. `puppeteer-core` doesn't download Chromium when installed. Being a library, `puppeteer-core` is fully driven |
docs/api.md
Outdated
| In most cases, you'll be fine using the `puppeteer` package right away. | ||
|
|
||
| However, you should use `puppeteer-core` if: | ||
| - you're building another end-user product or library atop of DevTools protocol. For example, one might build PDF generator using `puppeteer-core` and write a custom `install.js` script that downloads [`headless_shell`](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md) instead of Chromium to save up space. |
There was a problem hiding this comment.
save up space -> save disk space.
docs/api.md
Outdated
|
|
||
| However, you should use `puppeteer-core` if: | ||
| - you're building another end-user product or library atop of DevTools protocol. For example, one might build PDF generator using `puppeteer-core` and write a custom `install.js` script that downloads [`headless_shell`](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md) instead of Chromium to save up space. | ||
| - you're bundling puppeteer to use in Chrome Extension / Browser context. `puppeteer-core` contains all the code necessary to work with DevTools protocol and doesn't download unnecessary binary. |
docs/api.md
Outdated
|
|
||
| However, you should use `puppeteer-core` if: | ||
| - you're building another end-user product or library atop of DevTools protocol. For example, one might build PDF generator using `puppeteer-core` and write a custom `install.js` script that downloads [`headless_shell`](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md) instead of Chromium to save up space. | ||
| - you're bundling puppeteer to use in Chrome Extension / Browser context. `puppeteer-core` contains all the code necessary to work with DevTools protocol and doesn't download unnecessary binary. |
There was a problem hiding this comment.
with the DevTools protocol where downloading an additional Chromium binary is unnecessary.
ebidel
approved these changes
Sep 4, 2018
aslushnikov
force-pushed
the
docs-ppcore
branch
from
92024fc
to
d3cb03f
Compare
vsemozhetbyt
reviewed
Sep 4, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.