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

ZoneSpecification and related types are underdocumented #44669

Open
Hixie opened this issue Jan 14, 2021 · 0 comments
Open

ZoneSpecification and related types are underdocumented #44669

Hixie opened this issue Jan 14, 2021 · 0 comments
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-core type-documentation A request to add or improve documentation

Comments

@Hixie
Copy link
Contributor

Hixie commented Jan 14, 2021

I was trying to figure out how to catch all errors (sync and async) thrown while running a function. I figured out I probably want Zone.current.fork().runGuarded(), but when trying to figure out the arguments to fork I found that the following APIs are undocumented or underdocumented:

  • ZoneSpecification constructors don't explain their arguments
  • ZoneSpecification properties have no documentation
  • The typedefs used in those properties, such as CreatePeriodicTimerHandler, CreateTimerHandler, ErrorCallbackHandler, etc, have no documentation
  • The class itself doesn't say what the difference between errorCallback and handleUncaughtError is

See also #26455, #26454, #17667.

@devoncarew devoncarew added area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-core type-documentation A request to add or improve documentation labels Jan 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-core type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

2 participants