Skip to content

Exports

[<Class>]
type Exports =
    static member AbortController: AbortControllerConstructor with get, set
    static member AbortSignal: AbortSignalConstructor with get, set
    static member Blob: BlobConstructor with get, set
    static member BroadcastChannel: BroadcastChannelConstructor with get, set
    static member Buffer: BufferConstructor with get, set
    static member ByteLengthQueuingStrategy: ByteLengthQueuingStrategyConstructor with get, set
    static member CompressionStream: CompressionStreamConstructor with get, set
    static member CountQueuingStrategy: CountQueuingStrategyConstructor with get, set
    static member CustomEvent: CustomEventConstructor with get, set
    static member DOMException: DOMExceptionConstructor with get, set
    static member DecompressionStream: DecompressionStreamConstructor with get, set
    static member Event: EventConstructor with get, set
    static member EventSource: EventSourceConstructor with get, set
    static member EventTarget: EventTargetConstructor with get, set
    static member File: FileConstructor with get, set
    static member FormData: obj with get, set
    static member Headers: obj with get, set
    static member MessageChannel: MessageChannelConstructor with get, set
    static member MessageEvent: MessageEventConstructor with get, set
    static member MessagePort: MessagePortConstructor with get, set
    static member Navigator: NavigatorConstructor with get, set
    static member PerformanceEntry: PerformanceEntryConstructor with get, set
    static member PerformanceMark: PerformanceMarkConstructor with get, set
    static member PerformanceMeasure: PerformanceMeasureConstructor with get, set
    static member PerformanceObserver: PerformanceObserverConstructor with get, set
    static member PerformanceObserverEntryList: PerformanceObserverEntryListConstructor with get, set
    static member PerformanceResourceTiming: PerformanceResourceTimingConstructor with get, set
    static member ReadableByteStreamController: ReadableByteStreamControllerConstructor with get, set
    static member ReadableStream: ReadableStreamConstructor with get, set
    static member ReadableStreamBYOBReader: ReadableStreamBYOBReaderConstructor with get, set
    static member ReadableStreamBYOBRequest: ReadableStreamBYOBRequestConstructor with get, set
    static member ReadableStreamDefaultController: ReadableStreamDefaultControllerConstructor with get, set
    static member ReadableStreamDefaultReader: ReadableStreamDefaultReaderConstructor with get, set
    static member Request: obj with get, set
    static member Response: obj with get, set
    static member Storage: StorageConstructor with get, set
    static member TextDecoder: TextDecoderConstructor with get, set
    static member TextDecoderStream: TextDecoderStreamConstructor with get, set
    static member TextEncoder: TextEncoderConstructor with get, set
    static member TextEncoderStream: TextEncoderStreamConstructor with get, set
    static member TransformStream: TransformStreamConstructor with get, set
    static member TransformStreamDefaultController: TransformStreamDefaultControllerConstructor with get, set
    static member URL: URLConstructor with get, set
    static member URLSearchParams: URLSearchParamsConstructor with get, set
    static member WebSocket: WebSocketConstructor with get, set
    static member WritableStream: WritableStreamConstructor with get, set
    static member WritableStreamDefaultController: WritableStreamDefaultControllerConstructor with get, set
    static member WritableStreamDefaultWriter: WritableStreamDefaultWriterConstructor with get, set
    static member ___dirname: string with get, set
    static member ___filename: string with get, set
    static member console: Console with get, set
    static member crypto: Crypto with get, set
    static member exports: obj with get, set
    static member gc: GCFunction option with get, set
    static member global: obj with get, set
    static member localStorage: Storage with get, set
    static member module: Module with get, set
    static member navigator: Navigator with get, set
    static member performance: Performance with get, set
    static member process: Process with get, set
    static member require: Require with get, set
    static member sessionStorage: Storage with get, set
    static member setImmediate: SetImmediate
    static member setTimeout: SetTimeout
    static member atob (data: string) : string
    static member btoa (data: string) : string
    static member clearImmediate (?immediate: Immediate) : unit
    static member clearInterval (?timeout: U3<string,float,Timeout>) : unit
    static member clearTimeout (?timeout: U3<string,float,Timeout>) : unit
    static member fetch (input: U3<string,Request,URL>, ?init: RequestInit) : Promise<Response>
    static member queueMicrotask (callback: unit -> unit) : unit
    static member setInterval (callback: unit -> unit, ?delay: float) : Timeout
    static member setInterval<'TArgs> (callback: 'TArgs -> unit, delay: float option, args: 'TArgs) : Timeout
    static member structuredClone<'T> (value: 'T, ?options: Options) : 'T
AssemblyXantham.Fable.Node
Attributes[<Erase>] [<Global>]

The package's value exports, each bound to its import.

Properties

static member AbortController: AbortControllerConstructor with get, set
static member AbortSignal: AbortSignalConstructor with get, set
static member Blob: BlobConstructor with get, set

Blob class is a global reference for import { Blob } from 'node:buffer' https://nodejs.org/api/buffer.html#class-blob

@since v18.0.0

static member BroadcastChannel: BroadcastChannelConstructor with get, set

BroadcastChannel class is a global reference for import { BroadcastChannel } from 'worker_threads' https://nodejs.org/api/globals.html#broadcastchannel

@since v18.0.0

static member Buffer: BufferConstructor with get, set
static member ByteLengthQueuingStrategy: ByteLengthQueuingStrategyConstructor with get, set

ByteLengthQueuingStrategy class is a global reference for import { ByteLengthQueuingStrategy } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-bytelengthqueuingstrategy

@since v18.0.0

static member CompressionStream: CompressionStreamConstructor with get, set
static member CountQueuingStrategy: CountQueuingStrategyConstructor with get, set

CountQueuingStrategy class is a global reference for import { CountQueuingStrategy } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-countqueuingstrategy

@since v18.0.0

static member CustomEvent: CustomEventConstructor with get, set
static member DOMException: DOMExceptionConstructor with get, set
static member DecompressionStream: DecompressionStreamConstructor with get, set
static member Event: EventConstructor with get, set
static member EventSource: EventSourceConstructor with get, set
static member EventTarget: EventTargetConstructor with get, set
static member File: FileConstructor with get, set

File class is a global reference for import { File } from 'node:buffer' https://nodejs.org/api/buffer.html#class-file

@since v20.0.0

static member FormData: obj with get, set
static member Headers: obj with get, set
static member MessageChannel: MessageChannelConstructor with get, set

MessageChannel class is a global reference for import { MessageChannel } from 'worker_threads' https://nodejs.org/api/globals.html#messagechannel

@since v15.0.0

static member MessageEvent: MessageEventConstructor with get, set
static member MessagePort: MessagePortConstructor with get, set

MessagePort class is a global reference for import { MessagePort } from 'worker_threads' https://nodejs.org/api/globals.html#messageport

@since v15.0.0

static member Navigator: NavigatorConstructor with get, set
static member PerformanceEntry: PerformanceEntryConstructor with get, set

PerformanceEntry is a global reference for import { PerformanceEntry } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performanceentry

static member PerformanceMark: PerformanceMarkConstructor with get, set

PerformanceMark is a global reference for import { PerformanceMark } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performancemark

static member PerformanceMeasure: PerformanceMeasureConstructor with get, set

PerformanceMeasure is a global reference for import { PerformanceMeasure } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performancemeasure

static member PerformanceObserver: PerformanceObserverConstructor with get, set

PerformanceObserver is a global reference for import { PerformanceObserver } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performanceobserver

static member PerformanceObserverEntryList: PerformanceObserverEntryListConstructor with get, set

PerformanceObserverEntryList is a global reference for import { PerformanceObserverEntryList } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performanceobserverentrylist

static member PerformanceResourceTiming: PerformanceResourceTimingConstructor with get, set

PerformanceResourceTiming is a global reference for import { PerformanceResourceTiming } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performanceresourcetiming

static member ReadableByteStreamController: ReadableByteStreamControllerConstructor with get, set

ReadableByteStreamController class is a global reference for import { ReadableByteStreamController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablebytestreamcontroller

@since v18.0.0

static member ReadableStream: ReadableStreamConstructor with get, set

ReadableStream class is a global reference for import { ReadableStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestream

@since v18.0.0

static member ReadableStreamBYOBReader: ReadableStreamBYOBReaderConstructor with get, set

ReadableStreamBYOBReader class is a global reference for import { ReadableStreamBYOBReader } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreambyobreader

@since v18.0.0

static member ReadableStreamBYOBRequest: ReadableStreamBYOBRequestConstructor with get, set

ReadableStreamBYOBRequest class is a global reference for import { ReadableStreamBYOBRequest } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreambyobrequest

@since v18.0.0

static member ReadableStreamDefaultController: ReadableStreamDefaultControllerConstructor with get, set

ReadableStreamDefaultController class is a global reference for import { ReadableStreamDefaultController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreamdefaultcontroller

@since v18.0.0

static member ReadableStreamDefaultReader: ReadableStreamDefaultReaderConstructor with get, set

ReadableStreamDefaultReader class is a global reference for import { ReadableStreamDefaultReader } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreamdefaultreader

@since v18.0.0

static member Request: obj with get, set
static member Response: obj with get, set
static member Storage: StorageConstructor with get, set
static member TextDecoder: TextDecoderConstructor with get, set

TextDecoder class is a global reference for import { TextDecoder } from 'node:util' https://nodejs.org/api/globals.html#textdecoder

@since v11.0.0

static member TextDecoderStream: TextDecoderStreamConstructor with get, set

TextDecoderStream class is a global reference for import { TextDecoderStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-textdecoderstream

@since v18.0.0

static member TextEncoder: TextEncoderConstructor with get, set

TextEncoder class is a global reference for import { TextEncoder } from 'node:util' https://nodejs.org/api/globals.html#textencoder

@since v11.0.0

static member TextEncoderStream: TextEncoderStreamConstructor with get, set

TextEncoderStream class is a global reference for import { TextEncoderStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-textencoderstream

@since v18.0.0

static member TransformStream: TransformStreamConstructor with get, set

TransformStream class is a global reference for import { TransformStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-transformstream

@since v18.0.0

static member TransformStreamDefaultController: TransformStreamDefaultControllerConstructor with get, set

TransformStreamDefaultController class is a global reference for import { TransformStreamDefaultController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-transformstreamdefaultcontroller

@since v18.0.0

static member URL: URLConstructor with get, set

URL class is a global reference for import { URL } from 'url' https://nodejs.org/api/url.html#the-whatwg-url-api

@since v10.0.0

static member URLSearchParams: URLSearchParamsConstructor with get, set

URLSearchParams class is a global reference for import { URLSearchParams } from 'node:url' https://nodejs.org/api/url.html#class-urlsearchparams

@since v10.0.0

static member WebSocket: WebSocketConstructor with get, set
static member WritableStream: WritableStreamConstructor with get, set

WritableStream class is a global reference for import { WritableStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-writablestream

@since v18.0.0

static member WritableStreamDefaultController: WritableStreamDefaultControllerConstructor with get, set

WritableStreamDefaultController class is a global reference for import { WritableStreamDefaultController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-writablestreamdefaultcontroller

@since v18.0.0

static member WritableStreamDefaultWriter: WritableStreamDefaultWriterConstructor with get, set

WritableStreamDefaultWriter class is a global reference for import { WritableStreamDefaultWriter } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-writablestreamdefaultwriter

@since v18.0.0

static member ___dirname: string with get, set

The directory name of the current module. This is the same as the path.dirname() of the __filename.

@since v0.1.27

static member ___filename: string with get, set

The file name of the current module. This is the current module file's absolute path with symlinks resolved.

For a main program this is not necessarily the same as the file name used in the command line.

@since v0.0.1

static member console: Console with get, set

The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.

The module exports two specific components:

  • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
  • A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.

Example using the global console:

console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
//   Error: Whoops, something bad happened
//     at [eval]:5:15
//     at Script.runInThisContext (node:vm:132:18)
//     at Object.runInThisContext (node:vm:309:38)
//     at node:internal/process/execution:77:19
//     at [eval]-wrapper:6:22
//     at evalScript (node:internal/process/execution:76:60)
//     at node:internal/main/eval_string:23:3

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr

Example using the Console class:

const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err

@see source

static member crypto: Crypto with get, set
static member exports: obj with get, set

The exports variable is available within a module's file-level scope, and is assigned the value of module.exports before the module is evaluated.

@since v0.1.16

static member gc: GCFunction option with get, set

Enable this API with the --expose-gc CLI flag.

static member global: obj with get, set
static member localStorage: Storage with get, set
static member module: Module with get, set

A reference to the current module.

@since v0.1.16

static member navigator: Navigator with get, set
static member performance: Performance with get, set

performance is a global reference for import { performance } from 'node:perf_hooks'

@see https://nodejs.org/docs/latest-v22.x/api/globals.html#performance

static member process: Process with get, set
static member require: Require with get, set

@since v0.1.13

static member sessionStorage: Storage with get, set
static member setImmediate: SetImmediate

Schedules the "immediate" execution of the callback after I/O events' callbacks.

When multiple calls to setImmediate() are made, the callback functions are queued for execution in the order in which they are created. The entire callback queue is processed every event loop iteration. If an immediate timer is queued from inside an executing callback, that timer will not be triggered until the next event loop iteration.

If callback is not a function, a TypeError will be thrown.

This method has a custom variant for promises that is available using timersPromises.setImmediate().

@since v0.9.1

Parameter
callbackThe function to call at the end of this turn of the Node.js Event Loop
argsOptional arguments to pass when the callback is called.

Returns. for use with clearImmediate()

static member setTimeout: SetTimeout

Schedules execution of a one-time callback after delay milliseconds.

The callback will likely not be invoked in precisely delay milliseconds. Node.js makes no guarantees about the exact timing of when callbacks will fire, nor of their ordering. The callback will be called as close as possible to the time specified.

When delay is larger than 2147483647 or less than 1 or NaN, the delay will be set to 1. Non-integer delays are truncated to an integer.

If callback is not a function, a TypeError will be thrown.

This method has a custom variant for promises that is available using timersPromises.setTimeout().

@since v0.0.1

Parameter
callbackThe function to call when the timer elapses.
delayThe number of milliseconds to wait before calling the callback. Default:1.
argsOptional arguments to pass when the callback is called.

Returns. for use with clearTimeout()

Methods

static member atob (data: string) : string

Decodes a string of Base64-encoded data into bytes, and encodes those bytes into a string using Latin-1 (ISO-8859-1).

The data may be any JavaScript-value that can be coerced into a string.

This function is only provided for compatibility with legacy web platform APIsand should never be used in new code, because they use strings to representbinary data and predate the introduction of typed arrays in JavaScript.For code running using Node.js APIs, converting between base64-encoded stringsand binary data should be performed using Buffer.from(str, 'base64') and buf.toString('base64').

@since v15.13.0, v14.17.0

Parameter
dataThe Base64-encoded input string.
static member btoa (data: string) : string

Decodes a string into bytes using Latin-1 (ISO-8859), and encodes those bytes into a string using Base64.

The data may be any JavaScript-value that can be coerced into a string.

This function is only provided for compatibility with legacy web platform APIsand should never be used in new code, because they use strings to representbinary data and predate the introduction of typed arrays in JavaScript.For code running using Node.js APIs, converting between base64-encoded stringsand binary data should be performed using Buffer.from(str, 'base64') and buf.toString('base64').

@since v15.13.0, v14.17.0

Parameter
dataAn ASCII (Latin1) string.
static member clearImmediate (?immediate: Immediate) : unit

Cancels an Immediate object created by setImmediate().

@since v0.9.1

Parameter
immediateAn Immediate object as returned by setImmediate().
static member clearInterval (?timeout: U3<string,float,Timeout>) : unit

Cancels a Timeout object created by setInterval().

@since v0.0.1

Parameter
timeoutA Timeout object as returned by setInterval() or the primitive of the Timeout object as a string or a number.
static member clearTimeout (?timeout: U3<string,float,Timeout>) : unit

Cancels a Timeout object created by setTimeout().

@since v0.0.1

Parameter
timeoutA Timeout object as returned by setTimeout() or the primitive of the Timeout object as a string or a number.
static member fetch (input: U3<string,Request,URL>, ?init: RequestInit) : Promise<Response>
static member queueMicrotask (callback: unit -> unit) : unit

The queueMicrotask() method queues a microtask to invoke callback. If callback throws an exception, the process object 'uncaughtException' event will be emitted.

The microtask queue is managed by V8 and may be used in a similar manner to the process.nextTick() queue, which is managed by Node.js. The process.nextTick() queue is always processed before the microtask queue within each turn of the Node.js event loop.

@since v11.0.0

Parameter
callbackFunction to be queued.
static member setInterval (callback: unit -> unit, ?delay: float) : Timeout

Schedules repeated execution of callback every delay milliseconds.

When delay is larger than 2147483647 or less than 1 or NaN, the delay will be set to 1. Non-integer delays are truncated to an integer.

If callback is not a function, a TypeError will be thrown.

This method has a custom variant for promises that is available using timersPromises.setInterval().

@since v0.0.1

Parameter
callbackThe function to call when the timer elapses.
delayThe number of milliseconds to wait before calling the callback. Default:1.
argsOptional arguments to pass when the callback is called.

Returns. for use with clearInterval()

static member setInterval<'TArgs> (callback: 'TArgs -> unit, delay: float option, args: 'TArgs) : Timeout

Schedules repeated execution of callback every delay milliseconds.

When delay is larger than 2147483647 or less than 1 or NaN, the delay will be set to 1. Non-integer delays are truncated to an integer.

If callback is not a function, a TypeError will be thrown.

This method has a custom variant for promises that is available using timersPromises.setInterval().

@since v0.0.1

Parameter
callbackThe function to call when the timer elapses.
delayThe number of milliseconds to wait before calling the callback. Default:1.
argsOptional arguments to pass when the callback is called.

Returns. for use with clearInterval()

static member structuredClone<'T> (value: 'T, ?options: Options) : 'T