# Wonderland Engine API The bindings between Wonderland Engine's WebAssembly runtime and custom JavaScript or TypeScript components. Learn more about Wonderland Engine at [https://wonderlandengine.com](https://wonderlandengine.com). > 💡 The Wonderland Engine Runtime is compatible on all patch versions of the API, but the > major and minor versions are required to match. > > **Example:** You will be able to use Wonderland Editor 1.0.4 with API > version 1.0.0 or 1.0.9 for example, but not with API 1.1.0. 💡 ## Usage Wonderland Engine projects usually come with this package pre-installed. Install via `npm` or `yarn`: ```sh npm i --save @wonderlandengine/api # or: yarn add @wonderlandengine/api ``` To update the API to the latest version use ``` npm i --save @wonderlandengine/api@latest ``` ### Writing a Custom Component **JavaScript** ```js import {Component, Property} from '@wonderlandengine/api'; class Forward extends Component { static TypeName = 'forward'; static Properties = { speed: Property.float(1.5) }; _forward = new Float32Array(3); update(dt) { this.object.getForward(this._forward); this._forward[0] *= this.speed*dt; this._forward[1] *= this.speed*dt; this._forward[2] *= this.speed*dt; this.object.translateLocal(this._forward); } } ``` **TypeScript** ```ts import {Component} from '@wonderlandengine/api'; import {Component} from '@wonderlandengine/api/decorators.js'; class Forward extends Component { static TypeName = 'forward'; @property.float(1.5) speed!: number; private _forward = new Float32Array(3); update(dt) { this.object.getForward(this._forward); this._forward[0] *= this.speed*dt; this._forward[1] *= this.speed*dt; this._forward[2] *= this.speed*dt; this.object.translateLocal(this._forward); } } ``` For more information, please refer to the [JavaScript Quick Start Guide](https://wonderlandengine.com/getting-started/quick-start-js). ### For Library Maintainers To ensure the user of your library can use a range of API versions with your library, use `"peerDependencies"` in your `package.json`: ```json "peerDependencies": { "@wonderlandengine/api": ">= 1.0.0 < 2" }, ``` Which signals that your package works with any API version `>= 1.0.0` (choose the lowest version that provides all features you need) until `2.0.0`. Also see the [Writing JavaScript Libraries Tutorial](https://wonderlandengine.com/tutorials/writing-js-library/).