# @mm-snap/post-message-stream

> Sets up a duplex object stream over window.postMessage

Latest version **0.0.5** (published 2021-04-04) · 0 weekly downloads

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

## Install

```sh
npm install @mm-snap/post-message-stream
pnpm add @mm-snap/post-message-stream
yarn add @mm-snap/post-message-stream
bun add @mm-snap/post-message-stream
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2021-04-04 |
| First published | 2021-02-18 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 25.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 57 |
| Maintainers | rekmarks |

## Links

- npm: https://www.npmjs.com/package/@mm-snap/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/@mm-snap/post-message-stream

## Dependencies (1)

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

## Recent versions

- 0.0.5 (latest) — 2021-04-04
- 0.0.4 — 2021-03-20
- 0.0.3 — 2021-03-16
- 0.0.2 — 2021-02-25
- 0.0.1 — 2021-02-18

## README

# post-message-stream

Sets up a duplex object stream over `window.postMessage`, between pages or a Web Worker and its parent window.

## Usage

```javascript
const streamA = new WindowPostMessageStream({
  name: 'thing one',
  target: 'thing two',
})

const streamB = new WindowPostMessageStream({
  name: 'thing two',
  target: 'thing one',
})

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

## Constructor arguments

```javascript
const messageStream = new WindowPostMessageStream({

  // 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/@mm-snap/post-message-stream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._