@types/web 0.0.237 → 0.0.239

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.
@@ -3,7 +3,11 @@
3
3
  /////////////////////////////
4
4
 
5
5
  interface AudioParam {
6
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setValueCurveAtTime) */
6
+ /**
7
+ * The **`setValueCurveAtTime()`** method of the following a curve defined by a list of values.
8
+ *
9
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AudioParam/setValueCurveAtTime)
10
+ */
7
11
  setValueCurveAtTime(values: Iterable<number>, startTime: number, duration: number): AudioParam;
8
12
  }
9
13
 
@@ -11,9 +15,17 @@ interface AudioParamMap extends ReadonlyMap<string, AudioParam> {
11
15
  }
12
16
 
13
17
  interface BaseAudioContext {
14
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createIIRFilter) */
18
+ /**
19
+ * The **`createIIRFilter()`** method of the BaseAudioContext interface creates an IIRFilterNode, which represents a general **infinite impulse response** (IIR) filter which can be configured to serve as various types of filter.
20
+ *
21
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createIIRFilter)
22
+ */
15
23
  createIIRFilter(feedforward: Iterable<number>, feedback: Iterable<number>): IIRFilterNode;
16
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createPeriodicWave) */
24
+ /**
25
+ * The `createPeriodicWave()` method of the BaseAudioContext interface is used to create a PeriodicWave.
26
+ *
27
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/BaseAudioContext/createPeriodicWave)
28
+ */
17
29
  createPeriodicWave(real: Iterable<number>, imag: Iterable<number>, constraints?: PeriodicWaveConstraints): PeriodicWave;
18
30
  }
19
31
 
@@ -51,7 +63,11 @@ interface CSSUnparsedValue {
51
63
  }
52
64
 
53
65
  interface Cache {
54
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll) */
66
+ /**
67
+ * The **`addAll()`** method of the Cache interface takes an array of URLs, retrieves them, and adds the resulting response objects to the given cache.
68
+ *
69
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Cache/addAll)
70
+ */
55
71
  addAll(requests: Iterable<RequestInfo>): Promise<void>;
56
72
  }
57
73
 
@@ -65,6 +81,21 @@ interface CanvasPathDrawingStyles {
65
81
  setLineDash(segments: Iterable<number>): void;
66
82
  }
67
83
 
84
+ interface CookieStoreManager {
85
+ /**
86
+ * The **`subscribe()`** method of the CookieStoreManager interface subscribes a ServiceWorkerRegistration to cookie change events.
87
+ *
88
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStoreManager/subscribe)
89
+ */
90
+ subscribe(subscriptions: Iterable<CookieStoreGetOptions>): Promise<void>;
91
+ /**
92
+ * The **`unsubscribe()`** method of the CookieStoreManager interface stops the ServiceWorkerRegistration from receiving previously subscribed events.
93
+ *
94
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CookieStoreManager/unsubscribe)
95
+ */
96
+ unsubscribe(subscriptions: Iterable<CookieStoreGetOptions>): Promise<void>;
97
+ }
98
+
68
99
  interface CustomStateSet extends Set<string> {
69
100
  }
70
101
 
@@ -153,7 +184,7 @@ interface HighlightRegistry extends Map<string, Highlight> {
153
184
 
154
185
  interface IDBDatabase {
155
186
  /**
156
- * Returns a new transaction with the given mode ("readonly" or "readwrite") and scope which can be a single object store name or an array of names.
187
+ * The **`transaction`** method of the IDBDatabase interface immediately returns a transaction object (IDBTransaction) containing the IDBTransaction.objectStore method, which you can use to access your object store.
157
188
  *
158
189
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBDatabase/transaction)
159
190
  */
@@ -162,9 +193,7 @@ interface IDBDatabase {
162
193
 
163
194
  interface IDBObjectStore {
164
195
  /**
165
- * Creates a new index in store with the given name, keyPath and options and returns a new IDBIndex. If the keyPath and options define constraints that cannot be satisfied with the data already in store the upgrade transaction will abort with a "ConstraintError" DOMException.
166
- *
167
- * Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
196
+ * The **`createIndex()`** method of the field/column defining a new data point for each database record to contain.
168
197
  *
169
198
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/createIndex)
170
199
  */
@@ -179,7 +208,11 @@ interface MIDIInputMap extends ReadonlyMap<string, MIDIInput> {
179
208
  }
180
209
 
181
210
  interface MIDIOutput {
182
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send) */
211
+ /**
212
+ * The **`send()`** method of the MIDIOutput interface queues messages for the corresponding MIDI port.
213
+ *
214
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send)
215
+ */
183
216
  send(data: Iterable<number>, timestamp?: DOMHighResTimeStamp): void;
184
217
  }
185
218
 
@@ -216,12 +249,17 @@ interface NamedNodeMap {
216
249
 
217
250
  interface Navigator {
218
251
  /**
252
+ * The **`requestMediaKeySystemAccess()`** method of the Navigator interface returns a Promise which delivers a MediaKeySystemAccess object that can be used to access a particular media key system, which can in turn be used to create keys for decrypting a media stream.
219
253
  * Available only in secure contexts.
220
254
  *
221
255
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/requestMediaKeySystemAccess)
222
256
  */
223
257
  requestMediaKeySystemAccess(keySystem: string, supportedConfigurations: Iterable<MediaKeySystemConfiguration>): Promise<MediaKeySystemAccess>;
224
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate) */
258
+ /**
259
+ * The **`vibrate()`** method of the Navigator interface pulses the vibration hardware on the device, if such hardware exists.
260
+ *
261
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate)
262
+ */
225
263
  vibrate(pattern: Iterable<number>): boolean;
226
264
  }
227
265
 
@@ -254,7 +292,11 @@ interface PluginArray {
254
292
  }
255
293
 
256
294
  interface RTCRtpTransceiver {
257
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences) */
295
+ /**
296
+ * The **`setCodecPreferences()`** method of the RTCRtpTransceiver interface is used to set the codecs that the transceiver allows for decoding _received_ data, in order of decreasing preference.
297
+ *
298
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences)
299
+ */
258
300
  setCodecPreferences(codecs: Iterable<RTCRtpCodec>): void;
259
301
  }
260
302
 
@@ -309,17 +351,33 @@ interface StyleSheetList {
309
351
  }
310
352
 
311
353
  interface SubtleCrypto {
312
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey) */
354
+ /**
355
+ * The **`deriveKey()`** method of the SubtleCrypto interface can be used to derive a secret key from a master key.
356
+ *
357
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey)
358
+ */
313
359
  deriveKey(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, derivedKeyType: AlgorithmIdentifier | AesDerivedKeyParams | HmacImportParams | HkdfParams | Pbkdf2Params, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>;
314
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey) */
360
+ /**
361
+ * The **`generateKey()`** method of the SubtleCrypto interface is used to generate a new key (for symmetric algorithms) or key pair (for public-key algorithms).
362
+ *
363
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey)
364
+ */
315
365
  generateKey(algorithm: "Ed25519" | { name: "Ed25519" }, extractable: boolean, keyUsages: ReadonlyArray<"sign" | "verify">): Promise<CryptoKeyPair>;
316
366
  generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKeyPair>;
317
367
  generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
318
368
  generateKey(algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKeyPair | CryptoKey>;
319
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey) */
369
+ /**
370
+ * The **`importKey()`** method of the SubtleCrypto interface imports a key: that is, it takes as input a key in an external, portable format and gives you a CryptoKey object that you can use in the Web Crypto API.
371
+ *
372
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey)
373
+ */
320
374
  importKey(format: "jwk", keyData: JsonWebKey, algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
321
375
  importKey(format: Exclude<KeyFormat, "jwk">, keyData: BufferSource, algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>;
322
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey) */
376
+ /**
377
+ * The **`unwrapKey()`** method of the SubtleCrypto interface 'unwraps' a key.
378
+ *
379
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey)
380
+ */
323
381
  unwrapKey(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: CryptoKey, unwrapAlgorithm: AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams, unwrappedKeyAlgorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>;
324
382
  }
325
383
 
@@ -353,18 +411,38 @@ interface ViewTransitionTypeSet extends Set<string> {
353
411
  }
354
412
 
355
413
  interface WEBGL_draw_buffers {
356
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL) */
414
+ /**
415
+ * The **`WEBGL_draw_buffers.drawBuffersWEBGL()`** method is part of the WebGL API and allows you to define the draw buffers to which all fragment colors are written.
416
+ *
417
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL)
418
+ */
357
419
  drawBuffersWEBGL(buffers: Iterable<GLenum>): void;
358
420
  }
359
421
 
360
422
  interface WEBGL_multi_draw {
361
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL) */
423
+ /**
424
+ * The **`WEBGL_multi_draw.multiDrawArraysInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
425
+ *
426
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL)
427
+ */
362
428
  multiDrawArraysInstancedWEBGL(mode: GLenum, firstsList: Int32Array | Iterable<GLint>, firstsOffset: number, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, instanceCountsList: Int32Array | Iterable<GLsizei>, instanceCountsOffset: number, drawcount: GLsizei): void;
363
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL) */
429
+ /**
430
+ * The **`WEBGL_multi_draw.multiDrawArraysWEBGL()`** method of the WebGL API renders multiple primitives from array data.
431
+ *
432
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL)
433
+ */
364
434
  multiDrawArraysWEBGL(mode: GLenum, firstsList: Int32Array | Iterable<GLint>, firstsOffset: number, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, drawcount: GLsizei): void;
365
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL) */
435
+ /**
436
+ * The **`WEBGL_multi_draw.multiDrawElementsInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
437
+ *
438
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL)
439
+ */
366
440
  multiDrawElementsInstancedWEBGL(mode: GLenum, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, type: GLenum, offsetsList: Int32Array | Iterable<GLsizei>, offsetsOffset: number, instanceCountsList: Int32Array | Iterable<GLsizei>, instanceCountsOffset: number, drawcount: GLsizei): void;
367
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL) */
441
+ /**
442
+ * The **`WEBGL_multi_draw.multiDrawElementsWEBGL()`** method of the WebGL API renders multiple primitives from array data.
443
+ *
444
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL)
445
+ */
368
446
  multiDrawElementsWEBGL(mode: GLenum, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, type: GLenum, offsetsList: Int32Array | Iterable<GLsizei>, offsetsOffset: number, drawcount: GLsizei): void;
369
447
  }
370
448