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

Separate JsObjectType implementors to their own module #2080

Closed
jedel1043 opened this issue May 20, 2022 · 4 comments
Closed

Separate JsObjectType implementors to their own module #2080

jedel1043 opened this issue May 20, 2022 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@jedel1043
Copy link
Member

jedel1043 commented May 20, 2022

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 jedel1043 added the enhancement New feature or request label May 20, 2022
@jedel1043 jedel1043 added this to the v0.15.0 milestone May 20, 2022
@jedel1043 jedel1043 added the good first issue Good for newcomers label May 20, 2022
@Razican Razican modified the milestones: v0.15.0, v0.16.0 Jun 1, 2022
@jonah-saltzman
Copy link

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

@jedel1043
Copy link
Member Author

@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.

@Razican Razican modified the milestones: v0.16.0, v0.17.0 Sep 19, 2022
@CalliEve
Copy link
Contributor

CalliEve commented Oct 1, 2022

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

@jedel1043
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants