Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation/unit tests about protocol options #121

Closed
renarsvilnis opened this issue Aug 20, 2015 · 2 comments
Closed

Missing documentation/unit tests about protocol options #121

renarsvilnis opened this issue Aug 20, 2015 · 2 comments
Labels
build-target:mac 🍎 Bundling an Electron app specifically for macOS documentation 📝 has-pull-request tests-needed Pull request needs tests
Milestone

Comments

@renarsvilnis
Copy link

Found out by looking at source code there are missing documentation about the protocols option which gets used in electron-packager/mac.js for building electron apps that register custom url scheme on os. Example when opening myapp://blip-blop in browser it passes myapp://blip-blop string as an argument to open-url app module event.

@malept malept added the help wanted Needs a contributor from the community label Aug 20, 2015
@buddingmonkey
Copy link

👍

@max-mapper
Copy link
Contributor

Heres the usage:

--protocol-name=\"MyApp URL\" --protocol=\"myapp\"

This will cause your app.on('open-url') fn to fire when myapp:// links are opened from e.g. Chrome

@malept malept changed the title Missing documentation about protocol option Missing documentation/unit tests about protocol options Apr 20, 2016
@malept malept added tests-needed Pull request needs tests build-target:mac 🍎 Bundling an Electron app specifically for macOS labels Jul 8, 2016
@malept malept added this to the 7.6.0 milestone Aug 12, 2016
malept pushed a commit that referenced this issue Aug 12, 2016
@malept malept removed the help wanted Needs a contributor from the community label Feb 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-target:mac 🍎 Bundling an Electron app specifically for macOS documentation 📝 has-pull-request tests-needed Pull request needs tests
Projects
None yet
Development

No branches or pull requests

4 participants