{"id":33156881,"url":"https://github.com/EddyVerbruggen/nativescript-speech-recognition","last_synced_at":"2025-11-30T05:01:42.389Z","repository":{"id":46294817,"uuid":"81744206","full_name":"EddyVerbruggen/nativescript-speech-recognition","owner":"EddyVerbruggen","description":":speech_balloon: Speech to text, using the awesome engines readily available on the device.","archived":false,"fork":false,"pushed_at":"2021-11-01T12:42:58.000Z","size":2272,"stargazers_count":92,"open_issues_count":16,"forks_count":24,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-10-23T18:41:43.828Z","etag":null,"topics":["nativescript","nativescript-plugin","siri","speech-recognition","speech-to-text","voice-recognition"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EddyVerbruggen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-12T17:40:59.000Z","updated_at":"2025-03-07T08:33:51.000Z","dependencies_parsed_at":"2022-09-16T03:40:27.185Z","dependency_job_id":null,"html_url":"https://github.com/EddyVerbruggen/nativescript-speech-recognition","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/EddyVerbruggen/nativescript-speech-recognition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EddyVerbruggen%2Fnativescript-speech-recognition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EddyVerbruggen%2Fnativescript-speech-recognition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EddyVerbruggen%2Fnativescript-speech-recognition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EddyVerbruggen%2Fnativescript-speech-recognition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EddyVerbruggen","download_url":"https://codeload.github.com/EddyVerbruggen/nativescript-speech-recognition/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EddyVerbruggen%2Fnativescript-speech-recognition/sbom","scorecard":{"id":44203,"data":{"date":"2025-08-11","repo":{"name":"github.com/EddyVerbruggen/nativescript-speech-recognition","commit":"2fe477f832bb9111660b77ef8c2fd7c3afc58173"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 2/21 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: npmCommand not pinned by hash: publish/pack.sh:10","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"20 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T22:19:48.816Z","repository_id":46294817,"created_at":"2025-08-14T22:19:48.816Z","updated_at":"2025-08-14T22:19:48.816Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27377903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-30T02:00:05.582Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nativescript","nativescript-plugin","siri","speech-recognition","speech-to-text","voice-recognition"],"created_at":"2025-11-15T20:00:36.804Z","updated_at":"2025-11-30T05:01:42.384Z","avatar_url":"https://github.com/EddyVerbruggen.png","language":"TypeScript","funding_links":[],"categories":["Plugins"],"sub_categories":["Utility Plugins"],"readme":"# NativeScript Speech Recognition\n\n[![Build Status][build-status]][build-url]\n[![NPM version][npm-image]][npm-url]\n[![Downloads][downloads-image]][npm-url]\n[![Twitter Follow][twitter-image]][twitter-url]\n\n[build-status]:https://travis-ci.org/EddyVerbruggen/nativescript-speech-recognition.svg?branch=master\n[build-url]:https://travis-ci.org/EddyVerbruggen/nativescript-speech-recognition\n[npm-image]:http://img.shields.io/npm/v/nativescript-speech-recognition.svg\n[npm-url]:https://npmjs.org/package/nativescript-speech-recognition\n[downloads-image]:http://img.shields.io/npm/dm/nativescript-speech-recognition.svg\n[twitter-image]:https://img.shields.io/twitter/follow/eddyverbruggen.svg?style=social\u0026label=Follow%20me\n[twitter-url]:https://twitter.com/eddyverbruggen\n\nThis is the plugin [demo](https://github.com/EddyVerbruggen/nativescript-speech-recognition/tree/master/demo) in action..\n\n| ..while recognizing Dutch 🇳🇱 | .. after recognizing American-English 🇺🇸 |\n| --- | --- |\n| \u003cimg src=\"https://github.com/EddyVerbruggen/nativescript-speech-recognition/raw/master/screenshots/ios-nl.jpg\" width=\"375px\" /\u003e | \u003cimg src=\"https://github.com/EddyVerbruggen/nativescript-speech-recognition/raw/master/screenshots/ios-en.jpg\" width=\"375px\" /\u003e |\n\n## Installation\nFrom the command prompt go to your app's root folder and execute:\n\n### NativeScript 7+:\n```bash\nns plugin add nativescript-speech-recognition\n```\n\n### NativeScript \u003c 7:\n```\ntns plugin add nativescript-speech-recognition@1.5.0\n```\n\n## Testing\nYou'll need to test this on a real device as a Simulator/Emulator doesn't have speech recognition capabilities.\n\n## API\n\n### `available`\n\nDepending on the OS version a speech engine may not be available.\n\n#### JavaScript\n```js\n// require the plugin\nvar SpeechRecognition = require(\"nativescript-speech-recognition\").SpeechRecognition;\n\n// instantiate the plugin\nvar speechRecognition = new SpeechRecognition();\n\nspeechRecognition.available().then(\n  function(available) {\n    console.log(available ? \"YES!\" : \"NO\");\n  }\n);\n```\n\n#### TypeScript\n```typescript\n// import the plugin\nimport { SpeechRecognition } from \"nativescript-speech-recognition\";\n\nclass SomeClass {\n  private speechRecognition = new SpeechRecognition();\n  \n  public checkAvailability(): void {\n    this.speechRecognition.available().then(\n      (available: boolean) =\u003e console.log(available ? \"YES!\" : \"NO\"),\n      (err: string) =\u003e console.log(err)\n    );\n  }\n}\n```\n\n### `requestPermission`\nYou can either let `startListening` handle permissions when needed, but if you want to have more control\nover when the permission popups are shown, you can use this function:\n\n```typescript\nthis.speechRecognition.requestPermission().then((granted: boolean) =\u003e {\n  console.log(\"Granted? \" + granted);\n});\n```\n\n### `startListening`\n\nOn iOS this will trigger two prompts:\n\nThe first prompt requests to allow Apple to analyze the voice input. The user will see a consent screen which you can extend with your own message by adding a fragment like this to `app/App_Resources/iOS/Info.plist`:\n\n```xml\n\u003ckey\u003eNSSpeechRecognitionUsageDescription\u003c/key\u003e\n\u003cstring\u003eMy custom recognition usage description. Overriding the default empty one in the plugin.\u003c/string\u003e\n```\n\nThe second prompt requests access to the microphone:\n\n```xml\n\u003ckey\u003eNSMicrophoneUsageDescription\u003c/key\u003e\n\u003cstring\u003eMy custom microphone usage description. Overriding the default empty one in the plugin.\u003c/string\u003e\n```\n\n#### TypeScript\n```typescript\n// import the options\nimport { SpeechRecognitionTranscription } from \"nativescript-speech-recognition\";\n\nthis.speechRecognition.startListening(\n  {\n    // optional, uses the device locale by default\n    locale: \"en-US\",\n    // set to true to get results back continuously\n    returnPartialResults: true,\n    // this callback will be invoked repeatedly during recognition\n    onResult: (transcription: SpeechRecognitionTranscription) =\u003e {\n      console.log(`User said: ${transcription.text}`);\n      console.log(`User finished?: ${transcription.finished}`);\n    },\n    onError: (error: string | number) =\u003e {\n      // because of the way iOS and Android differ, this is either:\n      // - iOS: A 'string', describing the issue. \n      // - Android: A 'number', referencing an 'ERROR_*' constant from https://developer.android.com/reference/android/speech/SpeechRecognizer.\n      //            If that code is either 6 or 7 you may want to restart listening.\n    }\n  }\n).then(\n  (started: boolean) =\u003e { console.log(`started listening`) },\n  (errorMessage: string) =\u003e { console.log(`Error: ${errorMessage}`); }\n).catch((error: string | number) =\u003e {\n  // same as the 'onError' handler, but this may not return if the error occurs after listening has successfully started (because that resolves the promise,\n  // hence the' onError' handler was created.\n});\n```\n\n##### Angular tip\nIf you're using this plugin in Angular, then note that the `onResult` callback is not part of Angular's lifecycle.\nSo either update the UI in [an `ngZone` as shown here](https://github.com/EddyVerbruggen/nativescript-pluginshowcase/blob/28f65ef98716ad7c4698071b9c394cceb2d9748f/app/speech/speech.component.ts#L154),\nor use [`ChangeDetectorRef` as shown here](https://blog.paulhalliday.io/2017/06/24/nativescript-speech-recognition/).\n\n### `stopListening`\n\n#### TypeScript\n```typescript\nthis.speechRecognition.stopListening().then(\n  () =\u003e { console.log(`stopped listening`) },\n  (errorMessage: string) =\u003e { console.log(`Stop error: ${errorMessage}`); }\n);\n```\n\n## Demo app (Angular)\nThis plugin is part of the [plugin showcase app](https://github.com/EddyVerbruggen/nativescript-pluginshowcase/tree/master/app/speech) I built using Angular.\n\n### Angular video tutorial\nRather watch a video? Check out [this tutorial on YouTube](https://www.youtube.com/watch?v=C5i_EYjfuTE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEddyVerbruggen%2Fnativescript-speech-recognition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEddyVerbruggen%2Fnativescript-speech-recognition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEddyVerbruggen%2Fnativescript-speech-recognition/lists"}