From d619aab575b40543441912f04bc989a5d1fa5c58 Mon Sep 17 00:00:00 2001 From: atlowChemi Date: Fri, 15 Mar 2024 00:59:35 +0200 Subject: [PATCH] events: rename high & low watermark for consistency PR-URL: https://github.com/nodejs/node/pull/52080 Fixes: https://github.com/nodejs/node/issues/52078 Refs: https://github.com/nodejs/node/pull/41276 Reviewed-By: Moshe Atlow Reviewed-By: Trivikram Kamat --- lib/events.js | 14 ++++++++------ lib/internal/readline/interface.js | 2 +- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/lib/events.js b/lib/events.js index 9bb22059c1fd9a..6501b003ae46dc 100644 --- a/lib/events.js +++ b/lib/events.js @@ -1053,8 +1053,8 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) { * @param {{ * signal: AbortSignal; * close?: string[]; - * highWatermark?: number, - * lowWatermark?: number + * highWaterMark?: number, + * lowWaterMark?: number * }} [options] * @returns {AsyncIterator} */ @@ -1065,10 +1065,12 @@ function on(emitter, event, options = kEmptyObject) { validateAbortSignal(signal, 'options.signal'); if (signal?.aborted) throw new AbortError(undefined, { cause: signal?.reason }); - const highWatermark = options.highWatermark ?? NumberMAX_SAFE_INTEGER; - validateInteger(highWatermark, 'options.highWatermark', 1); - const lowWatermark = options.lowWatermark ?? 1; - validateInteger(lowWatermark, 'options.lowWatermark', 1); + // Support both highWaterMark and highWatermark for backward compatibility + const highWatermark = options.highWaterMark ?? options.highWatermark ?? NumberMAX_SAFE_INTEGER; + validateInteger(highWatermark, 'options.highWaterMark', 1); + // Support both lowWaterMark and lowWatermark for backward compatibility + const lowWatermark = options.lowWaterMark ?? options.lowWatermark ?? 1; + validateInteger(lowWatermark, 'options.lowWaterMark', 1); // Preparing controlling queues and variables FixedQueue ??= require('internal/fixed_queue'); diff --git a/lib/internal/readline/interface.js b/lib/internal/readline/interface.js index e26fa6561e8679..8ae051e4eadbeb 100644 --- a/lib/internal/readline/interface.js +++ b/lib/internal/readline/interface.js @@ -1359,7 +1359,7 @@ class Interface extends InterfaceConstructor { this[kLineObjectStream] = EventEmitter.on( this, 'line', { close: ['close'], - highWatermark: 1024, + highWaterMark: 1024, [kFirstEventParam]: true, }); }