add consistent types to functions #1245
Conversation
Signed-off-by: Micah Chiang <[email protected]>
micahchiang
changed the title
|
|
||
| private dismiss = () => { | ||
| private dismiss = (): string => { |
There was a problem hiding this comment.
This returns void, not a string.
| private validateBreadcrumbs(breadcrumbList: Breadcrumb[] | string) { | ||
| private validateBreadcrumbs( | ||
| breadcrumbList: Breadcrumb[] | string, | ||
| ): boolean | Breadcrumb[] { |
There was a problem hiding this comment.
If you make the return type : false | Breadcrumb[] it will simplify the logic above (separate comment there).
| @@ -69,9 +69,10 @@ export class VaBreadcrumbs { | |||
| @Watch('breadcrumbList') | |||
| watchBreadcrumbListHandler(breadcrumbList) { | |||
| if (!this.breadcrumbList?.length) return; | |||
| let potentialBreadcrumbs = this.validateBreadcrumbs(breadcrumbList); | |||
| let potentialBreadcrumbs: Breadcrumb[] | boolean = | |||
There was a problem hiding this comment.
If you adjust the return type for validateBreadcrumbs to be false | Breadcrumb[] then you don't need to specify the type of potentialBreadcrumbs explicitly.
| if (potentialBreadcrumbs) { | ||
| this.updateBreadCrumbList(potentialBreadcrumbs); | ||
| this.updateBreadCrumbList(potentialBreadcrumbs as Breadcrumb[]); |
There was a problem hiding this comment.
If you adjust the return type as stated above, you can remove as Breadcrumb[] here.
| @@ -237,10 +240,11 @@ export class VaBreadcrumbs { | |||
| if (this.uswds) { | |||
| if (!this.breadcrumbList?.length) return; | |||
|
|
|||
| let potentialBreadcrumbs = this.validateBreadcrumbs(this.breadcrumbList); | |||
| let potentialBreadcrumbs: Breadcrumb[] | boolean = | |||
There was a problem hiding this comment.
Same as above, can remove typing here if you adjust validateBreadcrumbs.
|
|
||
| if (potentialBreadcrumbs) { | ||
| this.updateBreadCrumbList(potentialBreadcrumbs); | ||
| this.updateBreadCrumbList(potentialBreadcrumbs as Breadcrumb[]); |
| @@ -300,17 +301,16 @@ const removeOldPreviews = (dropTarget, instructions) => { | |||
| * @param {Object} fileNames - The selected files found in the fileList object. | |||
| * @param {Array} fileStore - The array of uploaded file names created from the fileNames object. | |||
| */ | |||
| const updateStatusMessage = (statusElement, fileNames, fileStore) => { | |||
| const updateStatusMessage = (statusElement: HTMLDivElement | Element, fileNames: FileList | File[], fileStore: string[]): void => { | |||
There was a problem hiding this comment.
This can be simplified to statusElement: Element as every element will match that type.
| const multiple = fileInputEl.getAttribute('multiple'); // TODO: Double-check this works correctly when multiple is re-enabled | ||
| const fileNames = multiple ? e.target.files : [e.target.files[0]]; | ||
| const fileNames = multiple ? (e.target as HTMLInputElement).files : [(e.target as HTMLInputElement).files[0]]; |
There was a problem hiding this comment.
Instead of casting the type twice, you could store e.target as a separate variable and cast it once maybe?
| @@ -148,12 +149,12 @@ export const days = { | |||
| * Return true if the year is a leap year. | |||
| * (Exported for testing purposes) | |||
| */ | |||
| export function checkLeapYear(year: number) { | |||
| export function checkLeapYear(year: number): boolean { | |||
There was a problem hiding this comment.
I'd love to rename this to isLeapYear but that may be more trouble than it's worth for what's essentially a personal preference.
Chromatic
https://mc-ts-updates--65a6e2ed2314f7b8f98609d8.chromatic.com
Description
Some of our functions contain things like return types and parameter types while others do not. Many functions also include JSDoc annotations that include parameter types and descriptions. While this is helpful, it doesn't necessarily provide the static type checking we may want from Typescript.
For example, the
replaceNamefunction in our instance of the file input upgrader. While thesparameter is given theStringtype in its JSDoc comment, it's never assigned a type in the parameter list and defaults toany, which introduces a potential silent failure like this:Assigning the
sparameter an explicit type ofstringgets us the intellisense we'd expect from the typescript server:This pull request adds types to our function type expressions that were missing them.