stream: update comment for needMoreData

Version: master
Platform: all
Subsystem: streams

Lines 304 to 315 in d37e59f

    
           // if it's past the high water mark, we can push in some more. 
        
           // Also, if we have no data yet, we can stand some 
        
           // more bytes.  This is to work around cases where hwm=0, 
        
           // such as the repl.  Also, if the push() triggered a 
        
           // readable event, and the user called read(largeNumber) such that 
        
           // needReadable was set, then we ought to push more, so that another 
        
           // 'readable' event will be triggered. 
        
           function needMoreData(state) { 
        
             return !state.ended && 
        
                    (state.length < state.highWaterMark || 
        
                     state.length === 0); 
        
           }

comment is out of date (ref. #19613 (comment)).

Specifically it states:

I think that comment is actually wrong. It says

if it's past the high water mark, we can push in some more.

However it has a check (simplified) as:

return state.length < state.highWaterMark

Which will return true if we are below the watermark.

This would be a good issue for someone willing to learn more about streams.

@mcollina

@mcollina I'd like to take this issue up. I do think I'd need some guidance and might have some followup questions while I wrap my head around the problem.

Definitely. If that also result in one more unit test, even better!
Ping me if you have any questions!

@mcollina

@mcollina, since there is no PR from 6 days, may I work on this issue? This is my first contribution so I would need some guidance.

Sure, feel free to ping me in IRC or twitter any time.

@mcollina

@mcollina - Apologies, something came up on my end.

@vsnehil92 - Feel free to work on this as I haven't had any time.

Fixed by e76831b. Closing.

Navigation Menu

Repository navigation

stream: update comment for needMoreData #19695

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	// if it's past the high water mark, we can push in some more.
	// Also, if we have no data yet, we can stand some
	// more bytes. This is to work around cases where hwm=0,
	// such as the repl. Also, if the push() triggered a
	// readable event, and the user called read(largeNumber) such that
	// needReadable was set, then we ought to push more, so that another
	// 'readable' event will be triggered.
	function needMoreData(state) {
	return !state.ended &&
	(state.length < state.highWaterMark \|\|
	state.length === 0);
	}

stream: update comment for needMoreData #19695

Description

Activity

Xavier-J-Ortiz commented on Mar 30, 2018

mcollina commented on Mar 30, 2018

vsnehil92 commented on Apr 5, 2018

mcollina commented on Apr 5, 2018

Xavier-J-Ortiz commented on Apr 5, 2018

lpinca commented on Apr 15, 2018

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions