shaveurl v1.1.7
shaveurl: URL Shortener Services
shaveurl is an npm package that provides easy integration with four URL shortener services that don't require API access tokens. You can easily shorten URLs using CleanUri, IsGd, 1pt, or shrtcode. Additionally, shaveurl comes with a command-line interface, enabling users to shorten URLs directly from the command line.
Quick try
You can use shaveurl directly from the command line using npx:
npx shaveurl 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes'
Table of Contents
Getting Started
Installation
You can install shaveurl locally for use in your project:
npm:
npm install shaveurl
yarn:
yarn add shaveurl
pnpm:
pnpm install shaveurl
Services Included
Usage
Library Usage
Import the `shortenUrl` function from the package and specify one of the four shortening services: cleanuri
, isgd
, 1pt
, or shrtcode
. If no service is specified, the default service is isgd
.
Example
import { shortenUrl } from 'shaveurl';
const longUrl = "https://en.wikipedia.org/wiki/List_of_HTTP_status_codes";
shortenUrl(longUrl).then(shortUrl => console.log(shortUrl));
with custom service:
import { shortenUrl } from 'shaveurl';
const longUrl = "https://en.wikipedia.org/wiki/List_of_HTTP_status_codes";
shortenUrl(longUrl, "cleanuri").then(shortUrl => console.log(shortUrl));
Command Line Usage
You can use shaveurl directly from the command line using npx:
npx shaveurl 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes'
Alternatively, you can install shaveurl globally for faster command line usage:
npm install -g shaveurl
Example with default service:
shaveurl 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes'
Example with specified service:
shaveurl 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes' cleanuri
For help with command line options, run:
shaveurl --help
Custom Shortlink
Specify a custom shortlink with isgd or 1pt:
const customShort = 'myshrinklink';
const url = 'https://en.wikipedia.org/wiki/List_of_HTTP_status_codes';
shortenUrl(longUrl, "isgd", customShort).then(shortUrl => console.log(shortUrl));
Contribution
Feel free to contribute to the shaveurl GitHub repository.
License
shaveurl is licensed under the MIT License - see the LICENSE file for details.