forurl
v1.0.3
Published
Forurl An Free URL Shortner Api
Downloads
11
Maintainers
Readme
⚡ forurl
- Forurl An Free URL Shortner Api
😏 Some Of Features
- Json Api
- Free & Simple
- Fast & Stable Database
🔌 Getting Started
- You can start install the package on your project:
npm i forurl
- Then Start define it like this:
const forurl = require('forurl')
- typescript
import forurl from 'forurl';
👀 Important Note
- If The Full URL Already Added The Database, API Will Send The Same Data
- Package Use: https://4url.ml/api/short?url=fullURL
💡 Some Notes
- This Package Use Node-Fetch Package
- The Package Using Official 4URL Api
- Package Just Have One Methood (Short) function
- Package Only Work With async function
🔋 Examples
- exmaple code:
var forurl = require("forurl")
async function shortLink(URL) {
const data = await forurl.Short(URL) // Json Data
var status = data.status // Json Status
var fullURL = data.fullURL // URL (In This Example: https://youtube.com)
var shortCode = data.shortCode // Short Code (AutoGen)
var shortURL = data.shortURL // https://4url.ml/:shortCode
var clicks = data.clicks // Short Url Clicks (Req)
var date = data.date // Date Of The ShortURL (Date.now of the req)
if(status == 400) {
console.log("4URL - Please Check The URL, Url is not vaild")
} else if(status == 200) {
console.log(`Status: ${status}\nFull URL: ${fullURL}\nShort Code: ${shortCode}\nClicks: ${clicks}\nDate: ${date}`)
} else {
console.log("4URL - Some Thing Wrong !!")
}
}
shortLink("https://youtube.com") // call the function
/*
* Example Output
- status: 200
- fullURL: https://youtube.com
- shortCode: cTK4RPaIG
- shortURL: https://4url.ml/cTK4RPaIG
- clicks: 0
- date: 2021/02/04
*/
💖 Any Bug Or Suggestion !!
- Contact With Me Discord: AzizJaber.#5414
- Or Beta Devs Discord