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

@zerodep/struct-stack

v2.0.10

Published

A factory that returns an optionally-typed Stack data structure instance.

Downloads

81

Readme

@zerodep/struct-stack

version language types license

CodeFactor Known Vulnerabilities

OpenSSF Best Practices

A factory function that returns an optionally-typed Stack data structure instance

Full documentation is available at the zerodep.app page.

Signature

declare const structStackFactory: <T = any>(items?: T[]) => Stack<T>;

interface Stack<T> {
  push: (item: T) => void;
  pop: () => T | undefined;
  peek: () => T | undefined;
  size: () => number;
  clear: () => void;
  toArray: () => T[];
}

Factory Parameters

The structStackFactory function has the following parameters:

  • items - an optional array of items with which to populate the stack, last item in the array is the top item in the stack, or, first item is at the bottom of the stack

Stack Methods

The structStackFactory returns an object with the following methods:

  • push() - adds an item to the top of the stack
  • pop() - gets and removes an item from the top of the stack
  • peek() - gets the item from the top of the stack, does not remove it
  • size() - how many items are in the stack
  • clear() - removes all items from the stack
  • toArray() - converts the stack to an array suitable for serialization, first item in the stack is the last item in the array, or, bottom item in the stack is the first value of the array

Examples

// ESM
import { structStackFactory } from '@zerodep/struct-stack';

// CJS
const { structStackFactory } = require('@zerodep/struct-stack');

Simple Case

const stack = structStackFactory();

// add items to the stack
stack.push('a');
stack.push('b');
stack.push('c');

// size()
stack.size(); // 3

// pop()
stack.pop(); // "c"

// peek()
stack.peek(); // "b"

// toArray()
stack.toArray(); // ["a", "b"]

Populate at Creation

const stack = structStackFactory(['aa', 'bb', 'cc', 'dd']);

// size()
stack.size(); // 4

// toArray()
stack.toArray(); // ["aa", "bb", "cc", "dd"]

Export/Serialize a Stack

const stack = structStackFactory(['aa', 'bb', 'cc', 'dd']);
stack.push('ee');
stack.push('ff');

// export items
const items = stack.toArray();
console.log(items); // ["aa", "bb", "cc", "dd", "ee", "ff"]

ZeroDep Advantages

  • Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
  • ESM & CJS - supports both ECMAScript modules and common JavaScript exports
  • Tree Shakable - built to be fully tree shakable ensuring your packages are the smallest possible size
  • Fully Typed - typescript definitions are provided/built-in to every package for a superior developer experience
  • Semantically Named - package and method names are easy to grok, remember, use, and read
  • Documented - actually useful documentation with examples at zerodep.app
  • Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
  • 100% Tested - all methods and packages are fully unit tested
  • Predictably Versioned - semantically versioned for peace-of-mind upgrading, valuable changelogs for understand changes
  • MIT Licensed - permissively licensed for maximum usability