deploy_feedback icon indicating copy to clipboard operation
deploy_feedback copied to clipboard

Mention the unsupported web APIs on the Deno Docs landing page

Open ttogola opened this issue 3 years ago • 5 comments

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.

ttogola avatar Aug 04 '22 17:08 ttogola

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

timfish avatar Aug 05 '22 11:08 timfish

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

MarkBennett avatar Aug 26 '22 14:08 MarkBennett

@MarkBennett https://github.com/denoland/deploy_feedback/issues/134

vwkd avatar Sep 11 '22 17:09 vwkd

@MarkBennett #134

Thanks, I've just subscribed to that issue!

MarkBennett avatar Sep 12 '22 16:09 MarkBennett

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.

kleisauke avatar Oct 07 '23 14:10 kleisauke