Skip to content

Commit 73d76c1

Browse files
authored
🤖 Merge PR DefinitelyTyped#73264 [openui5] Update readme text by @akudev
1 parent 87f179b commit 73d76c1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

types/openui5/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ For information on changes in the type definitions, in particular ones which req
1111

1212
## Only Use With an Additional Build Step
1313

14-
These definition files are <b>meant to be used together with an additional build step</b> that transforms the imports of ES modules into classic UI5 module loading (`sap.ui.define(...)`). See the [small TypeScript sample project](https://github.com/SAP-samples/ui5-typescript-helloworld) and the [step-by-step setup explanation](https://github.com/SAP-samples/ui5-typescript-helloworld/blob/main/step-by-step.md) in that project as well as [this larger project](https://github.com/SAP-samples/ui5-cap-event-app/blob/typescript/docs/typescript.md) for details.<br>
15-
These definition files do not provide type information for globals (like `sap.m.Button`) because the use of these globals are discouraged.
14+
These definition files are <b>meant to be used in application code together with an additional build step</b> that transforms the imports of ES modules into classic UI5 module loading (`sap.ui.define(...)`). See the [small TypeScript sample project](https://github.com/SAP-samples/ui5-typescript-helloworld) and the [step-by-step setup explanation](https://github.com/SAP-samples/ui5-typescript-helloworld/blob/main/step-by-step.md) in that project as well as [this larger project](https://github.com/SAP-samples/ui5-cap-event-app/blob/typescript/docs/typescript.md) for details.<br>
15+
These definition files do not provide type information for globals (like `sap.m.Button`) because the use of these globals is discouraged and deprecated.
1616

1717

1818
## Definitions are Generated
1919

20-
These definition files are <b>generated</b> out of the OpenUI5 JSDoc. In case of issues, either the generator or the JSDoc in the [original OpenUI5 repository](https://github.com/SAP/openui5) need to be fixed, not the definition files in this repository. So please do not create pull requests for definition files here (unless they are just meant for demonstration purposes). Instead, while the latest version of the generator is not yet available at GitHub, you can [contribute fixes to OpenUI5](https://github.com/SAP/openui5/blob/master/CONTRIBUTING.md#contribute-code).
20+
These definition files are <b>generated</b> from the OpenUI5 JSDoc. In case of issues, either the generator or the JSDoc in the [original OpenUI5 repository](https://github.com/SAP/openui5) need to be fixed, not the definition files in this repository. So please do not create pull requests for definition files here (unless they are for demonstration purposes). Instead, either [contribute fixes to OpenUI5 JSDoc](https://github.com/SAP/openui5/blob/master/CONTRIBUTING.md#contribute-code) or [to the dts-generator](https://github.com/UI5/typescript/tree/main/packages/dts-generator), which creates the type definitions from the JSDoc - depending on where the issue is caused.
2121

2222
When spotting weaknesses in the definition files, consider that it's not trivial to express a huge JavaScript API which has grown over 10+ years in optimal TypeScript which is produced by a generator. Hence, not all proposals can be implemented. That said, improvement suggestions are of course welcome!
2323

@@ -39,10 +39,10 @@ They are created the same way, from the same sources, <b>but there is a differen
3939
> The patch version of the type declaration package is unrelated to the library patch version
4040
4141
The reasoning behind this is that with semantic versioning, the API will remain the same for all patch releases of the same major/minor version. As an example: there is no API change between OpenUI5 1.90.0 and OpenUI5 1.90.8. Therefore there is no need to publish new type definitions for OpenUI5 1.90.8 (and 1.90.7, 1.90.6 and so on).<br>
42-
The only exception when we might still create new patch releases at DefinitelyTyped is when there are significant improvements or fixes in the documentation or in the definition generator. Release 1.115.1 is the first time this has happened since the first new and improved release 1.90.0.
42+
The only exception when we might still create new patch releases at DefinitelyTyped is when there are significant improvements or fixes in the documentation or in the definition generator. Release 1.115.1 is the first time this has happened since the first new and improved release 1.90.0 and at least until 1.138.0 there has not been any other instance of such an extra release.
4343

4444
Long story short:
45-
* For ease of consumption and most probably matching definitions, use the latest major/minor-matching version of `@types/openui5`. Also see the section below about the referenced jQuery and QUnit types.
45+
* For ease of consumption and most probably matching definitions, you can use the latest major/minor-matching version of `@types/openui5`. Also see the section below about the referenced jQuery and QUnit types.
4646
* Only in case of problems (also see potential jQuery-related problems in the section below), for perfectly matching definitions, use the version of [`@openui5/types`](https://www.npmjs.com/package/@openui5/types) which is identical to the used OpenUI5 version.
4747

4848

@@ -83,4 +83,4 @@ Our goal is to reduce the number of disabled tslint rules, but due to years of U
8383

8484
## Copyright
8585

86-
Copyright (c) 2023 SAP SE or an SAP affiliate company and OpenUI5 contributors.
86+
Copyright (c) 2025 SAP SE or an SAP affiliate company and OpenUI5 contributors.

0 commit comments

Comments
 (0)