@cloudflare/workers-types 5.20260811.1 → 5.20260812.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/experimental/index.d.ts +332 -356
- package/experimental/index.ts +334 -368
- package/index.d.ts +319 -343
- package/index.ts +321 -355
- package/package.json +1 -1
package/index.ts
CHANGED
|
@@ -16,26 +16,26 @@ and limitations under the License.
|
|
|
16
16
|
// noinspection JSUnusedGlobalSymbols
|
|
17
17
|
export declare var onmessage: never;
|
|
18
18
|
/**
|
|
19
|
-
* The **`DOMException`** interface represents an abnormal event (called an
|
|
19
|
+
* The **`DOMException`** interface represents an abnormal event (called an exception) that occurs as a result of calling a method or accessing a property of a web API. This is how error conditions are described in web APIs.
|
|
20
20
|
*
|
|
21
21
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException)
|
|
22
22
|
*/
|
|
23
23
|
export declare class DOMException extends Error {
|
|
24
24
|
constructor(message?: string, name?: string);
|
|
25
25
|
/**
|
|
26
|
-
* The **`message`** read-only property of the a message or description associated with the given error name.
|
|
26
|
+
* The **`message`** read-only property of the DOMException interface returns a string representing a message or description associated with the given error name.
|
|
27
27
|
*
|
|
28
28
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/message)
|
|
29
29
|
*/
|
|
30
30
|
readonly message: string;
|
|
31
31
|
/**
|
|
32
|
-
* The **`name`** read-only property of the one of the strings associated with an error name.
|
|
32
|
+
* The **`name`** read-only property of the DOMException interface returns a string that contains one of the strings associated with an error name.
|
|
33
33
|
*
|
|
34
34
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/name)
|
|
35
35
|
*/
|
|
36
36
|
readonly name: string;
|
|
37
37
|
/**
|
|
38
|
-
* The **`code`** read-only property of the DOMException interface returns one of the legacy error code constants, or
|
|
38
|
+
* The **`code`** read-only property of the DOMException interface returns one of the legacy error code constants, or 0 if none match.
|
|
39
39
|
* @deprecated
|
|
40
40
|
*
|
|
41
41
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DOMException/code)
|
|
@@ -85,7 +85,7 @@ export declare abstract class WorkerGlobalScope extends EventTarget<WorkerGlobal
|
|
|
85
85
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console)
|
|
86
86
|
*/
|
|
87
87
|
export interface Console {
|
|
88
|
-
|
|
88
|
+
assert(condition?: boolean, ...data: any[]): void;
|
|
89
89
|
/**
|
|
90
90
|
* The **`console.clear()`** static method clears the console if possible.
|
|
91
91
|
*
|
|
@@ -93,61 +93,61 @@ export interface Console {
|
|
|
93
93
|
*/
|
|
94
94
|
clear(): void;
|
|
95
95
|
/**
|
|
96
|
-
* The **`console.count()`** static method logs the number of times that this particular call to
|
|
96
|
+
* The **`console.count()`** static method logs the number of times that this particular call to count() has been called.
|
|
97
97
|
*
|
|
98
98
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count_static)
|
|
99
99
|
*/
|
|
100
100
|
count(label?: string): void;
|
|
101
101
|
/**
|
|
102
|
-
* The **`console.countReset()`** static method resets counter used with console
|
|
102
|
+
* The **`console.countReset()`** static method resets counter used with console.count().
|
|
103
103
|
*
|
|
104
104
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/countReset_static)
|
|
105
105
|
*/
|
|
106
106
|
countReset(label?: string): void;
|
|
107
107
|
/**
|
|
108
|
-
* The **`console.debug()`** static method outputs a message to the console at the
|
|
108
|
+
* The **`console.debug()`** static method outputs a message to the console at the "debug" log level. The message is only displayed to the user if the console is configured to display debug output. In most cases, the log level is configured within the console UI. This log level might correspond to the Debug or Verbose log level.
|
|
109
109
|
*
|
|
110
110
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug_static)
|
|
111
111
|
*/
|
|
112
112
|
debug(...data: any[]): void;
|
|
113
113
|
/**
|
|
114
|
-
* The **`console.dir()`** static method displays a list of the properties of the specified JavaScript object.
|
|
114
|
+
* The **`console.dir()`** static method displays a list of the properties of the specified JavaScript object. In browser consoles, the output is presented as a hierarchical listing with disclosure triangles that let you see the contents of child objects.
|
|
115
115
|
*
|
|
116
116
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir_static)
|
|
117
117
|
*/
|
|
118
118
|
dir(item?: any, options?: any): void;
|
|
119
119
|
/**
|
|
120
|
-
* The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element.
|
|
120
|
+
* The **`console.dirxml()`** static method displays an interactive tree of the descendant elements of the specified XML/HTML element. If it is not possible to display as an element the JavaScript Object view is shown instead. The output is presented as a hierarchical listing of expandable nodes that let you see the contents of child nodes.
|
|
121
121
|
*
|
|
122
122
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml_static)
|
|
123
123
|
*/
|
|
124
124
|
dirxml(...data: any[]): void;
|
|
125
125
|
/**
|
|
126
|
-
* The **`console.error()`** static method outputs a message to the console at the
|
|
126
|
+
* The **`console.error()`** static method outputs a message to the console at the "error" log level. The message is only displayed to the user if the console is configured to display error output. In most cases, the log level is configured within the console UI. The message may be formatted as an error, with red colors and call stack information.
|
|
127
127
|
*
|
|
128
128
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error_static)
|
|
129
129
|
*/
|
|
130
130
|
error(...data: any[]): void;
|
|
131
131
|
/**
|
|
132
|
-
* The **`console.group()`** static method creates a new inline group in the Web console log, causing any subsequent console messages to be indented by an additional level, until console
|
|
132
|
+
* The **`console.group()`** static method creates a new inline group in the Web console log, causing any subsequent console messages to be indented by an additional level, until console.groupEnd() is called.
|
|
133
133
|
*
|
|
134
134
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group_static)
|
|
135
135
|
*/
|
|
136
136
|
group(...data: any[]): void;
|
|
137
137
|
/**
|
|
138
|
-
* The **`console.groupCollapsed()`** static method creates a new inline group in the console.
|
|
138
|
+
* The **`console.groupCollapsed()`** static method creates a new inline group in the console. Unlike console.group(), however, the new group is created collapsed. The user will need to use the disclosure button next to it to expand it, revealing the entries created in the group.
|
|
139
139
|
*
|
|
140
140
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed_static)
|
|
141
141
|
*/
|
|
142
142
|
groupCollapsed(...data: any[]): void;
|
|
143
143
|
/**
|
|
144
|
-
* The **`console.groupEnd()`** static method exits the current inline group in the console.
|
|
144
|
+
* The **`console.groupEnd()`** static method exits the current inline group in the console. See Using groups in the console in the console documentation for details and examples.
|
|
145
145
|
*
|
|
146
146
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd_static)
|
|
147
147
|
*/
|
|
148
148
|
groupEnd(): void;
|
|
149
149
|
/**
|
|
150
|
-
* The **`console.info()`** static method outputs a message to the console at the
|
|
150
|
+
* The **`console.info()`** static method outputs a message to the console at the "info" log level. The message is only displayed to the user if the console is configured to display info output. In most cases, the log level is configured within the console UI. The message may receive special formatting, such as a small "i" icon next to it.
|
|
151
151
|
*
|
|
152
152
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info_static)
|
|
153
153
|
*/
|
|
@@ -165,23 +165,24 @@ export interface Console {
|
|
|
165
165
|
*/
|
|
166
166
|
table(tabularData?: any, properties?: string[]): void;
|
|
167
167
|
/**
|
|
168
|
-
* The **`console.time()`** static method starts a timer you can use to track how long an operation takes.
|
|
168
|
+
* The **`console.time()`** static method starts a timer you can use to track how long an operation takes. You give each timer a unique name, and may have up to 10,000 timers running on a given page. When you call console.timeEnd() with the same name, the browser will output the time, in milliseconds, that elapsed since the timer was started.
|
|
169
169
|
*
|
|
170
170
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time_static)
|
|
171
171
|
*/
|
|
172
172
|
time(label?: string): void;
|
|
173
173
|
/**
|
|
174
|
-
* The **`console.timeEnd()`** static method stops a timer that was previously started by calling console
|
|
174
|
+
* The **`console.timeEnd()`** static method stops a timer that was previously started by calling console.time().
|
|
175
175
|
*
|
|
176
176
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd_static)
|
|
177
177
|
*/
|
|
178
178
|
timeEnd(label?: string): void;
|
|
179
179
|
/**
|
|
180
|
-
* The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling console
|
|
180
|
+
* The **`console.timeLog()`** static method logs the current value of a timer that was previously started by calling console.time().
|
|
181
181
|
*
|
|
182
182
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog_static)
|
|
183
183
|
*/
|
|
184
184
|
timeLog(label?: string, ...data: any[]): void;
|
|
185
|
+
/* The **`console.timeStamp()`** static method adds a single marker to the browser's Performance tool (Firefox bug 1387528, Chrome). This lets you correlate a point in your code with the other events recorded in the timeline, such as layout and paint events. */
|
|
185
186
|
timeStamp(label?: string): void;
|
|
186
187
|
/**
|
|
187
188
|
* The **`console.trace()`** static method outputs a stack trace to the console.
|
|
@@ -190,7 +191,7 @@ export interface Console {
|
|
|
190
191
|
*/
|
|
191
192
|
trace(...data: any[]): void;
|
|
192
193
|
/**
|
|
193
|
-
* The **`console.warn()`** static method outputs a warning message to the console at the
|
|
194
|
+
* The **`console.warn()`** static method outputs a warning message to the console at the "warning" log level. The message is only displayed to the user if the console is configured to display warning output. In most cases, the log level is configured within the console UI. The message may receive special formatting, such as yellow colors and a warning icon.
|
|
194
195
|
*
|
|
195
196
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn_static)
|
|
196
197
|
*/
|
|
@@ -218,13 +219,7 @@ export declare namespace WebAssembly {
|
|
|
218
219
|
constructor(message?: string);
|
|
219
220
|
}
|
|
220
221
|
type ValueType =
|
|
221
|
-
| "
|
|
222
|
-
| "externref"
|
|
223
|
-
| "f32"
|
|
224
|
-
| "f64"
|
|
225
|
-
| "i32"
|
|
226
|
-
| "i64"
|
|
227
|
-
| "v128";
|
|
222
|
+
"anyfunc" | "externref" | "f32" | "f64" | "i32" | "i64" | "v128";
|
|
228
223
|
interface GlobalDescriptor {
|
|
229
224
|
value: ValueType;
|
|
230
225
|
mutable?: boolean;
|
|
@@ -412,7 +407,7 @@ export declare function removeEventListener<
|
|
|
412
407
|
options?: EventTargetEventListenerOptions | boolean,
|
|
413
408
|
): void;
|
|
414
409
|
/**
|
|
415
|
-
* The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
|
|
410
|
+
* The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
|
|
416
411
|
*
|
|
417
412
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
|
|
418
413
|
*/
|
|
@@ -479,6 +474,7 @@ export declare const crypto: Crypto;
|
|
|
479
474
|
* [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/cache/)
|
|
480
475
|
*/
|
|
481
476
|
export declare const caches: CacheStorage;
|
|
477
|
+
/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/scheduler) */
|
|
482
478
|
export declare const scheduler: Scheduler;
|
|
483
479
|
/**
|
|
484
480
|
* The Workers runtime supports a subset of the Performance API, used to measure timing and performance,
|
|
@@ -672,10 +668,7 @@ export declare abstract class DurableObjectNamespace<
|
|
|
672
668
|
): DurableObjectNamespace<T>;
|
|
673
669
|
}
|
|
674
670
|
export type DurableObjectJurisdiction =
|
|
675
|
-
| "
|
|
676
|
-
| "fedramp"
|
|
677
|
-
| "fedramp-high"
|
|
678
|
-
| "us";
|
|
671
|
+
"eu" | "fedramp" | "fedramp-high" | "us";
|
|
679
672
|
export interface DurableObjectNamespaceNewUniqueIdOptions {
|
|
680
673
|
jurisdiction?: DurableObjectJurisdiction;
|
|
681
674
|
}
|
|
@@ -825,8 +818,7 @@ export interface DurableObjectFacets {
|
|
|
825
818
|
get<T extends Rpc.DurableObjectBranded | undefined = undefined>(
|
|
826
819
|
name: string,
|
|
827
820
|
getStartupOptions: () =>
|
|
828
|
-
| FacetStartupOptions<T
|
|
829
|
-
| Promise<FacetStartupOptions<T>>,
|
|
821
|
+
FacetStartupOptions<T> | Promise<FacetStartupOptions<T>>,
|
|
830
822
|
): Fetcher<T>;
|
|
831
823
|
abort(name: string, reason: any): void;
|
|
832
824
|
delete(name: string): void;
|
|
@@ -847,26 +839,26 @@ export interface AnalyticsEngineDataPoint {
|
|
|
847
839
|
blobs?: ((ArrayBuffer | string) | null)[];
|
|
848
840
|
}
|
|
849
841
|
/**
|
|
850
|
-
* The **`Event`** interface represents an event which takes place on an
|
|
842
|
+
* The **`Event`** interface represents an event which takes place on an EventTarget.
|
|
851
843
|
*
|
|
852
844
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event)
|
|
853
845
|
*/
|
|
854
846
|
export declare class Event {
|
|
855
847
|
constructor(type: string, init?: EventInit);
|
|
856
848
|
/**
|
|
857
|
-
* The **`type`** read-only property of the Event interface returns a string containing the event's type.
|
|
849
|
+
* The **`type`** read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.
|
|
858
850
|
*
|
|
859
851
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)
|
|
860
852
|
*/
|
|
861
853
|
get type(): string;
|
|
862
854
|
/**
|
|
863
|
-
* The **`eventPhase`** read-only property of the being evaluated.
|
|
855
|
+
* The **`eventPhase`** read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
|
|
864
856
|
*
|
|
865
857
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)
|
|
866
858
|
*/
|
|
867
859
|
get eventPhase(): number;
|
|
868
860
|
/**
|
|
869
|
-
* The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.
|
|
861
|
+
* The read-only **`composed`** property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
|
|
870
862
|
*
|
|
871
863
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)
|
|
872
864
|
*/
|
|
@@ -903,13 +895,13 @@ export declare class Event {
|
|
|
903
895
|
*/
|
|
904
896
|
get currentTarget(): EventTarget | undefined;
|
|
905
897
|
/**
|
|
906
|
-
* The read-only **`target`** property of the dispatched.
|
|
898
|
+
* The read-only **`target`** property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.
|
|
907
899
|
*
|
|
908
900
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)
|
|
909
901
|
*/
|
|
910
902
|
get target(): EventTarget | undefined;
|
|
911
903
|
/**
|
|
912
|
-
* The deprecated **`Event.srcElement`** is an alias for the Event.target property.
|
|
904
|
+
* The deprecated **`Event.srcElement`** is an alias for the Event.target property. Use Event.target instead.
|
|
913
905
|
* @deprecated
|
|
914
906
|
*
|
|
915
907
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)
|
|
@@ -922,45 +914,45 @@ export declare class Event {
|
|
|
922
914
|
*/
|
|
923
915
|
get timeStamp(): number;
|
|
924
916
|
/**
|
|
925
|
-
* The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and
|
|
917
|
+
* The **`isTrusted`** read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.
|
|
926
918
|
*
|
|
927
919
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)
|
|
928
920
|
*/
|
|
929
921
|
get isTrusted(): boolean;
|
|
930
922
|
/**
|
|
931
|
-
* The **`cancelBubble`** property of the Event interface is deprecated.
|
|
923
|
+
* The **`cancelBubble`** property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.
|
|
932
924
|
* @deprecated
|
|
933
925
|
*
|
|
934
926
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)
|
|
935
927
|
*/
|
|
936
928
|
get cancelBubble(): boolean;
|
|
937
929
|
/**
|
|
938
|
-
* The **`cancelBubble`** property of the Event interface is deprecated.
|
|
930
|
+
* The **`cancelBubble`** property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.
|
|
939
931
|
* @deprecated
|
|
940
932
|
*
|
|
941
933
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)
|
|
942
934
|
*/
|
|
943
935
|
set cancelBubble(value: boolean);
|
|
944
936
|
/**
|
|
945
|
-
* The **`stopImmediatePropagation()`** method of the
|
|
937
|
+
* The **`stopImmediatePropagation()`** method of the Event interface prevents other listeners of the same event from being called.
|
|
946
938
|
*
|
|
947
939
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)
|
|
948
940
|
*/
|
|
949
941
|
stopImmediatePropagation(): void;
|
|
950
942
|
/**
|
|
951
|
-
* The **`preventDefault()`** method of the Event interface tells the user agent that
|
|
943
|
+
* The **`preventDefault()`** method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.
|
|
952
944
|
*
|
|
953
945
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)
|
|
954
946
|
*/
|
|
955
947
|
preventDefault(): void;
|
|
956
948
|
/**
|
|
957
|
-
* The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.
|
|
949
|
+
* The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().
|
|
958
950
|
*
|
|
959
951
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)
|
|
960
952
|
*/
|
|
961
953
|
stopPropagation(): void;
|
|
962
954
|
/**
|
|
963
|
-
* The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.
|
|
955
|
+
* The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
|
|
964
956
|
*
|
|
965
957
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)
|
|
966
958
|
*/
|
|
@@ -985,7 +977,7 @@ export type EventListenerOrEventListenerObject<
|
|
|
985
977
|
EventType extends Event = Event,
|
|
986
978
|
> = EventListener<EventType> | EventListenerObject<EventType>;
|
|
987
979
|
/**
|
|
988
|
-
* The **`EventTarget`** interface is implemented by objects that can receive events and may have listeners for them.
|
|
980
|
+
* The **`EventTarget`** interface is implemented by objects that can receive events and may have listeners for them. In other words, any target of events implements the three methods associated with this interface.
|
|
989
981
|
*
|
|
990
982
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget)
|
|
991
983
|
*/
|
|
@@ -1004,7 +996,7 @@ export declare class EventTarget<
|
|
|
1004
996
|
options?: EventTargetAddEventListenerOptions | boolean,
|
|
1005
997
|
): void;
|
|
1006
998
|
/**
|
|
1007
|
-
* The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
|
|
999
|
+
* The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
|
|
1008
1000
|
*
|
|
1009
1001
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
|
|
1010
1002
|
*/
|
|
@@ -1014,7 +1006,7 @@ export declare class EventTarget<
|
|
|
1014
1006
|
options?: EventTargetEventListenerOptions | boolean,
|
|
1015
1007
|
): void;
|
|
1016
1008
|
/**
|
|
1017
|
-
* The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
|
|
1009
|
+
* The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
|
|
1018
1010
|
*
|
|
1019
1011
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
|
|
1020
1012
|
*/
|
|
@@ -1046,7 +1038,7 @@ export declare class AbortController {
|
|
|
1046
1038
|
*/
|
|
1047
1039
|
get signal(): AbortSignal;
|
|
1048
1040
|
/**
|
|
1049
|
-
* The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed.
|
|
1041
|
+
* The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed. This is able to abort fetch requests, the consumption of any response bodies, or streams.
|
|
1050
1042
|
*
|
|
1051
1043
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort)
|
|
1052
1044
|
*/
|
|
@@ -1059,7 +1051,7 @@ export declare class AbortController {
|
|
|
1059
1051
|
*/
|
|
1060
1052
|
export declare abstract class AbortSignal extends EventTarget {
|
|
1061
1053
|
/**
|
|
1062
|
-
* The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an
|
|
1054
|
+
* The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an abort event).
|
|
1063
1055
|
*
|
|
1064
1056
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static)
|
|
1065
1057
|
*/
|
|
@@ -1071,13 +1063,13 @@ export declare abstract class AbortSignal extends EventTarget {
|
|
|
1071
1063
|
*/
|
|
1072
1064
|
static timeout(delay: number): AbortSignal;
|
|
1073
1065
|
/**
|
|
1074
|
-
* The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal.
|
|
1066
|
+
* The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal. The returned abort signal is aborted when any of the input iterable abort signals are aborted. The abort reason 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 AbortSignal.
|
|
1075
1067
|
*
|
|
1076
1068
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static)
|
|
1077
1069
|
*/
|
|
1078
1070
|
static any(signals: AbortSignal[]): AbortSignal;
|
|
1079
1071
|
/**
|
|
1080
|
-
* The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (
|
|
1072
|
+
* The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (true) or not (false).
|
|
1081
1073
|
*
|
|
1082
1074
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/aborted)
|
|
1083
1075
|
*/
|
|
@@ -1093,12 +1085,17 @@ export declare abstract class AbortSignal extends EventTarget {
|
|
|
1093
1085
|
/* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */
|
|
1094
1086
|
set onabort(value: any | null);
|
|
1095
1087
|
/**
|
|
1096
|
-
* The **`throwIfAborted()`** method throws the signal's abort
|
|
1088
|
+
* The **`throwIfAborted()`** method throws the signal's abort reason if the signal has been aborted; otherwise it does nothing.
|
|
1097
1089
|
*
|
|
1098
1090
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted)
|
|
1099
1091
|
*/
|
|
1100
1092
|
throwIfAborted(): void;
|
|
1101
1093
|
}
|
|
1094
|
+
/**
|
|
1095
|
+
* The **`Scheduler`** interface of the Prioritized Task Scheduling API provides methods for scheduling prioritized tasks.
|
|
1096
|
+
*
|
|
1097
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Scheduler)
|
|
1098
|
+
*/
|
|
1102
1099
|
export interface Scheduler {
|
|
1103
1100
|
wait(delay: number, maybeOptions?: SchedulerWaitOptions): Promise<void>;
|
|
1104
1101
|
}
|
|
@@ -1106,20 +1103,20 @@ export interface SchedulerWaitOptions {
|
|
|
1106
1103
|
signal?: AbortSignal;
|
|
1107
1104
|
}
|
|
1108
1105
|
/**
|
|
1109
|
-
* The **`ExtendableEvent`** interface extends the lifetime of the
|
|
1106
|
+
* The **`ExtendableEvent`** interface extends the lifetime of the install and activate events dispatched on the global scope as part of the service worker lifecycle. This ensures that any functional events (like FetchEvent) are not dispatched until it upgrades database schemas and deletes the outdated cache entries.
|
|
1110
1107
|
*
|
|
1111
1108
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ExtendableEvent)
|
|
1112
1109
|
*/
|
|
1113
1110
|
export declare abstract class ExtendableEvent extends Event {
|
|
1114
1111
|
/**
|
|
1115
|
-
* The **`ExtendableEvent.waitUntil()`** method tells the event dispatcher that work is ongoing.
|
|
1112
|
+
* The **`ExtendableEvent.waitUntil()`** method tells the event dispatcher that work is ongoing. It can also be used to detect whether that work was successful. In service workers, waitUntil() tells the browser that work is ongoing until the promise settles, and it shouldn't terminate the service worker if it wants that work to complete.
|
|
1116
1113
|
*
|
|
1117
1114
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ExtendableEvent/waitUntil)
|
|
1118
1115
|
*/
|
|
1119
1116
|
waitUntil(promise: Promise<any>): void;
|
|
1120
1117
|
}
|
|
1121
1118
|
/**
|
|
1122
|
-
* The **`CustomEvent`** interface
|
|
1119
|
+
* The **`CustomEvent`** interface can be used to attach custom data to an event generated by an application.
|
|
1123
1120
|
*
|
|
1124
1121
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent)
|
|
1125
1122
|
*/
|
|
@@ -1161,7 +1158,7 @@ export declare class Blob {
|
|
|
1161
1158
|
*/
|
|
1162
1159
|
get type(): string;
|
|
1163
1160
|
/**
|
|
1164
|
-
* The **`slice()`** method of the Blob interface creates and returns a new
|
|
1161
|
+
* The **`slice()`** method of the Blob interface creates and returns a new Blob object which contains data from a subset of the blob on which it's called.
|
|
1165
1162
|
*
|
|
1166
1163
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice)
|
|
1167
1164
|
*/
|
|
@@ -1179,13 +1176,13 @@ export declare class Blob {
|
|
|
1179
1176
|
*/
|
|
1180
1177
|
bytes(): Promise<Uint8Array>;
|
|
1181
1178
|
/**
|
|
1182
|
-
* The **`text()`** method of the string containing the contents of the blob, interpreted as UTF-8.
|
|
1179
|
+
* The **`text()`** method of the Blob interface returns a Promise that resolves with a string containing the contents of the blob, interpreted as UTF-8.
|
|
1183
1180
|
*
|
|
1184
1181
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text)
|
|
1185
1182
|
*/
|
|
1186
1183
|
text(): Promise<string>;
|
|
1187
1184
|
/**
|
|
1188
|
-
* The **`stream()`** method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the
|
|
1185
|
+
* The **`stream()`** method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the Blob.
|
|
1189
1186
|
*
|
|
1190
1187
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream)
|
|
1191
1188
|
*/
|
|
@@ -1206,13 +1203,13 @@ export declare class File extends Blob {
|
|
|
1206
1203
|
options?: FileOptions,
|
|
1207
1204
|
);
|
|
1208
1205
|
/**
|
|
1209
|
-
* The **`name`** read-only property of the File interface returns the name of the file represented by a File object.
|
|
1206
|
+
* The **`name`** read-only property of the File interface returns the name of the file represented by a File object. For security reasons, the path is excluded from this property.
|
|
1210
1207
|
*
|
|
1211
1208
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name)
|
|
1212
1209
|
*/
|
|
1213
1210
|
get name(): string;
|
|
1214
1211
|
/**
|
|
1215
|
-
* The **`lastModified`** read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight).
|
|
1212
|
+
* The **`lastModified`** read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.
|
|
1216
1213
|
*
|
|
1217
1214
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified)
|
|
1218
1215
|
*/
|
|
@@ -1229,7 +1226,7 @@ export interface FileOptions {
|
|
|
1229
1226
|
*/
|
|
1230
1227
|
export declare abstract class CacheStorage {
|
|
1231
1228
|
/**
|
|
1232
|
-
* The **`open()`** method of the the Cache object matching the
|
|
1229
|
+
* The **`open()`** method of the CacheStorage interface returns a Promise that resolves to the Cache object matching the cacheName.
|
|
1233
1230
|
*
|
|
1234
1231
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CacheStorage/open)
|
|
1235
1232
|
*/
|
|
@@ -1268,14 +1265,14 @@ export interface CacheQueryOptions {
|
|
|
1268
1265
|
*/
|
|
1269
1266
|
export declare abstract class Crypto {
|
|
1270
1267
|
/**
|
|
1271
|
-
* The **`Crypto.subtle`** read-only property returns a cryptographic operations.
|
|
1268
|
+
* The **`Crypto.subtle`** read-only property returns a SubtleCrypto which can then be used to perform low-level cryptographic operations.
|
|
1272
1269
|
* Available only in secure contexts.
|
|
1273
1270
|
*
|
|
1274
1271
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/subtle)
|
|
1275
1272
|
*/
|
|
1276
1273
|
get subtle(): SubtleCrypto;
|
|
1277
1274
|
/**
|
|
1278
|
-
* The **`Crypto.getRandomValues()`** method lets you get cryptographically strong random values.
|
|
1275
|
+
* The **`Crypto.getRandomValues()`** method lets you get cryptographically strong random values. The array given as the parameter is filled with random numbers (random in its cryptographic meaning).
|
|
1279
1276
|
*
|
|
1280
1277
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Crypto/getRandomValues)
|
|
1281
1278
|
*/
|
|
@@ -1317,7 +1314,7 @@ export declare abstract class SubtleCrypto {
|
|
|
1317
1314
|
plainText: ArrayBuffer | ArrayBufferView,
|
|
1318
1315
|
): Promise<ArrayBuffer>;
|
|
1319
1316
|
/**
|
|
1320
|
-
* The **`decrypt()`** method of the SubtleCrypto interface decrypts some encrypted data.
|
|
1317
|
+
* The **`decrypt()`** method of the SubtleCrypto interface decrypts some encrypted data. It takes as arguments a key to decrypt with, some optional extra parameters, and the data to decrypt (also known as "ciphertext"). It returns a Promise which will be fulfilled with the decrypted data (also known as "plaintext").
|
|
1321
1318
|
*
|
|
1322
1319
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/decrypt)
|
|
1323
1320
|
*/
|
|
@@ -1348,7 +1345,7 @@ export declare abstract class SubtleCrypto {
|
|
|
1348
1345
|
data: ArrayBuffer | ArrayBufferView,
|
|
1349
1346
|
): Promise<boolean>;
|
|
1350
1347
|
/**
|
|
1351
|
-
* The **`digest()`** method of the SubtleCrypto interface generates a
|
|
1348
|
+
* The **`digest()`** method of the SubtleCrypto interface generates a digest of the given data, using the specified hash function. A digest is a short fixed-length value derived from some variable-length input. Cryptographic digests should exhibit collision-resistance, meaning that it's hard to come up with two different inputs that have the same digest value.
|
|
1352
1349
|
*
|
|
1353
1350
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/digest)
|
|
1354
1351
|
*/
|
|
@@ -1379,7 +1376,7 @@ export declare abstract class SubtleCrypto {
|
|
|
1379
1376
|
keyUsages: string[],
|
|
1380
1377
|
): Promise<CryptoKey>;
|
|
1381
1378
|
/**
|
|
1382
|
-
* The **`deriveBits()`** method of the key.
|
|
1379
|
+
* The **`deriveBits()`** method of the SubtleCrypto interface can be used to derive an array of bits from a base key.
|
|
1383
1380
|
*
|
|
1384
1381
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveBits)
|
|
1385
1382
|
*/
|
|
@@ -1407,7 +1404,7 @@ export declare abstract class SubtleCrypto {
|
|
|
1407
1404
|
*/
|
|
1408
1405
|
exportKey(format: string, key: CryptoKey): Promise<ArrayBuffer | JsonWebKey>;
|
|
1409
1406
|
/**
|
|
1410
|
-
* The **`wrapKey()`** method of the SubtleCrypto interface
|
|
1407
|
+
* The **`wrapKey()`** method of the SubtleCrypto interface "wraps" a key. This means that it exports the key in an external, portable format, then encrypts the exported key. Wrapping a key helps protect it in untrusted environments, such as inside an otherwise unprotected data store or in transmission over an unprotected network.
|
|
1411
1408
|
*
|
|
1412
1409
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/wrapKey)
|
|
1413
1410
|
*/
|
|
@@ -1418,7 +1415,7 @@ export declare abstract class SubtleCrypto {
|
|
|
1418
1415
|
wrapAlgorithm: string | SubtleCryptoEncryptAlgorithm,
|
|
1419
1416
|
): Promise<ArrayBuffer>;
|
|
1420
1417
|
/**
|
|
1421
|
-
* The **`unwrapKey()`** method of the SubtleCrypto interface
|
|
1418
|
+
* The **`unwrapKey()`** method of the SubtleCrypto interface "unwraps" a key. This means that it takes as its input a key that has been exported and then encrypted (also called "wrapped"). It decrypts the key and then imports it, returning a CryptoKey object that can be used in the Web Crypto API.
|
|
1422
1419
|
*
|
|
1423
1420
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey)
|
|
1424
1421
|
*/
|
|
@@ -1437,20 +1434,20 @@ export declare abstract class SubtleCrypto {
|
|
|
1437
1434
|
): boolean;
|
|
1438
1435
|
}
|
|
1439
1436
|
/**
|
|
1440
|
-
* The **`CryptoKey`** interface of the Web Crypto API represents a cryptographic key obtained from one of the SubtleCrypto methods
|
|
1437
|
+
* The **`CryptoKey`** interface of the Web Crypto API represents a cryptographic key obtained from one of the SubtleCrypto methods generateKey(), deriveKey(), importKey(), or unwrapKey().
|
|
1441
1438
|
* Available only in secure contexts.
|
|
1442
1439
|
*
|
|
1443
1440
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey)
|
|
1444
1441
|
*/
|
|
1445
1442
|
export declare abstract class CryptoKey {
|
|
1446
1443
|
/**
|
|
1447
|
-
* The read-only **`type`** property of the CryptoKey interface indicates which kind of key is represented by the object.
|
|
1444
|
+
* The read-only **`type`** property of the CryptoKey interface indicates which kind of key is represented by the object. It can have the following values:
|
|
1448
1445
|
*
|
|
1449
1446
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/type)
|
|
1450
1447
|
*/
|
|
1451
1448
|
readonly type: string;
|
|
1452
1449
|
/**
|
|
1453
|
-
* The read-only **`extractable`** property of the CryptoKey interface indicates whether or not the key may be extracted using
|
|
1450
|
+
* The read-only **`extractable`** property of the CryptoKey interface indicates whether or not the key may be extracted using SubtleCrypto.exportKey() or SubtleCrypto.wrapKey().
|
|
1454
1451
|
*
|
|
1455
1452
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CryptoKey/extractable)
|
|
1456
1453
|
*/
|
|
@@ -1580,7 +1577,7 @@ export declare class DigestStream extends WritableStream<
|
|
|
1580
1577
|
get bytesWritten(): number | bigint;
|
|
1581
1578
|
}
|
|
1582
1579
|
/**
|
|
1583
|
-
* The **`TextDecoder`** interface represents a decoder for a specific text encoding, such as
|
|
1580
|
+
* The **`TextDecoder`** interface represents a decoder for a specific text encoding, such as UTF-8, ISO-8859-2, or GBK. A decoder takes an array of bytes as input and returns a JavaScript string.
|
|
1584
1581
|
*
|
|
1585
1582
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoder)
|
|
1586
1583
|
*/
|
|
@@ -1600,20 +1597,20 @@ export declare class TextDecoder {
|
|
|
1600
1597
|
get ignoreBOM(): boolean;
|
|
1601
1598
|
}
|
|
1602
1599
|
/**
|
|
1603
|
-
* The **`TextEncoder`** interface
|
|
1600
|
+
* The **`TextEncoder`** interface enables you to encode a JavaScript string using UTF-8.
|
|
1604
1601
|
*
|
|
1605
1602
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder)
|
|
1606
1603
|
*/
|
|
1607
1604
|
export declare class TextEncoder {
|
|
1608
1605
|
constructor();
|
|
1609
1606
|
/**
|
|
1610
|
-
* The **`TextEncoder.encode()`** method takes a string as input, and returns a
|
|
1607
|
+
* The **`TextEncoder.encode()`** method takes a string as input, and returns a Uint8Array containing the string encoded using UTF-8.
|
|
1611
1608
|
*
|
|
1612
1609
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encode)
|
|
1613
1610
|
*/
|
|
1614
1611
|
encode(input?: string): Uint8Array;
|
|
1615
1612
|
/**
|
|
1616
|
-
* The **`TextEncoder.encodeInto()`** method takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into, and returns
|
|
1613
|
+
* The **`TextEncoder.encodeInto()`** method takes a string to encode and a destination Uint8Array to put resulting UTF-8 encoded text into, and returns an object indicating the progress of the encoding. This is potentially more performant than the encode() method — especially when the target buffer is a view into a Wasm heap.
|
|
1617
1614
|
*
|
|
1618
1615
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoder/encodeInto)
|
|
1619
1616
|
*/
|
|
@@ -1684,31 +1681,31 @@ export interface ErrorEventErrorEventInit {
|
|
|
1684
1681
|
export declare class MessageEvent extends Event {
|
|
1685
1682
|
constructor(type: string, initializer: MessageEventInit);
|
|
1686
1683
|
/**
|
|
1687
|
-
* The **`data`** read-only property of the
|
|
1684
|
+
* The **`data`** read-only property of the MessageEvent interface represents the data sent by the message emitter.
|
|
1688
1685
|
*
|
|
1689
1686
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data)
|
|
1690
1687
|
*/
|
|
1691
1688
|
readonly data: any;
|
|
1692
1689
|
/**
|
|
1693
|
-
* The **`origin`** read-only property of the origin of the message emitter.
|
|
1690
|
+
* The **`origin`** read-only property of the MessageEvent interface is a string representing the origin of the message emitter.
|
|
1694
1691
|
*
|
|
1695
1692
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin)
|
|
1696
1693
|
*/
|
|
1697
1694
|
readonly origin: string | null;
|
|
1698
1695
|
/**
|
|
1699
|
-
* The **`lastEventId`** read-only property of the unique ID for the event.
|
|
1696
|
+
* The **`lastEventId`** read-only property of the MessageEvent interface is a string representing a unique ID for the event.
|
|
1700
1697
|
*
|
|
1701
1698
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId)
|
|
1702
1699
|
*/
|
|
1703
1700
|
readonly lastEventId: string;
|
|
1704
1701
|
/**
|
|
1705
|
-
* The **`source`** read-only property of the
|
|
1702
|
+
* The **`source`** read-only property of the MessageEvent interface is a MessageEventSource (which can be a WindowProxy, MessagePort, or ServiceWorker object) representing the message emitter.
|
|
1706
1703
|
*
|
|
1707
1704
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source)
|
|
1708
1705
|
*/
|
|
1709
1706
|
readonly source: MessagePort | null;
|
|
1710
1707
|
/**
|
|
1711
|
-
* The **`ports`** read-only property of the containing all MessagePort objects sent with the message, in order.
|
|
1708
|
+
* The **`ports`** read-only property of the MessageEvent interface is an array of MessagePort objects containing all MessagePort objects sent with the message, in order.
|
|
1712
1709
|
*
|
|
1713
1710
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports)
|
|
1714
1711
|
*/
|
|
@@ -1718,96 +1715,93 @@ export interface MessageEventInit {
|
|
|
1718
1715
|
data: ArrayBuffer | string;
|
|
1719
1716
|
}
|
|
1720
1717
|
/**
|
|
1721
|
-
* The **`PromiseRejectionEvent`** interface represents events which are sent to the global script context when JavaScript Promises are rejected.
|
|
1718
|
+
* The **`PromiseRejectionEvent`** interface represents events which are sent to the global script context when JavaScript Promises are rejected. These events are particularly useful for telemetry and debugging purposes.
|
|
1722
1719
|
*
|
|
1723
1720
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent)
|
|
1724
1721
|
*/
|
|
1725
1722
|
export declare abstract class PromiseRejectionEvent extends Event {
|
|
1726
1723
|
/**
|
|
1727
|
-
* The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript rejected.
|
|
1724
|
+
* The PromiseRejectionEvent interface's **`promise`** read-only property indicates the JavaScript Promise which was rejected. You can examine the event's PromiseRejectionEvent.reason property to learn why the promise was rejected.
|
|
1728
1725
|
*
|
|
1729
1726
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/promise)
|
|
1730
1727
|
*/
|
|
1731
1728
|
readonly promise: Promise<any>;
|
|
1732
1729
|
/**
|
|
1733
|
-
* The PromiseRejectionEvent **`reason`** read-only property is any JavaScript value or Object which provides the reason passed into Promise.reject().
|
|
1730
|
+
* The PromiseRejectionEvent **`reason`** read-only property is any JavaScript value or Object which provides the reason passed into Promise.reject(). This in theory provides information about why the promise was rejected.
|
|
1734
1731
|
*
|
|
1735
1732
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PromiseRejectionEvent/reason)
|
|
1736
1733
|
*/
|
|
1737
1734
|
readonly reason: any;
|
|
1738
1735
|
}
|
|
1739
1736
|
/**
|
|
1740
|
-
* The **`FormData`** interface provides a way to construct a set of key/value pairs representing form fields and their values, which can be sent using the
|
|
1737
|
+
* The **`FormData`** interface provides a way to construct a set of key/value pairs representing form fields and their values, which can be sent using the fetch(), XMLHttpRequest.send() or navigator.sendBeacon() methods. It uses the same format a form would use if the encoding type were set to "multipart/form-data".
|
|
1741
1738
|
*
|
|
1742
1739
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData)
|
|
1743
1740
|
*/
|
|
1744
1741
|
export declare class FormData {
|
|
1745
1742
|
constructor();
|
|
1746
1743
|
/**
|
|
1747
|
-
* The **`append()`** method of the FormData interface appends a new value onto an existing key inside a
|
|
1744
|
+
* The **`append()`** method of the FormData interface appends a new value onto an existing key inside a FormData object, or adds the key if it does not already exist.
|
|
1748
1745
|
*
|
|
1749
1746
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append)
|
|
1750
1747
|
*/
|
|
1751
1748
|
append(name: string, value: string | Blob): void;
|
|
1752
1749
|
/**
|
|
1753
|
-
* The **`append()`** method of the FormData interface appends a new value onto an existing key inside a
|
|
1750
|
+
* The **`append()`** method of the FormData interface appends a new value onto an existing key inside a FormData object, or adds the key if it does not already exist.
|
|
1754
1751
|
*
|
|
1755
1752
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append)
|
|
1756
1753
|
*/
|
|
1757
1754
|
append(name: string, value: string): void;
|
|
1758
1755
|
/**
|
|
1759
|
-
* The **`append()`** method of the FormData interface appends a new value onto an existing key inside a
|
|
1756
|
+
* The **`append()`** method of the FormData interface appends a new value onto an existing key inside a FormData object, or adds the key if it does not already exist.
|
|
1760
1757
|
*
|
|
1761
1758
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/append)
|
|
1762
1759
|
*/
|
|
1763
1760
|
append(name: string, value: Blob, filename?: string): void;
|
|
1764
1761
|
/**
|
|
1765
|
-
* The **`delete()`** method of the FormData interface deletes a key and its value(s) from a
|
|
1762
|
+
* The **`delete()`** method of the FormData interface deletes a key and its value(s) from a FormData object.
|
|
1766
1763
|
*
|
|
1767
1764
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/delete)
|
|
1768
1765
|
*/
|
|
1769
1766
|
delete(name: string): void;
|
|
1770
1767
|
/**
|
|
1771
|
-
* The **`get()`** method of the FormData interface returns the first value associated with a given key from within a
|
|
1768
|
+
* The **`get()`** method of the FormData interface returns the first value associated with a given key from within a FormData object. If you expect multiple values and want all of them, use the getAll() method instead.
|
|
1772
1769
|
*
|
|
1773
1770
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/get)
|
|
1774
1771
|
*/
|
|
1775
1772
|
get(name: string): (File | string) | null;
|
|
1776
1773
|
/**
|
|
1777
|
-
* The **`getAll()`** method of the FormData interface returns all the values associated with a given key from within a
|
|
1774
|
+
* The **`getAll()`** method of the FormData interface returns all the values associated with a given key from within a FormData object.
|
|
1778
1775
|
*
|
|
1779
1776
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/getAll)
|
|
1780
1777
|
*/
|
|
1781
1778
|
getAll(name: string): (File | string)[];
|
|
1782
1779
|
/**
|
|
1783
|
-
* The **`has()`** method of the FormData interface returns whether a
|
|
1780
|
+
* The **`has()`** method of the FormData interface returns whether a FormData object contains a certain key.
|
|
1784
1781
|
*
|
|
1785
1782
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/has)
|
|
1786
1783
|
*/
|
|
1787
1784
|
has(name: string): boolean;
|
|
1788
1785
|
/**
|
|
1789
|
-
* The **`set()`** method of the FormData interface sets a new value for an existing key inside a
|
|
1786
|
+
* The **`set()`** method of the FormData interface sets a new value for an existing key inside a FormData object, or adds the key/value if it does not already exist.
|
|
1790
1787
|
*
|
|
1791
1788
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set)
|
|
1792
1789
|
*/
|
|
1793
1790
|
set(name: string, value: string | Blob): void;
|
|
1794
1791
|
/**
|
|
1795
|
-
* The **`set()`** method of the FormData interface sets a new value for an existing key inside a
|
|
1792
|
+
* The **`set()`** method of the FormData interface sets a new value for an existing key inside a FormData object, or adds the key/value if it does not already exist.
|
|
1796
1793
|
*
|
|
1797
1794
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set)
|
|
1798
1795
|
*/
|
|
1799
1796
|
set(name: string, value: string): void;
|
|
1800
1797
|
/**
|
|
1801
|
-
* The **`set()`** method of the FormData interface sets a new value for an existing key inside a
|
|
1798
|
+
* The **`set()`** method of the FormData interface sets a new value for an existing key inside a FormData object, or adds the key/value if it does not already exist.
|
|
1802
1799
|
*
|
|
1803
1800
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FormData/set)
|
|
1804
1801
|
*/
|
|
1805
1802
|
set(name: string, value: Blob, filename?: string): void;
|
|
1806
|
-
/* Returns an array of key, value pairs for every entry in the list. */
|
|
1807
1803
|
entries(): IterableIterator<[key: string, value: File | string]>;
|
|
1808
|
-
/* Returns a list of keys in the list. */
|
|
1809
1804
|
keys(): IterableIterator<string>;
|
|
1810
|
-
/* Returns a list of values in the list. */
|
|
1811
1805
|
values(): IterableIterator<File | string>;
|
|
1812
1806
|
forEach<This = unknown>(
|
|
1813
1807
|
callback: (
|
|
@@ -1927,19 +1921,19 @@ export interface DocumentEnd {
|
|
|
1927
1921
|
append(content: string, options?: ContentOptions): DocumentEnd;
|
|
1928
1922
|
}
|
|
1929
1923
|
/**
|
|
1930
|
-
* This is the event type for
|
|
1924
|
+
* This is the event type for fetch events dispatched on the service worker global scope. It contains information about the fetch, including the request and how the receiver will treat the response. It provides the event.respondWith() method, which allows us to provide a response to this fetch.
|
|
1931
1925
|
*
|
|
1932
1926
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent)
|
|
1933
1927
|
*/
|
|
1934
1928
|
export declare abstract class FetchEvent extends ExtendableEvent {
|
|
1935
1929
|
/**
|
|
1936
|
-
* The **`request`** read-only property of the the event handler.
|
|
1930
|
+
* The **`request`** read-only property of the FetchEvent interface returns the Request that triggered the event handler.
|
|
1937
1931
|
*
|
|
1938
1932
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/request)
|
|
1939
1933
|
*/
|
|
1940
1934
|
readonly request: Request;
|
|
1941
1935
|
/**
|
|
1942
|
-
* The **`respondWith()`** method of allows you to provide a promise for a Response yourself.
|
|
1936
|
+
* The **`respondWith()`** method of FetchEvent prevents the browser's default fetch handling, and allows you to provide a promise for a Response yourself.
|
|
1943
1937
|
*
|
|
1944
1938
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/FetchEvent/respondWith)
|
|
1945
1939
|
*/
|
|
@@ -1947,49 +1941,47 @@ export declare abstract class FetchEvent extends ExtendableEvent {
|
|
|
1947
1941
|
passThroughOnException(): void;
|
|
1948
1942
|
}
|
|
1949
1943
|
export type HeadersInit =
|
|
1950
|
-
|
|
|
1951
|
-
| Iterable<Iterable<string>>
|
|
1952
|
-
| Record<string, string>;
|
|
1944
|
+
Headers | Iterable<Iterable<string>> | Record<string, string>;
|
|
1953
1945
|
/**
|
|
1954
|
-
* The **`Headers`** interface of the Fetch API allows you to perform various actions on HTTP request and response headers.
|
|
1946
|
+
* The **`Headers`** interface of the Fetch API allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing headers from the list of the request's headers.
|
|
1955
1947
|
*
|
|
1956
1948
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers)
|
|
1957
1949
|
*/
|
|
1958
1950
|
export declare class Headers {
|
|
1959
1951
|
constructor(init?: HeadersInit);
|
|
1960
1952
|
/**
|
|
1961
|
-
* The **`get()`** method of the Headers interface returns a byte string of all the values of a header within a
|
|
1953
|
+
* The **`get()`** method of the Headers interface returns a byte string of all the values of a header within a Headers object with a given name. If the requested header doesn't exist in the Headers object, it returns null.
|
|
1962
1954
|
*
|
|
1963
1955
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/get)
|
|
1964
1956
|
*/
|
|
1965
1957
|
get(name: string): string | null;
|
|
1966
1958
|
getAll(name: string): string[];
|
|
1967
1959
|
/**
|
|
1968
|
-
* The **`getSetCookie()`** method of the Headers interface returns an array containing the values of all Set-Cookie headers associated with a response.
|
|
1960
|
+
* The **`getSetCookie()`** method of the Headers interface returns an array containing the values of all Set-Cookie headers associated with a response. This allows Headers objects to handle having multiple Set-Cookie headers, which wasn't possible prior to its implementation.
|
|
1969
1961
|
*
|
|
1970
1962
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/getSetCookie)
|
|
1971
1963
|
*/
|
|
1972
1964
|
getSetCookie(): string[];
|
|
1973
1965
|
/**
|
|
1974
|
-
* The **`has()`** method of the Headers interface returns a boolean stating whether a
|
|
1966
|
+
* The **`has()`** method of the Headers interface returns a boolean stating whether a Headers object contains a certain header.
|
|
1975
1967
|
*
|
|
1976
1968
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/has)
|
|
1977
1969
|
*/
|
|
1978
1970
|
has(name: string): boolean;
|
|
1979
1971
|
/**
|
|
1980
|
-
* The **`set()`** method of the Headers interface sets a new value for an existing header inside a
|
|
1972
|
+
* The **`set()`** method of the Headers interface sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.
|
|
1981
1973
|
*
|
|
1982
1974
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/set)
|
|
1983
1975
|
*/
|
|
1984
1976
|
set(name: string, value: string): void;
|
|
1985
1977
|
/**
|
|
1986
|
-
* The **`append()`** method of the Headers interface appends a new value onto an existing header inside a
|
|
1978
|
+
* The **`append()`** method of the Headers interface appends a new value onto an existing header inside a Headers object, or adds the header if it does not already exist.
|
|
1987
1979
|
*
|
|
1988
1980
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/append)
|
|
1989
1981
|
*/
|
|
1990
1982
|
append(name: string, value: string): void;
|
|
1991
1983
|
/**
|
|
1992
|
-
* The **`delete()`** method of the Headers interface deletes a header from the current
|
|
1984
|
+
* The **`delete()`** method of the Headers interface deletes a header from the current Headers object.
|
|
1993
1985
|
*
|
|
1994
1986
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Headers/delete)
|
|
1995
1987
|
*/
|
|
@@ -1998,11 +1990,8 @@ export declare class Headers {
|
|
|
1998
1990
|
callback: (this: This, value: string, key: string, parent: Headers) => void,
|
|
1999
1991
|
thisArg?: This,
|
|
2000
1992
|
): void;
|
|
2001
|
-
/* Returns an iterator allowing to go through all key/value pairs contained in this object. */
|
|
2002
1993
|
entries(): IterableIterator<[key: string, value: string]>;
|
|
2003
|
-
/* Returns an iterator allowing to go through all keys of the key/value pairs contained in this object. */
|
|
2004
1994
|
keys(): IterableIterator<string>;
|
|
2005
|
-
/* Returns an iterator allowing to go through all values of the key/value pairs contained in this object. */
|
|
2006
1995
|
values(): IterableIterator<string>;
|
|
2007
1996
|
[Symbol.iterator](): IterableIterator<[key: string, value: string]>;
|
|
2008
1997
|
}
|
|
@@ -2071,7 +2060,7 @@ export interface Response extends Body {
|
|
|
2071
2060
|
*/
|
|
2072
2061
|
statusText: string;
|
|
2073
2062
|
/**
|
|
2074
|
-
* The **`headers`** read-only property of the with the response.
|
|
2063
|
+
* The **`headers`** read-only property of the Response interface contains the Headers object associated with the response.
|
|
2075
2064
|
*
|
|
2076
2065
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers)
|
|
2077
2066
|
*/
|
|
@@ -2089,7 +2078,7 @@ export interface Response extends Body {
|
|
|
2089
2078
|
*/
|
|
2090
2079
|
redirected: boolean;
|
|
2091
2080
|
/**
|
|
2092
|
-
* The **`url`** read-only property of the Response interface contains the URL of the response.
|
|
2081
|
+
* The **`url`** read-only property of the Response interface contains the URL of the response. The value of the url property will be the final URL obtained after any redirects.
|
|
2093
2082
|
*
|
|
2094
2083
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url)
|
|
2095
2084
|
*/
|
|
@@ -2097,7 +2086,7 @@ export interface Response extends Body {
|
|
|
2097
2086
|
webSocket: WebSocket | null;
|
|
2098
2087
|
cf: any | undefined;
|
|
2099
2088
|
/**
|
|
2100
|
-
* The **`type`** read-only property of the Response interface contains the type of the response.
|
|
2089
|
+
* The **`type`** read-only property of the Response interface contains the type of the response. The type determines whether scripts are able to access the response body and headers.
|
|
2101
2090
|
*
|
|
2102
2091
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type)
|
|
2103
2092
|
*/
|
|
@@ -2137,13 +2126,13 @@ export interface Request<
|
|
|
2137
2126
|
Cf = CfProperties<CfHostMetadata>,
|
|
2138
2127
|
> extends Body {
|
|
2139
2128
|
/**
|
|
2140
|
-
* The **`clone()`** method of the Request interface creates a copy of the current
|
|
2129
|
+
* The **`clone()`** method of the Request interface creates a copy of the current Request object.
|
|
2141
2130
|
*
|
|
2142
2131
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/clone)
|
|
2143
2132
|
*/
|
|
2144
2133
|
clone(): Request<CfHostMetadata, Cf>;
|
|
2145
2134
|
/**
|
|
2146
|
-
* The **`method`** read-only property of the
|
|
2135
|
+
* The **`method`** read-only property of the Request interface contains the request's method (GET, POST, etc.)
|
|
2147
2136
|
*
|
|
2148
2137
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/method)
|
|
2149
2138
|
*/
|
|
@@ -2155,7 +2144,7 @@ export interface Request<
|
|
|
2155
2144
|
*/
|
|
2156
2145
|
url: string;
|
|
2157
2146
|
/**
|
|
2158
|
-
* The **`headers`** read-only property of the with the request.
|
|
2147
|
+
* The **`headers`** read-only property of the Request interface contains the Headers object associated with the request.
|
|
2159
2148
|
*
|
|
2160
2149
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/headers)
|
|
2161
2150
|
*/
|
|
@@ -2181,13 +2170,13 @@ export interface Request<
|
|
|
2181
2170
|
*/
|
|
2182
2171
|
integrity: string;
|
|
2183
2172
|
/**
|
|
2184
|
-
* The **`keepalive`** read-only property of the Request interface contains the request's
|
|
2173
|
+
* The **`keepalive`** read-only property of the Request interface contains the request's keepalive setting (true or false), which indicates whether the browser will keep the associated request alive if the page that initiated it is unloaded before the request is complete.
|
|
2185
2174
|
*
|
|
2186
2175
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/keepalive)
|
|
2187
2176
|
*/
|
|
2188
2177
|
keepalive: boolean;
|
|
2189
2178
|
/**
|
|
2190
|
-
* The **`cache`** read-only property of the Request interface contains the cache mode of the request.
|
|
2179
|
+
* The **`cache`** read-only property of the Request interface contains the cache mode of the request. It controls how the request will interact with the browser's HTTP cache.
|
|
2191
2180
|
*
|
|
2192
2181
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/cache)
|
|
2193
2182
|
*/
|
|
@@ -2493,12 +2482,7 @@ export interface R2Bucket {
|
|
|
2493
2482
|
put(
|
|
2494
2483
|
key: string,
|
|
2495
2484
|
value:
|
|
2496
|
-
|
|
|
2497
|
-
| ArrayBuffer
|
|
2498
|
-
| ArrayBufferView
|
|
2499
|
-
| string
|
|
2500
|
-
| null
|
|
2501
|
-
| Blob,
|
|
2485
|
+
ReadableStream | ArrayBuffer | ArrayBufferView | string | null | Blob,
|
|
2502
2486
|
options?: R2PutOptions & {
|
|
2503
2487
|
onlyIf: R2Conditional | Headers;
|
|
2504
2488
|
},
|
|
@@ -2506,12 +2490,7 @@ export interface R2Bucket {
|
|
|
2506
2490
|
put(
|
|
2507
2491
|
key: string,
|
|
2508
2492
|
value:
|
|
2509
|
-
|
|
|
2510
|
-
| ArrayBuffer
|
|
2511
|
-
| ArrayBufferView
|
|
2512
|
-
| string
|
|
2513
|
-
| null
|
|
2514
|
-
| Blob,
|
|
2493
|
+
ReadableStream | ArrayBuffer | ArrayBufferView | string | null | Blob,
|
|
2515
2494
|
options?: R2PutOptions,
|
|
2516
2495
|
): Promise<R2Object>;
|
|
2517
2496
|
createMultipartUpload(
|
|
@@ -2732,7 +2711,7 @@ export type ReadableStreamReadResult<R = any> =
|
|
|
2732
2711
|
value?: undefined;
|
|
2733
2712
|
};
|
|
2734
2713
|
/**
|
|
2735
|
-
* The
|
|
2714
|
+
* The **`ReadableStream`** interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.
|
|
2736
2715
|
*
|
|
2737
2716
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream)
|
|
2738
2717
|
*/
|
|
@@ -2750,13 +2729,13 @@ export interface ReadableStream<R = any> {
|
|
|
2750
2729
|
*/
|
|
2751
2730
|
cancel(reason?: any): Promise<void>;
|
|
2752
2731
|
/**
|
|
2753
|
-
* The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it.
|
|
2732
|
+
* The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.
|
|
2754
2733
|
*
|
|
2755
2734
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader)
|
|
2756
2735
|
*/
|
|
2757
2736
|
getReader(): ReadableStreamDefaultReader<R>;
|
|
2758
2737
|
/**
|
|
2759
|
-
* The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it.
|
|
2738
|
+
* The **`getReader()`** method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.
|
|
2760
2739
|
*
|
|
2761
2740
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader)
|
|
2762
2741
|
*/
|
|
@@ -2771,7 +2750,7 @@ export interface ReadableStream<R = any> {
|
|
|
2771
2750
|
options?: StreamPipeOptions,
|
|
2772
2751
|
): ReadableStream<T>;
|
|
2773
2752
|
/**
|
|
2774
|
-
* The **`pipeTo()`** method of the ReadableStream interface pipes the current
|
|
2753
|
+
* The **`pipeTo()`** method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
|
|
2775
2754
|
*
|
|
2776
2755
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo)
|
|
2777
2756
|
*/
|
|
@@ -2780,7 +2759,7 @@ export interface ReadableStream<R = any> {
|
|
|
2780
2759
|
options?: StreamPipeOptions,
|
|
2781
2760
|
): Promise<void>;
|
|
2782
2761
|
/**
|
|
2783
|
-
* The **`tee()`** method of the two-element array containing the two resulting branches as new ReadableStream instances.
|
|
2762
|
+
* The **`tee()`** method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.
|
|
2784
2763
|
*
|
|
2785
2764
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee)
|
|
2786
2765
|
*/
|
|
@@ -2791,7 +2770,7 @@ export interface ReadableStream<R = any> {
|
|
|
2791
2770
|
): AsyncIterableIterator<R>;
|
|
2792
2771
|
}
|
|
2793
2772
|
/**
|
|
2794
|
-
* The
|
|
2773
|
+
* The **`ReadableStream`** interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.
|
|
2795
2774
|
*
|
|
2796
2775
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream)
|
|
2797
2776
|
*/
|
|
@@ -2829,7 +2808,7 @@ export declare class ReadableStreamDefaultReader<R = any> {
|
|
|
2829
2808
|
releaseLock(): void;
|
|
2830
2809
|
}
|
|
2831
2810
|
/**
|
|
2832
|
-
* The
|
|
2811
|
+
* The **`ReadableStreamBYOBReader`** interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source. It is used for efficient copying from underlying sources where the data is delivered as an "anonymous" sequence of bytes, such as files.
|
|
2833
2812
|
*
|
|
2834
2813
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader)
|
|
2835
2814
|
*/
|
|
@@ -2838,7 +2817,7 @@ export declare class ReadableStreamBYOBReader {
|
|
|
2838
2817
|
get closed(): Promise<void>;
|
|
2839
2818
|
cancel(reason?: any): Promise<void>;
|
|
2840
2819
|
/**
|
|
2841
|
-
* The **`read()`** method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream.
|
|
2820
|
+
* The **`read()`** method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream. A request for data will be satisfied from the stream's internal queues if there is any data present. If the stream queues are empty, the request may be supplied as a zero-copy transfer from the underlying byte source.
|
|
2842
2821
|
*
|
|
2843
2822
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read)
|
|
2844
2823
|
*/
|
|
@@ -2846,7 +2825,7 @@ export declare class ReadableStreamBYOBReader {
|
|
|
2846
2825
|
view: T,
|
|
2847
2826
|
): Promise<ReadableStreamReadResult<T>>;
|
|
2848
2827
|
/**
|
|
2849
|
-
* The **`releaseLock()`** method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream.
|
|
2828
|
+
* The **`releaseLock()`** method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream. After the lock is released, the reader is no longer active.
|
|
2850
2829
|
*
|
|
2851
2830
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock)
|
|
2852
2831
|
*/
|
|
@@ -2868,7 +2847,7 @@ export interface ReadableStreamGetReaderOptions {
|
|
|
2868
2847
|
mode: "byob";
|
|
2869
2848
|
}
|
|
2870
2849
|
/**
|
|
2871
|
-
* The **`ReadableStreamBYOBRequest`** interface of the Streams API represents a
|
|
2850
|
+
* The **`ReadableStreamBYOBRequest`** interface of the Streams API represents a "pull request" for data from an underlying source that will made as a zero-copy transfer to a consumer (bypassing the stream's internal queues).
|
|
2872
2851
|
*
|
|
2873
2852
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest)
|
|
2874
2853
|
*/
|
|
@@ -2894,13 +2873,13 @@ export declare abstract class ReadableStreamBYOBRequest {
|
|
|
2894
2873
|
get atLeast(): number | null;
|
|
2895
2874
|
}
|
|
2896
2875
|
/**
|
|
2897
|
-
* The **`ReadableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue.
|
|
2876
|
+
* The **`ReadableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue. Default controllers are for streams that are not byte streams.
|
|
2898
2877
|
*
|
|
2899
2878
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController)
|
|
2900
2879
|
*/
|
|
2901
2880
|
export declare abstract class ReadableStreamDefaultController<R = any> {
|
|
2902
2881
|
/**
|
|
2903
|
-
* The **`desiredSize`** read-only property of the required to fill the stream's internal queue.
|
|
2882
|
+
* The **`desiredSize`** read-only property of the ReadableStreamDefaultController interface returns the desired size required to fill the stream's internal queue.
|
|
2904
2883
|
*
|
|
2905
2884
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize)
|
|
2906
2885
|
*/
|
|
@@ -2912,32 +2891,32 @@ export declare abstract class ReadableStreamDefaultController<R = any> {
|
|
|
2912
2891
|
*/
|
|
2913
2892
|
close(): void;
|
|
2914
2893
|
/**
|
|
2915
|
-
* The **`enqueue()`** method of the
|
|
2894
|
+
* The **`enqueue()`** method of the ReadableStreamDefaultController interface enqueues a given chunk in the associated stream.
|
|
2916
2895
|
*
|
|
2917
2896
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue)
|
|
2918
2897
|
*/
|
|
2919
2898
|
enqueue(chunk?: R): void;
|
|
2920
2899
|
/**
|
|
2921
|
-
* The **`error()`** method of the with the associated stream to error.
|
|
2900
|
+
* The **`error()`** method of the ReadableStreamDefaultController interface causes any future interactions with the associated stream to error.
|
|
2922
2901
|
*
|
|
2923
2902
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error)
|
|
2924
2903
|
*/
|
|
2925
2904
|
error(reason: any): void;
|
|
2926
2905
|
}
|
|
2927
2906
|
/**
|
|
2928
|
-
* The **`ReadableByteStreamController`** interface of the Streams API represents a controller for a readable byte stream.
|
|
2907
|
+
* The **`ReadableByteStreamController`** interface of the Streams API represents a controller for a readable byte stream. It allows control of the state and internal queue of a ReadableStream with an underlying byte source, and enables efficient zero-copy transfer of data from the underlying source to a consumer when the stream's internal queue is empty.
|
|
2929
2908
|
*
|
|
2930
2909
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController)
|
|
2931
2910
|
*/
|
|
2932
2911
|
export declare abstract class ReadableByteStreamController {
|
|
2933
2912
|
/**
|
|
2934
|
-
* The **`byobRequest`** read-only property of the ReadableByteStreamController interface returns the current BYOB request, or
|
|
2913
|
+
* The **`byobRequest`** read-only property of the ReadableByteStreamController interface returns the current BYOB request, or null if there are no pending requests.
|
|
2935
2914
|
*
|
|
2936
2915
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest)
|
|
2937
2916
|
*/
|
|
2938
2917
|
get byobRequest(): ReadableStreamBYOBRequest | null;
|
|
2939
2918
|
/**
|
|
2940
|
-
* The **`desiredSize`** read-only property of the ReadableByteStreamController interface returns the number of bytes required to fill the stream's internal queue to its
|
|
2919
|
+
* The **`desiredSize`** read-only property of the ReadableByteStreamController interface returns the number of bytes required to fill the stream's internal queue to its "desired size".
|
|
2941
2920
|
*
|
|
2942
2921
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/desiredSize)
|
|
2943
2922
|
*/
|
|
@@ -2949,7 +2928,7 @@ export declare abstract class ReadableByteStreamController {
|
|
|
2949
2928
|
*/
|
|
2950
2929
|
close(): void;
|
|
2951
2930
|
/**
|
|
2952
|
-
* The **`enqueue()`** method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is
|
|
2931
|
+
* The **`enqueue()`** method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is transferred into the stream's internal queues).
|
|
2953
2932
|
*
|
|
2954
2933
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue)
|
|
2955
2934
|
*/
|
|
@@ -2962,7 +2941,7 @@ export declare abstract class ReadableByteStreamController {
|
|
|
2962
2941
|
error(reason: any): void;
|
|
2963
2942
|
}
|
|
2964
2943
|
/**
|
|
2965
|
-
* The **`WritableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a WritableStream's state.
|
|
2944
|
+
* The **`WritableStreamDefaultController`** interface of the Streams API represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate.
|
|
2966
2945
|
*
|
|
2967
2946
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController)
|
|
2968
2947
|
*/
|
|
@@ -2974,7 +2953,7 @@ export declare abstract class WritableStreamDefaultController {
|
|
|
2974
2953
|
*/
|
|
2975
2954
|
get signal(): AbortSignal;
|
|
2976
2955
|
/**
|
|
2977
|
-
* The **`error()`** method of the with the associated stream to error.
|
|
2956
|
+
* The **`error()`** method of the WritableStreamDefaultController interface causes any future interactions with the associated stream to error.
|
|
2978
2957
|
*
|
|
2979
2958
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error)
|
|
2980
2959
|
*/
|
|
@@ -2999,7 +2978,7 @@ export declare abstract class TransformStreamDefaultController<O = any> {
|
|
|
2999
2978
|
*/
|
|
3000
2979
|
enqueue(chunk?: O): void;
|
|
3001
2980
|
/**
|
|
3002
|
-
* The **`error()`** method of the TransformStreamDefaultController interface errors both sides of the stream.
|
|
2981
|
+
* The **`error()`** method of the TransformStreamDefaultController interface errors both sides of the stream. Any further interactions with it will fail with the given error message, and any chunks in the queue will be discarded.
|
|
3003
2982
|
*
|
|
3004
2983
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStreamDefaultController/error)
|
|
3005
2984
|
*/
|
|
@@ -3021,7 +3000,7 @@ export interface ReadableWritablePair<R = any, W = any> {
|
|
|
3021
3000
|
writable: WritableStream<W>;
|
|
3022
3001
|
}
|
|
3023
3002
|
/**
|
|
3024
|
-
* The **`WritableStream`** interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink.
|
|
3003
|
+
* The **`WritableStream`** interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.
|
|
3025
3004
|
*
|
|
3026
3005
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream)
|
|
3027
3006
|
*/
|
|
@@ -3031,7 +3010,7 @@ export declare class WritableStream<W = any> {
|
|
|
3031
3010
|
queuingStrategy?: QueuingStrategy,
|
|
3032
3011
|
);
|
|
3033
3012
|
/**
|
|
3034
|
-
* The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the
|
|
3013
|
+
* The **`locked`** read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.
|
|
3035
3014
|
*
|
|
3036
3015
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked)
|
|
3037
3016
|
*/
|
|
@@ -3043,70 +3022,70 @@ export declare class WritableStream<W = any> {
|
|
|
3043
3022
|
*/
|
|
3044
3023
|
abort(reason?: any): Promise<void>;
|
|
3045
3024
|
/**
|
|
3046
|
-
* The **`close()`** method of the WritableStream interface closes the associated stream.
|
|
3025
|
+
* The **`close()`** method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.
|
|
3047
3026
|
*
|
|
3048
3027
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close)
|
|
3049
3028
|
*/
|
|
3050
3029
|
close(): Promise<void>;
|
|
3051
3030
|
/**
|
|
3052
|
-
* The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance.
|
|
3031
|
+
* The **`getWriter()`** method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.
|
|
3053
3032
|
*
|
|
3054
3033
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter)
|
|
3055
3034
|
*/
|
|
3056
3035
|
getWriter(): WritableStreamDefaultWriter<W>;
|
|
3057
3036
|
}
|
|
3058
3037
|
/**
|
|
3059
|
-
* The **`WritableStreamDefaultWriter`** interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the
|
|
3038
|
+
* The **`WritableStreamDefaultWriter`** interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the WritableStream ensuring that no other streams can write to the underlying sink.
|
|
3060
3039
|
*
|
|
3061
3040
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter)
|
|
3062
3041
|
*/
|
|
3063
3042
|
export declare class WritableStreamDefaultWriter<W = any> {
|
|
3064
3043
|
constructor(stream: WritableStream);
|
|
3065
3044
|
/**
|
|
3066
|
-
* The **`closed`** read-only property of the the stream errors or the writer's lock is released.
|
|
3045
|
+
* The **`closed`** read-only property of the WritableStreamDefaultWriter interface returns a Promise that fulfills if the stream becomes closed, or rejects if the stream errors or the writer's lock is released.
|
|
3067
3046
|
*
|
|
3068
3047
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed)
|
|
3069
3048
|
*/
|
|
3070
3049
|
get closed(): Promise<void>;
|
|
3071
3050
|
/**
|
|
3072
|
-
* The **`ready`** read-only property of the that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure.
|
|
3051
|
+
* The **`ready`** read-only property of the WritableStreamDefaultWriter interface returns a Promise that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure.
|
|
3073
3052
|
*
|
|
3074
3053
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready)
|
|
3075
3054
|
*/
|
|
3076
3055
|
get ready(): Promise<void>;
|
|
3077
3056
|
/**
|
|
3078
|
-
* The **`desiredSize`** read-only property of the to fill the stream's internal queue.
|
|
3057
|
+
* The **`desiredSize`** read-only property of the WritableStreamDefaultWriter interface returns the desired size required to fill the stream's internal queue.
|
|
3079
3058
|
*
|
|
3080
3059
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize)
|
|
3081
3060
|
*/
|
|
3082
3061
|
get desiredSize(): number | null;
|
|
3083
3062
|
/**
|
|
3084
|
-
* The **`abort()`** method of the the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
|
|
3063
|
+
* The **`abort()`** method of the WritableStreamDefaultWriter interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
|
|
3085
3064
|
*
|
|
3086
3065
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort)
|
|
3087
3066
|
*/
|
|
3088
3067
|
abort(reason?: any): Promise<void>;
|
|
3089
3068
|
/**
|
|
3090
|
-
* The **`close()`** method of the stream.
|
|
3069
|
+
* The **`close()`** method of the WritableStreamDefaultWriter interface closes the associated writable stream.
|
|
3091
3070
|
*
|
|
3092
3071
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close)
|
|
3093
3072
|
*/
|
|
3094
3073
|
close(): Promise<void>;
|
|
3095
3074
|
/**
|
|
3096
|
-
* The **`write()`** method of the operation.
|
|
3075
|
+
* The **`write()`** method of the WritableStreamDefaultWriter interface writes a passed chunk of data to a WritableStream and its underlying sink, then returns a Promise that resolves to indicate the success or failure of the write operation.
|
|
3097
3076
|
*
|
|
3098
3077
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write)
|
|
3099
3078
|
*/
|
|
3100
3079
|
write(chunk?: W): Promise<void>;
|
|
3101
3080
|
/**
|
|
3102
|
-
* The **`releaseLock()`** method of the corresponding stream.
|
|
3081
|
+
* The **`releaseLock()`** method of the WritableStreamDefaultWriter interface releases the writer's lock on the corresponding stream. After the lock is released, the writer is no longer active. If the associated stream is errored when the lock is released, the writer will appear errored in the same way from now on; otherwise, the writer will appear closed.
|
|
3103
3082
|
*
|
|
3104
3083
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock)
|
|
3105
3084
|
*/
|
|
3106
3085
|
releaseLock(): void;
|
|
3107
3086
|
}
|
|
3108
3087
|
/**
|
|
3109
|
-
* The **`TransformStream`** interface of the Streams API represents a concrete implementation of the pipe chain
|
|
3088
|
+
* The **`TransformStream`** interface of the Streams API represents a concrete implementation of the pipe chain transform stream concept.
|
|
3110
3089
|
*
|
|
3111
3090
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream)
|
|
3112
3091
|
*/
|
|
@@ -3117,13 +3096,13 @@ export declare class TransformStream<I = any, O = any> {
|
|
|
3117
3096
|
readableStrategy?: QueuingStrategy<O>,
|
|
3118
3097
|
);
|
|
3119
3098
|
/**
|
|
3120
|
-
* The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this
|
|
3099
|
+
* The **`readable`** read-only property of the TransformStream interface returns the ReadableStream instance controlled by this TransformStream. This stream emits the transformed output data.
|
|
3121
3100
|
*
|
|
3122
3101
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/readable)
|
|
3123
3102
|
*/
|
|
3124
3103
|
get readable(): ReadableStream<O>;
|
|
3125
3104
|
/**
|
|
3126
|
-
* The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this
|
|
3105
|
+
* The **`writable`** read-only property of the TransformStream interface returns the WritableStream instance controlled by this TransformStream. This stream accepts input data that will be transformed and emitted to the readable stream.
|
|
3127
3106
|
*
|
|
3128
3107
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TransformStream/writable)
|
|
3129
3108
|
*/
|
|
@@ -3148,7 +3127,7 @@ export interface ReadableStreamValuesOptions {
|
|
|
3148
3127
|
preventCancel?: boolean;
|
|
3149
3128
|
}
|
|
3150
3129
|
/**
|
|
3151
|
-
* The **`CompressionStream`** interface of the Compression Streams API
|
|
3130
|
+
* The **`CompressionStream`** interface of the Compression Streams API compresses a stream of data. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.
|
|
3152
3131
|
*
|
|
3153
3132
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompressionStream)
|
|
3154
3133
|
*/
|
|
@@ -3159,7 +3138,7 @@ export declare class CompressionStream extends TransformStream<
|
|
|
3159
3138
|
constructor(format: "gzip" | "deflate" | "deflate-raw");
|
|
3160
3139
|
}
|
|
3161
3140
|
/**
|
|
3162
|
-
* The **`DecompressionStream`** interface of the Compression Streams API
|
|
3141
|
+
* The **`DecompressionStream`** interface of the Compression Streams API decompresses a stream of data. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.
|
|
3163
3142
|
*
|
|
3164
3143
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/DecompressionStream)
|
|
3165
3144
|
*/
|
|
@@ -3170,7 +3149,7 @@ export declare class DecompressionStream extends TransformStream<
|
|
|
3170
3149
|
constructor(format: "gzip" | "deflate" | "deflate-raw");
|
|
3171
3150
|
}
|
|
3172
3151
|
/**
|
|
3173
|
-
* The **`TextEncoderStream`** interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding.
|
|
3152
|
+
* The **`TextEncoderStream`** interface of the Encoding API converts a stream of strings into bytes in the UTF-8 encoding. It is the streaming equivalent of TextEncoder. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.
|
|
3174
3153
|
*
|
|
3175
3154
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextEncoderStream)
|
|
3176
3155
|
*/
|
|
@@ -3182,7 +3161,7 @@ export declare class TextEncoderStream extends TransformStream<
|
|
|
3182
3161
|
get encoding(): string;
|
|
3183
3162
|
}
|
|
3184
3163
|
/**
|
|
3185
|
-
* The **`TextDecoderStream`** interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings.
|
|
3164
|
+
* The **`TextDecoderStream`** interface of the Encoding API converts a stream of text in a binary encoding, such as UTF-8 etc., to a stream of strings. It is the streaming equivalent of TextDecoder. It implements the same shape as a TransformStream, allowing it to be used in ReadableStream.pipeThrough() and similar methods.
|
|
3186
3165
|
*
|
|
3187
3166
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/TextDecoderStream)
|
|
3188
3167
|
*/
|
|
@@ -3374,7 +3353,7 @@ export interface UnsafeTraceMetrics {
|
|
|
3374
3353
|
fromTrace(item: TraceItem): TraceMetrics;
|
|
3375
3354
|
}
|
|
3376
3355
|
/**
|
|
3377
|
-
* The **`URL`** interface is used to parse, construct, normalize, and encode URL.
|
|
3356
|
+
* The **`URL`** interface is used to parse, construct, normalize, and encode URLs. It works by providing properties which allow you to easily read and modify the components of a URL.
|
|
3378
3357
|
*
|
|
3379
3358
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL)
|
|
3380
3359
|
*/
|
|
@@ -3399,121 +3378,121 @@ export declare class URL {
|
|
|
3399
3378
|
*/
|
|
3400
3379
|
set href(value: string);
|
|
3401
3380
|
/**
|
|
3402
|
-
* The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final
|
|
3381
|
+
* The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final ":".
|
|
3403
3382
|
*
|
|
3404
3383
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol)
|
|
3405
3384
|
*/
|
|
3406
3385
|
get protocol(): string;
|
|
3407
3386
|
/**
|
|
3408
|
-
* The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final
|
|
3387
|
+
* The **`protocol`** property of the URL interface is a string containing the protocol or scheme of the URL, including the final ":".
|
|
3409
3388
|
*
|
|
3410
3389
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/protocol)
|
|
3411
3390
|
*/
|
|
3412
3391
|
set protocol(value: string);
|
|
3413
3392
|
/**
|
|
3414
|
-
* The **`username`** property of the URL interface is a string containing the username component of the URL.
|
|
3393
|
+
* The **`username`** property of the URL interface is a string containing the username component of the URL. If the URL does not have a username, this property contains an empty string, "".
|
|
3415
3394
|
*
|
|
3416
3395
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username)
|
|
3417
3396
|
*/
|
|
3418
3397
|
get username(): string;
|
|
3419
3398
|
/**
|
|
3420
|
-
* The **`username`** property of the URL interface is a string containing the username component of the URL.
|
|
3399
|
+
* The **`username`** property of the URL interface is a string containing the username component of the URL. If the URL does not have a username, this property contains an empty string, "".
|
|
3421
3400
|
*
|
|
3422
3401
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/username)
|
|
3423
3402
|
*/
|
|
3424
3403
|
set username(value: string);
|
|
3425
3404
|
/**
|
|
3426
|
-
* The **`password`** property of the URL interface is a string containing the password component of the URL.
|
|
3405
|
+
* The **`password`** property of the URL interface is a string containing the password component of the URL. If the URL does not have a password, this property contains an empty string, "".
|
|
3427
3406
|
*
|
|
3428
3407
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password)
|
|
3429
3408
|
*/
|
|
3430
3409
|
get password(): string;
|
|
3431
3410
|
/**
|
|
3432
|
-
* The **`password`** property of the URL interface is a string containing the password component of the URL.
|
|
3411
|
+
* The **`password`** property of the URL interface is a string containing the password component of the URL. If the URL does not have a password, this property contains an empty string, "".
|
|
3433
3412
|
*
|
|
3434
3413
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/password)
|
|
3435
3414
|
*/
|
|
3436
3415
|
set password(value: string);
|
|
3437
3416
|
/**
|
|
3438
|
-
* The **`host`** property of the URL interface is a string containing the host, which is the
|
|
3417
|
+
* The **`host`** property of the URL interface is a string containing the host, which is the hostname, and then, if the port of the URL is nonempty, a ":", followed by the port of the URL. If the URL does not have a hostname, this property contains an empty string, "".
|
|
3439
3418
|
*
|
|
3440
3419
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host)
|
|
3441
3420
|
*/
|
|
3442
3421
|
get host(): string;
|
|
3443
3422
|
/**
|
|
3444
|
-
* The **`host`** property of the URL interface is a string containing the host, which is the
|
|
3423
|
+
* The **`host`** property of the URL interface is a string containing the host, which is the hostname, and then, if the port of the URL is nonempty, a ":", followed by the port of the URL. If the URL does not have a hostname, this property contains an empty string, "".
|
|
3445
3424
|
*
|
|
3446
3425
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/host)
|
|
3447
3426
|
*/
|
|
3448
3427
|
set host(value: string);
|
|
3449
3428
|
/**
|
|
3450
|
-
* The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL.
|
|
3429
|
+
* The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. If the URL does not have a hostname, this property contains an empty string, "". IPv4 and IPv6 addresses are normalized, such as stripping leading zeros, and domain names are converted to IDN.
|
|
3451
3430
|
*
|
|
3452
3431
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname)
|
|
3453
3432
|
*/
|
|
3454
3433
|
get hostname(): string;
|
|
3455
3434
|
/**
|
|
3456
|
-
* The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL.
|
|
3435
|
+
* The **`hostname`** property of the URL interface is a string containing either the domain name or IP address of the URL. If the URL does not have a hostname, this property contains an empty string, "". IPv4 and IPv6 addresses are normalized, such as stripping leading zeros, and domain names are converted to IDN.
|
|
3457
3436
|
*
|
|
3458
3437
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hostname)
|
|
3459
3438
|
*/
|
|
3460
3439
|
set hostname(value: string);
|
|
3461
3440
|
/**
|
|
3462
|
-
* The **`port`** property of the URL interface is a string containing the port number of the URL.
|
|
3441
|
+
* The **`port`** property of the URL interface is a string containing the port number of the URL. If the port is the default for the protocol (80 for ws: and http:, 443 for wss: and https:, and 21 for ftp:), this property contains an empty string, "".
|
|
3463
3442
|
*
|
|
3464
3443
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port)
|
|
3465
3444
|
*/
|
|
3466
3445
|
get port(): string;
|
|
3467
3446
|
/**
|
|
3468
|
-
* The **`port`** property of the URL interface is a string containing the port number of the URL.
|
|
3447
|
+
* The **`port`** property of the URL interface is a string containing the port number of the URL. If the port is the default for the protocol (80 for ws: and http:, 443 for wss: and https:, and 21 for ftp:), this property contains an empty string, "".
|
|
3469
3448
|
*
|
|
3470
3449
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/port)
|
|
3471
3450
|
*/
|
|
3472
3451
|
set port(value: string);
|
|
3473
3452
|
/**
|
|
3474
|
-
* The **`pathname`** property of the URL interface represents a location in a hierarchical structure.
|
|
3453
|
+
* The **`pathname`** property of the URL interface represents a location in a hierarchical structure. It is a string constructed from a list of path segments, each of which is prefixed by a / character.
|
|
3475
3454
|
*
|
|
3476
3455
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname)
|
|
3477
3456
|
*/
|
|
3478
3457
|
get pathname(): string;
|
|
3479
3458
|
/**
|
|
3480
|
-
* The **`pathname`** property of the URL interface represents a location in a hierarchical structure.
|
|
3459
|
+
* The **`pathname`** property of the URL interface represents a location in a hierarchical structure. It is a string constructed from a list of path segments, each of which is prefixed by a / character.
|
|
3481
3460
|
*
|
|
3482
3461
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/pathname)
|
|
3483
3462
|
*/
|
|
3484
3463
|
set pathname(value: string);
|
|
3485
3464
|
/**
|
|
3486
|
-
* The **`search`** property of the URL interface is a search string, also called a
|
|
3465
|
+
* The **`search`** property of the URL interface is a search string, also called a query string, that is a string containing a "?" followed by the parameters of the URL. If the URL does not have a search query, this property contains an empty string, "".
|
|
3487
3466
|
*
|
|
3488
3467
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search)
|
|
3489
3468
|
*/
|
|
3490
3469
|
get search(): string;
|
|
3491
3470
|
/**
|
|
3492
|
-
* The **`search`** property of the URL interface is a search string, also called a
|
|
3471
|
+
* The **`search`** property of the URL interface is a search string, also called a query string, that is a string containing a "?" followed by the parameters of the URL. If the URL does not have a search query, this property contains an empty string, "".
|
|
3493
3472
|
*
|
|
3494
3473
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/search)
|
|
3495
3474
|
*/
|
|
3496
3475
|
set search(value: string);
|
|
3497
3476
|
/**
|
|
3498
|
-
* The **`hash`** property of the URL interface is a string containing a
|
|
3477
|
+
* The **`hash`** property of the URL interface is a string containing a "#" followed by the fragment identifier of the URL. If the URL does not have a fragment identifier, this property contains an empty string, "".
|
|
3499
3478
|
*
|
|
3500
3479
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash)
|
|
3501
3480
|
*/
|
|
3502
3481
|
get hash(): string;
|
|
3503
3482
|
/**
|
|
3504
|
-
* The **`hash`** property of the URL interface is a string containing a
|
|
3483
|
+
* The **`hash`** property of the URL interface is a string containing a "#" followed by the fragment identifier of the URL. If the URL does not have a fragment identifier, this property contains an empty string, "".
|
|
3505
3484
|
*
|
|
3506
3485
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/hash)
|
|
3507
3486
|
*/
|
|
3508
3487
|
set hash(value: string);
|
|
3509
3488
|
/**
|
|
3510
|
-
* The **`searchParams`** read-only property of the access to the
|
|
3489
|
+
* The **`searchParams`** read-only property of the URL interface returns a URLSearchParams object allowing access to the GET decoded query arguments contained in the URL.
|
|
3511
3490
|
*
|
|
3512
3491
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/searchParams)
|
|
3513
3492
|
*/
|
|
3514
3493
|
get searchParams(): URLSearchParams;
|
|
3515
3494
|
/**
|
|
3516
|
-
* The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as
|
|
3495
|
+
* The **`toJSON()`** method of the URL interface returns a string containing a serialized version of the URL, although in practice it seems to have the same effect as URL.toString().
|
|
3517
3496
|
*
|
|
3518
3497
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/toJSON)
|
|
3519
3498
|
*/
|
|
@@ -3533,13 +3512,13 @@ export declare class URL {
|
|
|
3533
3512
|
*/
|
|
3534
3513
|
static parse(url: string, base?: string): URL | null;
|
|
3535
3514
|
/**
|
|
3536
|
-
* The **`createObjectURL()`** static method of the URL interface creates a string containing a URL
|
|
3515
|
+
* The **`createObjectURL()`** static method of the URL interface creates a string containing a blob URL pointing to the object given in the parameter.
|
|
3537
3516
|
*
|
|
3538
3517
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/createObjectURL_static)
|
|
3539
3518
|
*/
|
|
3540
3519
|
static createObjectURL(object: File | Blob): string;
|
|
3541
3520
|
/**
|
|
3542
|
-
* The **`revokeObjectURL()`** static method of the URL interface releases an existing object URL which was previously created by calling
|
|
3521
|
+
* The **`revokeObjectURL()`** static method of the URL interface releases an existing object URL which was previously created by calling URL.createObjectURL().
|
|
3543
3522
|
*
|
|
3544
3523
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URL/revokeObjectURL_static)
|
|
3545
3524
|
*/
|
|
@@ -3591,22 +3570,19 @@ export declare class URLSearchParams {
|
|
|
3591
3570
|
*/
|
|
3592
3571
|
has(name: string, value?: string): boolean;
|
|
3593
3572
|
/**
|
|
3594
|
-
* The **`set()`** method of the URLSearchParams interface sets the value associated with a given search parameter to the given value.
|
|
3573
|
+
* The **`set()`** method of the URLSearchParams interface sets the value associated with a given search parameter to the given value. If there were several matching values, this method deletes the others. If the search parameter doesn't exist, this method creates it.
|
|
3595
3574
|
*
|
|
3596
3575
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/set)
|
|
3597
3576
|
*/
|
|
3598
3577
|
set(name: string, value: string): void;
|
|
3599
3578
|
/**
|
|
3600
|
-
* The **`URLSearchParams.sort()`** method sorts all key/value pairs contained in this object in place and returns
|
|
3579
|
+
* The **`URLSearchParams.sort()`** method sorts all key/value pairs contained in this object in place and returns undefined. Key/value pairs are sorted by the values of the UTF-16 code units of the keys. This method uses a stable sorting algorithm (i.e., the relative order between key/value pairs with equal keys will be preserved).
|
|
3601
3580
|
*
|
|
3602
3581
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort)
|
|
3603
3582
|
*/
|
|
3604
3583
|
sort(): void;
|
|
3605
|
-
/* Returns an array of key, value pairs for every entry in the search params. */
|
|
3606
3584
|
entries(): IterableIterator<[key: string, value: string]>;
|
|
3607
|
-
/* Returns a list of keys in the search params. */
|
|
3608
3585
|
keys(): IterableIterator<string>;
|
|
3609
|
-
/* Returns a list of values in the search params. */
|
|
3610
3586
|
values(): IterableIterator<string>;
|
|
3611
3587
|
forEach<This = unknown>(
|
|
3612
3588
|
callback: (
|
|
@@ -3621,22 +3597,82 @@ export declare class URLSearchParams {
|
|
|
3621
3597
|
toString(): string;
|
|
3622
3598
|
[Symbol.iterator](): IterableIterator<[key: string, value: string]>;
|
|
3623
3599
|
}
|
|
3600
|
+
/**
|
|
3601
|
+
* The **`URLPattern`** interface of the URL Pattern API matches URLs or parts of URLs against a pattern. The pattern can contain capturing groups that extract parts of the matched URL.
|
|
3602
|
+
*
|
|
3603
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern)
|
|
3604
|
+
*/
|
|
3624
3605
|
export declare class URLPattern {
|
|
3625
3606
|
constructor(
|
|
3626
3607
|
input?: string | URLPatternInit,
|
|
3627
3608
|
baseURL?: string | URLPatternOptions,
|
|
3628
3609
|
patternOptions?: URLPatternOptions,
|
|
3629
3610
|
);
|
|
3611
|
+
/**
|
|
3612
|
+
* The **`protocol`** read-only property of the URLPattern interface is a string containing the pattern used to match the protocol part of a URL.
|
|
3613
|
+
*
|
|
3614
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/protocol)
|
|
3615
|
+
*/
|
|
3630
3616
|
get protocol(): string;
|
|
3617
|
+
/**
|
|
3618
|
+
* The **`username`** read-only property of the URLPattern interface is a string containing the pattern used to match the username part of a URL.
|
|
3619
|
+
*
|
|
3620
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/username)
|
|
3621
|
+
*/
|
|
3631
3622
|
get username(): string;
|
|
3623
|
+
/**
|
|
3624
|
+
* The **`password`** read-only property of the URLPattern interface is a string containing the pattern used to match the password part of a URL.
|
|
3625
|
+
*
|
|
3626
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/password)
|
|
3627
|
+
*/
|
|
3632
3628
|
get password(): string;
|
|
3629
|
+
/**
|
|
3630
|
+
* The **`hostname`** read-only property of the URLPattern interface is a string containing the pattern used to match the hostname part of a URL.
|
|
3631
|
+
*
|
|
3632
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/hostname)
|
|
3633
|
+
*/
|
|
3633
3634
|
get hostname(): string;
|
|
3635
|
+
/**
|
|
3636
|
+
* The **`port`** read-only property of the URLPattern interface is a string containing the pattern used to match the port part of a URL.
|
|
3637
|
+
*
|
|
3638
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/port)
|
|
3639
|
+
*/
|
|
3634
3640
|
get port(): string;
|
|
3641
|
+
/**
|
|
3642
|
+
* The **`pathname`** read-only property of the URLPattern interface is a string containing the pattern used to match the pathname part of a URL.
|
|
3643
|
+
*
|
|
3644
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/pathname)
|
|
3645
|
+
*/
|
|
3635
3646
|
get pathname(): string;
|
|
3647
|
+
/**
|
|
3648
|
+
* The **`search`** read-only property of the URLPattern interface is a string containing the pattern used to match the search part of a URL.
|
|
3649
|
+
*
|
|
3650
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/search)
|
|
3651
|
+
*/
|
|
3636
3652
|
get search(): string;
|
|
3653
|
+
/**
|
|
3654
|
+
* The **`hash`** read-only property of the URLPattern interface is a string containing the pattern used to match the fragment part of a URL.
|
|
3655
|
+
*
|
|
3656
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/hash)
|
|
3657
|
+
*/
|
|
3637
3658
|
get hash(): string;
|
|
3659
|
+
/**
|
|
3660
|
+
* The **`hasRegExpGroups`** read-only property of the URLPattern interface is a boolean indicating whether or not any of the URLPattern components contain regular expression capturing groups.
|
|
3661
|
+
*
|
|
3662
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/hasRegExpGroups)
|
|
3663
|
+
*/
|
|
3638
3664
|
get hasRegExpGroups(): boolean;
|
|
3665
|
+
/**
|
|
3666
|
+
* The **`test()`** method of the URLPattern interface takes a URL string or object of URL parts, and returns a boolean indicating if the given input matches the current pattern.
|
|
3667
|
+
*
|
|
3668
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/test)
|
|
3669
|
+
*/
|
|
3639
3670
|
test(input?: string | URLPatternInit, baseURL?: string): boolean;
|
|
3671
|
+
/**
|
|
3672
|
+
* The **`exec()`** method of the URLPattern interface takes a URL or object of URL parts, and returns either an object containing the results of matching the URL to the pattern, or null if the URL does not match the pattern.
|
|
3673
|
+
*
|
|
3674
|
+
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLPattern/exec)
|
|
3675
|
+
*/
|
|
3640
3676
|
exec(
|
|
3641
3677
|
input?: string | URLPatternInit,
|
|
3642
3678
|
baseURL?: string,
|
|
@@ -3672,7 +3708,7 @@ export interface URLPatternOptions {
|
|
|
3672
3708
|
ignoreCase?: boolean;
|
|
3673
3709
|
}
|
|
3674
3710
|
/**
|
|
3675
|
-
* A
|
|
3711
|
+
* A **`CloseEvent`** is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.
|
|
3676
3712
|
*
|
|
3677
3713
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent)
|
|
3678
3714
|
*/
|
|
@@ -3691,7 +3727,7 @@ export declare class CloseEvent extends Event {
|
|
|
3691
3727
|
*/
|
|
3692
3728
|
readonly reason: string;
|
|
3693
3729
|
/**
|
|
3694
|
-
* The **`wasClean`** read-only property of the CloseEvent interface returns
|
|
3730
|
+
* The **`wasClean`** read-only property of the CloseEvent interface returns true if the connection closed cleanly.
|
|
3695
3731
|
*
|
|
3696
3732
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/wasClean)
|
|
3697
3733
|
*/
|
|
@@ -3709,7 +3745,7 @@ export type WebSocketEventMap = {
|
|
|
3709
3745
|
error: ErrorEvent;
|
|
3710
3746
|
};
|
|
3711
3747
|
/**
|
|
3712
|
-
* The
|
|
3748
|
+
* The **`WebSocket`** object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
|
|
3713
3749
|
*
|
|
3714
3750
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
|
|
3715
3751
|
*/
|
|
@@ -3726,20 +3762,20 @@ export declare var WebSocket: {
|
|
|
3726
3762
|
readonly CLOSED: number;
|
|
3727
3763
|
};
|
|
3728
3764
|
/**
|
|
3729
|
-
* The
|
|
3765
|
+
* The **`WebSocket`** object provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
|
|
3730
3766
|
*
|
|
3731
3767
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
|
|
3732
3768
|
*/
|
|
3733
3769
|
export interface WebSocket extends EventTarget<WebSocketEventMap> {
|
|
3734
3770
|
accept(options?: WebSocketAcceptOptions): void;
|
|
3735
3771
|
/**
|
|
3736
|
-
* The **`WebSocket.send()`** method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of
|
|
3772
|
+
* The **`WebSocket.send()`** method enqueues the specified data to be transmitted to the server over the WebSocket connection, increasing the value of bufferedAmount by the number of bytes needed to contain the data. If the data can't be sent (for example, because it needs to be buffered but the buffer is full), the socket is closed automatically. The browser will throw an exception if you call send() when the connection is in the CONNECTING state. If you call send() when the connection is in the CLOSING or CLOSED states, the browser will silently discard the data.
|
|
3737
3773
|
*
|
|
3738
3774
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/send)
|
|
3739
3775
|
*/
|
|
3740
3776
|
send(message: (ArrayBuffer | ArrayBufferView) | string): void;
|
|
3741
3777
|
/**
|
|
3742
|
-
* The **`WebSocket.close()`** method closes the already
|
|
3778
|
+
* The **`WebSocket.close()`** method closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.
|
|
3743
3779
|
*
|
|
3744
3780
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close)
|
|
3745
3781
|
*/
|
|
@@ -3759,13 +3795,13 @@ export interface WebSocket extends EventTarget<WebSocketEventMap> {
|
|
|
3759
3795
|
*/
|
|
3760
3796
|
url: string | null;
|
|
3761
3797
|
/**
|
|
3762
|
-
* The **`WebSocket.protocol`** read-only property returns the name of the sub-protocol the server selected; this will be one of the strings specified in the
|
|
3798
|
+
* The **`WebSocket.protocol`** read-only property returns the name of the sub-protocol the server selected; this will be one of the strings specified in the protocols parameter when creating the WebSocket object, or the empty string if no connection is established.
|
|
3763
3799
|
*
|
|
3764
3800
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/protocol)
|
|
3765
3801
|
*/
|
|
3766
3802
|
protocol: string | null;
|
|
3767
3803
|
/**
|
|
3768
|
-
* The **`WebSocket.extensions`** read-only property returns the extensions selected by the server.
|
|
3804
|
+
* The **`WebSocket.extensions`** read-only property returns the extensions selected by the server. This is currently only the empty string or a list of extensions as negotiated by the connection.
|
|
3769
3805
|
*
|
|
3770
3806
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/extensions)
|
|
3771
3807
|
*/
|
|
@@ -3858,25 +3894,25 @@ export interface SocketInfo {
|
|
|
3858
3894
|
export declare class EventSource extends EventTarget {
|
|
3859
3895
|
constructor(url: string, init?: EventSourceEventSourceInit);
|
|
3860
3896
|
/**
|
|
3861
|
-
* The **`close()`** method of the EventSource interface closes the connection, if one is made, and sets the
|
|
3897
|
+
* The **`close()`** method of the EventSource interface closes the connection, if one is made, and sets the EventSource.readyState attribute to 2 (closed).
|
|
3862
3898
|
*
|
|
3863
3899
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/close)
|
|
3864
3900
|
*/
|
|
3865
3901
|
close(): void;
|
|
3866
3902
|
/**
|
|
3867
|
-
* The **`url`** read-only property of the URL of the source.
|
|
3903
|
+
* The **`url`** read-only property of the EventSource interface returns a string representing the URL of the source.
|
|
3868
3904
|
*
|
|
3869
3905
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/url)
|
|
3870
3906
|
*/
|
|
3871
3907
|
get url(): string;
|
|
3872
3908
|
/**
|
|
3873
|
-
* The **`withCredentials`** read-only property of the the
|
|
3909
|
+
* The **`withCredentials`** read-only property of the EventSource interface returns a boolean value indicating whether the EventSource object was instantiated with CORS credentials set.
|
|
3874
3910
|
*
|
|
3875
3911
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/withCredentials)
|
|
3876
3912
|
*/
|
|
3877
3913
|
get withCredentials(): boolean;
|
|
3878
3914
|
/**
|
|
3879
|
-
* The **`readyState`** read-only property of the connection.
|
|
3915
|
+
* The **`readyState`** read-only property of the EventSource interface returns a number representing the state of the connection.
|
|
3880
3916
|
*
|
|
3881
3917
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/readyState)
|
|
3882
3918
|
*/
|
|
@@ -3993,7 +4029,7 @@ export interface ContainerStartResources {
|
|
|
3993
4029
|
*/
|
|
3994
4030
|
export declare abstract class MessagePort extends EventTarget {
|
|
3995
4031
|
/**
|
|
3996
|
-
* The **`postMessage()`** method of the transfers ownership of objects to other browsing contexts.
|
|
4032
|
+
* The **`postMessage()`** method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
|
|
3997
4033
|
*
|
|
3998
4034
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage)
|
|
3999
4035
|
*/
|
|
@@ -4002,13 +4038,13 @@ export declare abstract class MessagePort extends EventTarget {
|
|
|
4002
4038
|
options?: any[] | MessagePortPostMessageOptions,
|
|
4003
4039
|
): void;
|
|
4004
4040
|
/**
|
|
4005
|
-
* The **`close()`** method of the MessagePort interface disconnects the port, so it is no longer active.
|
|
4041
|
+
* The **`close()`** method of the MessagePort interface disconnects the port, so it is no longer active. This stops the flow of messages to that port.
|
|
4006
4042
|
*
|
|
4007
4043
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/close)
|
|
4008
4044
|
*/
|
|
4009
4045
|
close(): void;
|
|
4010
4046
|
/**
|
|
4011
|
-
* The **`start()`** method of the MessagePort interface starts the sending of messages queued on the port.
|
|
4047
|
+
* The **`start()`** method of the MessagePort interface starts the sending of messages queued on the port. This method is only needed when using EventTarget.addEventListener; it is implied when using onmessage.
|
|
4012
4048
|
*
|
|
4013
4049
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessagePort/start)
|
|
4014
4050
|
*/
|
|
@@ -4024,13 +4060,13 @@ export declare abstract class MessagePort extends EventTarget {
|
|
|
4024
4060
|
export declare class MessageChannel {
|
|
4025
4061
|
constructor();
|
|
4026
4062
|
/**
|
|
4027
|
-
* The **`port1`** read-only property of the the port attached to the context that originated the channel.
|
|
4063
|
+
* The **`port1`** read-only property of the MessageChannel interface returns the first port of the message channel — the port attached to the context that originated the channel.
|
|
4028
4064
|
*
|
|
4029
4065
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel/port1)
|
|
4030
4066
|
*/
|
|
4031
4067
|
readonly port1: MessagePort;
|
|
4032
4068
|
/**
|
|
4033
|
-
* The **`port2`** read-only property of the the port attached to the context at the other end of the channel, which the message is initially sent to.
|
|
4069
|
+
* The **`port2`** read-only property of the MessageChannel interface returns the second port of the message channel — the port attached to the context at the other end of the channel, which the message is initially sent to.
|
|
4034
4070
|
*
|
|
4035
4071
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageChannel/port2)
|
|
4036
4072
|
*/
|
|
@@ -4150,7 +4186,7 @@ export declare abstract class Performance extends EventTarget {
|
|
|
4150
4186
|
*/
|
|
4151
4187
|
clearMeasures(name?: string): void;
|
|
4152
4188
|
/**
|
|
4153
|
-
* The **`clearResourceTimings()`** method removes all performance entries with an
|
|
4189
|
+
* The **`clearResourceTimings()`** method removes all performance entries with an entryType of "resource" from the browser's performance timeline and sets the size of the performance resource data buffer to zero.
|
|
4154
4190
|
*
|
|
4155
4191
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Performance/clearResourceTimings)
|
|
4156
4192
|
*/
|
|
@@ -4162,13 +4198,13 @@ export declare abstract class Performance extends EventTarget {
|
|
|
4162
4198
|
*/
|
|
4163
4199
|
getEntries(): PerformanceEntry[];
|
|
4164
4200
|
/**
|
|
4165
|
-
* The **`getEntriesByName()`** method returns an array of PerformanceEntry objects currently present in the performance timeline with the given
|
|
4201
|
+
* The **`getEntriesByName()`** method returns an array of PerformanceEntry objects currently present in the performance timeline with the given name and type.
|
|
4166
4202
|
*
|
|
4167
4203
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Performance/getEntriesByName)
|
|
4168
4204
|
*/
|
|
4169
4205
|
getEntriesByName(name: string, type?: string): PerformanceEntry[];
|
|
4170
4206
|
/**
|
|
4171
|
-
* The **`getEntriesByType()`** method returns an array of PerformanceEntry objects currently present in the performance timeline for a given
|
|
4207
|
+
* The **`getEntriesByType()`** method returns an array of PerformanceEntry objects currently present in the performance timeline for a given type.
|
|
4172
4208
|
*
|
|
4173
4209
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Performance/getEntriesByType)
|
|
4174
4210
|
*/
|
|
@@ -4190,13 +4226,13 @@ export declare abstract class Performance extends EventTarget {
|
|
|
4190
4226
|
maybeEndMark?: string,
|
|
4191
4227
|
): PerformanceMeasure;
|
|
4192
4228
|
/**
|
|
4193
|
-
* The **`setResourceTimingBufferSize()`** method sets the desired size of the browser's resource timing buffer which stores the
|
|
4229
|
+
* The **`setResourceTimingBufferSize()`** method sets the desired size of the browser's resource timing buffer which stores the "resource" performance entries.
|
|
4194
4230
|
*
|
|
4195
4231
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Performance/setResourceTimingBufferSize)
|
|
4196
4232
|
*/
|
|
4197
4233
|
setResourceTimingBufferSize(size: number): void;
|
|
4198
4234
|
/**
|
|
4199
|
-
* The **`toJSON()`** method of the Performance interface is a
|
|
4235
|
+
* The **`toJSON()`** method of the Performance interface is a serializer; it returns a JSON representation of the Performance object.
|
|
4200
4236
|
*
|
|
4201
4237
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Performance/toJSON)
|
|
4202
4238
|
*/
|
|
@@ -4228,14 +4264,14 @@ export interface UvMetricsInfo {
|
|
|
4228
4264
|
eventsWaiting: number;
|
|
4229
4265
|
}
|
|
4230
4266
|
/**
|
|
4231
|
-
* **`PerformanceMark`** is an interface for PerformanceEntry objects with an
|
|
4267
|
+
* **`PerformanceMark`** is an interface for PerformanceEntry objects with an entryType of "mark".
|
|
4232
4268
|
*
|
|
4233
4269
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceMark)
|
|
4234
4270
|
*/
|
|
4235
4271
|
export declare class PerformanceMark extends PerformanceEntry {
|
|
4236
4272
|
constructor(name: string, maybeOptions?: PerformanceMarkOptions);
|
|
4237
4273
|
/**
|
|
4238
|
-
* The read-only **`detail`** property returns arbitrary metadata that was included in the mark upon construction (either when using
|
|
4274
|
+
* The read-only **`detail`** property returns arbitrary metadata that was included in the mark upon construction (either when using performance.mark() or the PerformanceMark() constructor).
|
|
4239
4275
|
*
|
|
4240
4276
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceMark/detail)
|
|
4241
4277
|
*/
|
|
@@ -4243,13 +4279,13 @@ export declare class PerformanceMark extends PerformanceEntry {
|
|
|
4243
4279
|
toJSON(): object;
|
|
4244
4280
|
}
|
|
4245
4281
|
/**
|
|
4246
|
-
* **`PerformanceMeasure`** is an
|
|
4282
|
+
* **`PerformanceMeasure`** is an abstract interface for PerformanceEntry objects with an entryType of "measure". Entries of this type are created by calling performance.measure() to add a named DOMHighResTimeStamp (the measure) between two marks to the browser's performance timeline.
|
|
4247
4283
|
*
|
|
4248
4284
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceMeasure)
|
|
4249
4285
|
*/
|
|
4250
4286
|
export declare abstract class PerformanceMeasure extends PerformanceEntry {
|
|
4251
4287
|
/**
|
|
4252
|
-
* The read-only **`detail`** property returns arbitrary metadata that was included in the mark upon construction (when using
|
|
4288
|
+
* The read-only **`detail`** property returns arbitrary metadata that was included in the mark upon construction (when using performance.measure().
|
|
4253
4289
|
*
|
|
4254
4290
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceMeasure/detail)
|
|
4255
4291
|
*/
|
|
@@ -4267,25 +4303,25 @@ export interface PerformanceMeasureOptions {
|
|
|
4267
4303
|
end?: number;
|
|
4268
4304
|
}
|
|
4269
4305
|
/**
|
|
4270
|
-
* The **`PerformanceObserverEntryList`** interface is a list of
|
|
4306
|
+
* The **`PerformanceObserverEntryList`** interface is a list of performance events that were explicitly observed via the observe() method.
|
|
4271
4307
|
*
|
|
4272
4308
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserverEntryList)
|
|
4273
4309
|
*/
|
|
4274
4310
|
export declare abstract class PerformanceObserverEntryList {
|
|
4275
4311
|
/**
|
|
4276
|
-
* The **`getEntries()`** method of the PerformanceObserverEntryList interface returns a list of explicitly observed
|
|
4312
|
+
* The **`getEntries()`** method of the PerformanceObserverEntryList interface returns a list of explicitly observed performance entry objects. The list's members are determined by the set of entry types specified in the call to the observe() method. The list is available in the observer's callback function (as the first parameter in the callback).
|
|
4277
4313
|
*
|
|
4278
4314
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserverEntryList/getEntries)
|
|
4279
4315
|
*/
|
|
4280
4316
|
getEntries(): PerformanceEntry[];
|
|
4281
4317
|
/**
|
|
4282
|
-
* The **`getEntriesByType()`** method of the PerformanceObserverEntryList returns a list of explicitly
|
|
4318
|
+
* The **`getEntriesByType()`** method of the PerformanceObserverEntryList returns a list of explicitly observed performance entry objects for a given performance entry type. The list's members are determined by the set of entry types specified in the call to the observe() method. The list is available in the observer's callback function (as the first parameter in the callback).
|
|
4283
4319
|
*
|
|
4284
4320
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserverEntryList/getEntriesByType)
|
|
4285
4321
|
*/
|
|
4286
4322
|
getEntriesByType(type: string): PerformanceEntry[];
|
|
4287
4323
|
/**
|
|
4288
|
-
* The **`getEntriesByName()`** method of the PerformanceObserverEntryList interface returns a list of explicitly observed PerformanceEntry objects for a given
|
|
4324
|
+
* The **`getEntriesByName()`** method of the PerformanceObserverEntryList interface returns a list of explicitly observed PerformanceEntry objects for a given name and entryType. The list's members are determined by the set of entry types specified in the call to the observe() method. The list is available in the observer's callback function (as the first parameter in the callback).
|
|
4289
4325
|
*
|
|
4290
4326
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserverEntryList/getEntriesByName)
|
|
4291
4327
|
*/
|
|
@@ -4298,7 +4334,7 @@ export declare abstract class PerformanceObserverEntryList {
|
|
|
4298
4334
|
*/
|
|
4299
4335
|
export declare abstract class PerformanceEntry {
|
|
4300
4336
|
/**
|
|
4301
|
-
* The read-only **`name`** property of the PerformanceEntry interface is a string representing the name for a performance entry.
|
|
4337
|
+
* The read-only **`name`** property of the PerformanceEntry interface is a string representing the name for a performance entry. It acts as an identifier, but it does not have to be unique. The value depends on the subclass.
|
|
4302
4338
|
*
|
|
4303
4339
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceEntry/name)
|
|
4304
4340
|
*/
|
|
@@ -4310,68 +4346,68 @@ export declare abstract class PerformanceEntry {
|
|
|
4310
4346
|
*/
|
|
4311
4347
|
get entryType(): string;
|
|
4312
4348
|
/**
|
|
4313
|
-
* The read-only **`startTime`** property returns the first
|
|
4349
|
+
* The read-only **`startTime`** property returns the first timestamp recorded for this PerformanceEntry. The meaning of this property depends on the value of this entry's entryType.
|
|
4314
4350
|
*
|
|
4315
4351
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceEntry/startTime)
|
|
4316
4352
|
*/
|
|
4317
4353
|
get startTime(): number;
|
|
4318
4354
|
/**
|
|
4319
|
-
* The read-only **`duration`** property returns a
|
|
4355
|
+
* The read-only **`duration`** property returns a timestamp that is the duration of the performance entry. The meaning of this property depends on the value of this entry's entryType.
|
|
4320
4356
|
*
|
|
4321
4357
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceEntry/duration)
|
|
4322
4358
|
*/
|
|
4323
4359
|
get duration(): number;
|
|
4324
4360
|
/**
|
|
4325
|
-
* The **`toJSON()`** method is a
|
|
4361
|
+
* The **`toJSON()`** method is a serializer; it returns a JSON representation of the PerformanceEntry object.
|
|
4326
4362
|
*
|
|
4327
4363
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceEntry/toJSON)
|
|
4328
4364
|
*/
|
|
4329
4365
|
toJSON(): object;
|
|
4330
4366
|
}
|
|
4331
4367
|
/**
|
|
4332
|
-
* The **`PerformanceResourceTiming`** interface enables retrieval and analysis of detailed network timing data regarding the loading of an application's resources.
|
|
4368
|
+
* The **`PerformanceResourceTiming`** interface enables retrieval and analysis of detailed network timing data regarding the loading of an application's resources. An application can use the timing metrics to determine, for example, the length of time it takes to fetch a specific resource, such as an XMLHttpRequest, <SVG>, image, or script.
|
|
4333
4369
|
*
|
|
4334
4370
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming)
|
|
4335
4371
|
*/
|
|
4336
4372
|
export declare abstract class PerformanceResourceTiming extends PerformanceEntry {
|
|
4337
4373
|
/**
|
|
4338
|
-
* The **`connectEnd`** read-only property returns the
|
|
4374
|
+
* The **`connectEnd`** read-only property returns the timestamp immediately after the browser finishes establishing the connection to the server to retrieve the resource. The timestamp value includes the time interval to establish the transport connection, as well as other time intervals such as TLS handshake and SOCKS authentication.
|
|
4339
4375
|
*
|
|
4340
4376
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/connectEnd)
|
|
4341
4377
|
*/
|
|
4342
4378
|
get connectEnd(): number;
|
|
4343
4379
|
/**
|
|
4344
|
-
* The **`connectStart`** read-only property returns the
|
|
4380
|
+
* The **`connectStart`** read-only property returns the timestamp immediately before the user agent starts establishing the connection to the server to retrieve the resource.
|
|
4345
4381
|
*
|
|
4346
4382
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/connectStart)
|
|
4347
4383
|
*/
|
|
4348
4384
|
get connectStart(): number;
|
|
4349
4385
|
/**
|
|
4350
|
-
* The **`decodedBodySize`** read-only property returns the size (in octets) received from the fetch (HTTP or cache) of the message body after removing any applied content encoding (like gzip or Brotli).
|
|
4386
|
+
* The **`decodedBodySize`** read-only property returns the size (in octets) received from the fetch (HTTP or cache) of the message body after removing any applied content encoding (like gzip or Brotli). If the resource is retrieved from an application cache or local resources, it returns the size of the payload after removing any applied content encoding.
|
|
4351
4387
|
*
|
|
4352
4388
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/decodedBodySize)
|
|
4353
4389
|
*/
|
|
4354
4390
|
get decodedBodySize(): number;
|
|
4355
4391
|
/**
|
|
4356
|
-
* The **`domainLookupEnd`** read-only property returns the
|
|
4392
|
+
* The **`domainLookupEnd`** read-only property returns the timestamp immediately after the browser finishes the domain-name lookup for the resource.
|
|
4357
4393
|
*
|
|
4358
4394
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/domainLookupEnd)
|
|
4359
4395
|
*/
|
|
4360
4396
|
get domainLookupEnd(): number;
|
|
4361
4397
|
/**
|
|
4362
|
-
* The **`domainLookupStart`** read-only property returns the
|
|
4398
|
+
* The **`domainLookupStart`** read-only property returns the timestamp immediately before the browser starts the domain name lookup for the resource.
|
|
4363
4399
|
*
|
|
4364
4400
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/domainLookupStart)
|
|
4365
4401
|
*/
|
|
4366
4402
|
get domainLookupStart(): number;
|
|
4367
4403
|
/**
|
|
4368
|
-
* The **`encodedBodySize`** read-only property represents the size (in octets) received from the fetch (HTTP or cache) of the payload body before removing any applied content encodings (like gzip or Brotli).
|
|
4404
|
+
* The **`encodedBodySize`** read-only property represents the size (in octets) received from the fetch (HTTP or cache) of the payload body before removing any applied content encodings (like gzip or Brotli). If the resource is retrieved from an application cache or a local resource, it must return the size of the payload body before removing any applied content encoding.
|
|
4369
4405
|
*
|
|
4370
4406
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/encodedBodySize)
|
|
4371
4407
|
*/
|
|
4372
4408
|
get encodedBodySize(): number;
|
|
4373
4409
|
/**
|
|
4374
|
-
* The **`fetchStart`** read-only property represents a
|
|
4410
|
+
* The **`fetchStart`** read-only property represents a timestamp immediately before the browser starts to fetch the resource.
|
|
4375
4411
|
*
|
|
4376
4412
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/fetchStart)
|
|
4377
4413
|
*/
|
|
@@ -4389,31 +4425,31 @@ export declare abstract class PerformanceResourceTiming extends PerformanceEntry
|
|
|
4389
4425
|
*/
|
|
4390
4426
|
get nextHopProtocol(): string;
|
|
4391
4427
|
/**
|
|
4392
|
-
* The **`redirectEnd`** read-only property returns a
|
|
4428
|
+
* The **`redirectEnd`** read-only property returns a timestamp immediately after receiving the last byte of the response of the last redirect.
|
|
4393
4429
|
*
|
|
4394
4430
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/redirectEnd)
|
|
4395
4431
|
*/
|
|
4396
4432
|
get redirectEnd(): number;
|
|
4397
4433
|
/**
|
|
4398
|
-
* The **`redirectStart`** read-only property returns a
|
|
4434
|
+
* The **`redirectStart`** read-only property returns a timestamp representing the start time of the fetch which that initiates the redirect.
|
|
4399
4435
|
*
|
|
4400
4436
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/redirectStart)
|
|
4401
4437
|
*/
|
|
4402
4438
|
get redirectStart(): number;
|
|
4403
4439
|
/**
|
|
4404
|
-
* The **`requestStart`** read-only property returns a
|
|
4440
|
+
* The **`requestStart`** read-only property returns a timestamp of the time immediately before the browser starts requesting the resource from the server, cache, or local resource. If the transport connection fails and the browser retries the request, the value returned will be the start of the retry request.
|
|
4405
4441
|
*
|
|
4406
4442
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/requestStart)
|
|
4407
4443
|
*/
|
|
4408
4444
|
get requestStart(): number;
|
|
4409
4445
|
/**
|
|
4410
|
-
* The **`responseEnd`** read-only property returns a
|
|
4446
|
+
* The **`responseEnd`** read-only property returns a timestamp immediately after the browser receives the last byte of the resource or immediately before the transport connection is closed, whichever comes first.
|
|
4411
4447
|
*
|
|
4412
4448
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/responseEnd)
|
|
4413
4449
|
*/
|
|
4414
4450
|
get responseEnd(): number;
|
|
4415
4451
|
/**
|
|
4416
|
-
* The **`responseStart`** read-only property returns a
|
|
4452
|
+
* The **`responseStart`** read-only property returns a timestamp immediately after the browser receives the first byte of the response from the server, cache, or local resource.
|
|
4417
4453
|
*
|
|
4418
4454
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/responseStart)
|
|
4419
4455
|
*/
|
|
@@ -4425,39 +4461,39 @@ export declare abstract class PerformanceResourceTiming extends PerformanceEntry
|
|
|
4425
4461
|
*/
|
|
4426
4462
|
get responseStatus(): number;
|
|
4427
4463
|
/**
|
|
4428
|
-
* The **`secureConnectionStart`** read-only property returns a
|
|
4464
|
+
* The **`secureConnectionStart`** read-only property returns a timestamp immediately before the browser starts the handshake process to secure the current connection. If a secure connection is not used, the property returns zero.
|
|
4429
4465
|
*
|
|
4430
4466
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/secureConnectionStart)
|
|
4431
4467
|
*/
|
|
4432
4468
|
get secureConnectionStart(): number | undefined;
|
|
4433
4469
|
/**
|
|
4434
|
-
* The **`transferSize`** read-only property represents the size (in octets) of the fetched resource.
|
|
4470
|
+
* The **`transferSize`** read-only property represents the size (in octets) of the fetched resource. The size includes the response header fields plus the response payload body (as defined by RFC7230).
|
|
4435
4471
|
*
|
|
4436
4472
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/transferSize)
|
|
4437
4473
|
*/
|
|
4438
4474
|
get transferSize(): number;
|
|
4439
4475
|
/**
|
|
4440
|
-
* The **`workerStart`** read-only property of the PerformanceResourceTiming interface returns a
|
|
4476
|
+
* The **`workerStart`** read-only property of the PerformanceResourceTiming interface returns a DOMHighResTimeStamp immediately before dispatching the FetchEvent if a Service Worker thread is already running, or immediately before starting the Service Worker thread if it is not already running. If the resource is not intercepted by a Service Worker the property will always return 0.
|
|
4441
4477
|
*
|
|
4442
4478
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming/workerStart)
|
|
4443
4479
|
*/
|
|
4444
4480
|
get workerStart(): number;
|
|
4445
4481
|
}
|
|
4446
4482
|
/**
|
|
4447
|
-
* The **`PerformanceObserver`** interface is used to observe performance measurement events and be notified of new
|
|
4483
|
+
* The **`PerformanceObserver`** interface is used to observe performance measurement events and be notified of new performance entries as they are recorded in the browser's performance timeline.
|
|
4448
4484
|
*
|
|
4449
4485
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserver)
|
|
4450
4486
|
*/
|
|
4451
4487
|
export declare class PerformanceObserver {
|
|
4452
4488
|
constructor(callback: any);
|
|
4453
4489
|
/**
|
|
4454
|
-
* The **`disconnect()`** method of the PerformanceObserver interface is used to stop the performance observer from receiving any
|
|
4490
|
+
* The **`disconnect()`** method of the PerformanceObserver interface is used to stop the performance observer from receiving any performance entry events.
|
|
4455
4491
|
*
|
|
4456
4492
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserver/disconnect)
|
|
4457
4493
|
*/
|
|
4458
4494
|
disconnect(): void;
|
|
4459
4495
|
/**
|
|
4460
|
-
* The **`observe()`** method of the
|
|
4496
|
+
* The **`observe()`** method of the PerformanceObserver interface is used to specify the set of performance entry types to observe.
|
|
4461
4497
|
*
|
|
4462
4498
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/PerformanceObserver/observe)
|
|
4463
4499
|
*/
|
|
@@ -5045,10 +5081,7 @@ export type AiSearchInstanceInfo = {
|
|
|
5045
5081
|
max_num_results?: number;
|
|
5046
5082
|
cache?: boolean;
|
|
5047
5083
|
cache_threshold?:
|
|
5048
|
-
| "
|
|
5049
|
-
| "close_enough"
|
|
5050
|
-
| "flexible_friend"
|
|
5051
|
-
| "anything_goes";
|
|
5084
|
+
"super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes";
|
|
5052
5085
|
custom_metadata?: Array<{
|
|
5053
5086
|
field_name: string;
|
|
5054
5087
|
data_type: "text" | "number" | "boolean" | "datetime";
|
|
@@ -5126,10 +5159,7 @@ export type AiSearchConfig = {
|
|
|
5126
5159
|
cache?: boolean;
|
|
5127
5160
|
/** Similarity threshold for cache hits. Stricter = fewer cache hits but higher relevance. */
|
|
5128
5161
|
cache_threshold?:
|
|
5129
|
-
| "
|
|
5130
|
-
| "close_enough"
|
|
5131
|
-
| "flexible_friend"
|
|
5132
|
-
| "anything_goes";
|
|
5162
|
+
"super_strict_match" | "close_enough" | "flexible_friend" | "anything_goes";
|
|
5133
5163
|
custom_metadata?: Array<{
|
|
5134
5164
|
field_name: string;
|
|
5135
5165
|
data_type: "text" | "number" | "boolean" | "datetime";
|
|
@@ -5175,12 +5205,7 @@ export type AiSearchListItemsParams = {
|
|
|
5175
5205
|
sort_by?: "status" | "modified_at";
|
|
5176
5206
|
/** Filter items by processing status. */
|
|
5177
5207
|
status?:
|
|
5178
|
-
| "
|
|
5179
|
-
| "running"
|
|
5180
|
-
| "completed"
|
|
5181
|
-
| "error"
|
|
5182
|
-
| "skipped"
|
|
5183
|
-
| "outdated";
|
|
5208
|
+
"queued" | "running" | "completed" | "error" | "skipped" | "outdated";
|
|
5184
5209
|
/** Filter items by source (e.g. "builtin" or "web-crawler:https://example.com"). */
|
|
5185
5210
|
source?: string;
|
|
5186
5211
|
/** JSON-encoded Vectorize filter for metadata filtering. */
|
|
@@ -5725,11 +5750,7 @@ export declare abstract class BaseAiTextEmbeddings {
|
|
|
5725
5750
|
}
|
|
5726
5751
|
export type RoleScopedChatInput = {
|
|
5727
5752
|
role:
|
|
5728
|
-
| "
|
|
5729
|
-
| "assistant"
|
|
5730
|
-
| "system"
|
|
5731
|
-
| "tool"
|
|
5732
|
-
| (string & NonNullable<unknown>);
|
|
5753
|
+
"user" | "assistant" | "system" | "tool" | (string & NonNullable<unknown>);
|
|
5733
5754
|
content: string;
|
|
5734
5755
|
name?: string;
|
|
5735
5756
|
};
|
|
@@ -5924,8 +5945,7 @@ export type ChatCompletionCustomToolTextFormat = {
|
|
|
5924
5945
|
type: "text";
|
|
5925
5946
|
};
|
|
5926
5947
|
export type ChatCompletionCustomToolFormat =
|
|
5927
|
-
|
|
|
5928
|
-
| ChatCompletionCustomToolGrammarFormat;
|
|
5948
|
+
ChatCompletionCustomToolTextFormat | ChatCompletionCustomToolGrammarFormat;
|
|
5929
5949
|
export type ChatCompletionCustomTool = {
|
|
5930
5950
|
type: "custom";
|
|
5931
5951
|
custom: {
|
|
@@ -5935,8 +5955,7 @@ export type ChatCompletionCustomTool = {
|
|
|
5935
5955
|
};
|
|
5936
5956
|
};
|
|
5937
5957
|
export type ChatCompletionTool =
|
|
5938
|
-
|
|
|
5939
|
-
| ChatCompletionCustomTool;
|
|
5958
|
+
ChatCompletionFunctionTool | ChatCompletionCustomTool;
|
|
5940
5959
|
export type ChatCompletionMessageFunctionToolCall = {
|
|
5941
5960
|
id: string;
|
|
5942
5961
|
type: "function";
|
|
@@ -5955,8 +5974,7 @@ export type ChatCompletionMessageCustomToolCall = {
|
|
|
5955
5974
|
};
|
|
5956
5975
|
};
|
|
5957
5976
|
export type ChatCompletionMessageToolCall =
|
|
5958
|
-
|
|
|
5959
|
-
| ChatCompletionMessageCustomToolCall;
|
|
5977
|
+
ChatCompletionMessageFunctionToolCall | ChatCompletionMessageCustomToolCall;
|
|
5960
5978
|
export type ChatCompletionToolChoiceFunction = {
|
|
5961
5979
|
type: "function";
|
|
5962
5980
|
function: {
|
|
@@ -6235,11 +6253,7 @@ export type ChatCompletionChoice = {
|
|
|
6235
6253
|
index: number;
|
|
6236
6254
|
message: ChatCompletionResponseMessage;
|
|
6237
6255
|
finish_reason:
|
|
6238
|
-
| "
|
|
6239
|
-
| "length"
|
|
6240
|
-
| "tool_calls"
|
|
6241
|
-
| "content_filter"
|
|
6242
|
-
| "function_call";
|
|
6256
|
+
"stop" | "length" | "tool_calls" | "content_filter" | "function_call";
|
|
6243
6257
|
logprobs: ChatCompletionLogprobs | null;
|
|
6244
6258
|
};
|
|
6245
6259
|
export type ChatCompletionsMessagesInput = {
|
|
@@ -6434,8 +6448,7 @@ export type ResponseFunctionCallArgumentsDoneEvent = {
|
|
|
6434
6448
|
type: "response.function_call_arguments.done";
|
|
6435
6449
|
};
|
|
6436
6450
|
export type ResponseFunctionCallOutputItem =
|
|
6437
|
-
|
|
|
6438
|
-
| ResponseInputImageContent;
|
|
6451
|
+
ResponseInputTextContent | ResponseInputImageContent;
|
|
6439
6452
|
export type ResponseFunctionCallOutputItemList =
|
|
6440
6453
|
Array<ResponseFunctionCallOutputItem>;
|
|
6441
6454
|
export type ResponseFunctionToolCall = {
|
|
@@ -6457,8 +6470,7 @@ export type ResponseFunctionToolCallOutputItem = {
|
|
|
6457
6470
|
status?: "in_progress" | "completed" | "incomplete";
|
|
6458
6471
|
};
|
|
6459
6472
|
export type ResponseIncludable =
|
|
6460
|
-
|
|
6461
|
-
| "message.output_text.logprobs";
|
|
6473
|
+
"message.input_image.image_url" | "message.output_text.logprobs";
|
|
6462
6474
|
export type ResponseIncompleteEvent = {
|
|
6463
6475
|
response: Response;
|
|
6464
6476
|
sequence_number: number;
|
|
@@ -6524,9 +6536,7 @@ export type ResponseItem =
|
|
|
6524
6536
|
| ResponseFunctionToolCallItem
|
|
6525
6537
|
| ResponseFunctionToolCallOutputItem;
|
|
6526
6538
|
export type ResponseOutputItem =
|
|
6527
|
-
|
|
|
6528
|
-
| ResponseFunctionToolCall
|
|
6529
|
-
| ResponseReasoningItem;
|
|
6539
|
+
ResponseOutputMessage | ResponseFunctionToolCall | ResponseReasoningItem;
|
|
6530
6540
|
export type ResponseOutputItemAddedEvent = {
|
|
6531
6541
|
item: ResponseOutputItem;
|
|
6532
6542
|
output_index: number;
|
|
@@ -8160,8 +8170,7 @@ export declare abstract class Base_Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct {
|
|
|
8160
8170
|
postProcessedOutputs: Ai_Cf_Qwen_Qwen2_5_Coder_32B_Instruct_Output;
|
|
8161
8171
|
}
|
|
8162
8172
|
export type Ai_Cf_Qwen_Qwq_32B_Input =
|
|
8163
|
-
|
|
|
8164
|
-
| Ai_Cf_Qwen_Qwq_32B_Messages;
|
|
8173
|
+
Ai_Cf_Qwen_Qwq_32B_Prompt | Ai_Cf_Qwen_Qwq_32B_Messages;
|
|
8165
8174
|
export interface Ai_Cf_Qwen_Qwq_32B_Prompt {
|
|
8166
8175
|
/**
|
|
8167
8176
|
* The input text prompt for the model to generate a response.
|
|
@@ -8708,8 +8717,7 @@ export declare abstract class Base_Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruc
|
|
|
8708
8717
|
postProcessedOutputs: Ai_Cf_Mistralai_Mistral_Small_3_1_24B_Instruct_Output;
|
|
8709
8718
|
}
|
|
8710
8719
|
export type Ai_Cf_Google_Gemma_3_12B_It_Input =
|
|
8711
|
-
|
|
|
8712
|
-
| Ai_Cf_Google_Gemma_3_12B_It_Messages;
|
|
8720
|
+
Ai_Cf_Google_Gemma_3_12B_It_Prompt | Ai_Cf_Google_Gemma_3_12B_It_Messages;
|
|
8713
8721
|
export interface Ai_Cf_Google_Gemma_3_12B_It_Prompt {
|
|
8714
8722
|
/**
|
|
8715
8723
|
* The input text prompt for the model to generate a response.
|
|
@@ -11248,11 +11256,7 @@ export interface Ai_Cf_Deepgram_Flux_Output {
|
|
|
11248
11256
|
* The type of event being reported.
|
|
11249
11257
|
*/
|
|
11250
11258
|
event?:
|
|
11251
|
-
| "
|
|
11252
|
-
| "StartOfTurn"
|
|
11253
|
-
| "EagerEndOfTurn"
|
|
11254
|
-
| "TurnResumed"
|
|
11255
|
-
| "EndOfTurn";
|
|
11259
|
+
"Update" | "StartOfTurn" | "EagerEndOfTurn" | "TurnResumed" | "EndOfTurn";
|
|
11256
11260
|
/**
|
|
11257
11261
|
* The index of the current turn
|
|
11258
11262
|
*/
|
|
@@ -11788,8 +11792,7 @@ export type AIGatewayProviders =
|
|
|
11788
11792
|
| "adobe-firefly";
|
|
11789
11793
|
export type AIGatewayHeaders = {
|
|
11790
11794
|
"cf-aig-metadata":
|
|
11791
|
-
|
|
11792
|
-
| string;
|
|
11795
|
+
Record<string, number | string | boolean | null | bigint> | string;
|
|
11793
11796
|
"cf-aig-custom-cost":
|
|
11794
11797
|
| {
|
|
11795
11798
|
per_token_in?: number;
|
|
@@ -12212,10 +12215,7 @@ export declare abstract class AutoRAG {
|
|
|
12212
12215
|
): Promise<AutoRagAiSearchResponse | Response>;
|
|
12213
12216
|
}
|
|
12214
12217
|
export type BrowserRunLifecycleEvent =
|
|
12215
|
-
| "
|
|
12216
|
-
| "domcontentloaded"
|
|
12217
|
-
| "networkidle0"
|
|
12218
|
-
| "networkidle2";
|
|
12218
|
+
"load" | "domcontentloaded" | "networkidle0" | "networkidle2";
|
|
12219
12219
|
export type BrowserRunResourceType =
|
|
12220
12220
|
| "document"
|
|
12221
12221
|
| "stylesheet"
|
|
@@ -12838,9 +12838,7 @@ export interface RequestInitCfProperties extends Record<string, unknown> {
|
|
|
12838
12838
|
* response header.
|
|
12839
12839
|
*/
|
|
12840
12840
|
export type RequestInitCfPropertiesVaryAction =
|
|
12841
|
-
| "
|
|
12842
|
-
| "passthrough"
|
|
12843
|
-
| "bypass";
|
|
12841
|
+
"normalize" | "passthrough" | "bypass";
|
|
12844
12842
|
/** Configuration for Workers Standard Vary support. */
|
|
12845
12843
|
export interface RequestInitCfPropertiesVary {
|
|
12846
12844
|
/** The fallback action for varied request headers not listed in `headers`. */
|
|
@@ -13117,7 +13115,8 @@ export interface RequestInitCfPropertiesImageDraw extends BasicImageTransformati
|
|
|
13117
13115
|
/**
|
|
13118
13116
|
* How to combine the foreground and backdrop pixels to create the result
|
|
13119
13117
|
*/
|
|
13120
|
-
composite?:
|
|
13118
|
+
composite?:
|
|
13119
|
+
/** Foreground drawn on top of backdrop (default) */
|
|
13121
13120
|
| "over"
|
|
13122
13121
|
/** Foreground shown only where backdrop is opaque */
|
|
13123
13122
|
| "in"
|
|
@@ -13928,16 +13927,9 @@ export declare type Iso3166Alpha2Code =
|
|
|
13928
13927
|
| "ZW";
|
|
13929
13928
|
/** The 2-letter continent codes Cloudflare uses */
|
|
13930
13929
|
export declare type ContinentCode =
|
|
13931
|
-
| "
|
|
13932
|
-
| "AN"
|
|
13933
|
-
| "AS"
|
|
13934
|
-
| "EU"
|
|
13935
|
-
| "NA"
|
|
13936
|
-
| "OC"
|
|
13937
|
-
| "SA";
|
|
13930
|
+
"AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA";
|
|
13938
13931
|
export type CfProperties<HostMetadata = unknown> =
|
|
13939
|
-
|
|
13940
|
-
| RequestInitCfProperties;
|
|
13932
|
+
IncomingRequestCfProperties<HostMetadata> | RequestInitCfProperties;
|
|
13941
13933
|
export interface D1Meta {
|
|
13942
13934
|
duration: number;
|
|
13943
13935
|
size_after: number;
|
|
@@ -14879,9 +14871,7 @@ export declare namespace Rpc {
|
|
|
14879
14871
|
[__WORKFLOW_ENTRYPOINT_BRAND]: never;
|
|
14880
14872
|
}
|
|
14881
14873
|
export type EntrypointBranded =
|
|
14882
|
-
|
|
|
14883
|
-
| DurableObjectBranded
|
|
14884
|
-
| WorkflowEntrypointBranded;
|
|
14874
|
+
WorkerEntrypointBranded | DurableObjectBranded | WorkflowEntrypointBranded;
|
|
14885
14875
|
// Types that can be used through `Stub`s
|
|
14886
14876
|
export type Stubable = RpcTargetBranded | ((...args: any[]) => any);
|
|
14887
14877
|
// Types that can be passed over RPC
|
|
@@ -15123,16 +15113,9 @@ export declare namespace CloudflareWorkersModule {
|
|
|
15123
15113
|
webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
|
|
15124
15114
|
}
|
|
15125
15115
|
export type WorkflowDurationLabel =
|
|
15126
|
-
| "
|
|
15127
|
-
| "minute"
|
|
15128
|
-
| "hour"
|
|
15129
|
-
| "day"
|
|
15130
|
-
| "week"
|
|
15131
|
-
| "month"
|
|
15132
|
-
| "year";
|
|
15116
|
+
"second" | "minute" | "hour" | "day" | "week" | "month" | "year";
|
|
15133
15117
|
export type WorkflowSleepDuration =
|
|
15134
|
-
|
|
15135
|
-
| number;
|
|
15118
|
+
`${number} ${WorkflowDurationLabel}${"s" | ""}` | number;
|
|
15136
15119
|
export type WorkflowDelayDuration = WorkflowSleepDuration;
|
|
15137
15120
|
export type WorkflowDynamicDelayContext = {
|
|
15138
15121
|
ctx: WorkflowStepContext<WorkflowDelayFunction>;
|
|
@@ -15929,11 +15912,7 @@ export type StreamDownloadGetResponse = {
|
|
|
15929
15912
|
default?: StreamDownload;
|
|
15930
15913
|
};
|
|
15931
15914
|
export type StreamWatermarkPosition =
|
|
15932
|
-
| "
|
|
15933
|
-
| "upperLeft"
|
|
15934
|
-
| "lowerLeft"
|
|
15935
|
-
| "lowerRight"
|
|
15936
|
-
| "center";
|
|
15915
|
+
"upperRight" | "upperLeft" | "lowerLeft" | "lowerRight" | "center";
|
|
15937
15916
|
export type StreamWatermark = {
|
|
15938
15917
|
/**
|
|
15939
15918
|
* The unique identifier for a watermark profile.
|
|
@@ -16417,8 +16396,7 @@ export type VectorizeVectorMetadataValue = string | number | boolean | string[];
|
|
|
16417
16396
|
* Additional information to associate with a vector.
|
|
16418
16397
|
*/
|
|
16419
16398
|
export type VectorizeVectorMetadata =
|
|
16420
|
-
| VectorizeVectorMetadataValue
|
|
16421
|
-
| Record<string, VectorizeVectorMetadataValue>;
|
|
16399
|
+
VectorizeVectorMetadataValue | Record<string, VectorizeVectorMetadataValue>;
|
|
16422
16400
|
export type VectorFloatArray = Float32Array | Float64Array;
|
|
16423
16401
|
export interface VectorizeError {
|
|
16424
16402
|
code?: number;
|
|
@@ -16430,12 +16408,7 @@ export interface VectorizeError {
|
|
|
16430
16408
|
* This list is expected to grow as support for more operations are released.
|
|
16431
16409
|
*/
|
|
16432
16410
|
export type VectorizeVectorMetadataFilterOp =
|
|
16433
|
-
| "$
|
|
16434
|
-
| "$ne"
|
|
16435
|
-
| "$lt"
|
|
16436
|
-
| "$lte"
|
|
16437
|
-
| "$gt"
|
|
16438
|
-
| "$gte";
|
|
16411
|
+
"$eq" | "$ne" | "$lt" | "$lte" | "$gt" | "$gte";
|
|
16439
16412
|
export type VectorizeVectorMetadataFilterCollectionOp = "$in" | "$nin";
|
|
16440
16413
|
/**
|
|
16441
16414
|
* Filter criteria for vector metadata used to limit the retrieved query result set.
|
|
@@ -16864,16 +16837,9 @@ export type WorkflowBatchDeleteResult = {
|
|
|
16864
16837
|
}[];
|
|
16865
16838
|
};
|
|
16866
16839
|
export type WorkflowDurationLabel =
|
|
16867
|
-
| "
|
|
16868
|
-
| "minute"
|
|
16869
|
-
| "hour"
|
|
16870
|
-
| "day"
|
|
16871
|
-
| "week"
|
|
16872
|
-
| "month"
|
|
16873
|
-
| "year";
|
|
16840
|
+
"second" | "minute" | "hour" | "day" | "week" | "month" | "year";
|
|
16874
16841
|
export type WorkflowSleepDuration =
|
|
16875
|
-
|
|
16876
|
-
| number;
|
|
16842
|
+
`${number} ${WorkflowDurationLabel}${"s" | ""}` | number;
|
|
16877
16843
|
export type WorkflowRetentionDuration = WorkflowSleepDuration;
|
|
16878
16844
|
export interface WorkflowInstanceCreateOptions<PARAMS = unknown> {
|
|
16879
16845
|
/**
|