iobroker-typings v1.0.0

ioBroker-typings

TypeScript declarations for ioBroker adapter developers

Usage:

npm i --save-dev iobroker-typings

Declare your adapter instance as an ioBroker.adapter and have access to Intellisense for all methods.

JavaScript:

/** @type {ioBroker.Adapter} */
const adapter = utils.adapter({ /* ... */ });

TypeScript:

In TypeScript, you should either use a TS version of utils.js, or cast the return value of utils.adapter:

// Variant 1: special utils.ts
const adapter = utils.adapter({ /* ... */ });
// Variant 2: cast
const adapter = utils.adapter({ /* ... */ }) as ioBroker.Adapter;

Changelog

1.0.0

• (AlCalzone) Copied initially from iobroker.tradfri

License

The MIT License (MIT)

Copyright (c) 2017 AlCalzone d.griesel@gmx.net

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.