0Pricing
TypeScript Academy · Lektion

Pakete mit Typen veröffentlichen

Veröffentlichen Sie Bibliotheken mit erstklassigen Typisierungen: Erzeugen Sie .d.ts mit tsc, verweisen Sie in package.json darauf, behandeln Sie ESM-/CJS-Exporte und testen Sie vor der Veröffentlichung.

Pakete mit Typen veröffentlichen ist eine kostenlose TypeScript Academy-Lektion auf CoddyKit. Dies ist Lektion 2 von 2. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des TypeScript Academy-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der TypeScript Academy-Kurs umfasst insgesamt 2 Lektionen.

Einführung

Ziel: Veröffentlichen Sie ein Paket mit soliden Typdefinitionen. Sie erzeugen .d.ts-Dateien, konfigurieren package.json korrekt, unterstützen ESM/CJS über exports und überprüfen das Ergebnis mit tsc --noEmit in einer Beispielanwendung.

  • Deklarationen erzeugen
  • types oder eintragsspezifische exports angeben
  • Vor der Veröffentlichung testen

Deklarationen erzeugen

Aktivieren Sie declaration, um .d.ts-Dateien zu erzeugen. Verwenden Sie eine eigene Build-Konfiguration, damit die tsconfig der Anwendung strikt und übersichtlich bleibt.

// tsconfig.build.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "declaration": true,
    "emitDeclarationOnly": false,
    "outDir": "dist",
    "rootDir": "src",
    "stripInternal": true
  },
  "include": ["src/**/*"]
}

package.json types/exports

Verweisen Sie mit types auf die Deklaration im Stammverzeichnis. Fügen Sie bei Subpfad-Exports einen types-Eintrag hinzu, damit Editoren die modulspezifischen .d.ts-Dateien auflösen können.

// package.json
{
  "name": "@acme/widgets",
  "version": "1.0.0",
  "type": "module",
  "main": "./dist/index.cjs",
  "module": "./dist/index.js",
  "types": "./dist/index.d.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "require": "./dist/index.cjs"
    },
    "./utils": {
      "types": "./dist/utils.d.ts",
      "import": "./dist/utils.js",
      "require": "./dist/utils.cjs"
    }
  }
}

Quellcode im Vergleich zu .d.ts

Stellen Sie sicher, dass Ihre öffentliche API gut typisiert ist. Deklarationen spiegeln die Signaturen des Quellcodes wider, sodass Nutzer Autovervollständigung und Typprüfung erhalten.

// src/index.ts
export interface Widget { id: string; name: string }
export function greet(w: Widget): string { return `Hello, ${w.name}` }

// dist/index.d.ts (emitted)
export interface Widget { id: string; name: string }
export declare function greet(w: Widget): string

Im Consumer testen

Testen Sie das Paket vor der Veröffentlichung in einem kleinen Consumer-Projekt mit tsc --noEmit. Für ungültige Verwendungen sollten die erwarteten Fehler auftreten.

// consumer/tsconfig.json
{
  "compilerOptions": { "strict": true, "target": "ES2020", "module": "ESNext" },
  "include": ["./src"]
}

// consumer/src/app.ts
import { greet } from "@acme/widgets"

// Type checks in the consumer
console.log(greet({ id: "w1", name: "Ada" }))
// @ts-expect-error: missing name
// console.log(greet({ id: "w1" }))

Tipps & Fallstricke

Tipps:

  • Bevorzugen Sie exports für Subpfade mit eintragsspezifischen types.
  • Exportieren Sie interne Typen nicht oder markieren Sie sie mit @internal.
  • Verwenden Sie ein prepare-Skript, um vor npm publish zu bauen.

Typenveröffentlichung prüfen

Kurze Prüfung: Was ist die minimale korrekte Konfiguration, um Typen bereitzustellen?

Zusammenfassung

Zusammenfassung: Erzeugen Sie Deklarationen mit tsc, konfigurieren Sie package.json mit types/exports und überprüfen Sie das Paket vor der Veröffentlichung in einer Consumer-Anwendung.

Häufig gestellte Fragen

Ist die Lektion „Pakete mit Typen veröffentlichen“ kostenlos?

Ja — der vollständige Text von „Pakete mit Typen veröffentlichen“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des TypeScript Academy-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der TypeScript Academy-Kurs umfasst insgesamt 2 Lektionen.

Was lerne ich in „Pakete mit Typen veröffentlichen“?

Veröffentlichen Sie Bibliotheken mit erstklassigen Typisierungen: Erzeugen Sie .d.ts mit tsc, verweisen Sie in package.json darauf, behandeln Sie ESM-/CJS-Exporte und testen Sie vor der Veröffentlich… Du übst TypeScript Academy mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.

Brauche ich Erfahrung, um TypeScript Academy zu starten?

Keine Vorkenntnisse erforderlich. TypeScript Academy auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 2 von 2.

Wie lange dauert die Lektion „Pakete mit Typen veröffentlichen“?

Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.

Kann ich in dieser TypeScript Academy-Lektion Code schreiben und ausführen?

Ja. Jede TypeScript Academy-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.

Alle Lektionen in diesem Kurs

  1. .d.ts-Grundlagen; export type vs. export
  2. Pakete mit Typen veröffentlichen
← Zurück zu TypeScript Academy