Skip to content

Commit 44c1b24

Browse files
HazATHazAT
committed
feat: Add docs for @sentry packages
1 parent 8c55373 commit 44c1b24

File tree

93 files changed

+40680
-83
lines changed

Some content is hidden

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

93 files changed

+40680
-83
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules/
22
packages/
33
build/
4+
yarn-error.log

‎CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎assets/css/main.css

Lines changed: 865 additions & 0 deletions
Large diffs are not rendered by default.

‎assets/css/main.css.map

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/images/icons.png

9.26 KB

‎assets/images/icons@2x.png

27.1 KB

‎assets/images/widgets.png

480 Bytes

‎assets/images/widgets@2x.png

855 Bytes

‎assets/js/main.js

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/js/search.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎classes/browser.basetransport.html

Lines changed: 437 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.beacontransport.html

Lines changed: 435 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.breadcrumbs.html

Lines changed: 427 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.browserbackend.html

Lines changed: 672 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.browserclient.html

Lines changed: 929 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.dedupe.html

Lines changed: 406 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.ember.html

Lines changed: 414 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.fetchtransport.html

Lines changed: 435 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.functiontostring.html

Lines changed: 371 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.globalhandlers.html

Lines changed: 408 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.inboundfilters.html

Lines changed: 505 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.linkederrors.html

Lines changed: 492 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.reportingobserver.html

Lines changed: 447 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.sdkinformation.html

Lines changed: 371 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.trycatch.html

Lines changed: 371 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.vue.html

Lines changed: 414 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/browser.xhrtransport.html

Lines changed: 435 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/core.api.html

Lines changed: 489 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/core.basebackend.html

Lines changed: 583 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/core.baseclient.html

Lines changed: 855 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/core.dsn.html

Lines changed: 478 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/core.requestbuffer.html

Lines changed: 352 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/core.sentryerror.html

Lines changed: 351 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/hub.hub-1.html

Lines changed: 844 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/hub.scope.html

Lines changed: 1006 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.basetransport.html

Lines changed: 503 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.clientoptions.html

Lines changed: 362 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.console.html

Lines changed: 356 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.http.html

Lines changed: 356 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.httpstransport.html

Lines changed: 507 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.httptransport.html

Lines changed: 507 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.linkederrors.html

Lines changed: 474 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.modules.html

Lines changed: 362 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.nodebackend.html

Lines changed: 630 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.nodeclient.html

Lines changed: 877 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.onuncaughtexception.html

Lines changed: 440 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.onunhandledrejection.html

Lines changed: 397 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/node.sdkinformation.html

Lines changed: 356 additions & 0 deletions
Large diffs are not rendered by default.

‎classes/utils.store.html

Lines changed: 540 additions & 0 deletions
Large diffs are not rendered by default.

‎enums/core.loglevel.html

Lines changed: 314 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,314 @@
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>LogLevel | 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/core.html">core</a>
56+
</li>
57+
<li>
58+
<a href="core.loglevel.html">LogLevel</a>
59+
</li>
60+
</ul>
61+
<h1>Enumeration LogLevel</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>Console logging verbosity for the SDK.</p>
72+
</div>
73+
</div>
74+
</section>
75+
<section class="tsd-panel-group tsd-index-group">
76+
<h2>Index</h2>
77+
<section class="tsd-panel tsd-index-panel">
78+
<div class="tsd-index-content">
79+
<section class="tsd-index-section ">
80+
<h3>Enumeration members</h3>
81+
<ul class="tsd-index-list">
82+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="core.loglevel.html#debug" class="tsd-kind-icon">Debug</a></li>
83+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="core.loglevel.html#error" class="tsd-kind-icon">Error</a></li>
84+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="core.loglevel.html#none" class="tsd-kind-icon">None</a></li>
85+
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="core.loglevel.html#verbose" class="tsd-kind-icon">Verbose</a></li>
86+
</ul>
87+
</section>
88+
</div>
89+
</section>
90+
</section>
91+
<section class="tsd-panel-group tsd-member-group ">
92+
<h2>Enumeration members</h2>
93+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
94+
<a name="debug" class="tsd-anchor"></a>
95+
<h3>Debug</h3>
96+
<div class="tsd-signature tsd-kind-icon">Debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div>
97+
<aside class="tsd-sources">
98+
<ul>
99+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/dea78bf5/packages/core/src/interfaces.ts#L25">core/src/interfaces.ts:25</a></li>
100+
</ul>
101+
</aside>
102+
<div class="tsd-comment tsd-typography">
103+
<div class="lead">
104+
<p>Information useful for debugging the SDK will be logged.</p>
105+
</div>
106+
</div>
107+
</section>
108+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
109+
<a name="error" class="tsd-anchor"></a>
110+
<h3>Error</h3>
111+
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div>
112+
<aside class="tsd-sources">
113+
<ul>
114+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/dea78bf5/packages/core/src/interfaces.ts#L23">core/src/interfaces.ts:23</a></li>
115+
</ul>
116+
</aside>
117+
<div class="tsd-comment tsd-typography">
118+
<div class="lead">
119+
<p>Only SDK internal errors will be logged.</p>
120+
</div>
121+
</div>
122+
</section>
123+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
124+
<a name="none" class="tsd-anchor"></a>
125+
<h3>None</h3>
126+
<div class="tsd-signature tsd-kind-icon">None<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;0</span></div>
127+
<aside class="tsd-sources">
128+
<ul>
129+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/dea78bf5/packages/core/src/interfaces.ts#L21">core/src/interfaces.ts:21</a></li>
130+
</ul>
131+
</aside>
132+
<div class="tsd-comment tsd-typography">
133+
<div class="lead">
134+
<p>No logs will be generated.</p>
135+
</div>
136+
</div>
137+
</section>
138+
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
139+
<a name="verbose" class="tsd-anchor"></a>
140+
<h3>Verbose</h3>
141+
<div class="tsd-signature tsd-kind-icon">Verbose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;3</span></div>
142+
<aside class="tsd-sources">
143+
<ul>
144+
<li>Defined in <a href="https://github.com/getsentry/sentry-javascript/blob/dea78bf5/packages/core/src/interfaces.ts#L27">core/src/interfaces.ts:27</a></li>
145+
</ul>
146+
</aside>
147+
<div class="tsd-comment tsd-typography">
148+
<div class="lead">
149+
<p>All SDK actions will be logged.</p>
150+
</div>
151+
</div>
152+
</section>
153+
</section>
154+
</div>
155+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
156+
<nav class="tsd-navigation primary">
157+
<ul>
158+
<li class="globals ">
159+
<a href="../globals.html"><em>Globals</em></a>
160+
</li>
161+
<li class=" tsd-kind-external-module">
162+
<a href="../modules/browser.html">browser</a>
163+
</li>
164+
<li class="current tsd-kind-external-module">
165+
<a href="../modules/core.html">core</a>
166+
</li>
167+
<li class=" tsd-kind-external-module">
168+
<a href="../modules/hub.html">hub</a>
169+
</li>
170+
<li class=" tsd-kind-external-module">
171+
<a href="../modules/minimal.html">minimal</a>
172+
</li>
173+
<li class=" tsd-kind-external-module">
174+
<a href="../modules/node.html">node</a>
175+
</li>
176+
<li class=" tsd-kind-external-module">
177+
<a href="../modules/types.html">types</a>
178+
</li>
179+
<li class=" tsd-kind-external-module">
180+
<a href="../modules/utils.html">utils</a>
181+
</li>
182+
</ul>
183+
</nav>
184+
<nav class="tsd-navigation secondary menu-sticky">
185+
<ul class="before-current">
186+
</ul>
187+
<ul class="current">
188+
<li class="current tsd-kind-enum tsd-parent-kind-external-module">
189+
<a href="core.loglevel.html" class="tsd-kind-icon">Log<wbr>Level</a>
190+
<ul>
191+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
192+
<a href="core.loglevel.html#debug" class="tsd-kind-icon">Debug</a>
193+
</li>
194+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
195+
<a href="core.loglevel.html#error" class="tsd-kind-icon">Error</a>
196+
</li>
197+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
198+
<a href="core.loglevel.html#none" class="tsd-kind-icon">None</a>
199+
</li>
200+
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
201+
<a href="core.loglevel.html#verbose" class="tsd-kind-icon">Verbose</a>
202+
</li>
203+
</ul>
204+
</li>
205+
</ul>
206+
<ul class="after-current">
207+
<li class=" tsd-kind-class tsd-parent-kind-external-module">
208+
<a href="../classes/core.api.html" class="tsd-kind-icon">API</a>
209+
</li>
210+
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
211+
<a href="../classes/core.basebackend.html" class="tsd-kind-icon">Base<wbr>Backend</a>
212+
</li>
213+
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
214+
<a href="../classes/core.baseclient.html" class="tsd-kind-icon">Base<wbr>Client</a>
215+
</li>
216+
<li class=" tsd-kind-class tsd-parent-kind-external-module">
217+
<a href="../classes/core.dsn.html" class="tsd-kind-icon">Dsn</a>
218+
</li>
219+
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
220+
<a href="../classes/core.requestbuffer.html" class="tsd-kind-icon">Request<wbr>Buffer</a>
221+
</li>
222+
<li class=" tsd-kind-class tsd-parent-kind-external-module">
223+
<a href="../classes/core.sentryerror.html" class="tsd-kind-icon">Sentry<wbr>Error</a>
224+
</li>
225+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
226+
<a href="../interfaces/core.backend.html" class="tsd-kind-icon">Backend</a>
227+
</li>
228+
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
229+
<a href="../interfaces/core.backendclass.html" class="tsd-kind-icon">Backend<wbr>Class</a>
230+
</li>
231+
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
232+
<a href="../interfaces/core.client.html" class="tsd-kind-icon">Client</a>
233+
</li>
234+
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
235+
<a href="../interfaces/core.clientclass.html" class="tsd-kind-icon">Client<wbr>Class</a>
236+
</li>
237+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
238+
<a href="../interfaces/core.options.html" class="tsd-kind-icon">Options</a>
239+
</li>
240+
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
241+
<a href="../modules/core.html#initandbind" class="tsd-kind-icon">init<wbr>And<wbr>Bind</a>
242+
</li>
243+
</ul>
244+
</nav>
245+
</div>
246+
</div>
247+
</div>
248+
<footer class="with-border-bottom">
249+
<div class="container">
250+
<h2>Legend</h2>
251+
<div class="tsd-legend-group">
252+
<ul class="tsd-legend">
253+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
254+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
255+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
256+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
257+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
258+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
259+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
260+
</ul>
261+
<ul class="tsd-legend">
262+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
263+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
264+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
265+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
266+
</ul>
267+
<ul class="tsd-legend">
268+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
269+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
270+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
271+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
272+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
273+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
274+
</ul>
275+
<ul class="tsd-legend">
276+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
277+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
278+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
279+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
280+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
281+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
282+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
283+
</ul>
284+
<ul class="tsd-legend">
285+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
286+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
287+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
288+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
289+
</ul>
290+
<ul class="tsd-legend">
291+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
292+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
293+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
294+
</ul>
295+
<ul class="tsd-legend">
296+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
297+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
298+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
299+
</ul>
300+
<ul class="tsd-legend">
301+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
302+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
303+
</ul>
304+
</div>
305+
</div>
306+
</footer>
307+
<div class="container tsd-generator">
308+
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
309+
</div>
310+
<div class="overlay"></div>
311+
<script src="../assets/js/main.js"></script>
312+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
313+
</body>
314+
</html>

0 commit comments

Comments
 (0)