bugsnag / bugsnag-js

JavaScript error handling tool for BugSnag. Monitor and report JavaScript bugs & errors.
https://docs.bugsnag.com/platforms/javascript
MIT License
850 stars 251 forks source link

Documentation bug: web-worker does not declare @bugsnag/core as a dependency. #2175

Open subdavis opened 1 month ago

subdavis commented 1 month ago

Describe the bug

According to this documentation, Bugsnag web worker can be used standalone, but it requires install of @bugsnag/core as well.

https://docs.bugsnag.com/platforms/javascript/web-workers/

Steps to reproduce

Attempt to run typescript compiler on documented example code.

  Bugsnag.start({
    apiKey: '',
  })

produces error because of missing type defintions from bugsnag core.

Object literal may only specify known properties, and 'apiKey' does not exist in type 'WorkerConfig'.

Environment

Example code snippet

See example code above.

hannah-smartbear commented 1 month ago

Hi @subdavis

Our engineers are investigating this. We will be sure to let you know of any updates or fixes.