Class BomLinkDocument

Descriptor for another BOM document.

Hierarchy (View Summary)

BomLinkBase
- BomLinkDocument

Index

Constructors

Accessors

Methods

compare toString isValid

Constructors

constructor

new BomLinkDocument(value: string): BomLinkDocument
Parameters
- value: string
Returns BomLinkDocument
Throws
RangeError if value is invalid
Inherited from BomLinkBase.constructor
- Defined in src/models/bomLink.ts:33

Accessors

value

get value(): string
Returns string
Inherited from BomLinkBase.value
- Defined in src/models/bomLink.ts:37
set value(value: string): void
Parameters
- value: string
Returns void
Throws
RangeError if value is invalid
Inherited from BomLinkBase.value
- Defined in src/models/bomLink.ts:44

Methods

compare

compare(other: Stringable): 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: Stringable
Returns number
Inherited from BomLinkBase.compare
- Defined in src/models/bomLink.ts:51

toString

toString(): string
Returns string
Inherited from BomLinkBase.toString
- Defined in src/models/bomLink.ts:55

`Static`isValid

isValid(value: any): boolean
Whether the value is a valid descriptor for another BOM document.
Parameters
- value: any
Returns boolean
- Defined in src/models/bomLink.ts:72