Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 2.99 KB

README.fr.md

File metadata and controls

80 lines (53 loc) · 2.99 KB
English version here.

MoreShort

Une librairie capable de raccourcir des liens via une simple fonction, en utilisant de multiples services possédant des noms de domaines courts.

Domaines/services supportés

mdrr.fr ptdrr.com
is.gd v.gd
s.oriondev.fr liba.ro
s.3vm.cl s.erc.hr
s.585.eu s.jib.ar
s.ahpc.fi s.acme.si
s.cije.us s.coute.au
s.fronturi.ro shor.vercel.app

Installation

NodeJS

Aucun support n'est garanti pour les anciennes versions de NodeJS.

# Avec npm
npm i moreshort

# Ou avec pnpm
pnpm i moreshort
const moreshort = require('moreshort')

console.log(moreshort) // Retourne des informations sur la librairie
console.log(await moreshort.short('https://google.com')) // Retourne un lien raccourci

Navigateur

<script src="https://cdn.jsdelivr.net/npm/moreshort/dist/browser.js"></script>
console.log(moreshort) // Retourne des informations sur la librairie
console.log(await moreshort.short('https://google.com')) // Retourne un lien raccourci

Dans le navigateur, vous pouvez utiliser la fonction short directement, sans avoir à utiliser moreshort.short.

Utilisation de la méthode principale

La fonction principale dispose de 3 arguments :

  • url : L'URL à raccourcir (string)
  • provider : Nom de domaine du service à utiliser (string)

  • Vous pouvez obtenir la liste des services disponibles avec moreshort.servicesDomains

  • shortcode : Code court à utiliser (string)

  • Sera présent dans l'URL raccourci, après le slash (ex: https://is.gd/shortcode)

  • Seuls certains services supportent cette fonctionnalité, moreshort.servicesInfos dispose d'une propriété booléenne shortcode pour chaque service

Exemple :

const moreshort = require('moreshort')

console.log(await moreshort.short('https://google.com')) // Raccourci avec un service aléatoire
console.log(await moreshort.short('https://google.com', 'is.gd')) // Raccourci avec le service is.gd
console.log(await moreshort.short('https://google.com', 'is.gd', 'google')) // Raccourci avec le service is.gd et le code court "google"

Licence

MIT © Johan