@appthreat/cdx-proto

Version:

Library to serialize/deserialize CycloneDX BOM with protocol buffers

89 lines • 73 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Bom | cdx-proto</title><meta name="description" content="Documentation for cdx-proto"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdx-proto</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdx-proto</a></li><li><a href="../modules/cdx_16.html">cdx_16</a></li><li><a href="cdx_16.Bom.html">Bom</a></li></ul><h1>Class Bom</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from message cyclonedx.v1_6.Bom</p> </div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">Bom</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1829">source/lib/bom-1.6_pb.ts:1829</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="cdx_16.Bom.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="cdx_16.Bom.html#annotations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>annotations</span></a> <a href="cdx_16.Bom.html#components" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>components</span></a> <a href="cdx_16.Bom.html#compositions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compositions</span></a> <a href="cdx_16.Bom.html#declarations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>declarations</span></a> <a href="cdx_16.Bom.html#definitions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>definitions</span></a> <a href="cdx_16.Bom.html#dependencies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependencies</span></a> <a href="cdx_16.Bom.html#externalReferences" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>external<wbr/>References</span></a> <a href="cdx_16.Bom.html#formulation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>formulation</span></a> <a href="cdx_16.Bom.html#metadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata?</span></a> <a href="cdx_16.Bom.html#properties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>properties</span></a> <a href="cdx_16.Bom.html#serialNumber" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>serial<wbr/>Number?</span></a> <a href="cdx_16.Bom.html#services" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>services</span></a> <a href="cdx_16.Bom.html#specVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spec<wbr/>Version</span></a> <a href="cdx_16.Bom.html#version" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version?</span></a> <a href="cdx_16.Bom.html#vulnerabilities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vulnerabilities</span></a> <a href="cdx_16.Bom.html#fields" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a> <a href="cdx_16.Bom.html#runtime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a> <a href="cdx_16.Bom.html#typeName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Name</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="cdx_16.Bom.html#clone" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a> <a href="cdx_16.Bom.html#equals" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a> <a href="cdx_16.Bom.html#fromBinary" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Binary</span></a> <a href="cdx_16.Bom.html#fromJson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a> <a href="cdx_16.Bom.html#fromJsonString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json<wbr/>String</span></a> <a href="cdx_16.Bom.html#getType" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Type</span></a> <a href="cdx_16.Bom.html#toBinary" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Binary</span></a> <a href="cdx_16.Bom.html#toJSON" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a> <a href="cdx_16.Bom.html#toJson-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Json</span></a> <a href="cdx_16.Bom.html#toJsonString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Json<wbr/>String</span></a> <a href="cdx_16.Bom.html#equals-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a> <a href="cdx_16.Bom.html#fromBinary-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Binary</span></a> <a href="cdx_16.Bom.html#fromJson-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a> <a href="cdx_16.Bom.html#fromJsonString-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json<wbr/>String</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Bom" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Bom</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><a href="#constructor.new_Bom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">PartialMessage</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a></h4><aside class="tsd-sources"><p>Overrides Message<Bom>.constructor</p><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1935">source/lib/bom-1.6_pb.ts:1935</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="annotations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>annotations</span><a href="#annotations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">annotations</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Annotation.html" class="tsd-signature-type tsd-kind-class">Annotation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinion or commentary from various stakeholders.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Annotation annotations = 11;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1905">source/lib/bom-1.6_pb.ts:1905</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="components" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">components</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Provides the ability to document a list of components.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Component components = 5;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1863">source/lib/bom-1.6_pb.ts:1863</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="compositions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>compositions</span><a href="#compositions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">compositions</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Composition.html" class="tsd-signature-type tsd-kind-class">Composition</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Composition compositions = 9;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1891">source/lib/bom-1.6_pb.ts:1891</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="declarations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>declarations</span><a href="#declarations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">declarations</span><span class="tsd-signature-symbol">:</span> <a href="cdx_16.Declarations.html" class="tsd-signature-type tsd-kind-class">Declarations</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Declarations declarations = 14;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1926">source/lib/bom-1.6_pb.ts:1926</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="definitions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>definitions</span><a href="#definitions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">definitions</span><span class="tsd-signature-symbol">:</span> <a href="cdx_16.Definition.html" class="tsd-signature-type tsd-kind-class">Definition</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>A collection of reusable objects that are defined and may be used elsewhere in the BOM.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Definition definitions = 15;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1933">source/lib/bom-1.6_pb.ts:1933</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dependencies</span><a href="#dependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dependencies</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Dependency.html" class="tsd-signature-type tsd-kind-class">Dependency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Provides the ability to document dependency relationships.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Dependency dependencies = 8;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1884">source/lib/bom-1.6_pb.ts:1884</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="externalReferences" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>external<wbr/>References</span><a href="#externalReferences" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">external<wbr/>References</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.ExternalReference.html" class="tsd-signature-type tsd-kind-class">ExternalReference</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Provides the ability to document external references related to the BOM or to the project the BOM describes.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.ExternalReference external_references = 7;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1877">source/lib/bom-1.6_pb.ts:1877</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="formulation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>formulation</span><a href="#formulation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">formulation</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Formula.html" class="tsd-signature-type tsd-kind-class">Formula</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Describes how a component or service was manufactured or deployed. This is achieved through the use of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the observed formulas describing the steps which transpired in the manufacturing process.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Formula formulation = 13;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1919">source/lib/bom-1.6_pb.ts:1919</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metadata</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Metadata.html" class="tsd-signature-type tsd-kind-class">Metadata</a></div><div class="tsd-comment tsd-typography"><p>Provides additional information about a BOM.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_6.Metadata metadata = 4;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1856">source/lib/bom-1.6_pb.ts:1856</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>properties</span><a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">properties</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Property.html" class="tsd-signature-type tsd-kind-class">Property</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Specifies optional, custom, properties</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Property properties = 12;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1912">source/lib/bom-1.6_pb.ts:1912</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="serialNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>serial<wbr/>Number</span><a href="#serialNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serial<wbr/>Number</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Every BOM generated should have a unique serial number, even if the contents of the BOM being generated have not changed over time. The process or tool responsible for creating the BOM should create random UUID's for every BOM generated.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional string serial_number = 3;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1849">source/lib/bom-1.6_pb.ts:1849</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="services" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>services</span><a href="#services" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">services</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Service.html" class="tsd-signature-type tsd-kind-class">Service</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Provides the ability to document a list of external services.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Service services = 6;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1870">source/lib/bom-1.6_pb.ts:1870</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="specVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>spec<wbr/>Version</span><a href="#specVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spec<wbr/>Version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><div class="tsd-comment tsd-typography"><p>The version of the CycloneDX specification a BOM is written to (starting at version 1.3)</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: string spec_version = 1;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1835">source/lib/bom-1.6_pb.ts:1835</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The version allows component publishers/authors to make changes to existing BOMs to update various aspects of the document such as description or licenses. When a system is presented with multiple BOMs for the same component, the system should use the most recent version of the BOM. The default version is '1' and should be incremented for each version of the BOM that is published. Each version of a component should have a unique BOM and if no changes are made to the BOMs, then each BOM will have a version of '1'.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional int32 version = 2;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1842">source/lib/bom-1.6_pb.ts:1842</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="vulnerabilities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>vulnerabilities</span><a href="#vulnerabilities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vulnerabilities</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Vulnerability.html" class="tsd-signature-type tsd-kind-class">Vulnerability</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Vulnerabilities identified in components or services.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_6.Vulnerability vulnerabilities = 10;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1898">source/lib/bom-1.6_pb.ts:1898</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>fields</span><a href="#fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldList</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1942">source/lib/bom-1.6_pb.ts:1942</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="runtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>runtime</span><a href="#runtime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">runtime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProtoRuntime</span><span class="tsd-signature-symbol"> = proto3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1940">source/lib/bom-1.6_pb.ts:1940</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="typeName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>type<wbr/>Name</span><a href="#typeName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"cyclonedx.v1_6.Bom"</span><span class="tsd-signature-symbol"> = "cyclonedx.v1_6.Bom"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.6_pb.ts#L1941">source/lib/bom-1.6_pb.ts:1941</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a deep copy.</p> </div><h4 class="tsd-returns-title">Returns <a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.clone</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:27</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="equals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="equals.equals-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">equals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Compare with a message of the same type.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PlainMessage</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.equals</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:23</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromBinary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Binary</span><a href="#fromBinary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromBinary.fromBinary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Binary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bytes</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromBinary.fromBinary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse from binary data, merging fields.</p> <p>Repeated fields are appended. Map entries are added, overwriting existing keys.</p> <p>If a message field is already present, it will be merged with the new data.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bytes</span>: <span class="tsd-signature-type">Uint8Array</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BinaryReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromBinary</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:37</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromJson.fromJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonValue</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromJson.fromJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse a message from a JSON value.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonValue</span>: <span class="tsd-signature-type">JsonValue</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromJson</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:41</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromJsonString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Json<wbr/>String</span><a href="#fromJsonString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromJsonString.fromJsonString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Json<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonString</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromJsonString.fromJsonString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse a message from a JSON string.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonString</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromJsonString</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:45</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Type</span><a href="#getType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getType.getType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageType</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><span class="tsd-signature-symbol">></span><a href="#getType.getType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageType</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_16.html" class="tsd-signature-type tsd-kind-namespace">cdx_16</a><span class="tsd-signature-symbol">.</span><a href="cdx_16.Bom.html" class="tsd-signature-type tsd-kind-class">Bom</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.getType</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:80</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toBinary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Binary</span><a href="#toBinary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toBinary.toBinary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Binary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><a href="#toBinary.toBinary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serialize the message to binary data.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BinaryWriteOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.toBinary</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:49</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JsonValue</span><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).</p> <p>Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.</p> <p>This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.</p> </div><h4 class="tsd-