From 1e80e425730467ae64917f2a143791cb8a25b2cc Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Thu, 19 Nov 2020 09:09:57 -0800 Subject: [PATCH] fix(types): remove "undefined" dispatched events --- .travis.yml | 4 +++- COMPONENT_INDEX.md | 21 ++++++++------------ docs/src/COMPONENT_API.json | 13 +++++------- tests/carbon-components-svelte-tests.svelte | 2 +- types/DatePicker/DatePicker.d.ts | 1 - types/Tile/SelectableTile.d.ts | 1 - types/Tooltip/Tooltip.d.ts | 1 - types/UIShell/GlobalHeader/HeaderAction.d.ts | 1 - 8 files changed, 17 insertions(+), 27 deletions(-) diff --git a/.travis.yml b/.travis.yml index 21f72b4a..0f44cad7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,6 @@ language: node_js node_js: 12 cache: yarn -script: yarn prepack +script: + - yarn check-types + - yarn prepack diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index b62685a7..d98975fe 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -870,7 +870,6 @@ None. | mouseenter | forwarded | -- | | mouseleave | forwarded | -- | | change | dispatched | -- | -| undefined | dispatched | -- | ## `DatePickerInput` @@ -1396,7 +1395,6 @@ None. | :--------- | :--------- | :----- | | click | forwarded | -- | | close | dispatched | -- | -| undefined | dispatched | -- | ## `HeaderActionLink` @@ -2861,14 +2859,13 @@ None. ### Events -| Event name | Type | Detail | -| :--------- | :--------- | :----- | -| click | forwarded | -- | -| mouseover | forwarded | -- | -| mouseenter | forwarded | -- | -| mouseleave | forwarded | -- | -| keydown | forwarded | -- | -| undefined | dispatched | -- | +| Event name | Type | Detail | +| :--------- | :-------- | :----- | +| click | forwarded | -- | +| mouseover | forwarded | -- | +| mouseenter | forwarded | -- | +| mouseleave | forwarded | -- | +| keydown | forwarded | -- | ## `SideNav` @@ -4090,9 +4087,7 @@ None. ### Events -| Event name | Type | Detail | -| :--------- | :--------- | :----- | -| undefined | dispatched | -- | +None. ## `TooltipDefinition` diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index ee7e1382..7bddd650 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -3405,8 +3405,7 @@ { "type": "forwarded", "name": "mouseover", "element": "div" }, { "type": "forwarded", "name": "mouseenter", "element": "div" }, { "type": "forwarded", "name": "mouseleave", "element": "div" }, - { "type": "dispatched", "name": "change" }, - { "type": "dispatched" } + { "type": "dispatched", "name": "change" } ], "typedefs": [], "rest_props": { "type": "Element", "name": "div" } @@ -7631,7 +7630,7 @@ { "type": "forwarded", "name": "mouseleave", "element": "TagSkeleton" } ], "typedefs": [], - "rest_props": { "type": "InlineComponent", "name": "TagSkeleton" } + "rest_props": { "type": "Element", "name": "div | span" } }, { "moduleName": "TextArea", @@ -8515,8 +8514,7 @@ { "type": "forwarded", "name": "mouseover", "element": "label" }, { "type": "forwarded", "name": "mouseenter", "element": "label" }, { "type": "forwarded", "name": "mouseleave", "element": "label" }, - { "type": "forwarded", "name": "keydown", "element": "label" }, - { "type": "dispatched" } + { "type": "forwarded", "name": "keydown", "element": "label" } ], "typedefs": [], "rest_props": { "type": "Element", "name": "label" } @@ -9302,7 +9300,7 @@ "slot_props": "{}" } ], - "events": [{ "type": "dispatched" }], + "events": [], "typedefs": [], "rest_props": { "type": "Element", "name": "div" } }, @@ -9596,8 +9594,7 @@ ], "events": [ { "type": "forwarded", "name": "click", "element": "button" }, - { "type": "dispatched", "name": "close" }, - { "type": "dispatched" } + { "type": "dispatched", "name": "close" } ], "typedefs": [], "rest_props": { "type": "Element", "name": "button" } diff --git a/tests/carbon-components-svelte-tests.svelte b/tests/carbon-components-svelte-tests.svelte index 38f82cf6..02adb871 100644 --- a/tests/carbon-components-svelte-tests.svelte +++ b/tests/carbon-components-svelte-tests.svelte @@ -3,7 +3,7 @@ import { Tag } from "../types"; // example of a direct import - import TagSkeleton from "../types/Tag/Tag.Skeleton"; + import TagSkeleton from "../types/Tag/TagSkeleton"; diff --git a/types/DatePicker/DatePicker.d.ts b/types/DatePicker/DatePicker.d.ts index 7e950345..53cb7312 100644 --- a/types/DatePicker/DatePicker.d.ts +++ b/types/DatePicker/DatePicker.d.ts @@ -72,6 +72,5 @@ export default class DatePicker { $on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void; $on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void; $on(eventname: "change", cb: (event: CustomEvent) => void): () => void; - $on(eventname: "undefined", cb: (event: CustomEvent) => void): () => void; $on(eventname: string, cb: (event: Event) => void): () => void; } diff --git a/types/Tile/SelectableTile.d.ts b/types/Tile/SelectableTile.d.ts index 7d6b9f1a..5ba51e8a 100644 --- a/types/Tile/SelectableTile.d.ts +++ b/types/Tile/SelectableTile.d.ts @@ -67,6 +67,5 @@ export default class SelectableTile { $on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void; $on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void; $on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void; - $on(eventname: "undefined", cb: (event: CustomEvent) => void): () => void; $on(eventname: string, cb: (event: Event) => void): () => void; } diff --git a/types/Tooltip/Tooltip.d.ts b/types/Tooltip/Tooltip.d.ts index eb9cdf21..aebc8a3b 100644 --- a/types/Tooltip/Tooltip.d.ts +++ b/types/Tooltip/Tooltip.d.ts @@ -88,6 +88,5 @@ export default class Tooltip { triggerText: {}; }; - $on(eventname: "undefined", cb: (event: CustomEvent) => void): () => void; $on(eventname: string, cb: (event: Event) => void): () => void; } diff --git a/types/UIShell/GlobalHeader/HeaderAction.d.ts b/types/UIShell/GlobalHeader/HeaderAction.d.ts index 7075079c..cdf1bad3 100644 --- a/types/UIShell/GlobalHeader/HeaderAction.d.ts +++ b/types/UIShell/GlobalHeader/HeaderAction.d.ts @@ -34,6 +34,5 @@ export default class HeaderAction { $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void; $on(eventname: "close", cb: (event: CustomEvent) => void): () => void; - $on(eventname: "undefined", cb: (event: CustomEvent) => void): () => void; $on(eventname: string, cb: (event: Event) => void): () => void; }