Class SpdxLicense

Disjunctive license with (SPDX-)ID - aka SpdxLicense.

No validation is done internally. You may validate with SPDX.isSupportedSpdxId(). You may assert valid objects with Factories.LicenseFactory.makeSpdxLicense().

Hierarchy (View Summary)

DisjunctiveLicenseBase
- SpdxLicense

Index

Constructors

Properties

acknowledgement? text?

Accessors

Methods

Constructors

constructor

new SpdxLicense(
id: string,
op?: OptionalSpdxLicenseProperties,
): Models.SpdxLicense
Parameters
- id: string
- op: OptionalSpdxLicenseProperties = {}
Returns Models.SpdxLicense
Throws
RangeError if id is empy string
Overrides DisjunctiveLicenseBase.constructor
- Defined in src/models/license.ts:122

Properties

`Optional`acknowledgement

acknowledgement?: LicenseAcknowledgement

`Optional`text

text?: Models.Attachment

Accessors

id

get id(): string
Returns string
- Defined in src/models/license.ts:127
set id(value: string): void
Parameters
- value: string
Returns void
Throws
RangeError if value is empy string
- Defined in src/models/license.ts:134

url

get url(): undefined | string | URL
Returns undefined | string | URL
Inherited from DisjunctiveLicenseBase.url
- Defined in src/models/license.ts:74
set url(value: undefined | string | URL): void
Parameters
- value: undefined | string | URL
Returns void
Inherited from DisjunctiveLicenseBase.url
- Defined in src/models/license.ts:78

Methods

compare

compare(other: Models.SpdxLicense): number
Parameters
- other: Models.SpdxLicense
Returns number
- Defined in src/models/license.ts:141