Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/webpack-embedded-dependencies-plugin > IPackageData

IPackageData interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Data type for a package.json file. This is a superset of the full package.json file and includes additional fields that are generated by the plugin, including licenseSource, licenses, copyright, and author.

Signature:

export interface IPackageData extends IPackageJson 

Extends: IPackageJson

Properties

Property

Modifiers

Type

Description

author?

string | { name?: string; }

(BETA) (Optional) The author of the package. This is a superset of the full package.json author field. Grabs either the author field or author.name field from package.json.

copyright

string | undefined

(BETA) A small string subset which is used for copyright extraction from a licenseSource file.

licenses?

{ type: string; url: string; }[]

(BETA) (Optional) Additional license metadata if present. May contain information about a project which has multiple licenses.

licenseSource?

string

(BETA) (Optional) The source of the license file itself used for generating THIRD-PARTY-NOTICES.html or custom license files.