electron-serve
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    electron-serve

    Static file serving for Electron apps

    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()'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, vue-router, etc.

    Install

    $ npm install electron-serve
    

    Requires Electron 8 or later.

    Usage

    const {app, BrowserWindow} = require('electron');
    const serve = require('electron-serve');
    
    const loadURL = serve({directory: 'renderer'});
    
    let mainWindow;
    
    (async () => {
    	await app.whenReady();
    
    	mainWindow = new BrowserWindow();
    
    	await loadURL(mainWindow);
    
    	// The above is equivalent to this:
    	await mainWindow.loadURL('app://-');
    	// The `-` is just the required hostname
    })();

    API

    serve(options)

    options

    Type: object

    directory

    Required
    Type: string

    The directory to serve, relative to the app root directory.

    scheme

    Type: string
    Default: 'app'

    Custom scheme. For example, foo results in your directory being available at foo://-.

    isCorsEnabled

    Type: boolean
    Default: true

    Whether CORS should be enabled. Useful for testing purposes.

    partition

    Type: string
    Default: electron.session.defaultSession

    The partition the protocol should be installed to, if you're not using Electron's default partition.

    Related

    Install

    npm i electron-serve

    DownloadsWeekly Downloads

    4,747

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    7.86 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus