Sur cette page

SDK TypeScript et composant link-preview

Le dépôt contient un client TypeScript sans dépendance et un élément personnalisé <link-preview>. Tous deux se trouvent dans packages/sdk.

Le paquet @omnillink/sdk est construit depuis le dépôt. Sa publication sur le registre npm n’est pas confirmée à ce jour : en attendant, installez-le depuis packages/sdk.

Le client

TypeScript
import { createClient } from '@omnillink/sdk';

const omnillink = createClient({ baseUrl: 'https://omnillink.kayzen-lyon.com' });

const { data, meta } = await omnillink.meta('https://example.com/blog/launch');
console.log(data.title, data.image?.url, meta.cached);
OptionDéfautRôle
baseUrlDéfaut–RôleOrigine de l’instance. /api/v1 est ajouté pour vous.
apiKeyDéfaut–RôleEnvoyée dans l’en-tête x-api-key.
fetchDéfautfetch globalRôleVotre propre implémentation, pour les tests par exemple.
timeoutMsDéfaut30000RôleDélai d’une requête entière. 0 le désactive.

Les méthodes meta, extract, content, screenshot et pdf reprennent les paramètres de l’API. Les méthodes JSON renvoient { data, meta }.

L’élément <link-preview>

Un point d’entrée séparé enregistre l’élément. Il affiche une carte d’aperçu à partir de /meta.

HTML
<script type="module">
  import '@omnillink/sdk/element';
</script>

<link-preview url="https://example.com/blog/launch" base-url="https://omnillink.kayzen-lyon.com"></link-preview>

React

Le paquet @omnillink/react, dans packages/react, fournit le composant <LinkPreview> et le hook useLinkMeta(). Le composant enveloppe l’élément <link-preview> avec des props typées. Sur le serveur, il rend un simple lien ; dans le navigateur, il devient la carte.

React
import { LinkPreview } from '@omnillink/react';

<LinkPreview url="https://example.com/blog/launch" baseUrl="https://omnillink.kayzen-lyon.com" />;

Action GitHub

L’action .github/actions/link-preview récupère les métadonnées d’une adresse, les expose en sorties de l’étape et écrit un aperçu dans le résumé du job. Elle peut aussi prendre une capture.

YAML
- uses: kayzen-lyon/linkforge/.github/actions/link-preview@main
  id: preview
  with:
    url: https://example.com/blog/launch
    base-url: https://omnillink.kayzen-lyon.com
- run: echo "$TITLE"
  env:
    TITLE: ${{ steps.preview.outputs.title }}

Le bac à sable génère cette balise pour l’adresse que vous testez. Le détail des options est dans le fichier README.md du paquet.

Raccourcis clavier

CtrlKou/
Ouvrir la recherche et les commandes
?
Afficher cette aide
←→
Passer d’un onglet à l’autre
Ctrl↵
Lancer la requête dans le bac à sable
Esc
Fermer un panneau ou un menu

Les raccourcis à une seule touche se désactivent dans les options d’accessibilité.