TypeScript Rollout Tier 8 - TimepickerMixin #372
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rewrites `src/utils/TimepickerMixin.js` in TypeScript. Also includes a fix of an obvious issue that the obsolete `value` prop was used. Introduces a new interface `ITimepickerMixin` which extracts the props, and computed values of `TimepickerMixin` as a super type. While `TimepickerMixin` contains itself in its type definition, we can avoid type recursive by using `ITimepickerMixin` instead; see `TimeFormatter`, and `TimeParser`. Introduces new function types: - `TimeCreator`: type of the `timeCreator` prop - `TimeFormatter`: type of the `timeFormatter` prop - `TimeParser`: type of the `timeParser` prop Introduces a new type `HourFormat` which is a union of the constants `HOUR_FORMAT_24` and `HOUR_FORMAT_12` and represents the type of the `hourFormat` prop. The following methods of `src/utils/TimepickerMixin.ts` accept `number` in addition to `string`: - `onHoursChange` - `onMinutesChange` - `onSecondsChange` The `minTime` and `maxTime` props of `TimepickerMixin` allow `null` so that they meet the requirements of `Datetimepicker`. Some tricky changes: - Applies the `valueOf` method to the `Date` argument before passing it to `isNaN`, because `isNaN` does not accept a `Date` type in TypeScript. As far as I tested on Node v18, `Date.valueOf` returned `NaN` when `isNaN` was expected to return `true`. - Performs an extra concatenation with an empty string (`+ ''`) is on some arguments given to `parseInt` to make sure they are strings. Maybe too optimistic assumptions: - While the `Intl.DateTimeFormat.resolvedOptions` returns `ResolvedDateTimeFormatOptions`, it is casted as `DateTimeFormatOptions` without checks - Supposes the `input` ref to refer to an `Input` component instance - Supposes the `dropdown` ref to refer to a `Dropdown` component instance - Supposes the `target` field of the `event` parameter of the `onChangeNativePicker` method to be an `HTMLInputElement` The `modelValue` prop allows `null`. The following changes are trivial but I want to leave reasons for them: - Replaces JSDoc comments with ordinary ones so that `@microsoft/api-extractor` won't pick them up for documentation - Overuses non-null assertions (!) to keep the original behavior
Rewrites `src/utils/TimepickerMixin.spec.js` in TypeScript. Passes "0" to the `onSecondsChange` method, because it now requires a string. Moves the definition of the test component before `wrapper` so that `wrapper` can be properly typed with `VueWrapper`. Trivial changes: - Replaces the extension: ".js" → ".ts" - Imports the spec building blocks from the `vitest` package - Replaces `jest` with `vi`
wesdevpro
approved these changes
Jan 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issues:
Proposed Changes
TimepickerMixin