TinyURL JavaScript Client


Easily use TinyURL in your browser.

Getting Started

1. Install it

$ npm install @kulkul/tinyurl-client

2. Use it

``javascript
import shortenUrl from "@kulkul/tinyurl-client";

shortenUrl("https://kulkul.tech").then((result) => {
console.log({ result }); // https://tinyurl.com/
});
`

Important Note on Custom Aliases

Custom aliases are no longer supported. The underlying TinyURL API endpoint used by this client does not support custom aliases. Any alias parameter provided will be ignored, and a random slug will be generated instead.

`javascript
import shortenUrl from "@kulkul/tinyurl-client";

// Alias parameter is deprecated and will be ignored
shortenUrl("https://kulkul.tech", "my-custom-alias").then((result) => {
console.log({ result }); // https://tinyurl.com/ (NOT my-custom-alias)
});
``