🐌 space-slug

Get a unique string that looks like this wonderful-jabba or this hyperspace-4812.

Generate unique slugs, usernames, numbers, custom words, and more using an intuitive api with zero dependencies.

1const { spaceSlug } from 'space-slug';
2
3const slug = spaceSlug();
4// Returns: joyful-illusion-30

📡 Install

1npm install space-slug
2
3yarn add space-slug
4
5pnpm add space-slug

👋 Hello there! Follow me @linesofcode or visit linesofcode.dev for more cool projects like this one.

🚀 Getting Started

1const { spaceSlug, adjective, color, digits, noun } from 'space-slug';
2
3const slug = spaceSlug([color(), adjective(), noun(1), digits(3)], {
4  separator: '_'
5});
6// Returns: blue_celestial_labyrinth_718

📚 Custom dictionaries and locales

1const { spaceSlug, word, SpaceSlugDictionary } from 'space-slug';
2
3const dictionary: SpaceSlugDictionary = {
4  en: {
5    starwars: ['jabba', 'ezra'],
6  },
7};
8
9const slug = spaceSlug([word('starwars')(2), digits(2)], {
10  dictionary,
11  locale: 'en',
12});
13/// Returns: jabba-ezra-39

🗃️ Tracking used slugs

1const { uniqueSpaceSlug, color, digits } from 'space-slug';
2
3const slug = await uniqueSpaceSlug([
4  color(1),
5  digits(4),
6], {
7  usedSlugs: ['orange-3918']
8});
9// Returns: a slug that is not orange-3918

✅ Verifying that a slug is a unique

1const { uniqueSpaceSlug } from 'space-slug';
2
3await uniqueSpaceSlug([], {
4  maxAttempts: 10, // default is 10 attempts before throwing an error
5  isUnique: async (slug) => {
6    // check database to see if slug is unique
7    return true;
8  }
9});
10// Returns: a slug that you have verified is unique

🦄 Making a slug unique

1await uniqueSpaceSlug(['jabba'], {
2  isUnique: async (slug) => {
3    // a db lookup to see if slug is unique
4    return false;
5  },
6  makeUnique: async (slug) => {
7    // somehow make the slug unique
8    return slug + '-hutt';
9  }
10});

✨ Transforming a slug

1const { spaceSlug } from 'space-slug';
2
3await spaceSlug([], {
4  transform: (x) => x.toUpperCase()
5});
6// Returns: QUAINT-HORIZON-1293

✏️ Using hard-coded values

1const { spaceSlug, color, digits } from 'space-slug';
2
3spaceSlug([
4  'jabba',
5  digits(),
6];
7// Returns: jabba-1293
8
9spaceSlug([
10  color(),
11  ['jabba', 'hutt'],
12  digits(),
13];
14// Returns: red-jabba-hutt-3979

:toolbox: Functions

• word
• digits
• cleanString
• uniqueSpaceSlug
• spaceSlug

:gear: word

Function	Type
word	(type: string) => (count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: digits

Function	Type
digits	(count?: number or undefined, noConsecutive?: boolean or undefined) => (options: SpaceSlugOptions) => string

:gear: cleanString

Function	Type
cleanString	(inputString: string, separator: string) => string

:gear: uniqueSpaceSlug

Function	Type
uniqueSpaceSlug	(spaceSlugFn: SpaceSlugInput[], options?: SpaceSlugOptions and UniqueSpaceSlugOptions) => Promise<string>

:gear: spaceSlug

Function	Type
spaceSlug	(spaceSlugInputs?: SpaceSlugInput[] or undefined, options?: SpaceSlugOptions) => string

:wrench: Constants

• spaceSlugDefaultDictionary
• spaceSlugDefaultOptions
• noun
• adjective
• color
• season
• emoji
• verb
• animal
• cosmos

:gear: spaceSlugDefaultDictionary

Constant	Type
spaceSlugDefaultDictionary	SpaceSlugDictionary

:gear: spaceSlugDefaultOptions

Constant	Type
spaceSlugDefaultOptions	Partial<SpaceSlugOptions>

:gear: noun

Constant	Type
noun	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: adjective

Constant	Type
adjective	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: color

Constant	Type
color	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: season

Constant	Type
season	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: emoji

Constant	Type
emoji	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: verb

Constant	Type
verb	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: animal

Constant	Type
animal	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>

:gear: cosmos

Constant	Type
cosmos	(count?: number or undefined, _words?: string[] or undefined) => (options: SpaceSlugOptions) => Set<string>