Skip to content

Commit 953cf54

Browse files
TiLiedTiLied
committed
Updated generated docs.
Updated icon.
1 parent e719979 commit 953cf54

File tree

6,358 files changed

+67770
-65838
lines changed

Some content is hidden

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

6,358 files changed

+67770
-65838
lines changed

‎CSharpToJavaScript/Utils/CSTOJS_128.png‎

1.54 KB
Loading

‎CSharpToJavaScript/Utils/Docs/.generated.xml‎

Lines changed: 4199 additions & 5 deletions
Large diffs are not rendered by default.

‎CSharpToJavaScript/Utils/Docs/Abortcontroller/Abortcontroller.generated.xml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,33 @@ The <strong><c>AbortController</c></strong> interface represents a controller ob
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>
1111
</AbortController>
12+
<AbortControllerAbort>
13+
<summary>
14+
The <strong><c>abort()</c></strong> method of the <see cref="AbortController"/> interface aborts an asynchronous operation before it has completed.<br/>This is able to abort <see href="https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch">fetch requests</see>, the consumption of any response bodies, or streams.
15+
</summary>
16+
<remarks>
17+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
18+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort"> <em>See also on MDN</em> </seealso></para>
19+
</remarks>
20+
<returns>None (<see cref="Undefined"/>).</returns>
21+
</AbortControllerAbort>
22+
<AbortControllerAbortController>
23+
<summary>
24+
The <strong><c>AbortController()</c></strong> constructor creates a new <see cref="AbortController"/> object instance.
25+
</summary>
26+
<remarks>
27+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
28+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/AbortController"> <em>See also on MDN</em> </seealso></para>
29+
</remarks>
30+
</AbortControllerAbortController>
31+
<AbortControllerSignal>
32+
<summary>
33+
The <strong><c>signal</c></strong> read-only property of the <see cref="AbortController"/> interface returns an <see cref="AbortSignal"/> object instance, which can be used to communicate with/abort an asynchronous operation as desired.
34+
</summary>
35+
<remarks>
36+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
37+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal"> <em>See also on MDN</em> </seealso></para>
38+
</remarks>
39+
<value>An <see cref="AbortSignal"/> object instance.</value>
40+
</AbortControllerSignal>
1241
</docs>

‎CSharpToJavaScript/Utils/Docs/AbortcontrollerAbort/AbortcontrollerAbort.generated.xml‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎CSharpToJavaScript/Utils/Docs/AbortcontrollerAbortcontroller/AbortcontrollerAbortcontroller.generated.xml‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎CSharpToJavaScript/Utils/Docs/AbortcontrollerSignal/AbortcontrollerSignal.generated.xml‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎CSharpToJavaScript/Utils/Docs/Abortsignal/Abortsignal.generated.xml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,73 @@ The <strong><c>AbortSignal</c></strong> interface represents a signal object tha
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>
1111
</AbortSignal>
12+
<AbortSignalAborted>
13+
<summary>
14+
The <strong><c>aborted</c></strong> read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (<c>true</c>) or not (<c>false</c>).
15+
</summary>
16+
<remarks>
17+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
18+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/aborted"> <em>See also on MDN</em> </seealso></para>
19+
</remarks>
20+
<value><c>true</c> (aborted) or <c>false</c></value>
21+
</AbortSignalAborted>
22+
<AbortSignalAbort>
23+
<summary>
24+
The <strong><c>abort</c></strong> event of the <see cref="AbortSignal"/> is fired when the associated request is aborted, i.e., using <see cref="AbortController.Abort"/>.
25+
</summary>
26+
<remarks>
27+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort"> <em>See also on MDN</em> </seealso></para>
28+
</remarks>
29+
</AbortSignalAbort>
30+
<AbortSignalAbort>
31+
<summary>
32+
The <strong><c>AbortSignal.abort()</c></strong> static method returns an <see cref="AbortSignal"/> that is already set as aborted (and which does not trigger an <see cref="AbortSignalabort"/> event).
33+
</summary>
34+
<remarks>
35+
<para>This is shorthand for the following code:</para><para>This could, for example, be passed to a fetch method in order to run its abort logic (i.e., it may be that code is organized such that the abort logic should be run even if the intended fetch operation has not been started).</para><blockquote class="NOTE"><h5>NOTE</h5><para>The method is similar in purpose to <see cref="PromiseReject"/>.</para></blockquote>
36+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort"> <em>See also on MDN</em> </seealso></para>
37+
</remarks>
38+
<returns>An <c>AbortSignal</c> instance with the <see cref="AbortSignal.Aborted"/> property set to <c>true</c>, and <see cref="AbortSignal.Reason"/> set to the specified or default reason value.</returns>
39+
</AbortSignalAbort>
40+
<AbortSignalAny>
41+
<summary>
42+
The <strong><c>AbortSignal.any()</c></strong> static method takes an iterable of abort signals and returns an <see cref="AbortSignal"/>. The returned abort signal is aborted when any of the input iterable abort signals are aborted. The {{domxref("AbortSignal.reason", "abort reason",&amp;quot;&amp;quot;,"true")}} will be set to the reason of the first signal that is aborted. If any of the given abort signals are already aborted then so will be the returned <see cref="AbortSignal"/>.
43+
</summary>
44+
<remarks>
45+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any"> <em>See also on MDN</em> </seealso></para>
46+
</remarks>
47+
<returns>A <see cref="AbortSignal"/> that is:</returns>
48+
</AbortSignalAny>
49+
<AbortSignalReason>
50+
<summary>
51+
The <strong><c>reason</c></strong> read-only property returns a JavaScript value that indicates the abort reason.
52+
</summary>
53+
<remarks>
54+
<para>The property is <c>undefined</c> when the signal has not been aborted.<br/>It can be set to a specific value when the signal is aborted, using <see cref="AbortController.Abort"/> or <see cref="AbortSignalabort"/>.<br/>If not explicitly set in those methods, it defaults to "AbortError" <see cref="DOMException"/>.</para>
55+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
56+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/reason"> <em>See also on MDN</em> </seealso></para>
57+
</remarks>
58+
<value>A JavaScript value that indicates the abort reason, or <c>undefined</c>, if not aborted.</value>
59+
</AbortSignalReason>
60+
<AbortSignalThrowIfAborted>
61+
<summary>
62+
The <strong><c>throwIfAborted()</c></strong> method throws the signal's abort <see cref="AbortSignal.Reason"/> if the signal has been aborted; otherwise it does nothing.
63+
</summary>
64+
<remarks>
65+
<para>An API that needs to support aborting can accept an <see cref="AbortSignal"/> object and use <c>throwIfAborted()</c> to test and throw when the <see href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort_event"><c>abort</c></see> event is signalled.</para><para>This method can also be used to abort operations at particular points in code, rather than passing to functions that take a signal.</para>
66+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
67+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/throwIfAborted"> <em>See also on MDN</em> </seealso></para>
68+
</remarks>
69+
<returns>None (<see cref="Undefined"/>).</returns>
70+
</AbortSignalThrowIfAborted>
71+
<AbortSignalTimeout>
72+
<summary>
73+
The <strong><c>AbortSignal.timeout()</c></strong> static method returns an <see cref="AbortSignal"/> that will automatically abort after a specified time.
74+
</summary>
75+
<remarks>
76+
<para>The signal aborts with a <c>TimeoutError</c> <see cref="DOMException"/> on timeout.</para><para>The timeout is based on active rather than elapsed time, and will effectively be paused if the code is running in a suspended worker, or while the document is in a back-forward cache (&amp;quot;<see href="https://web.dev/articles/bfcache">bfcache</see>&amp;quot;).</para><para>To combine multiple signals, you can use <see cref="AbortSignalany"/>, for example, to directly abort a download using either a timeout signal or by calling <see cref="AbortController.Abort"/>.</para>
77+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout"> <em>See also on MDN</em> </seealso></para>
78+
</remarks>
79+
<returns>An <see cref="AbortSignal"/>.The signal will abort with its <see cref="AbortSignal.Reason"/> property set to a <c>TimeoutError</c> <see cref="DOMException"/> on timeout, or an <c>AbortError</c> <see cref="DOMException"/> if the operation was user-triggered.</returns>
80+
</AbortSignalTimeout>
1281
</docs>

‎CSharpToJavaScript/Utils/Docs/AbortsignalAbort/AbortsignalAbort.generated.xml‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎CSharpToJavaScript/Utils/Docs/AbortsignalAborted/AbortsignalAborted.generated.xml‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎CSharpToJavaScript/Utils/Docs/AbortsignalAny/AbortsignalAny.generated.xml‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)