Web APIs reference
Web APIs
Every web platform API implemented by Deno, by category. Use your browser's find-in-page to locate a symbol, then click through for full documentation.
Cache
- CacheIv
Represents a single named store of
Request/Responsepairs. Obtain aCacheviaCacheStorage.openand use it to persist responses and later match incoming requests against them. - CacheQueryOptionsI
- CacheStorageIv
- MultiCacheQueryOptionsI
- cachesv
The global
CacheStorageinstance, providing access to the namedCacheobjects used to store and retrieveRequest/Responsepairs.
Canvas
- createImageBitmapf
Create a new
ImageBitmapobject from a given source. - GPUCanvasConfigurationI
- GPUCanvasContextIv
The rendering context that presents WebGPU-rendered images on an
OffscreenCanvas. Obtained fromOffscreenCanvas.getContextwith the"webgpu"context id. - ImageBitmapIv
ImageBitmapinterface represents a bitmap image which can be drawn to a canvas. - ImageBitmapOptionsI
The options of
createImageBitmap. - ImageBitmapRenderingContextIv
A rendering context that displays the contents of an
ImageBitmapon anOffscreenCanvas. Obtained fromOffscreenCanvas.getContextwith the"bitmaprenderer"context id. - ImageEncodeOptionsI
- OffscreenCanvasIv
A canvas that can be rendered to off the main thread and without being attached to the DOM. It exposes drawing contexts via
OffscreenCanvas.getContextand can produce aBloborImageBitmapfrom its contents. - ColorSpaceConversionT
Specifies whether the image should be decoded using color space conversion. Either none or default (default). The value default indicates that implementation-specific behavior is used.
- GPUCanvasAlphaModeT
- GPUPresentModeT
- ImageBitmapSourceT
The
ImageBitmapSourcetype represents an image data source that can be used to create anImageBitmap. - ImageOrientationT
Specifies how the bitmap image should be oriented.
- OffscreenRenderingContextT
- OffscreenRenderingContextIdT
- PremultiplyAlphaT
Specifies whether the bitmap's color channels should be premultiplied by the alpha channel.
- ResizeQualityT
Specifies the algorithm to be used for resizing the input to match the output dimensions. One of
pixelated,low(default),medium, orhigh.
Crypto
- AesCbcParamsI
- AesCtrParamsI
- AesDerivedKeyParamsI
- AesGcmParamsI
- AesKeyAlgorithmI
- AesKeyGenParamsI
- AlgorithmI
- CryptoIv
This Web Crypto API interface provides basic cryptographic functionality. It is accessed via the global
cryptoproperty, which gives access to cryptographically strong random number generation and to the low-level primitives exposed bySubtleCryptothroughCrypto.subtle. - CryptoKeyIv
The CryptoKey dictionary of the Web Crypto API represents a cryptographic key.
- CryptoKeyPairIv
The CryptoKeyPair dictionary of the Web Crypto API represents a key pair for an asymmetric cryptography algorithm, also known as a public-key algorithm.
- EcdhKeyDeriveParamsI
- EcdsaParamsI
- EcKeyAlgorithmI
- EcKeyGenParamsI
- EcKeyImportParamsI
- HkdfParamsI
- HmacImportParamsI
- HmacKeyAlgorithmI
- HmacKeyGenParamsI
- JsonWebKeyI
- KeyAlgorithmI
- Pbkdf2ParamsI
- RsaHashedImportParamsI
- RsaHashedKeyAlgorithmI
- RsaHashedKeyGenParamsI
- RsaKeyAlgorithmI
- RsaKeyGenParamsI
- RsaOaepParamsI
- RsaOtherPrimesInfoI
- RsaPssParamsI
- SubtleCryptoIv
This Web Crypto API interface provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via globalThis.crypto).
- AlgorithmIdentifierT
- BigIntegerT
- HashAlgorithmIdentifierT
- KeyFormatT
- KeyTypeT
- KeyUsageT
- NamedCurveT
- cryptov
The global instance of
Cryptothat provides access to the Web Crypto API, including cryptographically secure random number generation viaCrypto.getRandomValues, random UUID generation viaCrypto.randomUUID, and the low-level primitives exposed bySubtleCryptothroughCrypto.subtle.
Encoding
- atobf
Decodes a string of data which has been encoded using base-64 encoding.
- btoaf
Creates a base-64 ASCII encoded string from the input string.
- TextDecodeOptionsI
- TextDecoderIv
Represents a decoder for a specific text encoding, allowing you to convert binary data into a string given the encoding.
- TextDecoderCommonI
- TextDecoderOptionsI
- TextDecoderStreamIv
- TextEncoderIv
Allows you to convert a string into binary data (in the form of a Uint8Array) given the encoding.
- TextEncoderCommonI
- TextEncoderEncodeIntoResultI
- TextEncoderStreamIv
Events
- addEventListenerf
Registers an event listener in the global scope, which will be called synchronously whenever the event
typeis dispatched. - dispatchEventf
Dispatches an event in the global scope, synchronously invoking any registered event listeners for this event in the appropriate order. Returns false if event is cancelable and at least one of the event handlers which handled this event called Event.preventDefault(). Otherwise it returns true.
- removeEventListenerf
Remove a previously registered event listener from the global scope
- AddEventListenerOptionsI
Options for configuring an event listener via
addEventListener. - CustomEventIv
- CustomEventInitI
- ErrorEventIv
- ErrorEventInitI
- EventIv
An event which takes place in the DOM.
- EventInitI
- EventListenerI
- EventListenerObjectI
The
EventListenerObjectinterface represents an object that can handle events dispatched by anEventTargetobject. - EventListenerOptionsI
- EventTargetIv
EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.
- MessageEventIv
- MessageEventInitI
- ProgressEventIv
Events measuring progress of an underlying process, like an HTTP request (for an XMLHttpRequest, or the loading of the underlying resource of an
,