Skip to content

docs: README overstates what isSupported() checks (Permissions API is not part of the check) #250

Description

@untemps

Summary

The "Browser support flag" section (README.md:463) states that isSupported "returns true when the browser supports the Web Speech API (along with the Permissions and MediaDevices APIs that @untemps/vocal relies on)." The actual check does not include the Permissions API.

Current state

isSupported is re-exported from @untemps/vocal (src/index.ts:12). In @untemps/vocal 2.2.0 it is defined as isSupported = () => !!SpeechRecognitionCtor() && isMediaDevicesSupported() — it only checks SpeechRecognition and MediaDevices. isPermissionsSupported exists in the library and is used elsewhere (the permission-watching path) but is not referenced in the isSupported definition. So a browser supporting SpeechRecognition + MediaDevices but lacking the Permissions API would still return true, contradicting the "along with the Permissions ... APIs" wording.

Proposed improvement

Reword README.md:463 to drop "Permissions" from the list of APIs gating the result (e.g. "returns true when the browser supports the Web Speech API and the MediaDevices API"), or clarify that the Permissions API is used at runtime but is not part of the support check. Documentation only; no behavior change, and low real-world impact since the Permissions API is broadly available wherever SpeechRecognition exists.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions