From d8ac4fa94a899b17e9bb98b599d69cc8b5d4a2a7 Mon Sep 17 00:00:00 2001 From: Leonard Thieu Date: Fri, 23 Jun 2017 16:43:32 -0400 Subject: [PATCH] [jquery] Add documentation describing project structure. --- types/jquery/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/types/jquery/README.md b/types/jquery/README.md index 632805df4a..8fab451ce0 100644 --- a/types/jquery/README.md +++ b/types/jquery/README.md @@ -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)
+ [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)
+ [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`.