Skip to content

Commit e96053f

Browse files
HazATHazAT
committed
meta: Update docs
1 parent d35ed84 commit e96053f

File tree

76 files changed

+959
-912
lines changed

Some content is hidden

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

76 files changed

+959
-912
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: 12 additions & 12 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/4ff4f094/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/3e84a1d6/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/4ff4f094/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/3e84a1d6/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/4ff4f094/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/3e84a1d6/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/4ff4f094/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/3e84a1d6/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">
@@ -285,26 +285,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
285285
<li class=" tsd-kind-class tsd-parent-kind-external-module">
286286
<a href="browser.fetchtransport.html" class="tsd-kind-icon">Fetch<wbr>Transport</a>
287287
</li>
288-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
289-
<a href="browser.functiontostring.html" class="tsd-kind-icon">Function<wbr>ToString</a>
290-
</li>
291288
<li class=" tsd-kind-class tsd-parent-kind-external-module">
292289
<a href="browser.globalhandlers.html" class="tsd-kind-icon">Global<wbr>Handlers</a>
293290
</li>
294-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
295-
<a href="browser.inboundfilters.html" class="tsd-kind-icon">Inbound<wbr>Filters</a>
296-
</li>
297291
<li class=" tsd-kind-class tsd-parent-kind-external-module">
298292
<a href="browser.linkederrors.html" class="tsd-kind-icon">Linked<wbr>Errors</a>
299293
</li>
300294
<li class=" tsd-kind-class tsd-parent-kind-external-module">
301295
<a href="browser.reportingobserver.html" class="tsd-kind-icon">Reporting<wbr>Observer</a>
302296
</li>
303297
<li class=" tsd-kind-class tsd-parent-kind-external-module">
304-
<a href="browser.sdkinformation.html" class="tsd-kind-icon">SDKInformation</a>
298+
<a href="browser.trycatch.html" class="tsd-kind-icon">Try<wbr>Catch</a>
305299
</li>
306300
<li class=" tsd-kind-class tsd-parent-kind-external-module">
307-
<a href="browser.trycatch.html" class="tsd-kind-icon">Try<wbr>Catch</a>
301+
<a href="browser.useragent.html" class="tsd-kind-icon">User<wbr>Agent</a>
308302
</li>
309303
<li class=" tsd-kind-class tsd-parent-kind-external-module">
310304
<a href="browser.vue.html" class="tsd-kind-icon">Vue</a>
@@ -318,6 +312,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
318312
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
319313
<a href="../interfaces/browser.sentrywrappedxmlhttprequest.html" class="tsd-kind-icon">Sentry<wbr>WrappedXMLHttp<wbr>Request</a>
320314
</li>
315+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
316+
<a href="../interfaces/browser.stackframe.html" class="tsd-kind-icon">Stack<wbr>Frame</a>
317+
</li>
318+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
319+
<a href="../interfaces/browser.stacktrace.html" class="tsd-kind-icon">Stack<wbr>Trace</a>
320+
</li>
321321
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
322322
<a href="../modules/browser.html#sdk_name" class="tsd-kind-icon">SDK_<wbr>NAME</a>
323323
</li>

‎classes/browser.beacontransport.html

Lines changed: 12 additions & 12 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/4ff4f094/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/3e84a1d6/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/4ff4f094/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/3e84a1d6/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/4ff4f094/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/3e84a1d6/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/4ff4f094/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/3e84a1d6/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">
@@ -283,26 +283,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
283283
<li class=" tsd-kind-class tsd-parent-kind-external-module">
284284
<a href="browser.fetchtransport.html" class="tsd-kind-icon">Fetch<wbr>Transport</a>
285285
</li>
286-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
287-
<a href="browser.functiontostring.html" class="tsd-kind-icon">Function<wbr>ToString</a>
288-
</li>
289286
<li class=" tsd-kind-class tsd-parent-kind-external-module">
290287
<a href="browser.globalhandlers.html" class="tsd-kind-icon">Global<wbr>Handlers</a>
291288
</li>
292-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
293-
<a href="browser.inboundfilters.html" class="tsd-kind-icon">Inbound<wbr>Filters</a>
294-
</li>
295289
<li class=" tsd-kind-class tsd-parent-kind-external-module">
296290
<a href="browser.linkederrors.html" class="tsd-kind-icon">Linked<wbr>Errors</a>
297291
</li>
298292
<li class=" tsd-kind-class tsd-parent-kind-external-module">
299293
<a href="browser.reportingobserver.html" class="tsd-kind-icon">Reporting<wbr>Observer</a>
300294
</li>
301295
<li class=" tsd-kind-class tsd-parent-kind-external-module">
302-
<a href="browser.sdkinformation.html" class="tsd-kind-icon">SDKInformation</a>
296+
<a href="browser.trycatch.html" class="tsd-kind-icon">Try<wbr>Catch</a>
303297
</li>
304298
<li class=" tsd-kind-class tsd-parent-kind-external-module">
305-
<a href="browser.trycatch.html" class="tsd-kind-icon">Try<wbr>Catch</a>
299+
<a href="browser.useragent.html" class="tsd-kind-icon">User<wbr>Agent</a>
306300
</li>
307301
<li class=" tsd-kind-class tsd-parent-kind-external-module">
308302
<a href="browser.vue.html" class="tsd-kind-icon">Vue</a>
@@ -316,6 +310,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
316310
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
317311
<a href="../interfaces/browser.sentrywrappedxmlhttprequest.html" class="tsd-kind-icon">Sentry<wbr>WrappedXMLHttp<wbr>Request</a>
318312
</li>
313+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
314+
<a href="../interfaces/browser.stackframe.html" class="tsd-kind-icon">Stack<wbr>Frame</a>
315+
</li>
316+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
317+
<a href="../interfaces/browser.stacktrace.html" class="tsd-kind-icon">Stack<wbr>Trace</a>
318+
</li>
319319
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
320320
<a href="../modules/browser.html#sdk_name" class="tsd-kind-icon">SDK_<wbr>NAME</a>
321321
</li>

‎classes/browser.breadcrumbs.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ <h3>constructor</h3>
123123
<li class="tsd-description">
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4ff4f094/packages/browser/src/integrations/breadcrumbs.ts#L52">browser/src/integrations/breadcrumbs.ts:52</a></li>
126+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3e84a1d6/packages/browser/src/integrations/breadcrumbs.ts#L51">browser/src/integrations/breadcrumbs.ts:51</a></li>
127127
</ul>
128128
</aside>
129129
<div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@ <h3>name</h3>
154154
<aside class="tsd-sources">
155155
<p>Implementation of <a href="../interfaces/types.integration.html">Integration</a>.<a href="../interfaces/types.integration.html#name">name</a></p>
156156
<ul>
157-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4ff4f094/packages/browser/src/integrations/breadcrumbs.ts#L52">browser/src/integrations/breadcrumbs.ts:52</a></li>
157+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3e84a1d6/packages/browser/src/integrations/breadcrumbs.ts#L51">browser/src/integrations/breadcrumbs.ts:51</a></li>
158158
</ul>
159159
</aside>
160160
<div class="tsd-comment tsd-typography">
@@ -177,7 +177,7 @@ <h3>install</h3>
177177
<li class="tsd-description">
178178
<aside class="tsd-sources">
179179
<ul>
180-
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/4ff4f094/packages/browser/src/integrations/breadcrumbs.ts#L454">browser/src/integrations/breadcrumbs.ts:454</a></li>
180+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/3e84a1d6/packages/browser/src/integrations/breadcrumbs.ts#L453">browser/src/integrations/breadcrumbs.ts:453</a></li>
181181
</ul>
182182
</aside>
183183
<div class="tsd-comment tsd-typography">
@@ -275,26 +275,20 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
275275
<li class=" tsd-kind-class tsd-parent-kind-external-module">
276276
<a href="browser.fetchtransport.html" class="tsd-kind-icon">Fetch<wbr>Transport</a>
277277
</li>
278-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
279-
<a href="browser.functiontostring.html" class="tsd-kind-icon">Function<wbr>ToString</a>
280-
</li>
281278
<li class=" tsd-kind-class tsd-parent-kind-external-module">
282279
<a href="browser.globalhandlers.html" class="tsd-kind-icon">Global<wbr>Handlers</a>
283280
</li>
284-
<li class=" tsd-kind-class tsd-parent-kind-external-module">
285-
<a href="browser.inboundfilters.html" class="tsd-kind-icon">Inbound<wbr>Filters</a>
286-
</li>
287281
<li class=" tsd-kind-class tsd-parent-kind-external-module">
288282
<a href="browser.linkederrors.html" class="tsd-kind-icon">Linked<wbr>Errors</a>
289283
</li>
290284
<li class=" tsd-kind-class tsd-parent-kind-external-module">
291285
<a href="browser.reportingobserver.html" class="tsd-kind-icon">Reporting<wbr>Observer</a>
292286
</li>
293287
<li class=" tsd-kind-class tsd-parent-kind-external-module">
294-
<a href="browser.sdkinformation.html" class="tsd-kind-icon">SDKInformation</a>
288+
<a href="browser.trycatch.html" class="tsd-kind-icon">Try<wbr>Catch</a>
295289
</li>
296290
<li class=" tsd-kind-class tsd-parent-kind-external-module">
297-
<a href="browser.trycatch.html" class="tsd-kind-icon">Try<wbr>Catch</a>
291+
<a href="browser.useragent.html" class="tsd-kind-icon">User<wbr>Agent</a>
298292
</li>
299293
<li class=" tsd-kind-class tsd-parent-kind-external-module">
300294
<a href="browser.vue.html" class="tsd-kind-icon">Vue</a>
@@ -308,6 +302,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
308302
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
309303
<a href="../interfaces/browser.sentrywrappedxmlhttprequest.html" class="tsd-kind-icon">Sentry<wbr>WrappedXMLHttp<wbr>Request</a>
310304
</li>
305+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
306+
<a href="../interfaces/browser.stackframe.html" class="tsd-kind-icon">Stack<wbr>Frame</a>
307+
</li>
308+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
309+
<a href="../interfaces/browser.stacktrace.html" class="tsd-kind-icon">Stack<wbr>Trace</a>
310+
</li>
311311
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
312312
<a href="../modules/browser.html#sdk_name" class="tsd-kind-icon">SDK_<wbr>NAME</a>
313313
</li>

0 commit comments

Comments
 (0)