# electron-preload-link

> Communicate between electron preload scripts and context-isolated processes.

Latest version **0.0.2** (published 2019-09-18) · MPL2 license · 0 weekly downloads

## Install

```sh
npm install electron-preload-link
pnpm add electron-preload-link
yarn add electron-preload-link
bun add electron-preload-link
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-09-18 |
| First published | 2019-09-18 |
| Weekly downloads | 0 |
| License | MPL2 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kklash |
| Maintainers | kklash |

## Links

- npm: https://www.npmjs.com/package/electron-preload-link
- Repository: https://github.com/ExodusMovement/electron-preload-link
- Homepage: https://github.com/ExodusMovement/electron-preload-link#readme
- Issues: https://github.com/ExodusMovement/electron-preload-link/issues
- npm.io page: https://npm.io/package/electron-preload-link

## Recent versions

- 0.0.2 (latest) — 2019-09-18
- 0.0.1 — 2019-09-18

## README

# electron-preload-link

A simple utility to send and listen for messages via the `window.postMessage` API. Useful for communication between electron preload scripts and sandboxed + context isolated child processes.

Example:

## Child Process

```js
const preloadLink = require('electron-preload-link')

preloadLink.on('shutdown-imminent', (timeRemaining) => {
  window.alert(
    `You have ${timeRemaining}ms before this process is shut down.`
  )
})

function handleSuccess(clipboardContents) {
  window.alert(`The contents of your clipboard are: ${clipboardContents}`)
  preloadLink.off('clipboard-request-fail', handleFail)
}

function handleFail(err) {
  console.error(err)
  window.alert('Failed to get clipboard contents!')
  preloadLink.off('clipboard-request-success', handleSuccess)
}

preloadLink.once('clipboard-request-success', handleSuccess)
preloadLink.once('clipboard-request-fail', handleFail)
preloadLink.emit('clipboard-request')
```

## Preload Script

```js
const preloadLink = require('electron-preload-link')
const { clipboard } = require('electron')

preloadLink.emit('shutdown-imminent', 60 * 1000)

preloadLink.on('clipboard-request', () => {
  try {
    const clipboardContent = clipboard.readText()
    preloadLink.emit('clipboard-request-success', clipboardContent)
  } catch (err) {
    preloadLink.emit('clipboard-request-fail', err)
  }
})

```

---
_Source: https://npm.io/package/electron-preload-link · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._