doc: add caveat and tradeoff example to readline

[vsemozhetbyt]

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• documentation is changed or added
• commit message follows commit guidelines

Refs: #23916

[nodejs-github-bot]

@vsemozhetbyt build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2782/pipeline

[vsemozhetbyt]

If this is approved, this should be backported after backporting of #26078.

[BridgeAR]

Is the performance for readline something critical? If so, I'll have a look at improving it.

[vsemozhetbyt]

See #23916 (comment) for a simple comparing:

So event implementation currently 3 times as fast as async iterator implementation.

[BridgeAR]

@vsemozhetbyt it's not about the actual performance. I am pretty sure there is indeed a significant performance difference. I just wonder if that matters at all for the readline module. I currently can not think of any use case that is performance critical while using readline.

[vsemozhetbyt]

Say, I have a huge text file in some parsable format (CSV, digital dictionary, logfile etc). I want to process it line by line, retrieve some data or convert it in another format. Currently, readline is the only core way to do this. For files about 1 GB, the difference between 15 and 45 sec seems significant, especially if I have a batch of such files to process.

[mcollina]

LGTM

[vsemozhetbyt]

Landed in 15e741a
Thank you for the reviews.

[Palisand]

I cannot get this to work. An error is thrown during the invocation of once: TypeError: once is not a function.

(v11.11.0)

[vsemozhetbyt]

@Palisand As per "Added in:" field in the doc, you need v11.13.0 at least.