This is a repository for A-Frame typings.
Currently this repository is a work in progress and provides a basic set of typings to work with Entity and
Component. Contributors welcome <3.
Include the AFRAME.d.ts file as part of your TypeScript project. An A-Frame Boilerplate that uses these typings is available as a quick start. There is also a number of A-Frame Experiments written in TypeScript.
As we update typings, we plan to keep them up-to-date with the latest stable version of TypeScript.
The quickest way to get started with adding additional types is:
npm installgrunt watch
And viola! Every time a change is detected the project will be rebuilt.
Definitely Typed recommends that all typings are built against some code to ensure that they compile correctly. We take the additional step of running Intern, a real testing framework, against types to ensure assumptions like optional types are exercised and leaf blocks of code are tested.
Test can be run using grunt test
Versioning tracks the A-Frame version the typings were built and tested against. Multiple releases against the same
version of A-Frame (i.e. due to fixes) are denoted after the dash (-) in the version and incremented from 0;
i.e. 0.3.1-1 is the second release of typings against A-Frame version 0.3.1.