https://github.com/guest271314/native-messaging-typescript

TypeScript Native Messaging host
https://github.com/guest271314/native-messaging-typescript

javascript native-messaging native-messaging-host typescript

Last synced: 6 months ago
JSON representation

TypeScript Native Messaging host

• Host: GitHub
• URL: https://github.com/guest271314/native-messaging-typescript
• Owner: guest271314
• License: wtfpl
• Created: 2024-07-29T02:14:54.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-27T16:25:05.000Z (7 months ago)
• Last Synced: 2024-10-27T20:00:03.946Z (7 months ago)
• Topics: javascript, native-messaging, native-messaging-host, typescript
• Language: TypeScript
• Homepage:
• Size: 41 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
TypeScript Native Messaging host

Installation and usage on Chrome and Chromium

1. Navigate to `chrome://extensions`.

2. Toggle `Developer mode`.

3. Click `Load unpacked`.

4. Select `native-messaging-typescript` folder.

5. Note the generated extension ID.

6. Open `nm_typescript.json` in a text editor, set `"path"` to absolute path of `nm_typescript.ts` and `chrome-extension:///` using ID from 5 in `"allowed_origins"` array. 

7. Copy the file to Chrome or Chromium configuration folder, e.g., Chromium on \*nix `~/.config/chromium/NativeMessagingHosts`; Chrome dev channel on \*nix `~/.config/google-chrome-unstable/NativeMessagingHosts`.

8. Use one of the commented shebang lines in `nm_typescript.ts` for `deno`, `bun`, `node`, and make sure the file is executable.

9. To test click `service worker` link in panel of unpacked extension which is DevTools for `background.js` in MV3 `ServiceWorker`, observe echo'ed message from Bun Native Messaging host. To disconnect run `port.disconnect()`.

The Native Messaging host echoes back the message passed. 

For differences between OS and browser implementations see [Chrome incompatibilities](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Chrome_incompatibilities#native_messaging).

# License

Do What the Fuck You Want to Public License [WTFPLv2](http://www.wtfpl.net/about/)