bs-webapi - npm Package Compare versions

Comparing version 0.4.1 to 0.5.0

bsconfig.json

@@ -17,2 +17,3 @@ /* This is the BuckleScript configuration file. Note that this is a comment;
             "events",
+            "geometry",
             "html",
@@ -26,3 +27,3 @@ "nodes",
         },
-        "gl",
+        "canvas",
         "storage"
@@ -48,3 +49,4 @@ ]
         },
-        "storage"
+        "storage",
+        "canvas"
       ]
@@ -51,0 +53,0 @@ }, {

package.json

 {
   "name": "bs-webapi",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Reason + BuckleScript bindings to DOM",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -5,2 +5,4 @@ # bs-webapi
 
+The bindings are currently undocumented, but as the code mostly just consists of external declarations with type signatures, the code itself is fairly self-documenting. The bindings generally also correspond very well to the Web APIs they bind to, so using MDN along with GitHub should go a long way.
+
 ## Installation
@@ -22,1 +24,40 @@ ```
 See the [examples folder](https://github.com/BuckleTypes/bs-webapi-incubator/tree/eb5f71847848a3e896733017fde00eee7fb5edf5/examples)
+
+## Some notes on the DOM API
+
+The DOM API is mostly organized into interfaces and relies heavily on inheritance. The ergonomics of the API is also heavily dependent on dynamic typing, which makes it somewhat challenging to implement a thin binding layer that is both safe and ergonomic. To achieve this we employ subtyping and implementation inheritance, concepts which aren't very idiomatic to OCaml (or Reason), but all the more beneficial to understand in order to be able to use these bindings effectively.
+
+### Subtyping
+
+The Dom types, and the relationships between them, are actually defined in the `Dom` module that ships with `bs-platform` ([Source code](https://github.com/glennsl/bucklescript/blob/master/jscomp/others/dom.mli)), where you'll find a bunch of types that look like this:
+
+```ml
+type 'a _element
+type 'a element_like = 'a _element node_like
+type element = _baseClass element_like
+```
+
+This is subtyping implemented with abstract types and phantom arguments. The details of how this works isn't very important (but see [#23](https://github.com/BuckleTypes/bs-webapi-incubator/pull/23) for a detailed explanation of how exactly this trickery works) in order to just use them, but there are a few things you should know:
+
+* If you expand the alias of a concrete DOM type, you'll discover it's actually a list of abstract types. e.g. `element` expands to `_baseClass _element _node _eventTarget_like` This means `element` is a subtype of `_element`, `_node` and `_eventTarget_like`.
+* The `_like` type are "open" (because they have a type variable). This means that a function accepting an `'a element_like` will accept any "supertype" of `element_like`. A function accepting just an `element` will only accept an `element` (Technically `element` is actually a "supertype" of `element_like` too).
+
+This system works exceptionally well, but has one significant flaw: It makes type errors even more complicated than they normally are. If you know what to look for it's not that bad, but unfortunately the formatting of these errors don't make looking for it any easier. We hope to improve that in other ways (see [BetterErrors](https://github.com/reasonml/BetterErrors))
+
+### Implementation inheritance
+
+If you've looked through the source code a bit, you've likely come across code like this:
+
+```reason
+include EventTargetRe.Impl { type nonrec t = t };
+include NodeRe.Impl { type nonrec t = t };
+include ParentNodeRe.Impl { type nonrec t = t };
+include NonDocumentTypeChildNodeRe.Impl { type nonrec t = t };
+include ChildNodeRe.Impl { type nonrec t = t };
+include SlotableRe.Impl { type nonrec t = t };
+include Impl { type nonrec t = t };
+```
+
+This is the implementation inheritance. Each "inheritable" module defines an "Impl" module where all its exported functions are defined. `include NodeRe.Impl { type nonrec t = t };` means that all the functions in `NodeRe.Impl` should be included in this module, but with the `t` type of that module replaced by the `t` type of this one. And that's it, it now has all the functions.
+
+Implementation inheritance is used instead of subtyping to make it easier to understand which functions operate on any given "subject". If you have an `element` and you need to use a function defined in `Node`, let's say `removeChild` you cannot just use `Node.removeChild`. Instead you need to use `Element.removeChild`, which you can since `Element` inherits from `Node`. As a general rule, always use the function in the module corresponding to the type you have. You'll find this makes it very easy to see what types you're dealing with just by reading the code.

No alert changes

Improved metrics

Total package byte prevSize

149560

increased by12.4%

Number of package files

132

increased by5.6%

Lines of code

55

increased by3.77%

Number of lines in readme file

62

increased by195.24%

No dependency changes