Documentation Index

Welcome to the documentation for URL Shortener. Below is a list of guides to help you understand, install, and use the package effectively.

📦 Description

URL Shortener is a fast, lightweight TypeScript package designed for shortening and resolving URLs using a Redis backend. It provides a clean API for working with custom aliases, optional TTL expiration, and seamless integration in Node.js environments.

Includes:

• Custom aliases and TTL expiration support
• Redis-backed storage
• Fully typed with TypeScript
• Minimal, focused API for backend apps
• CI/CD ready with linting and tests

---

🚀 Getting Started

• Installation Guide
• Usage Instructions

⚙️ Developer Guide

• API Reference
• Changelog

🤝 Community & Policies

• Code of Conduct

---

Need help? Start a conversation in GitHub Discussions.