@openui5/ts-types

@openui5/ts-types

This npm package contains the types signatures (based on deprecated globals, see below) for all the OpenUI5 libraries.

These signatures can be used to:

1. Enable advanced content assist in IDEs, e.g: (VSCode / IntelliJ / Webstorm) for OpenUI5.
2. Integrate type checking for OpenUI5 applications using the TypeScript compiler.

These two capabilities are available both for OpenUI5 apps written in TypeScript and in JavaScript.

NOTE: "based on globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is no longer recommended. In traditional JavaScript, UI5 application code should use the asynchronous sap.ui.define()/sap.ui.require() calls instead and for TypeScript code we recommend using ES6 module syntax provided by the @openui5/ts-types-esm package. So better use that one instead of this package.

Status

This project is in an experimental Beta State. Significant changes are likely to occur, including potential breaking changes.

For information on changes in the type definitions, in particular ones which require adaptation, please refer to the Release Notes.

The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://sap.github.io/ui5-typescript.

License

OpenUI5 is licensed under Apache License 2.0.