@types/web 0.0.237 → 0.0.238

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
 
@@ -153,7 +169,7 @@ interface HighlightRegistry extends Map<string, Highlight> {
153
169
 
154
170
  interface IDBDatabase {
155
171
  /**
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.
172
+ * 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
173
  *
158
174
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBDatabase/transaction)
159
175
  */
@@ -162,9 +178,7 @@ interface IDBDatabase {
162
178
 
163
179
  interface IDBObjectStore {
164
180
  /**
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.
181
+ * The **`createIndex()`** method of the field/column defining a new data point for each database record to contain.
168
182
  *
169
183
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/createIndex)
170
184
  */
@@ -179,7 +193,11 @@ interface MIDIInputMap extends ReadonlyMap<string, MIDIInput> {
179
193
  }
180
194
 
181
195
  interface MIDIOutput {
182
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send) */
196
+ /**
197
+ * The **`send()`** method of the MIDIOutput interface queues messages for the corresponding MIDI port.
198
+ *
199
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send)
200
+ */
183
201
  send(data: Iterable<number>, timestamp?: DOMHighResTimeStamp): void;
184
202
  }
185
203
 
@@ -216,12 +234,17 @@ interface NamedNodeMap {
216
234
 
217
235
  interface Navigator {
218
236
  /**
237
+ * 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
238
  * Available only in secure contexts.
220
239
  *
221
240
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/requestMediaKeySystemAccess)
222
241
  */
223
242
  requestMediaKeySystemAccess(keySystem: string, supportedConfigurations: Iterable<MediaKeySystemConfiguration>): Promise<MediaKeySystemAccess>;
224
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate) */
243
+ /**
244
+ * The **`vibrate()`** method of the Navigator interface pulses the vibration hardware on the device, if such hardware exists.
245
+ *
246
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate)
247
+ */
225
248
  vibrate(pattern: Iterable<number>): boolean;
226
249
  }
227
250
 
@@ -254,7 +277,11 @@ interface PluginArray {
254
277
  }
255
278
 
256
279
  interface RTCRtpTransceiver {
257
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences) */
280
+ /**
281
+ * 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.
282
+ *
283
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences)
284
+ */
258
285
  setCodecPreferences(codecs: Iterable<RTCRtpCodec>): void;
259
286
  }
260
287
 
@@ -309,17 +336,33 @@ interface StyleSheetList {
309
336
  }
310
337
 
311
338
  interface SubtleCrypto {
312
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey) */
339
+ /**
340
+ * The **`deriveKey()`** method of the SubtleCrypto interface can be used to derive a secret key from a master key.
341
+ *
342
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey)
343
+ */
313
344
  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) */
345
+ /**
346
+ * The **`generateKey()`** method of the SubtleCrypto interface is used to generate a new key (for symmetric algorithms) or key pair (for public-key algorithms).
347
+ *
348
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey)
349
+ */
315
350
  generateKey(algorithm: "Ed25519" | { name: "Ed25519" }, extractable: boolean, keyUsages: ReadonlyArray<"sign" | "verify">): Promise<CryptoKeyPair>;
316
351
  generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKeyPair>;
317
352
  generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
318
353
  generateKey(algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKeyPair | CryptoKey>;
319
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey) */
354
+ /**
355
+ * 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.
356
+ *
357
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey)
358
+ */
320
359
  importKey(format: "jwk", keyData: JsonWebKey, algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
321
360
  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) */
361
+ /**
362
+ * The **`unwrapKey()`** method of the SubtleCrypto interface 'unwraps' a key.
363
+ *
364
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey)
365
+ */
323
366
  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
367
  }
325
368
 
@@ -353,18 +396,38 @@ interface ViewTransitionTypeSet extends Set<string> {
353
396
  }
354
397
 
355
398
  interface WEBGL_draw_buffers {
356
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL) */
399
+ /**
400
+ * 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.
401
+ *
402
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL)
403
+ */
357
404
  drawBuffersWEBGL(buffers: Iterable<GLenum>): void;
358
405
  }
359
406
 
360
407
  interface WEBGL_multi_draw {
361
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL) */
408
+ /**
409
+ * The **`WEBGL_multi_draw.multiDrawArraysInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
410
+ *
411
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL)
412
+ */
362
413
  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) */
414
+ /**
415
+ * The **`WEBGL_multi_draw.multiDrawArraysWEBGL()`** method of the WebGL API renders multiple primitives from array data.
416
+ *
417
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL)
418
+ */
364
419
  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) */
420
+ /**
421
+ * The **`WEBGL_multi_draw.multiDrawElementsInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
422
+ *
423
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL)
424
+ */
366
425
  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) */
426
+ /**
427
+ * The **`WEBGL_multi_draw.multiDrawElementsWEBGL()`** method of the WebGL API renders multiple primitives from array data.
428
+ *
429
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL)
430
+ */
368
431
  multiDrawElementsWEBGL(mode: GLenum, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, type: GLenum, offsetsList: Int32Array | Iterable<GLsizei>, offsetsOffset: number, drawcount: GLsizei): void;
369
432
  }
370
433