TextService.FilterStringAsync wrong undefined return type

[Felyrun]

API Reference (https://developer.roblox.com/en-us/api-reference/function/TextService/FilterStringAsync) says that TextService.FilterStringAsync returns a TextFilterResult (and not nil), but the return type here is TextFilterResult | undefined.

[Dionysusnu]

For reference, custom definition was first added in a3aa48d with no further type changes after that.

[osyrisrblx]

Actually it was 7003fdd where the change happened

[Validark]

Looks like I changed it by mistake? The documentation from 2019 is pretty much the same as it is today. I'm surprised no one noticed in 3 years. I wonder if anyone wrote a check in their code to make sure the return result is defined because of these types, or would they just have used type assertions?

[Dionysusnu]

I wonder if anyone wrote a check in their code to make sure the return result is defined because of these types, or would they just have used type assertions?

Considering this is an HTTP request and a critical part of user safety, I would say this is a good thing and have just kept the type with undefined, considering, as you say, no one ran into it for 3 years. Sometimes an overly restrictive type can be good for code style.

[Validark]

Well, if it's impossible for the API to return nil, there isn't any point to checking it. I don't see how it could be beneficial to write extra code and take up mental resources to deal with a situation that could never happen. I went ahead and changed it back to being always defined.