Class Component

constructor

• new Component(
      type: ComponentType,
      name: string,
      op?: OptionalComponentProperties,
  ): Models.Component

• Parameters

  • type: ComponentType
  • name: string
  • op: OptionalComponentProperties = {}

  Returns Models.Component

  Throws

  TypeError if op.cpe is neither CPE nor undefined

Optionalauthor

components

Optionalcopyright

dependencies

Optionaldescription

Optionalevidence

externalReferences

Optionalgroup

hashes

licenses

name

properties

Optionalpublisher

Optionalpurl

Optionalscope

Optionalsupplier

Optionalswid

type

Optionalversion

bomRef

• get bomRef(): BomRef

• Returns BomRef

cpe

• get cpe(): undefined | string

• Returns undefined | string

• set cpe(value: undefined | string): void

• Parameters

  • value: undefined | string

  Returns void

  Throws

  TypeError if value is neither CPE nor undefined

compare

• compare(other: Models.Component): number

• Compare one object with another.

  The purpose of this method is not to test for equality, but have deterministic comparability. As long as this method is deterministic, there is no need for a proper ordering in any result/downstream.

  Parameters

  • other: Models.Component

  Returns number