Skip to content

Commit cd5a6b7

Browse files
committed
Remove webxdc.d.ts and refer to the documentation for downloading it
1 parent e2fc7c4 commit cd5a6b7

File tree

3 files changed

+2
-202
lines changed

3 files changed

+2
-202
lines changed

.github/workflows/simulator_types.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,9 @@ Alternatively, use the more advanced [webxdc-dev](https://github.com/webxdc/webx
3737

3838
### Type-checking and completion
3939

40-
If you are using VSCode you can have autocompletion and type-checking even without using TypeScript by adding these two lines to your JavaScript source files:
40+
If you want to have type-checking and autocompletion you can use [@webxdc/types](https://github.com/webxdc/webxdc-types/) package.
41+
Refer to https://webxdc.org/docs/faq/typing.html and https://github.com/webxdc/webxdc-types/ README for the documentation on setting it up.
4142

42-
```js
43-
//@ts-check
44-
/** @typedef {import('./webxdc').Webxdc} Webxdc */
45-
```
46-
47-
Without VSCode you need to install TypeScript and then run the check manually.
48-
49-
```sh
50-
npm -g typescript
51-
tsc --noEmit --allowJs --lib es2016,dom webxdc.js # to check if types and simulator are in sync
52-
tsc --noEmit --allowJs --lib es2016,dom your_js_file.js
53-
```
5443

5544
### Developing in Safari
5645

webxdc.d.ts

Lines changed: 0 additions & 166 deletions
This file was deleted.

0 commit comments

Comments
 (0)