Type signature for JSON.stringify does not include undefined in the return type

[MazeChaZer]

Although calling JSON.stringify may return undefined (as documented here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description), it is not included in the type signature provided with TypeScript.

[MazeChaZer]

This is also true for Edge:

Values that do not have JSON representations, such as undefined, will not be converted.

https://docs.microsoft.com/en-us/scripting/javascript/reference/json-stringify-function-javascript

[mhegazy]

So we need a new overload for stringify(value: undefined, .....): undefined; ?

[MazeChaZer]

Thanks for the quick response!

That could work, please note that JSON.stringify(function() {}) also results in undefined.
Perhaps I should explain why this was a problem for me: I wrote an error handling function that would display JSON data

function showError(value: any): string {
    const json = JSON.stringify(value);
    // ...
    // Later in the code, a string function was used
    const lines = json.split('/n');
    // This is where I got the runtime exception
}

Would the overload catch this possible runtime error?

Something that would definitly work for me is a union return type that includes undefined, like so

stringify(value: any /* space, replacer, ... */): string | undefined

But of course I don't know conventions or guidelines for the type annotations very well, so this might be too broad.

[mhegazy]

PRs welcomed. You can find more information about contributing lib.d.ts fixes at https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md#contributing-libdts-fixes.

[MazeChaZer]

👍 Will do

[bradleyayers]

I just discovered a production bug that this would have caught. Any updates on it @MazeChaZer?

[NN---]

@mhegazy I suggest having both return value string|undefined and additional overload for undefined|Function|symbol to catch issues at compile time.

[greyblake]

Any progress on this one? (I got my fingers burned with this today)

[reverofevil]

@RyanCavanaugh Can we triage this? There's no movement on the critical issue for 5 years.

[ronyhe]

Here's a PR for this issue: #51897
This is my first attempt at contributing to the TS repo, advice and/or corrections would, of course, be welcome

[ronyhe]

Here's a PR for this issue: #51897 This is my first attempt at contributing to the TS repo, advice and/or corrections would, of course, be welcome

Ready for review

[ronyhe]

Any updates?
@MartinJohns Is there anything I should be doing to advance this?

[ecyrbe]

@sandersn can you reopen this bug since the PR got reverted ?

[RyanCavanaugh]

Having tried this and looked into it more, I don't think we're going to try this again. People can add this line to their project to opt into this behavior if they want it:

interface JSON { stringify(s: any): string | undefined; }

but if we add this today, there is no real way to opt back in to today's behavior.

However, if at some point we make a "stricter" version of the core lib, this would definitely be a change to consider in that feature

[DetachHead]

if at some point we make a "stricter" version of the core lib,

is there an open issue for this?

[KotlinIsland]

• This is resolved in ts-reset here: Add strong types for JSON.stringify total-typescript/ts-reset#21