Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] README indicates the lowest supported TypeScript version #2251

Merged
merged 3 commits into from
Sep 16, 2022
Merged

[DOC] README indicates the lowest supported TypeScript version #2251

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78208ea
[DOC] Doc the lowest TS version needed by bpmn-visualization
tbouffard Sep 16, 2022
b1e3e9b
highlight sentence
tbouffard Sep 16, 2022
e78a532
improve wording
tbouffard Sep 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,11 @@ You can set the BPMN content using one of the following ways:

#### 📜 TypeScript Support

`bpmn-visualization` provides type definitions, so the integration should work out of the box in TypeScript projects.
`bpmn-visualization` provides type definitions, so the integration works out of the box in TypeScript projects.

Depending on the build system used by the TypeScript project, it may get the following type errors:
`bpmn-visualization` requires **TypeScript 4.5** or greater.

Depending on the TypeScript configuration of the project, the following errors can occur:
- error TS2688: Cannot find type definition file for 'typed-mxgraph'
- error TS7016: Could not find a declaration file for module 'mxgraph'

Expand Down