boa icon indicating copy to clipboard operation
boa copied to clipboard

Separate `JsObjectType` implementors to their own module

Open jedel1043 opened this issue 2 years ago • 2 comments

Our safe wrappers around Javascript objects are not easily identifiable by looking at the docs, as you can see from the next screenshot:

image

I would propose moving all implementors of the JsObjectType trait to a standalone module and point to that module in the home page of our documentation.

jedel1043 avatar May 20 '22 03:05 jedel1043

I was interested in trying this issue out but it looks like it's already been done? Although I may be missing something because I only see 4 impls of JsObjectType in the whole repo

jonah-saltzman avatar Jun 25 '22 19:06 jonah-saltzman

@jonah-saltzman Not really. If you check the doc website, all the implementors are listed along JsObject, Object, ConstructorBuilder, etc.

https://boa-dev.github.io/boa/doc/boa_engine/object/index.html

Ideally, the implementors should be on their own module, and the module should document that these are wrappers for Javascript built-in objects.

jedel1043 avatar Jun 25 '22 19:06 jedel1043

Hi! I am interested in this issue and would like to work on it, if that's alright?

CalliEve avatar Oct 01 '22 10:10 CalliEve

@CalliEve Please do! I'll assign you the issue, let us know if you have any questions or if you need some guidance ☺️

jedel1043 avatar Oct 01 '22 19:10 jedel1043