Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
pkg
src
README.md
package-lock.json
package.json
tsconfig.json

README.md

@pika/plugin-build-types

A @pika/pack build plugin. Adds TypeScript type definitions to your package build.

Install

# npm:
npm install @pika/plugin-build-types --save-dev
# yarn:
yarn add @pika/plugin-build-types --dev

Usage

{
  "name": "example-package-json",
  "version": "1.0.0",
  "@pika/pack": {
    "pipeline": [
      ["@pika/plugin-standard-pkg"],
      ["@pika/plugin-build-types"]
    ]
  }
}

For more information about @pika/pack & help getting started, check out the main project repo.

Result

  1. Adds or generates TypeScript definitions for your package build: dist-types/
  • If your package is written in TypeScript: Types are automatically generated from your source.
  • If your package already includes custom-written type definitions: These files are automatically copied into your package build.
  • Otherwise: Automatically generate definitions from your JavaScript source. (Note that this currently requires that you include @pika/plugin-build-node or some other Node.js build earlier in the pipeline.)
  1. Adds a "types" entrypoint to your built package.json manifest.