feat(types): create peertube-types package

[github/Chocobozzz/PeerTube.git] / support / doc / development / lib.md

diff --git a/support/doc/development/lib.md b/support/doc/development/lib.md
index 6b0372150fc2ac989d8e860fdc3512a851ba7f77..9c67a39dd82fd7e682572b65f96cb94156e3ded6 100644 (file)
--- a/support/doc/development/lib.md
+++ b/support/doc/development/lib.md
@@ -8,3 +8,16 @@
 $ cd client/src/standalone/player/
 $ npm run build
 ```
+
+## @peertube/peertube-types
+
+Typescript definition files generation is controlled by the various `tsconfig.types.json` files, see:
+```
+yarn tsc -b --verbose tsconfig.types.json
+```
+
+But the complete types package is generated via:
+```
+yarn generate-types-package
+```
+> See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details.