Skip to content

Commit e150109

Browse files
kamilogorekkamilogorek
committed
meta: Update docs
1 parent 9a36ad4 commit e150109

File tree

95 files changed

+51548
-1
lines changed

Some content is hidden

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

95 files changed

+51548
-1
lines changed

‎assets/js/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎classes/apm.express.html

+422
Large diffs are not rendered by default.

‎classes/apm.span.html

+893
Large diffs are not rendered by default.

‎classes/apm.tracing.html

+665
Large diffs are not rendered by default.

‎classes/browser.basetransport.html

+493
Large diffs are not rendered by default.

‎classes/browser.breadcrumbs.html

+446
Large diffs are not rendered by default.

‎classes/browser.browserclient.html

+1,127
Large diffs are not rendered by default.

‎classes/browser.fetchtransport.html

+496
Large diffs are not rendered by default.

‎classes/browser.globalhandlers.html

+438
Large diffs are not rendered by default.

‎classes/browser.linkederrors.html

+441
Large diffs are not rendered by default.

‎classes/browser.trycatch.html

+398
Large diffs are not rendered by default.

‎classes/browser.useragent.html

+398
Large diffs are not rendered by default.

‎classes/browser.xhrtransport.html

+496
Large diffs are not rendered by default.

‎classes/core.api.html

+521
Large diffs are not rendered by default.

‎classes/core.baseclient.html

+1,084
Large diffs are not rendered by default.

‎classes/core.functiontostring.html

+359
Large diffs are not rendered by default.

‎classes/core.inboundfilters.html

+394
Large diffs are not rendered by default.

‎classes/core.nooptransport.html

+350
Large diffs are not rendered by default.

‎classes/hub.hub-1.html

+1,234
Large diffs are not rendered by default.

‎classes/hub.scope.html

+1,104
Large diffs are not rendered by default.

‎classes/integrations.angular.html

+458
Large diffs are not rendered by default.

‎classes/integrations.captureconsole.html

+438
Large diffs are not rendered by default.

‎classes/integrations.debug.html

+436
Large diffs are not rendered by default.

‎classes/integrations.dedupe.html

+395
Large diffs are not rendered by default.

‎classes/integrations.ember.html

+438
Large diffs are not rendered by default.

‎classes/integrations.extraerrordata.html

+471
Large diffs are not rendered by default.

‎classes/integrations.reportingobserver.html

+471
Large diffs are not rendered by default.

‎classes/integrations.rewriteframes.html

+470
Large diffs are not rendered by default.

‎classes/integrations.sessiontiming.html

+447
Large diffs are not rendered by default.

‎classes/integrations.transaction.html

+428
Large diffs are not rendered by default.

‎classes/integrations.vue.html

+438
Large diffs are not rendered by default.

‎classes/node.basetransport.html

+593
Large diffs are not rendered by default.

‎classes/node.console.html

+392
Large diffs are not rendered by default.

‎classes/node.http.html

+435
Large diffs are not rendered by default.

‎classes/node.httpstransport.html

+600
Large diffs are not rendered by default.

‎classes/node.httptransport.html

+600
Large diffs are not rendered by default.

‎classes/node.linkederrors.html

+510
Large diffs are not rendered by default.

‎classes/node.modules.html

+431
Large diffs are not rendered by default.

‎classes/node.nodeclient.html

+1,086
Large diffs are not rendered by default.

‎classes/node.onuncaughtexception.html

+476
Large diffs are not rendered by default.

‎classes/node.onunhandledrejection.html

+476
Large diffs are not rendered by default.

‎classes/utils.dsn.html

+477
Large diffs are not rendered by default.

‎classes/utils.memo.html

+344
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,344 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>Memo | Sentry JavaScript SDKs</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="../index.html" class="title">Sentry JavaScript SDKs</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
</div>
42+
</div>
43+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
44+
</div>
45+
</div>
46+
</div>
47+
</div>
48+
<div class="tsd-page-title">
49+
<div class="container">
50+
<ul class="tsd-breadcrumb">
51+
<li>
52+
<a href="../globals.html">Globals</a>
53+
</li>
54+
<li>
55+
<a href="../modules/utils.html">utils</a>
56+
</li>
57+
<li>
58+
<a href="utils.memo.html">Memo</a>
59+
</li>
60+
</ul>
61+
<h1>Class Memo</h1>
62+
</div>
63+
</div>
64+
</header>
65+
<div class="container container-main">
66+
<div class="row">
67+
<div class="col-8 col-content">
68+
<section class="tsd-panel tsd-comment">
69+
<div class="tsd-comment tsd-typography">
70+
<div class="lead">
71+
<p>Memo class used for decycle json objects. Uses WeakSet if available otherwise array.</p>
72+
</div>
73+
</div>
74+
</section>
75+
<section class="tsd-panel tsd-hierarchy">
76+
<h3>Hierarchy</h3>
77+
<ul class="tsd-hierarchy">
78+
<li>
79+
<span class="target">Memo</span>
80+
</li>
81+
</ul>
82+
</section>
83+
<section class="tsd-panel-group tsd-index-group">
84+
<h2>Index</h2>
85+
<section class="tsd-panel tsd-index-panel">
86+
<div class="tsd-index-content">
87+
<section class="tsd-index-section ">
88+
<h3>Constructors</h3>
89+
<ul class="tsd-index-list">
90+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="utils.memo.html#constructor" class="tsd-kind-icon">constructor</a></li>
91+
</ul>
92+
</section>
93+
<section class="tsd-index-section ">
94+
<h3>Methods</h3>
95+
<ul class="tsd-index-list">
96+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="utils.memo.html#memoize" class="tsd-kind-icon">memoize</a></li>
97+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="utils.memo.html#unmemoize" class="tsd-kind-icon">unmemoize</a></li>
98+
</ul>
99+
</section>
100+
</div>
101+
</section>
102+
</section>
103+
<section class="tsd-panel-group tsd-member-group ">
104+
<h2>Constructors</h2>
105+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
106+
<a name="constructor" class="tsd-anchor"></a>
107+
<h3>constructor</h3>
108+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
109+
<li class="tsd-signature tsd-kind-icon">new <wbr>Memo<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="utils.memo.html" class="tsd-signature-type">Memo</a></li>
110+
</ul>
111+
<ul class="tsd-descriptions">
112+
<li class="tsd-description">
113+
<aside class="tsd-sources">
114+
<ul>
115+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/72735fd6/packages/utils/src/memo.ts#L9">utils/src/memo.ts:9</a></li>
116+
</ul>
117+
</aside>
118+
<h4 class="tsd-returns-title">Returns <a href="utils.memo.html" class="tsd-signature-type">Memo</a></h4>
119+
</li>
120+
</ul>
121+
</section>
122+
</section>
123+
<section class="tsd-panel-group tsd-member-group ">
124+
<h2>Methods</h2>
125+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
126+
<a name="memoize" class="tsd-anchor"></a>
127+
<h3>memoize</h3>
128+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
129+
<li class="tsd-signature tsd-kind-icon">memoize<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
130+
</ul>
131+
<ul class="tsd-descriptions">
132+
<li class="tsd-description">
133+
<aside class="tsd-sources">
134+
<ul>
135+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/72735fd6/packages/utils/src/memo.ts#L21">utils/src/memo.ts:21</a></li>
136+
</ul>
137+
</aside>
138+
<div class="tsd-comment tsd-typography">
139+
<div class="lead">
140+
<p>Sets obj to remember.</p>
141+
</div>
142+
</div>
143+
<h4 class="tsd-parameters-title">Parameters</h4>
144+
<ul class="tsd-parameters">
145+
<li>
146+
<h5>obj: <span class="tsd-signature-type">any</span></h5>
147+
<div class="tsd-comment tsd-typography">
148+
<p>Object to remember</p>
149+
</div>
150+
</li>
151+
</ul>
152+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
153+
</li>
154+
</ul>
155+
</section>
156+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
157+
<a name="unmemoize" class="tsd-anchor"></a>
158+
<h3>unmemoize</h3>
159+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
160+
<li class="tsd-signature tsd-kind-icon">unmemoize<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
161+
</ul>
162+
<ul class="tsd-descriptions">
163+
<li class="tsd-description">
164+
<aside class="tsd-sources">
165+
<ul>
166+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/72735fd6/packages/utils/src/memo.ts#L44">utils/src/memo.ts:44</a></li>
167+
</ul>
168+
</aside>
169+
<div class="tsd-comment tsd-typography">
170+
<div class="lead">
171+
<p>Removes object from internal storage.</p>
172+
</div>
173+
</div>
174+
<h4 class="tsd-parameters-title">Parameters</h4>
175+
<ul class="tsd-parameters">
176+
<li>
177+
<h5>obj: <span class="tsd-signature-type">any</span></h5>
178+
<div class="tsd-comment tsd-typography">
179+
<p>Object to forget</p>
180+
</div>
181+
</li>
182+
</ul>
183+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
184+
</li>
185+
</ul>
186+
</section>
187+
</section>
188+
</div>
189+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
190+
<nav class="tsd-navigation primary">
191+
<ul>
192+
<li class="globals ">
193+
<a href="../globals.html"><em>Globals</em></a>
194+
</li>
195+
<li class=" tsd-kind-external-module">
196+
<a href="../modules/apm.html">apm</a>
197+
</li>
198+
<li class=" tsd-kind-external-module">
199+
<a href="../modules/browser.html">browser</a>
200+
</li>
201+
<li class=" tsd-kind-external-module">
202+
<a href="../modules/core.html">core</a>
203+
</li>
204+
<li class=" tsd-kind-external-module">
205+
<a href="../modules/hub.html">hub</a>
206+
</li>
207+
<li class=" tsd-kind-external-module">
208+
<a href="../modules/integrations.html">integrations</a>
209+
</li>
210+
<li class=" tsd-kind-external-module">
211+
<a href="../modules/minimal.html">minimal</a>
212+
</li>
213+
<li class=" tsd-kind-external-module">
214+
<a href="../modules/node.html">node</a>
215+
</li>
216+
<li class=" tsd-kind-external-module">
217+
<a href="../modules/types.html">types</a>
218+
</li>
219+
<li class="current tsd-kind-external-module">
220+
<a href="../modules/utils.html">utils</a>
221+
</li>
222+
</ul>
223+
</nav>
224+
<nav class="tsd-navigation secondary menu-sticky">
225+
<ul class="before-current">
226+
<li class=" tsd-kind-external-module">
227+
<a href="../modules/apm.html" class="tsd-kind-icon">apm</a>
228+
</li>
229+
<li class=" tsd-kind-external-module">
230+
<a href="../modules/browser.html" class="tsd-kind-icon">browser</a>
231+
</li>
232+
<li class=" tsd-kind-external-module">
233+
<a href="../modules/core.html" class="tsd-kind-icon">core</a>
234+
</li>
235+
<li class=" tsd-kind-external-module">
236+
<a href="../modules/hub.html" class="tsd-kind-icon">hub</a>
237+
</li>
238+
<li class=" tsd-kind-external-module">
239+
<a href="../modules/integrations.html" class="tsd-kind-icon">integrations</a>
240+
</li>
241+
<li class=" tsd-kind-external-module">
242+
<a href="../modules/minimal.html" class="tsd-kind-icon">minimal</a>
243+
</li>
244+
<li class=" tsd-kind-external-module">
245+
<a href="../modules/node.html" class="tsd-kind-icon">node</a>
246+
</li>
247+
<li class=" tsd-kind-external-module">
248+
<a href="../modules/types.html" class="tsd-kind-icon">types</a>
249+
</li>
250+
</ul>
251+
<ul class="current">
252+
<li class="current tsd-kind-external-module">
253+
<a href="../modules/utils.html" class="tsd-kind-icon">utils</a>
254+
<ul>
255+
<li class="current tsd-kind-class tsd-parent-kind-external-module">
256+
<a href="utils.memo.html" class="tsd-kind-icon">Memo</a>
257+
<ul>
258+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
259+
<a href="utils.memo.html#constructor" class="tsd-kind-icon">constructor</a>
260+
</li>
261+
<li class=" tsd-kind-method tsd-parent-kind-class">
262+
<a href="utils.memo.html#memoize" class="tsd-kind-icon">memoize</a>
263+
</li>
264+
<li class=" tsd-kind-method tsd-parent-kind-class">
265+
<a href="utils.memo.html#unmemoize" class="tsd-kind-icon">unmemoize</a>
266+
</li>
267+
</ul>
268+
</li>
269+
</ul>
270+
</li>
271+
</ul>
272+
<ul class="after-current">
273+
</ul>
274+
</nav>
275+
</div>
276+
</div>
277+
</div>
278+
<footer class="with-border-bottom">
279+
<div class="container">
280+
<h2>Legend</h2>
281+
<div class="tsd-legend-group">
282+
<ul class="tsd-legend">
283+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
284+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
285+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
286+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
287+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
288+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
289+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
290+
</ul>
291+
<ul class="tsd-legend">
292+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
293+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
294+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
295+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
296+
</ul>
297+
<ul class="tsd-legend">
298+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
299+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
300+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
301+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
302+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
303+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
304+
</ul>
305+
<ul class="tsd-legend">
306+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
307+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
308+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
309+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
310+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
311+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
312+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
313+
</ul>
314+
<ul class="tsd-legend">
315+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
316+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
317+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
318+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
319+
</ul>
320+
<ul class="tsd-legend">
321+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
322+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
323+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
324+
</ul>
325+
<ul class="tsd-legend">
326+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
327+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
328+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
329+
</ul>
330+
<ul class="tsd-legend">
331+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
332+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
333+
</ul>
334+
</div>
335+
</div>
336+
</footer>
337+
<div class="container tsd-generator">
338+
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
339+
</div>
340+
<div class="overlay"></div>
341+
<script src="../assets/js/main.js"></script>
342+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
343+
</body>
344+
</html>

0 commit comments

Comments
 (0)