Hitta en användbart packet

author: krm created: 2023-11-26
status: alpha

👁️‍🗨️ Om detta avsnitt

Denna guide beskriver överisktligt hur vi kan hitta ett packet för att använda i vårt projekt.

🧭 Vad är ett packet?

Ett packet är en samling av kod som gör det möjligt att göra mer saker i vårt program.

📚 Vad som behövs:

Du behöver ha ett node projekt som du vill lägga till ett packet till.

🏷 Viktigt information om systemet

• 🏷 PACKET_NAME Namnet på packet som du hittar.
• 🏷 CODE_NAME Namnet på objectet eller functionen som du behöver impoirtera för att använda projektet.

När det gäller _CODE_NAME_ och annat som kan variera mellan olika projekt så läs projektet README fil.

1. Fundera igenom vad du behöver för packet

Det finns många frågor som ka vara bra att ställa sig.

• Vad är det jag behöver?
• Kan jag inte skriva kod som gör detta själv?
• Är det möjligt att göra det jag vill?
• Kan det vara så att ingen har skrivit ett packer som gör det jag vill så jag får kankse kombinera flera packet?

Använd hela tiden internet och sök för att lära dig mer om ditt problem.

2. Sök efter ett packet

Gå till hemsidan för npm och sök efter ett packet. Anävnd lämpliga nyckelord. Du får upp en lista över packet. Försök att se vilket som är mest populärt och updateras frekvent och som gör det du vill. Titta också på exemplen på API och se att du tyckewr om det.

3. Installera packet

För att installera ett packet räcker det ofta bara med att skriva packetes namn.

npm install PACKET_NAME
`

3.1 ‼️ Installera packet som endast ska användas i utveckling

npm install -d PACKET_NAME

3.2 ⁉️ Du kan också redigera packet.json

Vill du har mer kontroll över vilka packet du har installerat eller kanske ta bort packet kan du editera packet.json filen.

EDITOR packet.json

4. Importera packet

För att kunna använda packet i ditt program behövwer du importera det som behövs för att kunna använda programmets API.

import CODE_NAME from "PACKET_NAME";

En del program beskriver ett äldre sätt att importera packet med en funktion som heter require. I så fall skriv om det på samma form som ovan och det kommer antagligen fungera.

5. ➕ Installera typer

Ibland har inte projektet typescript beskrivningar. Är det ett stort projekt gär det ofta installera via projektet @types som har många tredjeparts definitioner.

npm install -d @types/PACKET_NAME

Ofta så står det i typescript felmedelande vad du behöver göra för installera typen för packetet.

6. ✔️ Skriv ett demo

Läs igenom ett exempel i packetes README fil och implmentera ett litet demo program i ditt packet för att se om det fungerar.