From 8cf372617f8133ead7a543a1dd0a02d631f85559 Mon Sep 17 00:00:00 2001 From: meixg Date: Fri, 25 Mar 2022 18:56:47 +0800 Subject: [PATCH 1/2] doc: fix question promise API example --- doc/api/readline.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/readline.md b/doc/api/readline.md index 724fbc6be99afc..932dcee2988028 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -618,14 +618,14 @@ Using an `AbortController` to cancel a question. const ac = new AbortController(); const signal = ac.signal; -const answer = await rl.question('What is your favorite food? ', { signal }); -console.log(`Oh, so your favorite food is ${answer}`); - signal.addEventListener('abort', () => { console.log('The food question timed out'); }, { once: true }); setTimeout(() => ac.abort(), 10000); + +const answer = await rl.question('What is your favorite food? ', { signal }); +console.log(`Oh, so your favorite food is ${answer}`); ``` ### Class: `readlinePromises.Readline` From 5ec520e7c44b367ea28a82f0087e510089482542 Mon Sep 17 00:00:00 2001 From: meixg Date: Mon, 28 Mar 2022 12:34:56 +0800 Subject: [PATCH 2/2] doc: fix question promise API example using AbortSignal.timeout --- doc/api/readline.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/doc/api/readline.md b/doc/api/readline.md index 932dcee2988028..328af419d87829 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -591,7 +591,7 @@ added: v17.0.0 prompt. * `options` {Object} * `signal` {AbortSignal} Optionally allows the `question()` to be canceled - using an `AbortController`. + using an `AbortSignal`. * Returns: {Promise} A promise that is fulfilled with the user's input in response to the `query`. @@ -612,18 +612,15 @@ const answer = await rl.question('What is your favorite food? '); console.log(`Oh, so your favorite food is ${answer}`); ``` -Using an `AbortController` to cancel a question. +Using an `AbortSignal` to cancel a question. ```mjs -const ac = new AbortController(); -const signal = ac.signal; +const signal = AbortSignal.timeout(10_000); signal.addEventListener('abort', () => { console.log('The food question timed out'); }, { once: true }); -setTimeout(() => ac.abort(), 10000); - const answer = await rl.question('What is your favorite food? ', { signal }); console.log(`Oh, so your favorite food is ${answer}`); ```