npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

custom-protocol-check-tool

v1.1.0

Published

Detect whether a custom protocol is available in browser (Chrome, Firefox, Safari, iOS, IE8-IE11 and Edge)

Downloads

1,493

Readme

Custom Protocol Check in Browser

Build StatusDependency Status NPM version Pull requests GitHub license

Detect whether a custom protocol is available in browser (Chrome, Firefox, Safari, iOS, IE8-IE11 and Edge)

The implementation is different from one browser to another, sometimes depend on which OS you are. Most of them are hacks, meaning that the solution is not the prettiest.

Important feature: If current tab is not active when it's trying to detect focus then it would attempt to open protocol as soon as focus is back on current tab. It is more useful when there is a long running process and at the end of that process we need to detect whether that file can be opened using custom protocol. User might be doing his work on different tabs or applications so in such cases library would try to detect custom protocol as soon as current tab gets focus.

  • Chrome and iOS: using window onBlur to detect whether the focus is stolen from the browser. When the focus is stolen, it assumes that the custom protocol launches external app and therefore it exists.
  • Firefox (Version >= 64): using hidden iframe onBlur to detect whether the focus is stolen. When the focus is stolen, it assumes that the custom protocol launches external app and therefore it exists.
  • Firefox (Version < 64): try to open the handler in a hidden iframe and catch exception if the custom protocol is not available.
  • Safari: using hidden iframe onBlur to detect whether the focus is stolen. When the focus is stolen, it assumes that the custom protocol launches external app and therefore it exists.
  • IEs and Edge in Win 8/Win 10: the cleanest solution. IEs and Edge in Windows 8 and Windows 10 does provide an API to check the existence of custom protocol handlers. Other older IE versions are not supported.

Examples

import customProtocolCheck from "custom-protocol-check";

customProtocolCheck(
  "mycustomprotocol://params",
  () => {
    console.log("Custom protocol not found.");
  },
  () => {
    console.log("Custom protocol found and opened the file successfully.");
  }, 5000
);

Options

  • uri: Custom protocol url to check for.
  • failCb: Callback function which gets called when custom protocol not found.
  • successCb: Callback function which gets called when custom protocol is found.
  • timeout: (default: 2000) Timeout in milliseconds. It waits for timeout unless it calls failCb. If protocol already exists then it would try to open the app right away. Note: Sometimes app associated with custom protocol might take time to open up and this solution rely on blur event, so adjust this setting as per your app's first screen loading time to prevent failCb getting called.
  • unsupportedCb: Callback function which gets called when browser is not supported.

Known Issues

  • In some protocol such as "mailto:", IE seems to trigger the fail callback while continuing on opening the protocol just fine (tested in IE11/Win 10). This issue doesn't occur with a custom protocol.

Special Thanks

custom-protocol-check is forked from https://github.com/ismailhabib/custom-protocol-detection. Many thanks to Ismail Habib Muhammad.

Happy Coding! Viresh Shah (http://www.vireshshah.com)