facebook / hermes

A JavaScript engine optimized for running React Native.
https://hermesengine.dev/
MIT License
9.69k stars 621 forks source link

JS API Compatibility Documentation #701

Open tom-sherman opened 2 years ago

tom-sherman commented 2 years ago

Description

Right now the only way to figure out if a specific JS API is supported is to search the source code.

It would be great to add documentation as a reference on what can and can't be used on each Hermes version. It can also act as a source of truth for tools such as MDN and caniuse to add hermes compatibility to those docs.

ljharb commented 2 years ago

https://kangax.github.io/compat-table/es2016plus/

tom-sherman commented 2 years ago

@neildhar I see you've mentioned this issue around making feature documentation more comprehensive.

Would you be able to give a steer on what you had in mind? I'm happy to help with this where I can

henrymoulton commented 1 year ago

@neildhar just to echo what @tom-sherman, would love to help if possible, but might need a steer. Any thoughts?

neildhar commented 1 year ago

Sorry for the delay in responding. We do have some documentation here: https://github.com/facebook/hermes/blob/main/doc/Features.md which we updated late last year. And that information is supplemented by the Kangax table linked to above.

But certainly if you find major gaps (which there likely are), we would welcome an update to that documentation.