diff --git a/docs/TypeScript_FAQ_8439949.md b/docs/TypeScript_FAQ_8439949.md index bf359677..fa6c01f2 100644 --- a/docs/TypeScript_FAQ_8439949.md +++ b/docs/TypeScript_FAQ_8439949.md @@ -10,48 +10,37 @@ view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/843994 ## TypeScript FAQ -*** - - - -### Contents - -- [What is TypeScript about?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__whatists) -- [What is the overall approach for using TypeScript in OpenUI5 applications?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__approach) -- [How to set up a new OpenUI5 app for TypeScript development?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__howto) -- [How can I get an end-to-end hands-on impression of creating and developing a OpenUI5 app in TypeScript?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__handson) -- [How to develop custom controls in TypeScript?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__customcontrols) -- [How to test in TypeScript?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__test) -- [How to profit from TypeScript even when doing plain JavaScript development?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__profitfromts) -- [Are the type definitions ready for productive use?](TypeScript_FAQ_8439949.md#loio8439949bbdc34141bd2b9194f91d42c2__productiveuse) +Frequently asked questions regarding TypeScript in OpenUI5. *** - + -### FAQ - -*** - -#### What is TypeScript about? +### What is TypeScript about? TypeScript is an extension of JavaScript that enhances it with type information, enabling error detection through type checking and providing code assistance in numerous supporting code editors \(such as code completion and inline documentation\). It's important to note that browsers cannot directly execute TypeScript; a transpilation step is required. *** -#### What is the overall approach for using TypeScript in OpenUI5 applications? + + +### What is the overall approach for using TypeScript in OpenUI5 applications? We publish type definition files describing all the OpenUI5 APIs and types. With the help of these definitions, the TypeScript tools can do their job and support writing OpenUI5 apps in TypeScript. *** -#### How to set up a new OpenUI5 app for TypeScript development? + + +### How to set up a new OpenUI5 app for TypeScript development? For detailed information on developing applications with OpenUI5, see [Developing Apps](Developing_Apps_23cfd95.md). To write OpenUI5 apps in TypeScript and take advantage of its benefits, you also need to add TypeScript and the OpenUI5 type definitions as dev dependencies. Additionally, you must set up the TypeScript transpilation step. The [`ui5-typescript-helloworld`](https://github.com/SAP-samples/ui5-typescript-helloworld/blob/main/step-by-step.md) project can serve as copy template and provides a detailed step-by-step guide for setting up a TypeScript project. *** -#### How can I get an end-to-end hands-on impression of creating and developing a OpenUI5 app in TypeScript? + + +### How can I get an end-to-end hands-on impression of creating and developing a OpenUI5 app in TypeScript? You can follow the [`ui5-typescript`](https://github.com/SAP-samples/ui5-typescript-tutorial) tutorial, starting from scratch using an app template, extending the resulting app, and also covering advanced topics later on, like control development and integrating third-party libraries from npm. @@ -63,25 +52,35 @@ To start even faster, see one of the following app templates: *** -#### How to develop custom controls in TypeScript? + -You can check the [TypeScript Guidelines](TypeScript_Guidelines_192397d.md). +### How to test in TypeScript? + +You can check the `testing` branch of the [`ui5-typescript-helloworld`](https://github.com/SAP-samples/ui5-typescript-helloworld/tree/testing) sample app. *** -#### How to test in TypeScript? + + +### How to develop custom controls in TypeScript? -You can see the `testing` branch of the [`ui5-typescript-helloworld`](https://github.com/SAP-samples/ui5-typescript-helloworld/tree/testing) sample app. +Check the [TypeScript Guidelines](TypeScript_Guidelines_192397d.md). *** -#### How to profit from TypeScript even when doing plain JavaScript development? + -You can see the `js-with-typescript-support` branch of the [`ui5-cap-event-app`](https://github.com/SAP-samples/ui5-cap-event-app/blob/js-with-typescript-support/README.md) sample app. It explains how to add TypeScript-based benefits to an existing JavaScript app without actually switching to TypeScript development. +### How to profit from TypeScript even when doing plain JavaScript development? + +Check the `js-with-typescript-support` branch of the [`ui5-cap-event-app`](https://github.com/SAP-samples/ui5-cap-event-app/blob/js-with-typescript-support/README.md) sample app. It explains how to add TypeScript-based benefits to an existing JavaScript app without actually switching to TypeScript development. *** -#### Are the type definitions ready for productive use? + + +### Are the type definitions ready for productive use? They are ready for use since version 1.116. +*** + diff --git a/docs/TypeScript_Support_a7ee961.md b/docs/TypeScript_Support_a7ee961.md index 050eb702..a2f35a11 100644 --- a/docs/TypeScript_Support_a7ee961.md +++ b/docs/TypeScript_Support_a7ee961.md @@ -73,6 +73,6 @@ npm Packages \(check the individual packages for licensing information\): - [SAPUI5 type signatures on npm](https://www.npmjs.com/package/@sapui5/types) - [OpenUI5 type signatures on npm](https://www.npmjs.com/package/@openui5/types) -- **[TypeScript FAQ](TypeScript_FAQ_8439949.md "")** - +- **[TypeScript FAQ](TypeScript_FAQ_8439949.md "Frequently asked questions regarding TypeScript in OpenUI5. ")** +Frequently asked questions regarding TypeScript in OpenUI5.