Skip to content

Commit 52ffb94

Browse files
committed
doc: describe kSyncWriteAcceptedOnFalse stream sentinel
1 parent ce8cbb5 commit 52ffb94

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

lib/internal/streams/iter/types.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,12 @@ const kValidatedSource = Symbol('kValidatedSource');
7070
*/
7171
const kSyncWriteAccepted = Symbol('kSyncWriteAccepted');
7272

73+
/**
74+
* Internal sentinel for writers whose sync write methods may return false
75+
* after accepting data when backpressure is applied. Such writers must expose
76+
* desiredSize so callers can distinguish accepted backpressure from a sync
77+
* write that was not performed.
78+
*/
7379
const kSyncWriteAcceptedOnFalse = Symbol('kSyncWriteAcceptedOnFalse');
7480

7581
module.exports = {

0 commit comments

Comments
 (0)