ElectronProtocol.registerFileProtocol method

ElectronProtocol › registerFileProtocol

Unofficial

Registers a protocol of scheme that will send a file as the response.

Signature:

registerFileProtocol(scheme: string, handler: (request: ElectronProtocolRequest, callback: (response: string | ElectronProtocolResponse) => void) => void): boolean

Parameters:

Parameter	Type	Description
scheme	string	The scheme to register.
handler	(request: ElectronProtocolRequest, callback: (response: string | ElectronProtocolResponse) => void) => void	Called with the request and a callback to send the response.

Returns: boolean — Whether the protocol was successfully registered.