mdn / mdn/content

SpeechRecognition does not document all required parameters for the install method

Open
#44,024 4 comments 0 reactions 1 assignee Claimed by @chrisdavidmills View on GitHub
Content:WebAPI
Dominant language
Markdown
Stars
11k
Forks
23.2k
Avg merge
2d 9h
Merged PRs (30d)
331

Description

### MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/install_static

### What specific section or headline is this issue about?

Parameters

### What information was incorrect, unhelpful, or incomplete?

The Parameters section lists only options.langs as a supported parameter. Chrome requires the undocumented processLocally flag be passed as true for install to succeed, and the content in the JS example reflects that by including this parameter.

### What did you expect to see?

[Parameters](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/install_static#parameters)
[options](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/install_static#options)
An object specifying options for the installation. Possible properties include:

[langs](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/install_static#langs)
An array of one or more strings containing [BCP 47 language tags](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag), each representing a language that you want to install the language pack for.

[processLoecally](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition/install_static#processLocally)
A boolean value. The documentation here should explain that this is necessary for the install to succeed. It should also explain the purpose of the function if this is passed as false, which is unclear.

### Do you have any supporting links, references, or citations?

_No response_

### Do you have anything more you want to share?

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.