https://github.com/code-parth/typescript-slugify

typescript-slugify is a lightweight npm package that provides a simple function for converting strings into URL-friendly slugs. Written in TypeScript, this utility offers easy integration and efficient string processing, making it ideal for web development projects.
https://github.com/code-parth/typescript-slugify

npm-package slugify string-processing text-processing typescript typescript-slugify url utility

Last synced: 10 months ago
JSON representation

typescript-slugify is a lightweight npm package that provides a simple function for converting strings into URL-friendly slugs. Written in TypeScript, this utility offers easy integration and efficient string processing, making it ideal for web development projects.

• Host: GitHub
• URL: https://github.com/code-parth/typescript-slugify
• Owner: Code-Parth
• License: mit
• Created: 2024-02-29T21:55:11.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-29T22:51:14.000Z (almost 2 years ago)
• Last Synced: 2025-01-18T20:01:18.189Z (11 months ago)
• Topics: npm-package, slugify, string-processing, text-processing, typescript, typescript-slugify, url, utility
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/typescript-slugify
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# TypeScript Slugify

![GitHub package.json version](https://img.shields.io/github/package-json/v/code-parth/typescript-slugify)

TypeScript Slugify is a lightweight npm package that provides a simple function for converting strings into URL-friendly slugs.

## Installation

You can install TypeScript Slugify via npm:

```bash

npm install typescript-slugify

```

or

```bash

yarn add typescript-slugify

```

## Usage

```javascript

import slugify from 'typescript-slugify';

const originalString = "Hello World!";

const slug = slugify(originalString);

console.log(slug); // Output: hello-world

```

## API

### slugify(input: string): string

This function takes a string input and returns a slugified version of it, making it suitable for URLs.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.