Repository navigation
JSON parse works with type Buffer #44944
Description
lib Update Request
Configuration Check
My compilation target is ES2015 and my lib is the default.
Missing / Incorrect Definition
parse(text: string, reviver?: (this: any, key: string, value: any) => any): any;
Sample Code
const object = JSON.parse(readFileSync("sample.json"));
Documentation Link
https://262.ecma-international.org/5.1/#sec-15.12.2
https://github.com/nodejs/node/blob/c41c09375b217d9daec614edb590147b14ff9b21/lib/buffer.js#L405
Suggestion
parse(text: string | Buffer, reviver?: (this: any, key: string, value: any) => any): any;
Activity
IllusionMH commentedon Jul 8, 2021
Same as #17203 and moreover
Bufferis Node specific type and doesn't looks like it belongs to standard lib files.RyanCavanaugh commentedon Jul 8, 2021
This is just an implicit coercion, not anything
JSON.parsedoes.qwelias commentedon Dec 2, 2023
Literally false, see the spec step 1:
Let jsonString be ? ToString(text)which explicitly convertstextarg to it's string representation before doing anything elseRyanCavanaugh commentedon Dec 2, 2023
I'm curious what you think an implicit coercion is?
qraynaud commentedon Sep 11, 2024
Everything you said is true.
But I still think the original comment has some point. It should not be a TS error to pass a Buffer to
JSON.parse()since it’s pretty valid. Yes it’s an implicit coercion but it does make sense to use it there. Though I don’t know how you could patch this properly. It should still work in an ideal world.RyanCavanaugh commentedon Sep 11, 2024
If you have a raw
Bufferyou don't know if it's UTF-8, UTF-16, base64, etc.. Arguably the entire point of TS is to tell you when you're making assumptions like that.