Buffer.byteLength's implementation is not consistent with the documentation

Lines 729 to 752 in f71166b

    
           function byteLength(string, encoding) { 
        
             if (typeof string !== 'string') { 
        
               if (isArrayBufferView(string) || isAnyArrayBuffer(string)) { 
        
                 return string.byteLength; 
        
               } 
        
               throw new ERR_INVALID_ARG_TYPE( 
        
                 'string', ['string', 'Buffer', 'ArrayBuffer'], string 
        
               ); 
        
             } 
        
             const len = string.length; 
        
             const mustMatch = (arguments.length > 2 && arguments[2] === true); 
        
             if (!mustMatch && len === 0) 
        
               return 0; 
        
             if (!encoding) 
        
               return (mustMatch ? -1 : byteLengthUtf8(string)); 
        
             const ops = getEncodingOps(encoding); 
        
             if (ops === undefined) 
        
               return (mustMatch ? -1 : byteLengthUtf8(string)); 
        
             return ops.byteLength(string); 
        
           }

In line 741 it checks the third argument mustMatch, which is not mentioned in the document

So I guess either the implementation or the documentation should be updated.

@nodejs/buffer @nodejs/documentation

I believe it was part of a now outdated optimization. I think it can be removed from the code (the parts where mustMatch would've been true).

buffer: remove mustMatch from Buffer.bytelength()

buffer: refactor `byteLength` to remove outdated optimizations

Navigation Menu

Repository navigation

`Buffer.byteLength`'s implementation is not consistent with the documentation #38536

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	function byteLength(string, encoding) {
	if (typeof string !== 'string') {
	if (isArrayBufferView(string) \|\| isAnyArrayBuffer(string)) {
	return string.byteLength;
	}

	throw new ERR_INVALID_ARG_TYPE(
	'string', ['string', 'Buffer', 'ArrayBuffer'], string
	);
	}

	const len = string.length;
	const mustMatch = (arguments.length > 2 && arguments[2] === true);
	if (!mustMatch && len === 0)
	return 0;

	if (!encoding)
	return (mustMatch ? -1 : byteLengthUtf8(string));

	const ops = getEncodingOps(encoding);
	if (ops === undefined)
	return (mustMatch ? -1 : byteLengthUtf8(string));
	return ops.byteLength(string);
	}

Buffer.byteLength's implementation is not consistent with the documentation #38536

Description

Activity

Trott commented on May 5, 2021

mscdex commented on May 5, 2021

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

`Buffer.byteLength`'s implementation is not consistent with the documentation #38536