doc: Buffer.prototype.byteLength is undocumented

[silverwind]

📗 API Reference Docs Problem

• Subsystem: buffer

Location

Affected URL(s):

• https://nodejs.org/api/buffer.html

Description

Buffer instances have a undocumented .byteLength property. We should document it. Docs only exist for the static method Buffer.byteLength but not for Buffer.prototype.byteLength.

> Buffer.from("📗").byteLength
4

---

• I would like to work on this issue and submit a pull request.

[mscdex]

I believe that's because it's inherited from TypedArray.

[PoojaDurgad]

I would like to work on this issue and submit a pull request.

[PoojaDurgad]

@silverwind Can I document property under buffer class

[silverwind]

@mscdex isn't it coming from ArrayBuffer#byteLength?

@PoojaDurgad Let's first get clearance whether we document inherited properties or not. Once that is decided, I'd suggest adding it below the buf.buffer prototype method, possibly with just a link to MDN.

[mscdex]

@silverwind Not necessarily. If the Buffer/Uint8Array is a subset of the backing ArrayBuffer, then the subset length will be returned and not the ArrayBuffer length.

[silverwind]

Removing Good first issue for now as it's not as trivial as I thought it would be.

[Xstoudi]

Not really fan of documenting the TypedArray properties as it would probably open the door to document every TypedArray method.

Would you mind if completed this quote from the Buffer doc tho?

All TypedArray methods are available on Buffers.

[silverwind]

I think we could write "All TypedArray properties are available on Buffers." to make it clear that not only methods are available, but also instance properties like this one.

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

[silverwind]

#61355