Package-level declarations

Types

Link copied to clipboard

Manages abort control through a tandem AbortSignal; typically used to control abortion of pending or in-flight async operations.

Link copied to clipboard

Abort signals are used to trigger an abort of an operation; from MDN:

Link copied to clipboard
interface Blob

TBD.

Link copied to clipboard
interface Crypto : RandomSource

Main interface providing the Web Crypto API to guest JavaScript VMs. The Web Crypto API is primarily substantiated by this interface, in addition to SubtleCrypto, which focuses on cryptographic primitives which operate in constants time.

Link copied to clipboard
interface CryptoKey

The CryptoKey interface of the Web Crypto API represents a cryptographic key obtained, wrapped, or generated, using the SubtleCrypto facilities.

Link copied to clipboard
Link copied to clipboard
interface FetchAPI

TBD.

Link copied to clipboard

Describes the interface for a Fetch API compliant structure containing HTTP headers; this includes both the header names (as keys), and the header values, including multiple values per header, as applicable. Effectively, the fetch headers object acts as a container (as a JsMultiMap, specifically of all strings).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface FetchRequest

Specifies the interface defined by the Fetch API Specification, "Request," which represents an HTTP request created or received by the JavaScript runtime. Fetch requests model regular HTTP concepts such as the HTTP method, path, and parameters, augmenting with structure from classes like FetchHeaders and URLSearchParams.

Link copied to clipboard
interface FetchResponse

Describes the structure of an HTTP response provided via the Fetch sub-system, which implements the WhatWG Fetch API Standard, in both browser JavaScript engines and server-side JavaScript engines. The Fetch system and specification are designed to make HTTP data fetches easy in JavaScript environments, and stand as a modern replacement for the famous XMLHttpRequest API in browsers, and the http/https layers in NodeJS.

Link copied to clipboard
interface File

TBD.

Link copied to clipboard

TBD.

Link copied to clipboard

Defines a native intrinsic for use as a JavaScript console implementation; pipes to the central Elide logging system, with each corresponding log level. See method documentation for more info.

Link copied to clipboard
Link copied to clipboard
interface JsIterator<T> : Iterator<JsIterator.JsIteratorResult<T>> , ProxyIterator, ProxyIterable

Implements a standards-compliant JavaScript iterator, which either provides streamed values as it is polled, or fails upon value access if an error is encountered.

Link copied to clipboard
interface JsPromise<T> : ListenableFuture<T> , ProxyObject

TBD.

Link copied to clipboard
interface JsSymbol
Link copied to clipboard
interface MapLike<K : Any, V> : Map<K, V>

TBD.

Link copied to clipboard
interface MultiMapLike<K : Any, V> : MapLike<K, V>

TBD.

Link copied to clipboard
interface MutableMapLike<K : Any, V> : MapLike<K, V> , MutableMap<K, V>

TBD.

Link copied to clipboard

TBD.

Link copied to clipboard
interface MutableURL : URL

The URL class is universally supported across JavaScript engines and browser implementations, and behaves similarly in each case; it is used for parsing well-formed URLs and extracting their constituent parts. This interface extends the built-in URL intrinsic interface with mutable properties, where supported by spec.

Link copied to clipboard

The URLSearchParams interface and class is universally supported across most JavaScript and browser environments, and models query (GET-method) parameters expressed within a URL.

Link copied to clipboard
interface RandomSource

Base interface type which provides access to basic random data generation utilities; random bytes can be filled into a guest JS array (usually typed), and random UUIDs can be generated.

Link copied to clipboard

Models the ReadableStream interface, defined by the WhatWG Streams Standard (https://streams.spec.whatwg.org/). Readable streams implement streams of arbitrary data which can be consumed by an interested developer, and form part of the wider Web Streams API.

Link copied to clipboard
interface ServerAgent

Represents an abstract intrinsic which can be used to implement a server agent. This is a special type of intrinsic which is recognized by the Elide CLI/runtime as a server; behavior is triggered which prevents an immediate exit after executing user code.

Link copied to clipboard
Link copied to clipboard
interface SubtleCrypto
Link copied to clipboard
typealias TimerId = Long

ID type for timers.

Link copied to clipboard
interface Timers

Implements intrinsic JavaScript timers, at the familiar symbols setTimeout and setInterval; each method starts a timer task which is dispatched after a specified delay. Interval timers repeat their execution until canceled, while regular one-shot timers execute only once.

Link copied to clipboard
interface URL : Serializable, ProxyObject

The URL class is universally supported across JavaScript engines and browser implementations, and behaves similarly in each case; it is used for parsing well-formed URLs and extracting their constituent parts.

Link copied to clipboard
interface URLSearchParams : Serializable, MultiMapLike<String, String> , ProxyHashMap, ProxyObject

The URLSearchParams interface and class is universally supported across most JavaScript and browser environments, and models query (GET-method) parameters expressed within a URL.

Functions

Link copied to clipboard
inline fun <T> JsPromise<T>.deferred(): Deferred<T>