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

post-buffer

v0.0.2

Published

Serialize to array buffer and transfer between execution contexts, from the UI thread to WebWorkers.

Downloads

6

Readme

Post-Buffer

1 function to serialize Objects and String to ArrayBuffers, then transfer them between Worker/UI threads.

2 functions to decode them.

Motivation:

Passing messages from the Browser UI thread to WebWorkers allow 2 basic ways to pass messages, the first is to copy the data and allow both threads to manipulate the data independantly. The other way is to "transfer" the memory, making it unavailable on the sending thread. The latter way is less expensive in terms of time and memory management. It's also a real pain -- until now!

postBuffer:

The postBuffer function takes 2 arguments. The first is the variable to transfer, either a string or a JSON.stringify-able Object (thus Arrays, etc also work). The second depends on the caller, if the UI thread, then this argument is the worker to post to. If a worker is the caller, then the current scope, often called this, is required.

The return value is an array of 2 elements. The first is a boolean indicating success. If success is false, then the second is an error string.

bufferToString:

bufferToString takes an ArrayBuffer (the result of postBuffer on the receiving end) and decodes it to a plain string. It returns an array of 2 values, the first being either the decoded string or false literal. In case a false, the second value is an error message.

bufferToJSON:

bufferToJSON takes an ArrayBuffer (the result of postBuffer) and decodes it to a parsed JSON object. It returns an array of 2 values, the first being either the parsed JSON or false literal. In case a false, the second value is an error message.

Complete example is available from this example repo

Sample Usage: App.js (UI Thread):

import * as pb from "post-buffer";
...

function App() {
  useEffect(() => {
    echoWorker.onmessage = (msg) => {
      console.log(msg);
      let {data} = msg;
      let [result, errMsg] = pb.bufferToJSON(data);

      if (result) {
        console.log("UI thread heard:")
        console.log(result);
      } else {
        console.error("Error in UI unpacking buffer:")
        console.error(errMsg);
      }

      let [success, errMsg2] = pb.postBuffer(
        {hello: "world"}, 
        echoWorker
      );

      if (!success) {
        console.error("Error in UI posting buffer:")
        console.error(errMsg2);
      }
    };
  })

  ...
}

echo.worker.js (Worker Thread):

const pb = require("post-buffer");

module.exports = function(scope) {
    scope.onmessage = (msg) => {
        let {data} = msg;
        let [result, err] = pb.bufferToJSON(data);
        if (!result) {
            console.error("Err in worker while building buffer:")
            console.error(err);
            return
        }

        console.log("Echo worker heard:");
        console.log(result);
        let [success, err2] = pb.postBuffer(result, scope);
        if (!success) {
            console.error("Err in worker while posting buffer:")
            console.error(err2);
        }
    }
}