ESlint: Require explicit return types on exported functions, yes or no??

Per Theo's video I'll post below and the well articulated logic within, it's best to avoid using explicit return types whenever possible.

I just jumped in on a codebase that has eslint rules that yell at me when I don't explicitly type the return type of function's that are exported ie

export function foo()

export function foo()

export function foo()

export function foo() and

export default function

export default function

export default function

export default function. Should I (suggest we) disable this and let the return types be inferred as Theo suggested of functions in the below video? Specifically I am asking about this eslint rule: https://github.com/typescript-eslint/typescript-eslint/blob/v4.33.0/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md

https://www.youtube.com/watch?v=I6V2FkW1ozQ&t=495s

e of pi•7/29/23, 6:42 PM

Not if you just jumped in. Best you can reasonably do is ask why it's there. Either you learn something about a specific problem this is solving, or you can start a discussion and maybe others will start to see it your way.

(Unless you were specifically brought in to be a typescript expert or something)

currenthandleOP•7/29/23, 7:39 PM

More like the second one and the code is very minimal and there's a lot of bloat and boiler plate stuff in the repo that doesn't seem to do anything. So I'm trying to clean stuff up rn.

currenthandleOP•7/29/23, 7:40 PM

But when I look at the eslint config of create-t3-app app's there is no reference to anything like this '@typescript-eslint/explicit-module-boundary-types': 'off','@typescript-eslint/explicit-module-boundary-types': 'off',

so idk why it doesn't flag it in t3 apps

currenthandleOP•7/29/23, 7:42 PM

But I guess you're confirming it's an antipattern to use retun types...

e of pi•7/29/23, 7:50 PM

They're nice for libraries where you want TS to yell at you if you're going to break your contracts.

Ee of pi They're nice for libraries where you want TS to yell at you if you're going to b...

currenthandleOP•7/29/23, 8:00 PM

what?

currenthandleOP•7/29/23, 8:00 PM

Oh you like return types??

currenthandleOP•7/29/23, 8:01 PM

So you're taking the opposite side as theo on this one?

e of pi•7/29/23, 8:01 PM

For libraries you are sharing outside your team

e of pi•7/29/23, 8:01 PM

Internal or app code go with inferred returns for sure

Ee of pi For libraries you are sharing outside your team

currenthandleOP•7/29/23, 8:06 PM

Why?

currenthandleOP•7/29/23, 8:08 PM

Have you watched the video?

e of pi•7/29/23, 8:12 PM

If you want a video, here's an explanation of why to use explicit return types in libraries. https://youtu.be/nwSe95uFN8E?t=152

YouTubeMatt Pocock

Don't use return types, unless...

Your default attitude towards return types should be 'don't use them', unless one of three things are true:

You're writing a function with multiple branches
You're building a library
You have a specific TS perf concern and you're banging your head against the wall

Become a TypeScript Wizard with Matt's free TypeScript Course:

https://ww...

currenthandleOP•7/29/23, 8:13 PM

I don't want a video per se, but I'll watch this one

currenthandleOP•7/29/23, 8:13 PM

Do you have an explanation or you just gonna leave it to Matt?

e of pi•7/29/23, 8:13 PM

Matt is a top notch typescript resource. I recommend all his stuff.

e of pi•7/29/23, 8:14 PM

I can give you similar reasoning, I don't really have much to say that Matt doesn't

e of pi•7/29/23, 8:14 PM

Short answer is it makes things better for the consumers of your code

Ee of pi Matt is a top notch typescript resource. I recommend all his stuff.

currenthandleOP•7/29/23, 8:16 PM

Matt's content is high quality. His pricing and email marketing is utterly abusive.

currenthandleOP•7/29/23, 8:16 PM

I have actually seen that video before

Ee of pi Short answer is it makes things better for the consumers of your code

currenthandleOP•7/29/23, 8:16 PM

Because of performace?

e of pi•7/29/23, 8:16 PM

Heh, I guess I should say all his free stuff

e of pi•7/29/23, 8:17 PM

Also, you can export meaningful types that would never be inferred

Ee of pi Heh, I guess I should say all his free stuff

currenthandleOP•7/29/23, 8:18 PM

I bought his shit, it's good. Extremely overpriced, and I was blown away that he's adding another module that he's offering the low low price of $170 to you because you bought the $600 lifetime access to his platform. It's fucking crazy what a dick / moron ...

currenthandleOP•7/29/23, 8:18 PM

Like I am so confident he would make a lot more money if priced it less the $300

currenthandleOP•7/29/23, 8:18 PM

the content is really nice tho

currenthandleOP•7/29/23, 8:19 PM

I especially like Typetransforms workshop

Ee of pi Also, you can export meaningful types that would never be inferred

currenthandleOP•7/29/23, 8:21 PM

Well I could just assign whatever get's returned to this meaningful type with an

as

as

for example

currenthandleOP•7/29/23, 8:22 PM

and then I don't have explicit return types anywhere in my code.... which feels good and consistent

currenthandleOP•7/29/23, 8:22 PM

Btw I am building an external library

e of pi•7/29/23, 8:23 PM

I'd rather annotate my function than start throwing as around but at the end of the day it isn't a huge difference

ESlint: Require explicit return types on exported functions, yes or no??

Similar Threads

Similar Threads

Similar Threads