# post-message-stream

> Sets up a duplex object stream over window.postMessage

Latest version **3.0.0** (published 2017-07-13) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install post-message-stream
pnpm add post-message-stream
yarn add post-message-stream
bun add post-message-stream
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2017-07-13 |
| First published | 2016-08-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/post-message-stream) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kumavis |

## Links

- npm: https://www.npmjs.com/package/post-message-stream
- Repository: https://github.com/kumavis/post-message-stream
- Homepage: https://github.com/kumavis/post-message-stream#readme
- Issues: https://github.com/kumavis/post-message-stream/issues
- npm.io page: https://npm.io/package/post-message-stream

## Dependencies (1)

- [readable-stream](https://npm.io/package/readable-stream.md) ^2.1.4

## Recent versions

- 3.0.0 (latest) — 2017-07-13
- 2.0.0 — 2017-01-17
- 1.0.0 — 2016-08-11

## README

# post-message-stream

Sets up a duplex object stream over window.postMessage

```js
var streamA = new PostMessageStream({
  name: 'thing one',
  target: 'thing two',
})

var streamB = new PostMessageStream({
  name: 'thing two',
  target: 'thing one',
})

streamB.on('data', (data) => console.log(data))
streamA.write(chunk)
```

### constructor arguments

```js
var messageStream = new PostMessageStream({

  // required

  // name of stream, used to differentiate
  // when multiple streams are on the same window 
  name: 'source',

  // name of target stream 
  target: 'sink',

  // optional

  // window to send the message to
  // default is `window`
  window: iframe.contentWindow,
  
})
```

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