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

slugmaster

v1.2.5

Published

Slugmaster generates slugs and Coupon codes in a flash

Downloads

186

Readme

A simple TypeScript package for generating slugs. This package provides features like:

  • Genrate Random slug
  • Generate random slug form a user provided custom wordSet
  • Convert sentence to slug (Slugify)
  • Generate Complex AlphaNum like Coupons

Installation

To install the package, run:

npm install slugmaster

Usage

1. Generate Slug from random set of Words (generateSlug)

import { generateSlug } from 'slugmaster';
const slug = generateSlug({
  wordCount: 3
});
const customWordSlug = generateSlug({
  wordCount: 4,                        
  wordSet: ["tech", "code", "learn", "build", "scale", "launch"], 
});

2. Generate slug from a sentence (slugify)

import { slugify } from 'slugmaster';

const sentenceSlug = slugify("A blog title! to be converted to slug.");
// output: a-blog-title-to-be-converted-to-slug

OR

const sentenceSlug = slugify("A blog title! to be converted to SLUG.", {
  lowercase: false,            // if you opt to keep letters as it is (default: true)           
});
// output: A-blog-title-to-be-converted-to-SLUG

3. Generate Coupon codes

import { generateCouponCode } from 'slugmaster';
const couponCode = generateCouponCode({
  length: 10,
  prefix: 'SAVE',
  type: 'alphanumeric',
  includeLowercase: true,
  includeSymbols: false
});

Options

For Slug Generation

  • wordCount: Number of words in the slug (default: 3)
  • randomStringLength: Length of the random string to append (default: 0)

Custom Word Set Options (for generateSlug)

  • wordSet: Array of custom words for slug generation
  • wordCount: Number of words in the slug (default: 3)
  • randomStringLength: Length of random string appended to slug (default: 0)

Slugify Options

  • lowercase: Convert text to lowercase (default: true)
  • trim: Trim whitespace from the start and end of the text (default: true)
  • replaceSpaces: Replace spaces with dashes (default: true)
  • removeNonWordChars: Remove non-word characters (default: true)
  • replaceMultipleDashes: Replace multiple dashes with a single dash (default: true)
  • trimDashes: Trim dashes from the start and end of the text (default: true)

For Coupon Code

  • length: Length of the coupon code (default: 6)
  • type: Character types (alpha, alphanumeric, numeric)
  • prefix: Prefix for the coupon code (default: 'CP')
  • includeLowercase: Include lowercase letters (default: false)
  • includeSymbols: Include special characters (default: false)