dillonkearns / elm-electron

Type-safe interprocess communication for Electron apps built with Elm.

Elm-Electron

Communicate between your Elm pages and your main NodeJS Electron process with the type-safety your accustomed to in Elm.

Usage

See github.com/dillonkearns/elm-electron-starter for reference or to setup a brand new project.

See github.com/dillonkearns/mobster for a real-world example of this library in action.

• cd into your electron project.
• npm install --save-dev elm-electron.
• Add a script in your package.json scripts section similar to:

"scripts": {
  ...
  "generate-ipc": "elm-electron src/Ipc.elm --ts src/ipc.ts --elm src/IpcSerializer.elm"
}

Where src/Ipc.elm is the location of your Ipc.Msg union type and src/ipc.ts is the location where you would like to save the generated typescript discriminated union.

Import the generated code in your Electron nodejs typescript code with import { Ipc } from 'src/ipc.ts' (or whatever the relative path to your generated file is).