Electron App Universal Protocol Client

https://github.com/witcher112/electron-app-universal-protocol-client

Admin

A unified and simplified API for Electron applications to handle protocol requests (deep links)...

Tokens:1,161

Snippets:4

Trust Score:6.9

License:MIT

Update:1 year ago

Show doc for...

Tokens:

Raw

### Installation

Source: https://github.com/witcher112/electron-app-universal-protocol-client/blob/main/README.md

Install the package using either npm or yarn package managers.

```npm
npm install electron-app-universal-protocol-client
```

```yarn
yarn add electron-app-universal-protocol-client
```

--------------------------------

### Initialize Client

Source: https://github.com/witcher112/electron-app-universal-protocol-client/blob/main/README.md

Initialize the protocol client with a specific protocol string and an optional mode. It's crucial to register protocol handlers before calling initialize to avoid losing requests. The default mode is 'production'.

```js
await electronAppUniversalProtocolClient.initialize({
  protocol: 'your-app-id',
  mode: 'development', // Make sure to use 'production' when script is executed in bundled app
});
```

--------------------------------

### macOS Development Mode Permissions Fix

Source: https://github.com/witcher112/electron-app-universal-protocol-client/blob/main/README.md

A command to resolve potential 'Permission denied' errors on macOS when running Electron apps in development mode, related to the quarantine attribute.

```bash
sudo xattr -r -d com.apple.quarantine ./
```

--------------------------------

### Register Protocol Request Handler

Source: https://github.com/witcher112/electron-app-universal-protocol-client/blob/main/README.md

Register a handler function to process incoming protocol requests. The handler receives the full request URL as an argument.

```js
electronAppUniversalProtocolClient.on(
  'request',
  async (requestUrl) => {
    // Handle the request
  },
);
```

Tokens:

Raw