doc: add note about max string length in buffer.toString #10687
Conversation
nodejs-github-bot
added
buffer
|
@targos maybe something like |
doc/api/buffer.md
Outdated
| @@ -1845,6 +1845,10 @@ console.log(buf2.toString('utf8', 0, 3)); | |||
| console.log(buf2.toString(undefined, 0, 3)); | |||
| ``` | |||
|
|
|||
| _Note_: If the size of the resulting string would exceed an | |||
| implementation-specific limit, this method will throw an Error. This limit is | |||
| equal to 2^28 - 16 in V8. | |||
buffer.toString throws an Error when the resulting string would be bigger than `2^28 - 16`. Fixes: nodejs#9489
targos
force-pushed
the
doc-buffer-tostring-limit
branch
from
dfc771c to
c05ab2e
Compare
|
@aqrln thanks, updated! |
|
I wonder if it's better to move the note before the examples. |
| @@ -1845,6 +1845,10 @@ console.log(buf2.toString('utf8', 0, 3)); | |||
| console.log(buf2.toString(undefined, 0, 3)); | |||
| ``` | |||
|
|
|||
| _Note_: If the size of the resulting string would exceed an | |||
| implementation-specific limit, this method will throw an Error. This limit is | |||
| equal to `2^28 - 16` in V8. | |||
There was a problem hiding this comment.
hmm... the note is a bit too vague to be useful. Which implementation-specific limit? What implementation is it specific too? Is the limit fixed and are the variations sufficiently finite to be documented?
There was a problem hiding this comment.
Here is the info about ChakraCore.
There was a problem hiding this comment.
It would be good to either describe or link-to some of the implementation specific variances
|
Updates on this one? |
|
There hasn't been any activity here. I'm closing this. Feel free to reopen (or ping a collaborator) if I closed this in error. |
Fixes: #9489
I'm open to suggestions for the commit message that is currently > 50 chars.
Affected core subsystem(s)
doc, buffer