Class PostalAddress

A postal address used to identify a contactable location.

See

https://cyclonedx.org/docs/1.7/xml/#type_postalAddressType

Implements

Comparable<Models.PostalAddress>

Index

Constructors

Properties

country? locality? postalCode? postOfficeBoxNumber? region? streetAddress?

Methods

Constructors

constructor

new PostalAddress(op?: OptionalPostalAddressProperties): Models.PostalAddress
Parameters
- op: OptionalPostalAddressProperties = {}
Returns Models.PostalAddress
- Defined in src/models/postalAddress.ts:44

Properties

`Optional`country

country?: string

`Optional`locality

locality?: string

`Optional`postalCode

postalCode?: string

`Optional`postOfficeBoxNumber

postOfficeBoxNumber?: string

`Optional`region

region?: string

`Optional`streetAddress

streetAddress?: string

Methods

compare

compare(other: Models.PostalAddress): 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.PostalAddress
Returns number
Implementation of Comparable.compare
- Defined in src/models/postalAddress.ts:53