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

dyn-ring-buffer

v1.0.0

Published

A dynamic size ring buffer for Typescript/Javascript.

Downloads

2

Readme

A TyepScript/Javascript Dynamic Ring (Circular) Buffer.

Install

npm install dyn-ring-buffer

Usage

Create a new buffer

import { RingBuffer } from 'dyn-ring-buffer';

// a buffer with the size of 10
const buffer = RingBuffer.create<String>(10);

Write and Read

// write two items into the buffer
buffer.write('Hello');
buffer.write('World');

// read from the buffer
buffer.read(); // Hello

Shrink and Grow

const buffer = RingBuffer.create(10);

// grow the buffer with 2
buffer.grow(2);

buffer.size(); // 12

// shrink the buffer by 5
buffer.shrink(5);

buffer.size(); // 7

API

RingBuffer.create()

Create a buffer with the given size. Minimum size is 2, throws error otherwise.

// JS
const buffer = RingBuffer.create(10);
// TS with generics
const buffer RingBuffer.create<string>(10);

buffer.read()

Reads the next available item in the buffer. Throws error if buffer is empty.

buffer.read();

buffer.write()

Write data to the buffer. In typescript use the specified type durring creation. Throws error if buffer is full.

buffer.write('Hello World');

buffer.grow()

Grows the buffer with a given amount. Throws error when trying to grow the buffer with less than 1.

buffer.grow(2); // buffer size + 2

buffer.shrink()

Shrinks the buffer down with the given amount. Throws error when trying to shrink the buffer to less than 2.

buffer.shrink(2) // buffer size - 2

buffer.size()

Returns the size of the buffer.

buffer.size();

buffer.free()

Returns the amount of free space in the buffer.

buffer.free();

buffer.readIndex()

The position of the read token. Starting index is 0.

buffer.readIndex()

buffer.writeIndex()

The position of the write token.Starting index is 0.

buffer.writeIndex()

buffer.flush()

Flushes all the data (resets read and write token) from the buffer. Retains the size if that was changed.

buffer.flush();

buffer.reset()

Resets the buffer to its original size and the read write tokens.

buffer.reset();