Separate out "public API" utils from private ones #52

domenic · 2017-08-19T05:45:11Z

In particular, jsdom at least uses:

wrapperForImpl
implForWrapper
tryWrapperForImpl
tryImplForWrapper

But it imports these from the same generated utils.js file that also exports a bunch of other stuff, like mixin, implSymbol, iterInteralSymbol, etc.

Instead we should have something like webidl2js-utils.js (public API, those above) and webidl2js-wrapper-helpers.js (private API, the rest). Of course, webidl2js-wrapper-helpers.js can re-export the contents of webidl2js-utils.js so that the wrappers only have to import one file.

Then we can document the public ones.

Now includes the generated wrapper class file API, guidance on writing implementation class files, and documentation for the generated utils.js file. See #52, #53, #54, #55, and #56 for oddities discovered during the course of writing this, which we hope to clean up later. (Many of them having to do with functionality that should not be considered public, and as such is not documented here, but is exposed as if it were public.)

domenic mentioned this issue Sep 30, 2017

Fix mixins, stringifiers, and static attributes #68

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Separate out "public API" utils from private ones #52

Separate out "public API" utils from private ones #52

domenic commented Aug 19, 2017 •

edited

Loading

Separate out "public API" utils from private ones #52

Separate out "public API" utils from private ones #52

Comments

domenic commented Aug 19, 2017 • edited Loading

domenic commented Aug 19, 2017 •

edited

Loading