https://github.com/tastekim/tastekim-shortener

[npm] 🇰🇷 Easy way to make your long url shorter.
https://github.com/tastekim/tastekim-shortener

npm typescript

Last synced: 11 days ago
JSON representation

[npm] 🇰🇷 Easy way to make your long url shorter.

• Host: GitHub
• URL: https://github.com/tastekim/tastekim-shortener
• Owner: tastekim
• Created: 2023-07-15T07:49:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-16T13:36:31.000Z (over 1 year ago)
• Last Synced: 2024-12-09T18:37:55.691Z (16 days ago)
• Topics: npm, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@tastekim/url-shortener
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tastekim-Shortener

긴 url 을 가독성이 좋은 짧은 url 로 바꾸어주는 모듈입니다.

개인적으로 운영하는 서버를 통해 생성하고 있으며 일정 click count 를 체크해서 expire 하고 있습니다.

`commonjs`와 `ESM`을 모두 지원합니다.

[Buy Me a Coffee](https://www.buymeacoffee.com/tastekim)

## Install

```

npm install @tastekim/url-shortener

```

## Usage

```typescript

import { TasteShortener } from '@tastekim/url-shortener';

const url = 'http://github.com/tastekim';

const result = await TasteShortener(url);

console.log(result);

// or

const { TasteShortener } = require('@tastekim/url-shortener');

const url = 'http://github.com/tastekim';

const result = await TasteShortener(url);

console.log(result);

```

## Output

```typescript

interface Response {

  success: boolean;

  message: string;

  shortenUrl: string;

}

```

## Warning

* 짧은 시간 동안에 shorten url 을 다량 생성하게 되면 대기 시간이 생깁니다.