vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-11 20:40:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[jquery] Add documentation describing project structure.

Browse Source
This commit is contained in:
Leonard Thieu
2017-06-23 16:43:32 -04:00
committed by GitHub
parent 4c54d08d3c
commit d8ac4fa94a
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/jquery/README.md
+15
View File
@@ -23,6 +23,21 @@ const jQuery = jQueryFactory(window, true);
Note that while the factory function ignores the second parameter, it is required to get correct type declarations.
### Project structure
- [jquery-tests.ts](jquery-tests.ts)
- Tests that exercise TypeScript-specific usage and cases not covered by other test files.
- [test/example-tests.ts](test/example-tests.ts)
- Tests generated from examples in jQuery documentation.
- [test/longdesc-tests.ts](test/longdesc-tests.ts)
- Tests generated from non-example snippets in jQuery documentation.
- [test/jquery-window-module-tests.ts](test/jquery-window-module-tests.ts)<br>
[test/jquery-slim-window-module-tests.ts](test/jquery-slim-window-module-tests.ts)
- Tests importing jQuery with a DOM available
- [test/jquery-no-window-module-tests.ts](test/jquery-no-window-module-tests.ts)<br>
[test/jquery-slim-no-window-module-tests.ts](test/jquery-slim-no-window-module-tests.ts)
- Tests importing jQuery without a DOM available
### Authoring type definitions for jQuery plugins
`$.fn` is represented by `JQuery`.