Interface: IPackageLicenseInfo#

licenses.IPackageLicenseInfo

A best-effort single bundled package’s information.

Note

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

see https://github.com/spdx/spdx-spec/blob/development/v2.2.1/schemas/spdx-schema.json

Hierarchy#

  • ReadonlyJSONObject

    IPackageLicenseInfo

Properties#

extractedText#

extractedText: string

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

Defined in#

packages/licenses/lib/tokens.d.ts:73


licenseId#

licenseId: string

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

Defined in#

packages/licenses/lib/tokens.d.ts:69


name#

name: string

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

Defined in#

packages/licenses/lib/tokens.d.ts:61


versionInfo#

versionInfo: string

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

Defined in#

packages/licenses/lib/tokens.d.ts:65