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

als-sizeof

v3.0.0

Published

A utility function to estimate the memory size of objects in JavaScript, compatible with both Node.js and browser environments.

Downloads

36

Readme

als-sizeof

als-sizeof is a JavaScript utility function designed to estimate the memory size of objects, including buffers. It is compatible with both Node.js and browser environments, making it a versatile tool for memory usage estimation in various JavaScript applications.

Chang log for v3.0

  • Separated versions for nodejs and browser
  • Added Map and Set count support
  • formatBytes now is a property of sizeof

Features

  • Estimates the size of objects in bytes, including special handling for buffers in Node.js and ArrayBuffer in browsers.
  • Compatible with Node.js and browser environments.
  • Accounts for different data types like strings, numbers, booleans, objects, and buffers.
  • Provides a pretty formatting option to display the size in a more readable format.

Installation

You can install als-sizeof using npm:

npm install als-sizeof

Usage

To use als-sizeof, simply import it into your JavaScript project and pass the object you want to estimate the size of:

const sizeof = require("als-sizeof");

const obj = {
  key1: "value1",
  key2: 123,
  key3: true,
};

const size = sizeof(obj);
console.log(`Size of object: ${size} bytes`);
console.log(`Size of object: ${sizeof.formatBytes(size)}`);

Advanced Usage

als-sizeof also supports an advanced feature where you can pass a WeakSet as a second argument to the sizeof function. This WeakSet (referred to as objList) is used to keep track of the objects that have already been accounted for in size calculation. This is particularly useful for handling objects with circular references or when the same object instance appears multiple times in different parts of your data structure. To use this feature, simply create a WeakSet and pass it as the second argument to sizeof:

const sizeof = require("als-sizeof");

const obj = {
  key1: "value1",
  key2: {
    key3: "value3"
  }
};
obj.key2.key4 = obj; // Circular reference

const objList = new WeakSet();
const size = sizeof(obj, objList);
console.log(`Size of object: ${size} bytes`);

Browser usage

In the browser, include the script and use it similarly for ArrayBuffer:

<script src="node_modules/als-sizeof/sizeof.js"></script>
<script>
  const arrayBuffer = new ArrayBuffer(1024); // 1024 bytes
  const size = sizeof(arrayBuffer);
  console.log(`Size of ArrayBuffer: ${sizeof.formatBytes(size)} bytes`);
</script>