diff --git a/types/simulant/index.d.ts b/types/simulant/index.d.ts new file mode 100644 index 0000000000..ff2aee4b40 --- /dev/null +++ b/types/simulant/index.d.ts @@ -0,0 +1,14 @@ +// Type definitions for simulant 0.2 +// Project: https://github.com/Rich-Harris/simulant#readme +// Definitions by: Elizabeth Craig +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace event { + function fire(el: Node, e: Event): void; + function fire(el: Node, e: string, payload?: { [key: string]: any }): void; +} + +declare function event(eventName: string, payload?: { [key: string]: any }): Event; +declare function event(window: Window, eventName: string, payload?: { [key: string]: any }): Event; + +export = event; diff --git a/types/simulant/simulant-tests.ts b/types/simulant/simulant-tests.ts new file mode 100644 index 0000000000..6e0c8f70e2 --- /dev/null +++ b/types/simulant/simulant-tests.ts @@ -0,0 +1,16 @@ +import * as simulant from 'simulant'; + +simulant(window, 'click'); // $ExpectType Event +simulant(window, 'click', { foo: 'bar' }); // $ExpectType Event + +simulant('click'); // $ExpectType Event +simulant('click', { foo: 'bar' }); // $ExpectType Event + +const div = document.createElement('div'); + +simulant.fire(document, new MouseEvent('click')); // $ExpectType void +simulant.fire(div, new MouseEvent('click')); // $ExpectType void + +simulant.fire(document, 'click'); // $ExpectType void +simulant.fire(div, 'click'); // $ExpectType void +simulant.fire(div, 'click', { foo: 'bar' }); // $ExpectType void diff --git a/types/simulant/tsconfig.json b/types/simulant/tsconfig.json new file mode 100644 index 0000000000..97a52d4c08 --- /dev/null +++ b/types/simulant/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "simulant-tests.ts" + ] +} diff --git a/types/simulant/tslint.json b/types/simulant/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/simulant/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }