fetch.idl (4492B)
1 // GENERATED CONTENT - DO NOT EDIT 2 // Content was automatically extracted by Reffy into webref 3 // (https://github.com/w3c/webref) 4 // Source: Fetch Standard (https://fetch.spec.whatwg.org/) 5 6 typedef (sequence<sequence<ByteString>> or record<ByteString, ByteString>) HeadersInit; 7 8 [Exposed=(Window,Worker)] 9 interface Headers { 10 constructor(optional HeadersInit init); 11 12 undefined append(ByteString name, ByteString value); 13 undefined delete(ByteString name); 14 ByteString? get(ByteString name); 15 sequence<ByteString> getSetCookie(); 16 boolean has(ByteString name); 17 undefined set(ByteString name, ByteString value); 18 iterable<ByteString, ByteString>; 19 }; 20 21 typedef (Blob or BufferSource or FormData or URLSearchParams or USVString) XMLHttpRequestBodyInit; 22 23 typedef (ReadableStream or XMLHttpRequestBodyInit) BodyInit; 24 interface mixin Body { 25 readonly attribute ReadableStream? body; 26 readonly attribute boolean bodyUsed; 27 [NewObject] Promise<ArrayBuffer> arrayBuffer(); 28 [NewObject] Promise<Blob> blob(); 29 [NewObject] Promise<Uint8Array> bytes(); 30 [NewObject] Promise<FormData> formData(); 31 [NewObject] Promise<any> json(); 32 [NewObject] Promise<USVString> text(); 33 }; 34 typedef (Request or USVString) RequestInfo; 35 36 [Exposed=(Window,Worker)] 37 interface Request { 38 constructor(RequestInfo input, optional RequestInit init = {}); 39 40 readonly attribute ByteString method; 41 readonly attribute USVString url; 42 [SameObject] readonly attribute Headers headers; 43 44 readonly attribute RequestDestination destination; 45 readonly attribute USVString referrer; 46 readonly attribute ReferrerPolicy referrerPolicy; 47 readonly attribute RequestMode mode; 48 readonly attribute RequestCredentials credentials; 49 readonly attribute RequestCache cache; 50 readonly attribute RequestRedirect redirect; 51 readonly attribute DOMString integrity; 52 readonly attribute boolean keepalive; 53 readonly attribute boolean isReloadNavigation; 54 readonly attribute boolean isHistoryNavigation; 55 readonly attribute AbortSignal signal; 56 readonly attribute RequestDuplex duplex; 57 58 [NewObject] Request clone(); 59 }; 60 Request includes Body; 61 62 dictionary RequestInit { 63 ByteString method; 64 HeadersInit headers; 65 BodyInit? body; 66 USVString referrer; 67 ReferrerPolicy referrerPolicy; 68 RequestMode mode; 69 RequestCredentials credentials; 70 RequestCache cache; 71 RequestRedirect redirect; 72 DOMString integrity; 73 boolean keepalive; 74 AbortSignal? signal; 75 RequestDuplex duplex; 76 RequestPriority priority; 77 any window; // can only be set to null 78 }; 79 80 enum RequestDestination { "", "audio", "audioworklet", "document", "embed", "font", "frame", "iframe", "image", "json", "manifest", "object", "paintworklet", "report", "script", "sharedworker", "style", "track", "video", "worker", "xslt" }; 81 enum RequestMode { "navigate", "same-origin", "no-cors", "cors" }; 82 enum RequestCredentials { "omit", "same-origin", "include" }; 83 enum RequestCache { "default", "no-store", "reload", "no-cache", "force-cache", "only-if-cached" }; 84 enum RequestRedirect { "follow", "error", "manual" }; 85 enum RequestDuplex { "half" }; 86 enum RequestPriority { "high", "low", "auto" }; 87 88 [Exposed=(Window,Worker)] 89 interface Response { 90 constructor(optional BodyInit? body = null, optional ResponseInit init = {}); 91 92 [NewObject] static Response error(); 93 [NewObject] static Response redirect(USVString url, optional unsigned short status = 302); 94 [NewObject] static Response json(any data, optional ResponseInit init = {}); 95 96 readonly attribute ResponseType type; 97 98 readonly attribute USVString url; 99 readonly attribute boolean redirected; 100 readonly attribute unsigned short status; 101 readonly attribute boolean ok; 102 readonly attribute ByteString statusText; 103 [SameObject] readonly attribute Headers headers; 104 105 [NewObject] Response clone(); 106 }; 107 Response includes Body; 108 109 dictionary ResponseInit { 110 unsigned short status = 200; 111 ByteString statusText = ""; 112 HeadersInit headers; 113 }; 114 115 enum ResponseType { "basic", "cors", "default", "error", "opaque", "opaqueredirect" }; 116 117 partial interface mixin WindowOrWorkerGlobalScope { 118 [NewObject] Promise<Response> fetch(RequestInfo input, optional RequestInit init = {}); 119 }; 120 121 dictionary DeferredRequestInit : RequestInit { 122 DOMHighResTimeStamp activateAfter; 123 }; 124 125 [Exposed=Window] 126 interface FetchLaterResult { 127 readonly attribute boolean activated; 128 }; 129 130 partial interface Window { 131 [NewObject, SecureContext] FetchLaterResult fetchLater(RequestInfo input, optional DeferredRequestInit init = {}); 132 };