Skip to content

ElectronApp.isDefaultProtocolClient method

ElectronApp › isDefaultProtocolClient

Unofficial

Returns whether the current executable is the default handler for a protocol.

Signature:

isDefaultProtocolClient(protocol: string, path?: string | undefined, args?: string[] | undefined): boolean

Parameters:

Parameter Type Description
protocol string The protocol name, without the ://.
path? string | undefined The executable path to compare against.
args? string[] | undefined The arguments to compare against.

Returns: booleanWhether the current executable is the default handler.