From 853f6fa8b78c6f4cd2fe21ac2015588e70b4466a Mon Sep 17 00:00:00 2001
From: pkupczyk <piotr.kupczyk@id.ethz.ch>
Date: Mon, 29 Jan 2024 11:19:27 +0100
Subject: [PATCH] SSDM-14283 : V3 API TS: automated tests for auto-generated
 TypeScript definition file (d.ts) - extend README with info on how to compile
 TypeScript

---
 test-api-openbis-javascript/README.txt | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/test-api-openbis-javascript/README.txt b/test-api-openbis-javascript/README.txt
index 93b40da43f6..86d397b556b 100644
--- a/test-api-openbis-javascript/README.txt
+++ b/test-api-openbis-javascript/README.txt
@@ -45,6 +45,16 @@ Otherwise you need to specify the path to your Geckodriver in makeGeckodriverExe
 Some Tips:
 ==========
 
+TypeScript:
+-----------
+
+All tests that have ".ts" extension are written in TypeScript. Therefore, before then can be run, they need to be compiled to JavaScript.
+To do that you need to execute Gradle task named "compileTypeScript" in "test-api-openbis-javascript" module.
+
+The TypeScript compilation task is run automatically as part of the main "test" task that boots up the whole JavaScript tests machinery,
+still if you develop your tests without shutting everything down, after each change of the TypeScript code you need to remember to run the TypeScript compilation again.
+Otherwise, the browser will execute an old JavaScript code that does not contain your change.
+
 Developing:
 -----------
 
-- 
GitLab