Generate a unique string (e.g. for filenames or url slugs) using an incremental counter
npm install @acusti/uniquify
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.
``
npm install @acusti/uniquifyor
yarn add @acusti/uniquify
`ts
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'
`
This is the type signature for the payload you pass to uniquify. Onlyitems and value are required:
`ts`
type Payload = {
items: Array
They can be used like so:
`ts
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'
``