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

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

Open
subdavis opened this issue Jul 24, 2024 · 1 comment
Labels
needs discussion Requires internal analysis/discussion

Comments

@subdavis
Copy link

subdavis commented Jul 24, 2024

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

  • Bugsnag version: 7.25.0

Example code snippet

See example code above.

@subdavis subdavis changed the title web-worker typescript type definitions are all wrong. web-worker does not declare @bugsnag/core as a dependency. Jul 24, 2024
@subdavis subdavis changed the title web-worker does not declare @bugsnag/core as a dependency. Documentation bug: web-worker does not declare @bugsnag/core as a dependency. Jul 24, 2024
@hannah-smartbear hannah-smartbear added the needs discussion Requires internal analysis/discussion label Jul 29, 2024
@hannah-smartbear
Copy link

Hi @subdavis

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs discussion Requires internal analysis/discussion
Projects
None yet
Development

No branches or pull requests

2 participants