Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upSuggestion: `throws` clause and typed catch clause #13219
Comments
|
Just to clarify - one the ideas here is not to force users to catch the exception, but rather, to better infer the type of a catch clause variable? |
|
@DanielRosenwasser
But it will give developers a way to express which exceptions can be thrown (would be awesome to have that when using other libraries |
|
how is a checked throw different from type Tried<Result, Error> = Success<Result> | Failure<Error>;
interface Success<Result> { kind: 'result', result: Result }
interface Failure<Error> { kind: 'failure', error: Error }
function isSuccess(tried: Tried<Result, Error>): tried is Success<Result> {
return tried.kind === 'result';
}
function mightFail(): Tried<number, string> {
}
const tried = mightFail();
if (isSuccess(tried)) {
console.log(tried.success);
} else {
console.error(tried.error);
}instead of try {
const result: Result = mightFail();
console.log(success);
} catch (error: Error) {
console.error(error);
} |
|
You're suggesting not to use
Adding
And this is the good case when the error is documented. |
is there a reliable way in javascript to tell apart SyntaxError from Error?
other than that encoding an exception as a special result case is a very common practice in FP world whereas splitting a possible outcome into 2 parts:
looks a made up difficulty in my opinion, throw is good for failing fast and loud when nothing you can do about it, explicitly coded results are good for anything that implies a bad yet expected situation which you can recover from |
|
consider: // throw/catch
declare function doThis(): number throws string;
declare function doThat(): number throws string;
function doSomething(): number throws string {
let oneResult: number | undefined = undefined;
try {
oneResult = doThis();
} catch (e) {
throw e;
}
let anotherResult: number | undefined = undefined;
try {
anotherResult = doThat();
} catch (e) {
throw e;
}
return oneResult + anotherResult;
}
// explicit results
declare function doThis(): Tried<number, string>;
declare function doThat(): Tried<number, string>;
function withBothTried<T, E, R>(one: Tried<T, E>, another: Tried<T, E>, haveBoth: (one: T, another: T) => R): Tried<T, R> {
return isSuccess(one)
? isSuccess(another)
? successFrom(haveBoth(one.result, another.result))
: another
: one;
}
function add(one: number, another: number) { return one + another; }
function doSomething(): Tried<number, string> {
return withBothTried(
doThis(),
doThat(),
add
);
} |
|
My point with You can represent the same bad situation with throwing an error. Sometimes you have a long chain of function invocations and you might want to deal with some of the errors in different levels of the chain. I disagree with you, in a lot of cases you can recover from thrown errors, and if the language lets you express it better than it will be easier to do so. Like with a lot of things in typescript, the lack of support of the feature in javascript isn't an issue.
Will work as expected in javascript, just without the type annotation. Using |
|
if we talking about browsers var child = window.open('about:blank');
console.log(child.Error === window.Error);so when you do: try { child.doSomething(); } catch (e) { if (e instanceof SyntaxError) { } }you won't catch it another problem with exceptions that they might slip into your code from far beyond of where you expect them to happen try {
doSomething(); // <-- uses 3rd party library that by coincidence throws SyntaxError too, but you don' t know it
} catch (e) {} |
|
besides class StandardError {}
class CustomError extends StandardError {
}
function doSomething() { throw new CustomError(); }
function oldCode() {
try {
doSomething();
} catch (e) {
if (e instanceof StandardError) {
// problem
}
}
} |
|
@Aleksey-Bykov Explicitly threading errors as you suggest in monadic structures is quite hard and daunting task. It takes a lot of effort, makes the code hard to understand and requires language support / type-driven emit to be on the edge of being bearable. This is a comment comming from somebody who puts a lot of effort into popularising Haskell and FP as a whole. It is a working alternative, especially for enthusiasts (myself included), however I don't think it's a viable option for the larger audience. |
|
Actually, my main concern here is that people will start subclassing Error. I think this is a terrible pattern. More generally, anything that promotes the use of the instanceof operator is just going to create additional confusion around classes. |
i really think this should be pushed harder to the audience, not until it's digested and asked for more can we have better FP support in the language and it's not as daunting as you think, provided all combinators are written already, just use them to build a data flow, like we do in our project, but i agree that TS could have supported it better: #2319 |
|
Monad transformers are a real PITA. You need lifting, hoisting and selective running fairly often. The end result is hardly comprehendible code and much higher than needed barrier of entry. All the combinators and lifting functions (which provide the obligatory boxing/unboxing) are just noise distracting you from the problem at hand. I do believe that being explicit about state, effects, etc is a good thing, but I don't think we have found a convenient wrapping / abstraction yet. Until we find it, supporting traditional programming patterns seems like the way to go without stopping to experiment and explore in the mean time. PS: I think we need more than custom operators. Higher Kinded Types and some sort of type classes are also essential for a practical monadic library. Among them I'd rate HKT first and type classes a close second. With all that said, I believe TypeScript is not the language for practicing such concepts. Toying around - yes, but its philosophy and roots are fundamentally distant for a proper seamless integration. |
|
Back to the OP question - |
|
Developers should be aware of the different js issues you described, after all adding The fact that 3rd party libraries ca throw errors is exactly my point. @aluanhaddad @gcnew |
|
@nitzantomer Subclassing native classes ( |
|
@gcnew In anycase this suggestion doesn't assume that the user is subclassing the Error class, it was just an example. |
|
@nitzantomer I'm not arguing that the suggestion is limited to
For the cases where you want to distinguish among known alternatives TypeScript has Tagged Unions (also called discriminated unions or algebraic data types). The compiler makes sure that all cases are handled which gives you nice guarantees. The downside is that if you want to add a new entry to the type, you'll have to go through all the code discriminating on it and handle the newly added option. The upside is that such code would have most-likely been broken, but would have failed at runtime. |
|
I just gave this proposal a second thought and became against it. The reason is that if |
|
@gcnew Also, this suggestion takes error inferring into account, something that won't happen if errors are coming from documentation comments. With inferred checked exceptions the developer won't even need to specify the I agree that enforcing error handling isn't a good thing, but having this feature will just add more information which can be then used by those who wish to.
Is that there's no standard way of doing it. |
|
I would love to have information in the tooltip in VS if a function (or called function) can throw. For |
|
@HolgerJeromin |
|
here is a simple question, what signature should be inferred for function mightThrow(): void throws string {
if (Math.random() > 0.5) {
throw 'hey!';
}
}
function dontCare() {
return mightThrow();
}according to what you said in your proposal it should be function dontCare(): void throws string {i say it should be a type error since a checked exception wasn't properly handled function dontCare() { // <-- Checked exception wasn't handled.
^^^^^^^^^^why is that? because otherwise there is a very good chance of getting the state of the immediate caller corrupt: class MyClass {
private values: number[] = [];
keepAllValues(values: number[]) {
for (let index = 0; index < values.length; index ++) {
this.values.push(values[index]);
mightThrow();
}
}
}if you let an exception to slip through you can not infer it as checked, because the behavior contract of the only safe way to is catch them immediately and rethrow them explicitly keepAllValues(values: number[]) {
for (let index = 0; index < values.length; index ++) {
this.values.push(values[index]);
try {
mightThrow();
} catch (e) {
// the state of MyClass is going to be corrupt anyway
// but unlike the other example this is a deliberate choice
throw e;
}
}
}otherwise despite the callers know what can be trown you can't give them guarantees that it's safe to proceed using code that just threw so there is no such thing as automatic checked exception contract propagation and correct me if i am wrong, this is exactly what Java does, which you mentioned as an example earlier |
|
@Aleksey-Bykov
Means that both
Won't have a
Will have As for your
|
|
I love this suggested feature. |
|
Hello, I just spent a little of time trying to find a workaround with what we do currently have in TS. As there is no way to get the type of the thrown errors within a function scope (nor to get the type of the current method by the way) I figured out on how we could however explicitly set the expected errors within the method itself. We could later, retrieve those type and at least know what could be thrown within the method. Here is my POC /***********************************************
** The part to hide a type within another type
**********************************************/
// A symbol to hide the type without colliding with another existing type
const extraType = Symbol("A property only there to store types");
type extraType<T> = {
[extraType]?: T;
}
// Set an extra type to any other type
type extraTyped<T, E> = T & extraType<E>
// Get back this extra type
type getExtraType<T> = T extends extraType<infer T> ? T : never;
/***********************************************
** The part to implement a throwable logic
**********************************************/
// Throwable is only a type holding the possible errors which can be thrown
type throwable<T, E extends Error> = extraTyped<T,E>
// return the error typed according to the throwableMethod passed into parameter
type basicFunction = (...any: any[]) => any;
const getTypedError = function<T extends basicFunction> (error, throwableMethod:T) {
return error as getExtraType<ReturnType<T>>;
};
/***********************************************
** An example of usage
**********************************************/
class CustomError extends Error {
}
// Here is my unreliable method which can crash throwing Error or CustomError.
// The returned type is simply our custom type with what we expect as the first argument and the
// possible thrown errors types as the second (in our case a type union of Error and CustomError)
function unreliableNumberGenerator(): throwable<number, Error | CustomError> {
if (Math.random() > 0.5) {
return 42;
}
if (Math.random() > 0.5) {
new Error('No luck');
}
throw new CustomError('Really no luck')
}
// Usage
try {
let myNumber = unreliableNumberGenerator();
myNumber + 23;
}
// We cannot type error (see TS1196)
catch (error) {
// Therefore we redeclare a typed value here and we must tell the method which could have crashed
const typedError = getTypedError(error, unreliableNumberGenerator);
// 2 possible usages:
// Using if - else clauses
if (typedError instanceof CustomError) {
}
if (typedError instanceof Error) {
}
// Or using a switch case on the constructor:
// Note: it would have been really cool if TS did understood the typedError.constructor is narrowed by the types Error | CustomError
switch (typedError.constructor) {
case Error: ;
case CustomError: ;
}
}
// For now it is half a solution as the switch case is not narrowing anything. This would have been
// possible if the typedError would have been a string union however it would not be reliable to rely
// on typedError.constructor.name (considering I would have find a way to convert the type union to a string union) |
|
Thank you very much for your positive feedback! I realise it could be easier to refactor existing code without having to wrap the entire returned type into the // now only append '& throwable<ErrorsThrown>' to the returned type
function unreliableNumberGenerator(): number & throwable<Error | CustomError> { /* code */ }This is the only change for the example part, here is the new types declaration: /***********************************************
** The part to hide a type within another type
**********************************************/
// A symbol to hide the type without colliding with another existing type
const extraType = Symbol("A property only there to store types");
type extraType<T> = {
[extraType]?: T;
}
// Get back this extra type
type getExtraType<T> = T extends extraType<infer T> ? T : never;
/***********************************************
** The part to implement a throwable logic
**********************************************/
// Throwable is only a type holding the possible errors which can be thrown
type throwable<E extends Error> = extraType<E>
// return the error typed according to the throwableMethod passed into parameter
type basicFunction = (...any: any[]) => any;
type exceptionsOf<T extends basicFunction> = getExtraType<ReturnType<T>>;
const getTypedError = function<T extends basicFunction> (error: unknown, throwableMethod:T) {
return error as exceptionsOf<T>;
};I also added a new type function anotherUnreliableNumberGenerator(): number & throwable<exceptionsOf<typeof unreliableNumberGenerator>> {
// I don't want to use a try and catch block here
return (Math.random() > 0.5) ? unreliableNumberGenerator() : 100;
}As function aSuperUnreliableNumberGenerator(): number & throwable<exceptionsOf<typeof unreliableNumberGenerator> | exceptionsOf<typeof anotherUnreliableNumberGenerator>> {
// I don't want to use a try and catch block here
return (Math.random() > 0.5) ? unreliableNumberGenerator() : unreliableNumberGenerator();
}I don't like the use of You can test here the result tips: hover |
|
@Xample That's a great solution with the tools that we have now!
And the type of b is infered as number which is correct but just if it's wrapped inside a try |
|
@luisgurmendezMLabs I don't quite get what you mean. If you follow @Xample 's repo on line 56. You can see the result of In another phase, Congratulations on the awesome design @Xample |
|
@ivawzh My thoughts are that in practice this might bring some issues since:
That function type return is infered as number and that's not entierly correct |
|
@luisgurmendezMLabs the throwable type is within the return type of the function only as a way to stick the error's type with the function (and to be able to recover those types later). I never return errors for real, I only throw them. Therefore if you are within a try block or not won't change anything. @ivawzh thank you for asking, I just did it for you |
|
@luisgurmendezMLabs ah ok I understand your point, it seems typescript only infer the first type found. For instance if you had: function stillARiskyMethod() {
return superRiskyMethod();
}the return type of stillARiskyMethod would be inferred correctly, while function stillARiskyMethod() {
return Math.random() < 0.5 superRiskyMethod() : anotherSuperRiskyMethod();
}would only type the return type as For this reason, you need to manually escalate the error type. function stillARiskyMethod(): number & throwable<exceptionOf<typeof superRiskyMethod>> {
const a = superRiskyMethod();
return a + 1
} |
|
I also just wanted to drop my thoughts in on this. I think this would be a really good feature to implement as there are different use cases for wanting to return an Error/null and wanting to throw something and it could have a lot of potential. Throwing exceptions is part of the Javascript language anyway, so why shouldn't we give the option to type and infer these? For example, if I'm doing lots of tasks that could error, I'd find it inconvenient to have to use an if statement to check the return type each time, when this could be simplified by using a try/catch where if any one of these tasks throws, it'll be handled in the catch without any additional code. This is particularly useful when you're going to be handling the error's in the same way; for example in express/node.js, I might want to pass the error to the Rather than doing Also haven't seen this discussed yet (May have missed it however, this thread has quite a few comments!) but if this was implemented, would it be made mandatory (i.e: Compilation error) to have a function that throws without using the Edit: Another use-case I thought of could be this would also help with generation of JSDocs using the @throws tag |
|
I will repeat here what I said in the now committed issue. I think that typescript should be able to infer the error type of most of the JavaScript expressions. Allowing for faster implementation by library creators. function a() {
if (Math.random() > .5) {
throw 'unlucky';
}
}
function b() {
a();
}
function c() {
if (Math.random() > .5) {
throw 'unlucky';
}
if (Math.random() > .5) {
throw 'fairly lucky';
}
}
function d() {
return eval('You have no IDEA what I am capable of!');
}
function e() {
try {
return c;
} catch(e) {
throw 'too bad...';
}
}
function f() {
c();
}
function g() {
a();
c();
}
Here are some compiler options I think should be included, as users engagement with this feature may vary depending on their skill as well as type-safety of libraries they depend on in given project: {
"compilerOptions": {
"errorHandelig": {
"enable": true,
"forceCatching": false, // Maybe better suited for TSLint/ESLint...
"includeError": true, // If true, every function will by default throw `Error | (types of throw expressions)`
"catchUnknownOnly": false, // If true, every function will by default throw `unknown`, for those very skeptics (If someone replaces some global with weird proxy, for example...)
"errorAsesertion": true, // If false, the user will not be able to change error type manually
}
}
}As for syntax on how to express the error any function can produce, I am not sure, but I know we need the ability for it to be generic and inferable. declare function getValue<T extends {}, K extends keyof T>(obj: T, key: K): T[K] throws void;
declare function readFile<throws E = 'not valid file'>(file: string, customError: E): string throws E;My use-case, as showing an actual use-case might show other it has a value: declare function query<T extends {}, throws E>(sql: string, error: E): T[] throws E;
app.get('path',(req, res) => {
let user: User;
try {
user = query('SELECT * FROM ...', 'get user');
} catch(e) {
return res.status(401);
}
try {
const [posts, followers] = Promise.all([
query('SELECT * FROM ...', "user's posts"),
query('SELECT * FROM ...', "user's follower"'),
]);
res.send({ posts, followers });
} catch(e) {
switch (e) {
case "user's posts":
return res.status(500).send('Loading of user posts failed');
case "user's posts":
return res.status(500).send('Loading of user stalkers failed, thankfully...');
default:
return res.status(500).send('Very strange error!');
}
}
});I need an error sink to prevent sending headers of response multiple times for multiple errors (they usually don't happen, but when they do they do so in bulk!) |
|
This issue is still tagged |
|
We have a use case where we throw a specific error when an API call returs non-200 code: interface HttpError extends Error {
response: Response
}
try {
loadData()
} catch (error: Error | ResponseError) {
if (error.response) {
checkStatusCodeAndDoSomethingElse()
} else {
doGenericErrorHandling()
}
}Not being able to type the catch block ends up in developers forgetting that 2 possible types of errors can be thrown, and they need to handle both. |
|
I prefer to always throw Error object : function fn(num: number): void {
if (num === 0) {
throw new TypeError("Can't deal with 0")
}
}
try {
fn(0)
}
catch (err) {
if (err instanceof TypeError) {
if (err.message.includes('with 0')) { .....}
}
} |
|
Why does this feature still "not enough feedback"? It's so useful when invoking browser's API like indexedDB, localstorage. It's caused many failure in complex scenario but developer can't aware in programing. |
|
Hegel seems to have this feature perfectly. I wish TypeScript has similar feature! |
|
DL;DR;
Okay, perhaps we should simply clarify the what are our needs and expectations: Errors are usually handled in 3 ways in js 1. The node wayUsing callbacks (which can actually be typed) Example of usage: import * as fs from 'fs';
fs.readFile('readme.txt', 'utf8',(error, data) => {
if (error){
console.error(error);
}
if (data){
console.log(data)
}
});Where function readFile(path: PathLike | number, options: { encoding: string; flag?: string; } | string, callback: (err: NodeJS.ErrnoException | null, data: string) => void): void;Therefore the error is typed like so interface ErrnoException extends Error {
errno?: number;
code?: string;
path?: string;
syscall?: string;
stack?: string;
}2. The promise wayWhere the promise either resolve or reject, while you can type the resolved Here is the signature of a promise's constructor: Note the reason is typed new <T>(executor: (resolve: (value?: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;It could theoretically have been possible to type them as follow: new <T, U=any>(executor: (resolve: (value?: T | PromiseLike<T>) => void, reject: (reason?: U) => void) => void): Promise<T>;In this manner, we could still theoretically make a 1-1 conversion between a node callback and a promise, keeping all the typing along this process. For instance: const fs = require('fs')
const util = require('util')
const readFilePromise = util.promisify(fs.readFile); // (path: PathLike | number, options: { encoding: string; flag?: string; } | string) => Promise<data: string, NodeJS.ErrnoException>;3. The "try and catch" waytry {
throw new Error();
}
catch (error: unknown) { //typing the error is possible since ts 4.0
if (error instanceof Error) {
error.message;
}
}Despite we are throwing an error "Error" 2 lines before the catch bloc, TS is unable to type the Is it not the case neither using promises within an async function Example() {
try {
const data: string = await readFilePromise('readme.txt', 'utf-8');
console.log(data)
}
catch (error) { // it can only be NodeJS.ErrnoException, we can type is ourself… but nothing prevents us to make a mistake
console.error(error.message);
}
}There is no missing information for typescript to be able to predict what type of error could be thrown within a try scope. This is only the first step and there will still be room for improvement, such as a strict mode forcing TS to work like in Java i.e. to force the user to use a risky method (a method which can throw something) within a Last but not least: prevent missing an errorAnything can be thrown, not only an Error or even an instance of an object. Meaning the following is valid try {
if (Math.random() > 0.5) {
throw 0
} else {
throw new Error()
}
}
catch (error) { // error can be a number or an object of type Error
if (typeof error === "number") {
alert("silly number")
}
if (error instanceof Error) {
alert("error")
}
}To know that the error could be of type try {
if (Math.random() > 0.5) {
throw 0
} else {
throw new Error()
}
}
catch (error) { // error can be a Number or an object of type `Error`
switch (error.constructor){
case Number: alert("silly number"); break;
case Error: alert("error"); break;
}
}Horray… the only remaining problem is that TS does not type the Please comment if you need more feedback |

Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.

The typescript type system is helpful in most cases, but it can’t be utilized when handling exceptions.
For example:
The problem here is two fold (without looking through the code):
In many scenarios these aren't really a problem, but knowing whether a function/method might throw an exception can be very useful in different scenarios, especially when using different libraries.
By introducing (optional) checked exception the type system can be utilized for exception handling.
I know that checked exceptions isn't agreed upon (for example Anders Hejlsberg), but by making it optional (and maybe inferred? more later) then it just adds the opportunity to add more information about the code which can help developers, tools and documentation.
It will also allow a better usage of meaningful custom errors for large big projects.
As all javascript runtime errors are of type Error (or extending types such as
TypeError) the actual type for a function will always betype | Error.The grammar is straightforward, a function definition can end with a throws clause followed by a type:
When catching the exceptions the syntax is the same with the ability to declare the type(s) of the error:
catch(e: string | Error) { ... }Examples:
Here it’s clear that the function can throw an error and that the error will be a string, and so when calling this method the developer (and the compiler/IDE) is aware of it and can handle it better.
So:
Compiles with no errors, but:
Fails to compile because
numberisn'tstring.Control flow and error type inference
Throws
string.Throws
MyError | string.However:
Throws only
MyError.