Skip to content

Commit 3df7c86

Browse files
committed
gh-pages: update
1 parent 3b1f6ea commit 3df7c86

File tree

88 files changed

+2935
-837
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+2935
-837
lines changed

assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

classes/browser.basetransport.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h3>constructor</h3>
135135
<li class="tsd-description">
136136
<aside class="tsd-sources">
137137
<ul>
138-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
138+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
139139
</ul>
140140
</aside>
141141
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,7 +157,7 @@ <h3>options</h3>
157157
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/types.transportoptions.html" class="tsd-signature-type">TransportOptions</a></div>
158158
<aside class="tsd-sources">
159159
<ul>
160-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L11">browser/src/transports/base.ts:11</a></li>
160+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L11">browser/src/transports/base.ts:11</a></li>
161161
</ul>
162162
</aside>
163163
</section>
@@ -167,7 +167,7 @@ <h3>url</h3>
167167
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
168168
<aside class="tsd-sources">
169169
<ul>
170-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
170+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
171171
</ul>
172172
</aside>
173173
<div class="tsd-comment tsd-typography">
@@ -191,7 +191,7 @@ <h3>capture<wbr>Event</h3>
191191
<aside class="tsd-sources">
192192
<p>Implementation of <a href="../interfaces/types.transport.html">Transport</a>.<a href="../interfaces/types.transport.html#captureevent">captureEvent</a></p>
193193
<ul>
194-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L18">browser/src/transports/base.ts:18</a></li>
194+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L18">browser/src/transports/base.ts:18</a></li>
195195
</ul>
196196
</aside>
197197
<div class="tsd-comment tsd-typography">

classes/browser.beacontransport.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ <h3>constructor</h3>
130130
<aside class="tsd-sources">
131131
<p>Inherited from <a href="browser.basetransport.html">BaseTransport</a>.<a href="browser.basetransport.html#constructor">constructor</a></p>
132132
<ul>
133-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
133+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
134134
</ul>
135135
</aside>
136136
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -153,7 +153,7 @@ <h3>options</h3>
153153
<aside class="tsd-sources">
154154
<p>Inherited from <a href="browser.basetransport.html">BaseTransport</a>.<a href="browser.basetransport.html#options">options</a></p>
155155
<ul>
156-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L11">browser/src/transports/base.ts:11</a></li>
156+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L11">browser/src/transports/base.ts:11</a></li>
157157
</ul>
158158
</aside>
159159
</section>
@@ -164,7 +164,7 @@ <h3>url</h3>
164164
<aside class="tsd-sources">
165165
<p>Inherited from <a href="browser.basetransport.html">BaseTransport</a>.<a href="browser.basetransport.html#url">url</a></p>
166166
<ul>
167-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
167+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/base.ts#L9">browser/src/transports/base.ts:9</a></li>
168168
</ul>
169169
</aside>
170170
<div class="tsd-comment tsd-typography">
@@ -189,7 +189,7 @@ <h3>capture<wbr>Event</h3>
189189
<p>Implementation of <a href="../interfaces/types.transport.html">Transport</a>.<a href="../interfaces/types.transport.html#captureevent">captureEvent</a></p>
190190
<p>Overrides <a href="browser.basetransport.html">BaseTransport</a>.<a href="browser.basetransport.html#captureevent">captureEvent</a></p>
191191
<ul>
192-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/transports/beacon.ts#L13">browser/src/transports/beacon.ts:13</a></li>
192+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/transports/beacon.ts#L13">browser/src/transports/beacon.ts:13</a></li>
193193
</ul>
194194
</aside>
195195
<div class="tsd-comment tsd-typography">

classes/browser.breadcrumbs.html

Lines changed: 66 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,14 @@ <h3>Constructors</h3>
100100
<h3>Properties</h3>
101101
<ul class="tsd-index-list">
102102
<li class="tsd-kind-property tsd-parent-kind-class"><a href="browser.breadcrumbs.html#name" class="tsd-kind-icon">name</a></li>
103+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="browser.breadcrumbs.html#id" class="tsd-kind-icon">id</a></li>
103104
</ul>
104105
</section>
105106
<section class="tsd-index-section ">
106107
<h3>Methods</h3>
107108
<ul class="tsd-index-list">
108-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="browser.breadcrumbs.html#install" class="tsd-kind-icon">install</a></li>
109+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="browser.breadcrumbs.html#setuponce" class="tsd-kind-icon">setup<wbr>Once</a></li>
110+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="browser.breadcrumbs.html#addbreadcrumb" class="tsd-kind-icon">add<wbr>Breadcrumb</a></li>
109111
</ul>
110112
</section>
111113
</div>
@@ -123,7 +125,7 @@ <h3>constructor</h3>
123125
<li class="tsd-description">
124126
<aside class="tsd-sources">
125127
<ul>
126-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/integrations/breadcrumbs.ts#L65">browser/src/integrations/breadcrumbs.ts:65</a></li>
128+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/integrations/breadcrumbs.ts#L49">browser/src/integrations/breadcrumbs.ts:49</a></li>
127129
</ul>
128130
</aside>
129131
<div class="tsd-comment tsd-typography">
@@ -152,7 +154,24 @@ <h3>name</h3>
152154
<aside class="tsd-sources">
153155
<p>Implementation of <a href="../interfaces/types.integration.html">Integration</a>.<a href="../interfaces/types.integration.html#name">name</a></p>
154156
<ul>
155-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/integrations/breadcrumbs.ts#L62">browser/src/integrations/breadcrumbs.ts:62</a></li>
157+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/integrations/breadcrumbs.ts#L41">browser/src/integrations/breadcrumbs.ts:41</a></li>
158+
</ul>
159+
</aside>
160+
<div class="tsd-comment tsd-typography">
161+
<dl class="tsd-comment-tags">
162+
<dt>deprecated</dt>
163+
<dd><p>Use <a href="../interfaces/types.integrationclass.html#id">IntegrationClass.id</a> instead</p>
164+
</dd>
165+
</dl>
166+
</div>
167+
</section>
168+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
169+
<a name="id" class="tsd-anchor"></a>
170+
<h3><span class="tsd-flag ts-flagStatic">Static</span> id</h3>
171+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;Breadcrumbs&quot;</span></div>
172+
<aside class="tsd-sources">
173+
<ul>
174+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/integrations/breadcrumbs.ts#L46">browser/src/integrations/breadcrumbs.ts:46</a></li>
156175
</ul>
157176
</aside>
158177
<div class="tsd-comment tsd-typography">
@@ -166,16 +185,17 @@ <h3>name</h3>
166185
<section class="tsd-panel-group tsd-member-group ">
167186
<h2>Methods</h2>
168187
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
169-
<a name="install" class="tsd-anchor"></a>
170-
<h3>install</h3>
188+
<a name="setuponce" class="tsd-anchor"></a>
189+
<h3>setup<wbr>Once</h3>
171190
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
172-
<li class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/browser.browseroptions.html" class="tsd-signature-type">BrowserOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
191+
<li class="tsd-signature tsd-kind-icon">setup<wbr>Once<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
173192
</ul>
174193
<ul class="tsd-descriptions">
175194
<li class="tsd-description">
176195
<aside class="tsd-sources">
196+
<p>Implementation of <a href="../interfaces/types.integration.html">Integration</a>.<a href="../interfaces/types.integration.html#setuponce">setupOnce</a></p>
177197
<ul>
178-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3fd9e95/packages/browser/src/integrations/breadcrumbs.ts#L458">browser/src/integrations/breadcrumbs.ts:458</a></li>
198+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/integrations/breadcrumbs.ts#L471">browser/src/integrations/breadcrumbs.ts:471</a></li>
179199
</ul>
180200
</aside>
181201
<div class="tsd-comment tsd-typography">
@@ -190,10 +210,41 @@ <h3>install</h3>
190210
</ul>
191211
</div>
192212
</div>
213+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
214+
</li>
215+
</ul>
216+
</section>
217+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
218+
<a name="addbreadcrumb" class="tsd-anchor"></a>
219+
<h3><span class="tsd-flag ts-flagStatic">Static</span> add<wbr>Breadcrumb</h3>
220+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
221+
<li class="tsd-signature tsd-kind-icon">add<wbr>Breadcrumb<span class="tsd-signature-symbol">(</span>breadcrumb<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.breadcrumb.html" class="tsd-signature-type">Breadcrumb</a>, hint<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.sentrybreadcrumbhint.html" class="tsd-signature-type">SentryBreadcrumbHint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
222+
</ul>
223+
<ul class="tsd-descriptions">
224+
<li class="tsd-description">
225+
<aside class="tsd-sources">
226+
<ul>
227+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4b4e172/packages/browser/src/integrations/breadcrumbs.ts#L457">browser/src/integrations/breadcrumbs.ts:457</a></li>
228+
</ul>
229+
</aside>
230+
<div class="tsd-comment tsd-typography">
231+
<div class="lead">
232+
<p>Helper that checks if integration is enabled on the client.</p>
233+
</div>
234+
</div>
193235
<h4 class="tsd-parameters-title">Parameters</h4>
194236
<ul class="tsd-parameters">
195237
<li>
196-
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/browser.browseroptions.html" class="tsd-signature-type">BrowserOptions</a><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
238+
<h5>breadcrumb: <a href="../interfaces/types.breadcrumb.html" class="tsd-signature-type">Breadcrumb</a></h5>
239+
<div class="tsd-comment tsd-typography">
240+
<p>Breadcrumb</p>
241+
</div>
242+
</li>
243+
<li>
244+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hint: <a href="../interfaces/types.sentrybreadcrumbhint.html" class="tsd-signature-type">SentryBreadcrumbHint</a></h5>
245+
<div class="tsd-comment tsd-typography">
246+
<p>SentryBreadcrumbHint</p>
247+
</div>
197248
</li>
198249
</ul>
199250
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -250,8 +301,14 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
250301
<li class=" tsd-kind-property tsd-parent-kind-class">
251302
<a href="browser.breadcrumbs.html#name" class="tsd-kind-icon">name</a>
252303
</li>
304+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
305+
<a href="browser.breadcrumbs.html#id" class="tsd-kind-icon">id</a>
306+
</li>
253307
<li class=" tsd-kind-method tsd-parent-kind-class">
254-
<a href="browser.breadcrumbs.html#install" class="tsd-kind-icon">install</a>
308+
<a href="browser.breadcrumbs.html#setuponce" class="tsd-kind-icon">setup<wbr>Once</a>
309+
</li>
310+
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
311+
<a href="browser.breadcrumbs.html#addbreadcrumb" class="tsd-kind-icon">add<wbr>Breadcrumb</a>
255312
</li>
256313
</ul>
257314
</li>

0 commit comments

Comments
 (0)