npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

it-postmsg

v1.0.1

Published

Streaming iterables over window.postMessage

Downloads

6

Readme

it-postmsg

Build Status dependencies Status JavaScript Style Guide

Streaming iterables over window.postMessage

It provides the two parts of a duplex stream: a source stream and a sink stream that can be used together to stream data over window.postMessage.

Install

npm install it-postmsg

Usage

To use it-postmsg you need two window objects. One of the window objects has the data, the other wants the data. Under the hood, it-postmsg uses postmsg-rpc. If you're not familiar with it, it's a good idea to read up on how it works before continuing!

In the first window (the one that has the data):

const PostMessage = require('it-postmsg')
const pipe = require('it-pipe')

pipe(
  [/* your data */],
  PostMessage.sink('<stream ID>', {/* options passed to postmsg-rpc expose */})
)

In the second window (the one that wants the data):

const PostMessage = require('it-postmsg')
const pipe = require('it-pipe')

pipe(
  PostMessage.source('<stream ID>', {/* options passed to postmsg-rpc caller */}),
  async function logSink (source) {
    for await (const chunk of source) {
      console.log(chunk)
    }
  }
)
  1. Window that has the data calls PostMessage.sink, which exposes a function called <stream ID>_next & returns a sink
  2. Window that wants the data calls PostMessage.source, which creates a caller function for "read" & returns a source
  3. In the window that wants the data, the pipe(...) pipeline starts the flow of data from the PostMessage.source stream
  4. When data is requested from the PostMessage.source stream, it calls the exposed <stream ID>_next function
  5. This causes the PostMessage.sink stream in the window that has the data to retrieve the next item from the data array and return it all the way back to logSink in the window that wants the data

See the example for complete code.

Example

To build and run the example, run the following in your terminal:

git clone https://github.com/alanshaw/it-postmsg.git
cd it-postmsg
npm install
npm run example

Then open your browser at http://localhost:3000

API

PostMessage.sink(id, options)

Creates a new sink for writing data over postMessage.

  • id - a unique ID for the stream. postmsg-rpc uses it to expose functions that PostMessage.source can read from.
  • options - options passed directly to postmsg-rpc expose, see docs here

PostMessage.source(id, options)

Creates a new source for reading data over postMessage.

  • id - a unique ID for the stream, note that it should be the same ID used in PostMessage.sink
  • options - options passed directly to postmsg-rpc caller, see docs here

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Alan Shaw