docs: add user flow docs #13134
docs: add user flow docs #13134
Conversation
patrickhulce
requested review from
connorjclark
and removed request for
a team
|
|
docs/user-flows.md
Outdated
| async function main() { | ||
| const browser = await puppeteer.launch(); | ||
| const page = await browser.newPage(); | ||
| const flow = new lighthouse.UserFlow(page); |
There was a problem hiding this comment.
nit: should we expose a newUserFlow? perhaps exposing the api via a class isn't necessary / ideal. idk
There was a problem hiding this comment.
cc @adamraine thoughts?
There was a problem hiding this comment.
The ES6 class made the most sense to me, is the benefit here that it matches the puppeteer methods?
There was a problem hiding this comment.
I think @connorjclark is referring to the public entrypoint being something non-constructor based, not that we should move away from the class itself.
I have to agree constructor-based public APIs feel gross to me for a node library, but admittedly I don't have a compelling case for why, so I'm fine with either.
There was a problem hiding this comment.
Aight I slept on this one and a function entry point SGTM.
Summary
Adds some user flow documentation and explainers for the different modes. Feedback welcome :)
Related Issues/PRs
ref #11313