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

Mention the unsupported web APIs on the Deno Docs landing page #256

Open
ttogola opened this issue Aug 4, 2022 · 5 comments
Open

Mention the unsupported web APIs on the Deno Docs landing page #256

ttogola opened this issue Aug 4, 2022 · 5 comments

Comments

@ttogola
Copy link

ttogola commented Aug 4, 2022

Currently, anyone interested in Deno Deploy who reads the marketing page or the first few pages of the Deploy Docs might assume that anything that works in Deno will work in Deno Deploy. That is not the case, and it only becomes obvious when you run into a deployment failure or you scan the full docs until you find this runtime API Reference page:

It's different from Deno but aims to have similar APIs where applicable.

My suggestion is to make that fact stand out when entering the documentation, instead of leaving those important details buried. I found at least 2 feedback issues that were submitted because people weren't aware of the unsupported APIs.

For context, I ran into this because my toy project uses the Web Worker API. It works locally with Deno CLI, but Deno Deploy crashed with ReferenceError: Worker is not defined.

@timfish
Copy link

timfish commented Aug 5, 2022

Some of these APIs should just be stubbed out with sensible defaults. I just hit an issue with navigator.hardwareConcurrency not existing.

@MarkBennett
Copy link

This would be a good opportunity to make the Deno Deploy docs into a public repo so the community can contribute pull requests.

@vwkd
Copy link

vwkd commented Sep 11, 2022

@MarkBennett #134

@MarkBennett
Copy link

@MarkBennett #134

Thanks, I've just subscribed to that issue!

@kleisauke
Copy link

FWIW, https://workers.js.org/#browser-apis provides a comprehensive list of browser APIs supported across various worker runtimes, which could also be used as a reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants