In the world of URL shortening, simplicity meets efficiency with Tiny-Link, a lightweight Node.js module designed for seamless URL shortening and management. Inspired by the need for a straightforward and high-performance solution, Tiny-Link leverages the power of Redis, making it a top-notch choice for developers who prioritize speed and ease of use.

Why Tiny-Link?

1. Effortless URL Shortening:
   Tiny-Link simplifies the process of shortening URLs with just a few lines of code. Say goodbye to complex setups and welcome a hassle-free experience.

2. Inspired by Simplicity:
   The Tiny-Link philosophy revolves around simplicity. The module is crafted to be easy to use, understand, and integrate into your Node.js projects.

3. Redis Integration:
   Redis, the renowned in-memory data store, powers Tiny-Link's storage backend. This ensures lightning-fast read and write operations, making Tiny-Link ideal for scenarios where speed is paramount.

4. Efficient TTL Management:
   Tiny-Link provides efficient Time-To-Live (TTL) management for your shortened URLs. Set expiration times effortlessly, and Tiny-Link takes care of the rest.

Use Cases

• User Authentication Links: Simplify the generation of temporary authentication links. With Tiny-Link, create short-lived URLs for user authentication, enhancing security and usability.

const authLink = await tinyLink.shortenUrl('https://your-auth-service.com/user/verify?token=abc123', 3600); // Expires in 1 hour
console.log(authLink); // Example Output: "9aJdbC3eR_-pUz2vLIxq7"

• Social Media Sharing: Craft concise and shareable links for social media posts. Tiny-Link excels in creating short and memorable URLs, optimizing the user experience for your audience.

const promoLink = await tinyLink.shortenUrl('https://your-marketing-site.com/summer-sale', 0); // No expiration
console.log(promoLink); // Example Output: "4TddlZPBI5OvE27LDkbwL"

• Marketing Campaigns: Manage marketing campaign URLs with ease. Tiny-Link allows you to generate and track short URLs for promotional campaigns, ensuring efficient analytics and engagement monitoring.

const campaignLink = await tinyLink.shortenUrl('https://your-campaign-landing-page.com/new-product', 604800); // Expires in 7 days
console.log(campaignLink); // Example Output: "6TmD1p-N7fz9kROQyYNeW"

• Dynamic QR Codes: Integrate Tiny-Link with QR code generators to create dynamic QR codes for printed materials or digital platforms. Provide users with quick access to content without the need for lengthy URLs.

const qrCodeLink = await tinyLink.shortenUrl('https://your-qr-code-content.com/special-offer', 2592000); // Expires in 30 days
console.log(qrCodeLink); // Example Output: "x7l8UcP-2XJpWvR_q0HkD"

How to Get Started

npm install tiny-link

Example Usage:

const { TinyLink } = require('tiny-link');
const Redis = require('ioredis');

// Create an ioredis instance
const yourRedisClient = new Redis();

// Create an instance with your Redis client
const tinyLink = new TinyLink({ client: yourRedisClient });

// Shorten a URL
const shortKey = await tinyLink.shortenUrl('https://example.com');

// Get the original URL
const originalUrl = await tinyLink.getOriginalUrl(shortKey);

Check out the TinyLink GitHub repository for detailed documentation and customization options.

Get Involved
Tiny-Link is open source, and we invite you to contribute, report issues, or suggest enhancements. Join us on our GitHub repository and be part of the Tiny-Link community.