doc: document undocumented methods on buffer prototype #48041

Xstoudi · 2023-05-16T22:18:43Z

Fixes: #46467

Fixes: nodejs#46467

targos · 2023-05-30T15:11:26Z

@nodejs/buffer

Xstoudi · 2023-07-22T20:59:06Z

Any chance it get merged?

targos · 2023-07-24T07:38:32Z

@nodejs/documentation

doc/api/buffer.md

nodejs-github-bot · 2023-07-27T09:42:30Z

Commit Queue failed

- Loading data for nodejs/node/pull/48041
✔  Done loading data for nodejs/node/pull/48041
----------------------------------- PR info ------------------------------------
Title      doc: document undocumented methods on buffer prototype (#48041)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     Xstoudi:doc/buffer-undocumented-slice-write -> nodejs:main
Labels     buffer, doc, author ready
Commits    7
 - doc: document undocumented method on buffer prototype
 - doc: lint markdown
 - doc: remove trailing spaces
 - doc: forgot two trailing spaces
 - fix: remove trailing spaces
 - doc: add added date meta
 - doc: add missing console.log(bytesWritten)
Committers 2
 - Xavier Stouder 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/48041
Fixes: https://github.com/nodejs/node/issues/46467
Reviewed-By: James M Snell 
Reviewed-By: Trivikram Kamat 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/48041
Fixes: https://github.com/nodejs/node/issues/46467
Reviewed-By: James M Snell 
Reviewed-By: Trivikram Kamat 
--------------------------------------------------------------------------------
   ⚠  Commits were pushed since the last approving review:
   ⚠  - doc: add missing console.log(bytesWritten)
   ℹ  This PR was created on Tue, 16 May 2023 22:18:43 GMT
   ✔  Approvals: 2
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/48041#pullrequestreview-1449803511
   ✔  - Trivikram Kamat (@trivikr): https://github.com/nodejs/node/pull/48041#pullrequestreview-1549147920
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/5678981877

aduh95 · 2023-08-10T18:47:52Z

doc/api/buffer.md

+  **Default**: `buf.length`.
+* Returns: {string}
+
+Decodes buf to a string according ASCII character encoding. `start` and


Suggested change

Decodes buf to a string according ASCII character encoding. `start` and

Decodes `buf` to a string according ASCII character encoding. `start` and

aduh95 · 2023-08-10T18:48:06Z

doc/api/buffer.md

+  **Default**: `buf.length`.
+* Returns: {string}
+
+Decodes buf to a string according to base64 character encoding. `start` and


Suggested change

Decodes buf to a string according to base64 character encoding. `start` and

Decodes `buf` to a string according to base64 character encoding. `start` and

aduh95 · 2023-08-10T18:48:15Z

doc/api/buffer.md

+  **Default**: `buf.length`.
+* Returns: {string}
+
+Decodes buf to a string according to base64url character encoding. `start`


Suggested change

Decodes buf to a string according to base64url character encoding. `start`

Decodes `buf` to a string according to base64url character encoding. `start`

aduh95 · 2023-08-10T18:48:23Z

doc/api/buffer.md

+  **Default**: `buf.length`.
+* Returns: {string}
+
+Decodes buf to a string according to hex character encoding. `start` and


Suggested change

Decodes buf to a string according to hex character encoding. `start` and

Decodes `buf` to a string according to hex character encoding. `start` and

aduh95 · 2023-08-10T18:48:31Z

doc/api/buffer.md

+  **Default**: `buf.length`.
+* Returns: {string}
+
+Decodes buf to a string according to latin1 character encoding. `start` and


Suggested change

Decodes buf to a string according to latin1 character encoding. `start` and

Decodes `buf` to a string according to latin1 character encoding. `start` and

aduh95 · 2023-08-10T18:52:10Z

doc/api/buffer.md

+
+### `buf.asciiWrite(string[, offset[, length]])`
+
+* `string` {string} String to write to `buf`.


Does the string needs to be ASCII? Or what happens if it contains non-ASCII chars?

aduh95 · 2023-08-10T19:11:29Z

doc/api/buffer.md

+Writes `string` to `buf` at `offset` according to the base64 character encoding
+and returns the number of bytes written. If `buf` did not contain enough space
+to fit the entire string, only part of `string` will be written. However,
+partially encoded characters will not be written.


I'm not sure I'd know what to expect if the input string contains non-ASCII chars, does it first convert to UTF-8 or some other encoding then convert it to base64?

aduh95 · 2023-08-10T19:11:46Z

doc/api/buffer.md

+Writes `string` to `buf` at `offset` according to the base64url character
+encoding and returns the number of bytes written. If `buf` did not contain
+enough space to fit the entire string, only part of `string` will be written.
+However, partially encoded characters will not be written.


Same question here

aduh95 · 2023-08-10T19:11:54Z

doc/api/buffer.md

+Writes `string` to `buf` at `offset` according to the hex character encoding
+and returns the number of bytes written. If `buf` did not contain enough space
+to fit the entire string, only part of `string` will be written. However,
+partially encoded characters will not be written.


aduh95 · 2023-08-10T19:13:34Z

doc/api/buffer.md

+const bytesWritten = buf.latin1Write('buffer');
+console.log(bytesWritten);
+// Prints: 2


How does 'buffer' fit in a 2-byte representation? 🤔

doc: document undocumented method on buffer prototype

3e2bb60

Fixes: nodejs#46467

nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels May 16, 2023

Xstoudi changed the title ~~doc: document undocumented method on buffer prototype~~ doc: document undocumented methods on buffer prototype May 16, 2023

Xstoudi added 3 commits May 17, 2023 13:15

doc: lint markdown

a2526d0

doc: remove trailing spaces

85c958f

doc: forgot two trailing spaces

69433b7

Xstoudi force-pushed the doc/buffer-undocumented-slice-write branch from c19dbc9 to 69433b7 Compare May 17, 2023 18:40

Xstoudi added 2 commits May 21, 2023 20:46

fix: remove trailing spaces

2eca8b0

doc: add added date meta

3145d10

Xstoudi force-pushed the doc/buffer-undocumented-slice-write branch from ab71c21 to 3145d10 Compare May 25, 2023 18:41

jasnell approved these changes May 29, 2023

View reviewed changes

aymen94 approved these changes May 31, 2023

View reviewed changes

trivikr approved these changes Jul 27, 2023

View reviewed changes

trivikr reviewed Jul 27, 2023

View reviewed changes

doc/api/buffer.md Show resolved Hide resolved

doc: add missing console.log(bytesWritten)

737bc2e

trivikr added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 27, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 27, 2023

nodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Jul 27, 2023

aduh95 reviewed Aug 10, 2023

View reviewed changes

jasnell removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: document undocumented methods on buffer prototype #48041

doc: document undocumented methods on buffer prototype #48041

Xstoudi commented May 16, 2023

targos commented May 30, 2023

Xstoudi commented Jul 22, 2023

targos commented Jul 24, 2023

nodejs-github-bot commented Jul 27, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

aduh95 Aug 10, 2023

	Decodes buf to a string according ASCII character encoding. `start` and
	Decodes `buf` to a string according ASCII character encoding. `start` and

	Decodes buf to a string according to base64 character encoding. `start` and
	Decodes `buf` to a string according to base64 character encoding. `start` and

	Decodes buf to a string according to hex character encoding. `start` and
	Decodes `buf` to a string according to hex character encoding. `start` and

	Decodes buf to a string according to latin1 character encoding. `start` and
	Decodes `buf` to a string according to latin1 character encoding. `start` and


		### `buf.asciiWrite(string[, offset[, length]])`

		* `string` {string} String to write to `buf`.

doc: document undocumented methods on buffer prototype #48041

Are you sure you want to change the base?

doc: document undocumented methods on buffer prototype #48041

Conversation

Xstoudi commented May 16, 2023

targos commented May 30, 2023

Xstoudi commented Jul 22, 2023

targos commented Jul 24, 2023

nodejs-github-bot commented Jul 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment