wcg

webidl-class-generator

Generates classes from WebIDL plus implementation code

Showing:

Popularity

Downloads/wk

10

GitHub Stars

28

Maintenance

Last Commit

7yrs ago

Contributors

1

Package

Dependencies

2

Size (min+gzip)

21.3KB

License

BSD-2-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Generate JavaScript Classes from WebIDL Interfaces

The goal of this project is to take as input

// foo.idl
interface Foo : Bar {
    [Reflect] attribute unsigned long x;
    readonly attribute long y;
    attribute DOMString z;
    boolean method(DOMString arg);

    constant unsigned short A_CONSTANT = 42;
}

plus

// foo-impl.js
export default class FooImpl {
    get y() { return Math.random() * 1000; }
    get z() { return this._z; }
    set z(v) { this._z = v; }
    method(arg) { return arg.toLowerCase(); }
}

and produce something like

// foo.js
import reflector from "webidl-html-reflector";
import conversions from "webidl-conversions";
import Impl from "./foo-impl";

export default class Foo extends Bar {
    get x() {
        return reflector["unsigned long"].get(this, "x");
    }
    set x(v) {
        v = conversions["unsigned long"](v);
        reflector["unsigned long"].set(this, "x", v);
    }

    get y() {
        const implGetter = Object.getOwnPropertyDescriptor(Impl.prototype, "y").get;
        const implResult = implGetter.call(this);
        return conversions["long"](implResult);
    }

    get z() {
        const implGetter = Object.getOwnPropertyDescriptor(Impl.prototype, "z").get;
        const implResult = implGetter.call(this);
        return conversions["DOMString"](implResult);
    }
    set z(v) {
        v = conversions["DOMString"](v);
        const implSetter = Object.getOwnPropertyDescriptor(Impl.prototype, "z").set;
        implSetter.call(this, v);
    }

    method(arg) {
        arg = conversions["DOMString"](arg);
        const implMethod = Impl.prototype.method;
        const implResult = implMethod.call(this, arg);
        return conversions["boolean"](implResult);
    }
}

Object.defineProperty(Foo, "A_CONSTANT", { value: 42, enumerable: true });
Object.defineProperty(Foo.prototype, "A_CONSTANT", { value: 42, enumerable: true });

window.Foo = Foo;

API

This package's main module's default export is a function that takes as input a WebIDL string and the implementation module name, and returns a string of JavaScript. It will parse the WebIDL, making sure that it contains a single (non-partial) interface, and then build up the resulting JavaScript. Any unsupported WebIDL features—which is most of them, right now—will generally be ignored. An example:

const fs = require("fs");
import generate from "webidl-class-generator";

const idl = fs.readFileSync("html-hr-element.idl", { encoding: "utf-8" });
const js = generate(idl, "./html-hr-element-impl.js");

fs.writeFileSync("html-hr-element.js", js);

Nonstandard Extended Attributes

A couple of non-standard extended attributes are allowed which are not part of the WebIDL specification.

[Reflect]

The [Reflect] extended attribute is implemented to call this.getAttribute or this.setAttribute and process the input our output using webidl-html-reflector, on both setting and getting. If [Reflect] is specified, the implementation class will not be consulted for the getter or setter logic.

By default the attribute passed to this.getAttribute and this.setAttribute will be the same as the name of the property being reflected. You can use the form [Reflect=custom] or [Reflect=custom_with_dashes] to change that to be "custom" or "custom-with-dashes", respectively.

[NoConversion]

The [NoConversion] extended attribute will cause any type conversions to be omitted from a getter or setter. This is mostly useful when the implementation class already does the type conversion, e.g. if implementing URLUtils it is possible that the techniques using by the implementation class will already produce USVStrings, and thus it would be undesirable to convert them all over again.

[CustomElementCallbacks]

The [CustomElementCallbacks] extended attribute can be applied to an interface to denote that it should copy over any of the custom element callbacks from the implementation class to the generated class.

Status

We only support a subset of WebIDL features; they are being added on an as-needed basis for HTML as Custom Elements. Check out the test cases for a sampling of what's supported, and the issues for upcoming ones that need work.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100