@types/web 0.0.236 → 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
 
@@ -145,7 +161,7 @@ interface HighlightRegistry extends Map<string, Highlight> {
145
161
 
146
162
  interface IDBDatabase {
147
163
  /**
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.
164
+ * 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
165
  *
150
166
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBDatabase/transaction)
151
167
  */
@@ -154,9 +170,7 @@ interface IDBDatabase {
154
170
 
155
171
  interface IDBObjectStore {
156
172
  /**
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.
173
+ * The **`createIndex()`** method of the field/column defining a new data point for each database record to contain.
160
174
  *
161
175
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/createIndex)
162
176
  */
@@ -171,7 +185,11 @@ interface MIDIInputMap extends ReadonlyMap<string, MIDIInput> {
171
185
  }
172
186
 
173
187
  interface MIDIOutput {
174
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send) */
188
+ /**
189
+ * The **`send()`** method of the MIDIOutput interface queues messages for the corresponding MIDI port.
190
+ *
191
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MIDIOutput/send)
192
+ */
175
193
  send(data: Iterable<number>, timestamp?: DOMHighResTimeStamp): void;
176
194
  }
177
195
 
@@ -204,12 +222,17 @@ interface NamedNodeMap {
204
222
 
205
223
  interface Navigator {
206
224
  /**
225
+ * 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
226
  * Available only in secure contexts.
208
227
  *
209
228
  * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/requestMediaKeySystemAccess)
210
229
  */
211
230
  requestMediaKeySystemAccess(keySystem: string, supportedConfigurations: Iterable<MediaKeySystemConfiguration>): Promise<MediaKeySystemAccess>;
212
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate) */
231
+ /**
232
+ * The **`vibrate()`** method of the Navigator interface pulses the vibration hardware on the device, if such hardware exists.
233
+ *
234
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Navigator/vibrate)
235
+ */
213
236
  vibrate(pattern: Iterable<number>): boolean;
214
237
  }
215
238
 
@@ -242,7 +265,11 @@ interface PluginArray {
242
265
  }
243
266
 
244
267
  interface RTCRtpTransceiver {
245
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences) */
268
+ /**
269
+ * 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.
270
+ *
271
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/RTCRtpTransceiver/setCodecPreferences)
272
+ */
246
273
  setCodecPreferences(codecs: Iterable<RTCRtpCodec>): void;
247
274
  }
248
275
 
@@ -293,17 +320,33 @@ interface StyleSheetList {
293
320
  }
294
321
 
295
322
  interface SubtleCrypto {
296
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey) */
323
+ /**
324
+ * The **`deriveKey()`** method of the SubtleCrypto interface can be used to derive a secret key from a master key.
325
+ *
326
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/deriveKey)
327
+ */
297
328
  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) */
329
+ /**
330
+ * The **`generateKey()`** method of the SubtleCrypto interface is used to generate a new key (for symmetric algorithms) or key pair (for public-key algorithms).
331
+ *
332
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/generateKey)
333
+ */
299
334
  generateKey(algorithm: "Ed25519" | { name: "Ed25519" }, extractable: boolean, keyUsages: ReadonlyArray<"sign" | "verify">): Promise<CryptoKeyPair>;
300
335
  generateKey(algorithm: RsaHashedKeyGenParams | EcKeyGenParams, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKeyPair>;
301
336
  generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
302
337
  generateKey(algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKeyPair | CryptoKey>;
303
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey) */
338
+ /**
339
+ * 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.
340
+ *
341
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/importKey)
342
+ */
304
343
  importKey(format: "jwk", keyData: JsonWebKey, algorithm: AlgorithmIdentifier | RsaHashedImportParams | EcKeyImportParams | HmacImportParams | AesKeyAlgorithm, extractable: boolean, keyUsages: ReadonlyArray<KeyUsage>): Promise<CryptoKey>;
305
344
  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) */
345
+ /**
346
+ * The **`unwrapKey()`** method of the SubtleCrypto interface 'unwraps' a key.
347
+ *
348
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SubtleCrypto/unwrapKey)
349
+ */
307
350
  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
351
  }
309
352
 
@@ -333,18 +376,38 @@ interface ViewTransitionTypeSet extends Set<string> {
333
376
  }
334
377
 
335
378
  interface WEBGL_draw_buffers {
336
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL) */
379
+ /**
380
+ * 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.
381
+ *
382
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_draw_buffers/drawBuffersWEBGL)
383
+ */
337
384
  drawBuffersWEBGL(buffers: Iterable<GLenum>): void;
338
385
  }
339
386
 
340
387
  interface WEBGL_multi_draw {
341
- /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL) */
388
+ /**
389
+ * The **`WEBGL_multi_draw.multiDrawArraysInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
390
+ *
391
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysInstancedWEBGL)
392
+ */
342
393
  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) */
394
+ /**
395
+ * The **`WEBGL_multi_draw.multiDrawArraysWEBGL()`** method of the WebGL API renders multiple primitives from array data.
396
+ *
397
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawArraysWEBGL)
398
+ */
344
399
  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) */
400
+ /**
401
+ * The **`WEBGL_multi_draw.multiDrawElementsInstancedWEBGL()`** method of the WebGL API renders multiple primitives from array data.
402
+ *
403
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsInstancedWEBGL)
404
+ */
346
405
  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) */
406
+ /**
407
+ * The **`WEBGL_multi_draw.multiDrawElementsWEBGL()`** method of the WebGL API renders multiple primitives from array data.
408
+ *
409
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WEBGL_multi_draw/multiDrawElementsWEBGL)
410
+ */
348
411
  multiDrawElementsWEBGL(mode: GLenum, countsList: Int32Array | Iterable<GLsizei>, countsOffset: number, type: GLenum, offsetsList: Int32Array | Iterable<GLsizei>, offsetsOffset: number, drawcount: GLsizei): void;
349
412
  }
350
413