findBy* typings: Remove Error as a possible return value

[bopfer]

What:

• Remove | Error from findBy* return typings.

Why:

• The findBy* functions throw errors, so an Error will never actually be returned. Similar to the getBy* functions.
• See Add typescript definitions for findBy* queries #226 (comment) for more context.

How:

• I updated each of the 4 return typings for the findBy* functions and removed | Error.

Checklist:

• Documentation added to the docs site N/A
• Typescript definitions updated
• Tests N/A
• Ready to be merged

[alexkrolick]

https://github.com/Microsoft/TypeScript/blob/master/src/lib/es2015.promise.d.ts#L13

This looks correct, you can't type the rejected value of a Promise (thought you could 😅), and the error is not a return value, it's an exception.

So:

• ❌ Promise<OK, Err>
• ❌ Promise<OK | Err>
• ❌ Promise | Error
• ✅ Promise<OK>

[alexkrolick]

Codecov appears to be having issues https://status.codecov.io/ but this looks safe to merge when it's back up

[JaxCavalera]

Thanks for looking into this, I was on the fence about including the | Error but ultimately assumed there were more implementation details under the hood I wasn't across. Glad you were able to fix that one up.

[kentcdodds]

Thanks!

@allcontributors[bot], please add @bopfer for test

[allcontributors]

@kentcdodds

I've put up a pull request to add @bopfer! 🎉

[kentcdodds]

@allcontributors[bot], please add @JaxCavalera for review

[allcontributors]

@kentcdodds

I've put up a pull request to add @JaxCavalera! 🎉

[kentcdodds]

Whoops, let me try that again..

@allcontributors[bot], please add @JaxCavalera for review

[allcontributors]

@kentcdodds

I've put up a pull request to add @JaxCavalera! 🎉

[kentcdodds]

One last time!

@allcontributors[bot], please add @JaxCavalera for review

[allcontributors]

@kentcdodds

I've put up a pull request to add @JaxCavalera! 🎉

[kentcdodds]

🎉 This PR is included in version 3.19.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀