aframe-typescript
TypeScript icon, indicating that this package has built-in type declarations

0.9.0-dev • Public • Published

A-Frame TypeScript

npm version npm version github twitter mastodon ko-fi

This project contains helpers to make shaping the types of A-Frame components, systems in TypeScript projects easier when using aframe-types typings.

The helpers are exported as a set of functions that can be chained to further tweak the exact types of Components and Systems even in trickier situations. The helpers themselves are mostly identity functions with no behaviour. It should hardly increase your bundle size.

Note: These helpers should only be used when creating applications or libraries with aframe-typescript. In case you're working on typings for existing aframe projects, you won't need the helpers.

Testing

This project contains a handful of test cases to both test the helpers and aframe-types itself. Since there is no behaviour to test, just typings the current procedure relies on executing tsc in the test folder.

cd typescript-helpers/tests/
npx tsc

It's expected that this will show errors. Important is that the summary only shows errors in the failure cases located under tests/failures.

Note: the tests are setup to work with the aframe-types version in the same mono-repo, so not the version from the package.json used to build the typescript-helpers against.

Readme

Keywords

none

Package Sidebar

Install

npm i aframe-typescript

Weekly Downloads

37

Version

0.9.0-dev

License

none

Unpacked Size

2.95 kB

Total Files

4

Last publish

Collaborators

  • mrxz