@kaaiot/services
Version:
Type definitions for KaaIoT platform REST API service communication
24 lines (12 loc) • 1.11 kB
Markdown
# Kaa IoT Platform API TypeScript types
TypeScript types for [KaaIoT Platform](https://www.kaaiot.com/docs) API Clients aimed at giving the possibility to build custom TypeScript-compatible external widget plugins for KaaIoT platform UI.
In order to embed and try using custom external plugin for Kaa, register on [KaaIoT Cloud](https://cloud.kaaiot.com/).
Read more about the KaaIoT plugin widgets [here](https://www.kaaiot.com/docs/web-ui/custom-widgets).
## Installation and usage
In the root directory of the widget plugin project run:
```npm install --save-prod @kaaiot/services```
After the successful installation it will be possible to use Kaa API Clients in TypeScript projects.
## Available starter kits
In order to make the first acquaintance with KaaIoT custom widgets and their development process easier, we have prepared basic project configurations with [Webpack](https://webpack.js.org/) and [Rollup](https://rollupjs.org/guide/en/) bundlers:
- [Webpack starter](https://github.com/kaaproject/kaa-widget-webpack)
- [Rollup starter](https://github.com/kaaproject/kaa-widget-rollup)