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

@acusti/uniquify

v0.5.1

Published

Generate a unique string (e.g. for filenames or url slugs) using an incremental counter

Downloads

669

Readme

@acusti/uniquify

latest version maintenance status bundle size downloads per month

uniquify is a function that takes an array of items and a string and returns a string that is unique amongst those items, appending a counter (or incrementing an existing counter) if necessary. Much of the default behavior is based on how the macOS file system handles filename conflicts within a folder.

Usage

npm install @acusti/uniquify
# or
yarn add @acusti/uniquify

Default Usage

import uniquify from '@acusti/uniquify';

let items = ['bear', 'chickaree', 'coyote', 'marmot', 'pika'];

console.log(uniquify({ items, value: 'chipmunk' }));
//=> 'chipmunk'
console.log(uniquify({ items, value: 'bear' }));
//=> 'bear 2'

items = [...items, 'bear 2'];

console.log(uniquify({ items, value: 'bear' }));
//=> 'bear 3'
console.log(uniquify({ items, value: 'bear 2' }));
//=> 'bear 3'

Payload Options

This is the type signature for the payload you pass to uniquify. Only items and value are required:

type Payload = {
    items: Array<string> | Array<object>; // for Array<object>, pass propertyPath also
    value: string;
    // Options:
    caseSensitive?: boolean;
    propertyPath?: Array<string>; // the path of the property to compare
    separator?: string; // defaults to ' '
    suffix?: string; // add a suffix to the value (prepended with separator)
    isSuffixOptional?: boolean;
};

They can be used like so:

import uniquify from '@acusti/uniquify';

let routes = ['home', 'about', 'contact'];

console.log(
    uniquify({
        items: routes,
        separator: '-',
        value: 'about',
    }),
);
//=> 'about-2'

let files = [
    { file: { name: 'Ticket Receipt' } },
    { file: { name: 'Manifesto' } },
];

console.log(
    uniquify({
        items: files,
        propertyPath: ['file', 'name'],
        value: 'Ticket Receipt',
    }),
);
//=> 'Ticket Receipt 2'
console.log(
    uniquify({
        items: files,
        propertyPath: ['file', 'name'],
        value: 'ticket receipt',
    }),
);
//=> 'ticket receipt 2'
console.log(
    uniquify({
        caseSensitive: true,
        items: files,
        propertyPath: ['file', 'name'],
        value: 'ticket receipt',
    }),
);
//=> 'ticket receipt'
console.log(
    uniquify({
        items: files,
        propertyPath: ['file', 'name'],
        suffix: 'copy',
        value: 'Ticket Receipt',
    }),
);
//=> 'Ticket Receipt copy'
console.log(
    uniquify({
        items: files,
        propertyPath: ['file', 'name'],
        suffix: 'copy',
        value: 'Ticket Receipt 2',
    }),
);
//=> 'Ticket Receipt 2 copy'
console.log(
    uniquify({
        items: files,
        propertyPath: ['file', 'name'],
        isSuffixOptional: true, // <= changed
        suffix: 'copy',
        value: 'Ticket Receipt 2',
    }),
);
//=> 'Ticket Receipt 2'