Skip to content

Commit b29306a

Browse files
committed
docs: update jsDoc
1 parent 06b9ae7 commit b29306a

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

API.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,7 @@ used as fallback.
291291
| [options.volume] | <code>number</code> | Optional volume value >= 0 and <= 1 |
292292
| [options.force] | <code>boolean</code> | Optional set to true to force speaking, no matter the internal state |
293293
| [options.infiniteResume] | <code>boolean</code> | Optional, force or prevent internal resumeInfinity pattern |
294+
| [options.noStop] | <code>boolean</code> | Optional, if true will not stop current voices |
294295
| [handlers] | <code>object</code> | optional additional local handlers, can be directly added as top-level properties of the options |
295296
| [handlers.boundary] | <code>function</code> | optional, event handler |
296297
| [handlers.end] | <code>function</code> | optional, event handler |

src/EasySpeech.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,7 @@ const createUtterance = text => {
669669
* @param {number=} options.volume - Optional volume value >= 0 and <= 1
670670
* @param {boolean=} options.force - Optional set to true to force speaking, no matter the internal state
671671
* @param {boolean=} options.infiniteResume - Optional, force or prevent internal resumeInfinity pattern
672+
* @param {boolean=} options.noStop - Optional, if true will not stop current voices
672673
* @param {object=} handlers - optional additional local handlers, can be
673674
* directly added as top-level properties of the options
674675
* @param {function=} handlers.boundary - optional, event handler
@@ -679,7 +680,6 @@ const createUtterance = text => {
679680
* @param {function=} handlers.resume - optional, event handler
680681
* @param {function=} handlers.start - optional, event handler
681682
*
682-
*
683683
* @return {Promise<SpeechSynthesisEvent|SpeechSynthesisErrorEvent>}
684684
* @fulfill {SpeechSynthesisEvent} Resolves to the `end` event
685685
* @reject {SpeechSynthesisEvent} rejects using the `error` event

0 commit comments

Comments
 (0)