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

@wildpeaks/frozen

v3.0.0

Published

Manipulate frozen Arrays

Downloads

11

Readme

Frozen arrays utilities

Github Release

Typescript functions to manipulate frozen arrays.

All functions leave the original Array untouched, and return a new frozen Array with the modification.

Install:

npm install @wildpeaks/frozen

Function: arrayPush

Appends a single element at the end of an Array.

Usage:

function arrayPush<T>(frozenArray: ReadonlyArray<T>, newValue: T): ReadonlyArray<T>

Example:

import {arrayPush} from '@wildpeaks/frozen';

type MyArray = ReadonlyArray<string | number>;
const srcArray: MyArray = Object.freeze(['zero', 111, 'TWO']);
const newArray: MyArray = arrayPush(srcArray, 333);

// Result:
//  srcArray  ['zero', 111, 'TWO']
//  newArray  ['zero', 111, 'TWO', 333]

arrayRemove

Removes a single element, by index.

Usage:

function arrayRemove<T>(frozenArray: ReadonlyArray<T>, index: number): ReadonlyArray<T>

Example:

import {arrayRemove} from '@wildpeaks/frozen';

type MyArray = ReadonlyArray<string | number>;
const srcArray: MyArray = Object.freeze(['zero', 111, 'TWO']);
const newArray: MyArray = arrayRemove(srcArray, 0);

// Result:
//   srcArray  ['zero', 111, 'TWO']
//   newArray    [111, 'TWO']

arrayUniquePush

Appends a single element at the end of an Array like arrayPush, but only if the array doesn't already contain the value. The Array is expected to contain only unique values.

Usage:

function arrayUniquePush<T>(frozenArray: ReadonlyArray<T>, newValue: T): ReadonlyArray<T>

Example (the Array doesn't contain the value):

import {arrayUniquePush} from '@wildpeaks/frozen';

type MyArray = ReadonlyArray<string | number>;
const srcArray: MyArray = Object.freeze(['zero', 111, 'TWO']);
const newArray: MyArray = arrayUniquePush(srcArray, 333);

// Result:
//   srcArray  ['zero', 111, 'TWO']
//   newArray    ['zero', 111, 'TWO', 333]

Example (the Array already contains the value):

import {arrayUniquePush} from '@wildpeaks/frozen';

type MyArray = ReadonlyArray<string | number>;
const srcArray: MyArray = Object.freeze(['zero', 111, 'TWO']);
const newArray: MyArray = arrayUniquePush(srcArray, 111);

// Result:
//   srcArray  ['zero', 111, 'TWO']
//   newArray  ['zero', 111, 'TWO']

arrayUniqueRemove

Removes a single element from an Array, by value (whereas arrayRemove removes by index). The Array is expected to contain only unique values.

Usage:

function arrayUniqueRemove<T>(frozenArray: ReadonlyArray<T>, value: T): ReadonlyArray<T>

Example:

import {arrayUniqueRemove} from '@wildpeaks/frozen';

type MyArray = ReadonlyArray<string | number>;
const srcArray: MyArray = Object.freeze(['zero', 111, 'TWO']);
const newArray: MyArray = arrayUniqueRemove(srcArray, 111);

// Result:
//   srcArray  ['zero', 111, 'TWO']
//   newArray  ['zero', 'TWO']