Skip to content

Conversation

@silverwind
Copy link
Contributor

@silverwind silverwind commented Jan 12, 2026

Add "properties" to clarify presence of non-method properties like byteLength. This follows MDN which also distinguishes methods and properties.

Fixes: #34946
Ref: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength

"properties" is a more generic wording which also includes non-method
properties like `byteLength`.

Fixes: nodejs#34946
@nodejs-github-bot nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Jan 12, 2026
@avivkeller avivkeller added the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 16, 2026
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jan 16, 2026
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/61355
✔  Done loading data for nodejs/node/pull/61355
----------------------------------- PR info ------------------------------------
Title      doc: clarify TypedArray properties on Buffer (#61355)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     silverwind:bufdoc -> nodejs:main
Labels     buffer, doc
Commits    2
 - doc: clarify TypedArray properties on Buffer
 - use "methods and properties"
Committers 1
 - silverwind <me@silverwind.io>
PR-URL: https://github.com/nodejs/node/pull/61355
Fixes: https://github.com/nodejs/node/issues/34946
Refs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/61355
Fixes: https://github.com/nodejs/node/issues/34946
Refs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Mon, 12 Jan 2026 17:31:17 GMT
   ✔  Approvals: 1
   ✔  - Colin Ihrig (@cjihrig): https://github.com/nodejs/node/pull/61355#pullrequestreview-3655526833
   ✘  This PR needs to wait 89 more hours to land (or 0 minutes if there is one more approval)
   ✔  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/21052084247

@legendecas legendecas 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. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Jan 20, 2026
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jan 20, 2026
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/61355
✔  Done loading data for nodejs/node/pull/61355
----------------------------------- PR info ------------------------------------
Title      doc: clarify TypedArray properties on Buffer (#61355)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     silverwind:bufdoc -> nodejs:main
Labels     buffer, doc, author ready
Commits    2
 - doc: clarify TypedArray properties on Buffer
 - use "methods and properties"
Committers 1
 - silverwind <me@silverwind.io>
PR-URL: https://github.com/nodejs/node/pull/61355
Fixes: https://github.com/nodejs/node/issues/34946
Refs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/61355
Fixes: https://github.com/nodejs/node/issues/34946
Refs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Mon, 12 Jan 2026 17:31:17 GMT
   ✔  Approvals: 2
   ✔  - Colin Ihrig (@cjihrig): https://github.com/nodejs/node/pull/61355#pullrequestreview-3655526833
   ✔  - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/61355#pullrequestreview-3684304130
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 61355
From https://github.com/nodejs/node
 * branch                  refs/pull/61355/merge -> FETCH_HEAD
✔  Fetched commits as 33ea43eff383..3b0579c921e3
--------------------------------------------------------------------------------
[main 3722f5276a] doc: clarify TypedArray properties on Buffer
 Author: silverwind <me@silverwind.io>
 Date: Mon Jan 12 18:28:03 2026 +0100
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 97a62944aa] use "methods and properties"
 Author: silverwind <me@silverwind.io>
 Date: Mon Jan 12 18:33:57 2026 +0100
 1 file changed, 1 insertion(+), 1 deletion(-)
   ✔  Patches applied
There are 2 commits in the PR. Attempting autorebase.
(node:2396) [DEP0190] DeprecationWarning: Passing args to a child process with shell option true can lead to security vulnerabilities, as the arguments are not escaped, only concatenated.
(Use `node --trace-deprecation ...` to show where the warning was created)
Rebasing (2/4)
Executing: git node land --amend --yes
   ⚠  Found Fixes: https://github.com/nodejs/node/issues/34946, skipping..
--------------------------------- New Message ----------------------------------
doc: clarify TypedArray properties on Buffer

"properties" is a more generic wording which also includes non-method
properties like byteLength.

Fixes: #34946
PR-URL: #61355
Refs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

[detached HEAD 582fff2376] doc: clarify TypedArray properties on Buffer
Author: silverwind <me@silverwind.io>
Date: Mon Jan 12 18:28:03 2026 +0100
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (3/4)
Rebasing (4/4)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
use "methods and properties"

PR-URL: #61355
Fixes: #34946
Refs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteLength
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

[detached HEAD a806489531] use "methods and properties"
Author: silverwind <me@silverwind.io>
Date: Mon Jan 12 18:33:57 2026 +0100
1 file changed, 1 insertion(+), 1 deletion(-)
Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

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

@legendecas legendecas added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Jan 20, 2026
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 20, 2026
@nodejs-github-bot nodejs-github-bot merged commit 42d94e0 into nodejs:main Jan 20, 2026
43 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 42d94e0

@silverwind silverwind deleted the bufdoc branch January 21, 2026 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. buffer Issues and PRs related to the buffer subsystem. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: Buffer.prototype.byteLength is undocumented

5 participants