@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
 
@@ -145,7 +176,7 @@ interface HighlightRegistry extends Map<string, Highlight> {
145
176
 
146
177
  interface IDBDatabase {
147
178
  /**
148
- * 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.
179
+ * 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.
149
180
  *
150
181
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBDatabase/transaction)
151
182
  */
@@ -154,9 +185,7 @@ interface IDBDatabase {
154
185
 
155
186
  interface IDBObjectStore {
156
187
  /**
157
- * 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.
158
- *
159
- * Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
188
+ * The **`createIndex()`** method of the field/column defining a new data point for each database record to contain.
160
189
  *
161
190
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/createIndex)
162
191
  */
@@ -171,7 +200,11 @@ interface MIDIInputMap extends ReadonlyMap<string, MIDIInput> {
171
200
  }
172
201
 
173
202
  interface MIDIOutput {
174
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send) */
203
+ /**
204
+ * The **`send()`** method of the MIDIOutput interface queues messages for the corresponding MIDI port.
205
+ *
206
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send)
207
+ */
175
208
  send(data: Iterable<number>, timestamp?: DOMHighResTimeStamp): void;
176
209
  }
177
210
 
@@ -204,12 +237,17 @@ interface NamedNodeMap {
204
237
 
205
238
  interface Navigator {
206
239
  /**
240
+ * 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.
207
241
  * Available only in secure contexts.
208
242
  *
209
243
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/requestMediaKeySystemAccess)
210
244
  */
211
245
  requestMediaKeySystemAccess(keySystem: string, supportedConfigurations: Iterable<MediaKeySystemConfiguration>): Promise<MediaKeySystemAccess>;
212
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate) */
246
+ /**
247
+ * The **`vibrate()`** method of the Navigator interface pulses the vibration hardware on the device, if such hardware exists.
248
+ *
249
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate)
250
+ */
213
251
  vibrate(pattern: Iterable<number>): boolean;
214
252
  }
215
253
 
@@ -242,7 +280,11 @@ interface PluginArray {
242
280
  }
243
281
 
244
282
  interface RTCRtpTransceiver {
245
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences) */
283
+ /**
284
+ * 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.
285
+ *
286
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences)
287
+ */
246
288
  setCodecPreferences(codecs: Iterable<RTCRtpCodec>): void;
247
289
  }
248
290
 
@@ -293,17 +335,33 @@ interface StyleSheetList {
293
335
  }
294
336
 
295
337
  interface SubtleCrypto {
296
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey) */
338
+ /**
339
+ * The **`deriveKey()`** method of the SubtleCrypto interface can be used to derive a secret key from a master key.
340
+ *
341
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey)
342
+ */
297
343
  deriveKey(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, derivedKeyType: AlgorithmIdentifier | AesDerivedKeyParams | HmacImportParams | HkdfParams | Pbkdf2Params, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>;
298
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey) */
344
+ /**
345
+ * The **`generateKey()`** method of the SubtleCrypto interface is used to generate a new key (for symmetric algorithms) or key pair (for public-key algorithms).
346
+ *
347
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey)
348
+ */
299
349
  generateKey(algorithm: "Ed25519" | { name: "Ed25519" }, extractable: boolean, keyUsages: ReadonlyArray<"sign" | "verify">): Promise<CryptoKeyPair>;
300
350
  generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKeyPair>;
301
351
  generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
302
352
  generateKey(algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKeyPair | CryptoKey>;
303
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey) */
353
+ /**
354
+ * 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.
355
+ *
356
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey)
357
+ */
304
358
  importKey(format: "jwk", keyData: JsonWebKey, algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
305
359
  importKey(format: Exclude<KeyFormat, "jwk">, keyData: BufferSource, algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>;
306
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey) */
360
+ /**
361
+ * The **`unwrapKey()`** method of the SubtleCrypto interface 'unwraps' a key.
362
+ *
363
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey)
364
+ */
307
365
  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>;
308
366
  }
309
367
 
@@ -333,18 +391,38 @@ interface ViewTransitionTypeSet extends Set<string> {
333
391
  }
334
392
 
335
393
  interface WEBGL_draw_buffers {
336
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL) */
394
+ /**
395
+ * 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.
396
+ *
397
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL)
398
+ */
337
399
  drawBuffersWEBGL(buffers: Iterable<GLenum>): void;
338
400
  }
339
401
 
340
402
  interface WEBGL_multi_draw {
341
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL) */
403
+ /**
404
+ * The **`WEBGL_multi_draw.multiDrawArraysInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
405
+ *
406
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL)
407
+ */
342
408
  multiDrawArraysInstancedWEBGL(mode: GLenum, firstsList: Int32Array | Iterable<GLint>, firstsOffset: number, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, instanceCountsList: Int32Array | Iterable<GLsizei>, instanceCountsOffset: number, drawcount: GLsizei): void;
343
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL) */
409
+ /**
410
+ * The **`WEBGL_multi_draw.multiDrawArraysWEBGL()`** method of the WebGL API renders multiple primitives from array data.
411
+ *
412
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL)
413
+ */
344
414
  multiDrawArraysWEBGL(mode: GLenum, firstsList: Int32Array | Iterable<GLint>, firstsOffset: number, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, drawcount: GLsizei): void;
345
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL) */
415
+ /**
416
+ * The **`WEBGL_multi_draw.multiDrawElementsInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
417
+ *
418
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL)
419
+ */
346
420
  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;
347
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL) */
421
+ /**
422
+ * The **`WEBGL_multi_draw.multiDrawElementsWEBGL()`** method of the WebGL API renders multiple primitives from array data.
423
+ *
424
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL)
425
+ */
348
426
  multiDrawElementsWEBGL(mode: GLenum, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, type: GLenum, offsetsList: Int32Array | Iterable<GLsizei>, offsetsOffset: number, drawcount: GLsizei): void;
349
427
  }
350
428