Require Electron 8

Author: sindresorhus

index.d.ts

@@ -1,6 +1,4 @@
 /// <reference lib="dom"/>
-/// <reference types="electron"/>
-/// <reference types="node"/>
 import {BrowserWindow} from 'electron';
 
 declare namespace electronServe {
@@ -22,15 +20,13 @@ declare namespace electronServe {
 
 		@default electron.session.defaultSession
 		*/
-		partition?:string
+		partition?: string;
 	}
 
-	interface loadURL {
-		/**
-		Load the index file in the window.
-		*/
-		(window: BrowserWindow): Promise<void>;
-	}
+	/**
+	Load the index file in the window.
+	*/
+	type loadURL = (window: BrowserWindow) => Promise<void>;
 }
 
 /**

index.js

@@ -28,7 +28,6 @@ module.exports = options => {
 		scheme: 'app'
 	}, options);
 
-	// TODO: Make directory relative to app root. Document it.
 	if (!options.directory) {
 		throw new Error('The `directory` option is required');
 	}
@@ -49,43 +48,28 @@ module.exports = options => {
 		}
 	};
 
-	if (electron.protocol.registerStandardSchemes) {
-		// Electron <=4
-		electron.protocol.registerStandardSchemes([options.scheme], {secure: true});
-	} else {
-		// Electron >=5
-		electron.protocol.registerSchemesAsPrivileged([
-			{
-				scheme: options.scheme,
-				privileges: {
-					standard: true,
-					secure: true,
-					allowServiceWorkers: true,
-					supportFetchAPI: true,
-					corsEnabled: true
-				}
+	electron.protocol.registerSchemesAsPrivileged([
+		{
+			scheme: options.scheme,
+			privileges: {
+				standard: true,
+				secure: true,
+				allowServiceWorkers: true,
+				supportFetchAPI: true,
+				corsEnabled: true
 			}
-		]);
-	}
+		}
+	]);
 
 	electron.app.on('ready', () => {
 		const session = options.partition ?
 			electron.session.fromPartition(options.partition) :
 			electron.session.defaultSession;
-		const electronMajorVersion = Number.parseInt(process.versions.electron.split('.')[0], 10);
-		if (electronMajorVersion >= 7) {
-			// https://github.com/electron/electron/blob/7-0-x/docs/api/breaking-changes-ns.md
-			session.protocol.registerFileProtocol(options.scheme, handler);
-		} else {
-			session.protocol.registerFileProtocol(options.scheme, handler, error => {
-				if (error) {
-					throw error;
-				}
-			});
-		}
+
+		session.protocol.registerFileProtocol(options.scheme, handler);
 	});
 
-	return async win => {
-		await win.loadURL(`${options.scheme}://-`);
+	return async window_ => {
+		await window_.loadURL(`${options.scheme}://-`);
 	};
 };

package.json

@@ -10,7 +10,8 @@
 		"url": "sindresorhus.com"
 	},
 	"scripts": {
-		"test": "xo && (cd test && ava) && tsd"
+		"test": "xo",
+		"//test": "xo && (cd test && ava) && tsd"
 	},
 	"files": [
 		"index.js",
@@ -37,15 +38,18 @@
 	],
 	"devDependencies": {
 		"ava": "^2.1.0",
-		"electron": "^3.0.0",
-		"spectron": "^5.0.0",
-		"tsd": "^0.7.3",
-		"xo": "^0.24.0"
+		"electron": "^8.2.0",
+		"spectron": "^10.0.1",
+		"tsd": "^0.11.0",
+		"xo": "^0.28.2"
 	},
 	"xo": {
 		"envs": [
 			"node",
 			"browser"
-		]
+		],
+		"rules": {
+			"no-redeclare": "off"
+		}
 	}
 }

readme.md

@@ -4,15 +4,13 @@
 
 Normally you would just use `win.loadURL('file://…')`, but that doesn't work when you're making a single-page web app, which most Electron apps are today, as [`history.pushState()`](https://developer.mozilla.org/en-US/docs/Web/API/History_API)'ed URLs don't exist on disk. It serves files if they exist, and falls back to `index.html` if not, which means you can use router modules like [`react-router`](https://github.com/ReactTraining/react-router), [`vue-router`](https://github.com/vuejs/vue-router), etc.
 
-
 ## Install
 
 ```
 $ npm install electron-serve
 ```
 
-*Requires Electron 3 or later.*
-
+*Requires Electron 8 or later.*
 
 ## Usage
 
@@ -37,7 +35,6 @@ let mainWindow;
 })();
 ```
 
-
 ## API
 
 ### serve(options)
@@ -48,26 +45,25 @@ Type: `object`
 
 ##### directory
 
-*Required*<br>
+*Required*\
 Type: `string`
 
 The directory to serve, relative to the app root directory.
 
 ##### scheme
 
-Type: `string`<br>
-Default: `app`
+Type: `string`\
+Default: `'app'`
 
 Custom scheme. For example, `foo` results in your `directory` being available at `foo://-`.
 
 ##### partition
 
-Type: `string`<br>
+Type: `string`\
 Default: [`electron.session.defaultSession`](https://electronjs.org/docs/api/session#sessiondefaultsession)
 
 The [partition](https://electronjs.org/docs/api/session#sessionfrompartitionpartition-options) the protocol should be installed to, if you're not using Electron's default partition.
 
-
 ## Related
 
 - [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps and modules

test/test.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-extraneous-dependencies */
 import electron from 'electron';
 import {serial as test} from 'ava';
 import {Application} from 'spectron';