A best-effort single bundled package's information.

This is roughly informed by SPDX packages and hasExtractedLicenseInfos, as making it conformant would vastly complicate the structure.

interface IPackageLicenseInfo {
    extractedText: string;
    licenseId: string;
    name: string;
    versionInfo: string;
    readonly [key: string]: ReadonlyJSONValue;
}

Hierarchy

Indexable

  • readonly [key: string]: ReadonlyJSONValue

Properties

extractedText: string

the verbatim extracted text of the license, or an empty string if unknown

licenseId: string

an SPDX license identifier or LicenseRef, or an empty string if unknown

name: string

the name of the package as it appears in package.json

versionInfo: string

the version of the package, or an empty string if unknown