Supported Methods

Node

MethodDescriptionDocs

child_process.exec

Spawn a shell and execute an arbitrary command

child_process.execFile

Spawn a shell and execute an arbitrary file

child_process.fork

Fork a child process

child_process.spawn

Spawn a new process

child_process.execFileSync

Spawn a shell and execute an arbitrary file

child_process.execSync

Spawn a shell and execute an arbitrary command

child_process.spawnSync

Spawn a new process

cluster.disconnect

Disconnect a worker from its parent process

cluster.fork

Fork a new worker process

cluster.setupPrimary

Change the default fork behavior of cluster.fork

cluster.setupMaster

Change the default fork behavior of cluster.fork

dgram.createSocket

Create a datagram socket

dns.Resolver

Create a DNS resolver

dns.getServers

Get the list of current DNS servers

dns.lookup

Resolve a host name into the first found A or AAAA record

dns.lookupService

Resolve the given address and port into a host name and service

dns.resolve

Resolve a host name into an array of records

dns.resolve4

Resolve a host name to an IPv4 address

dns.resolve6

Resolve a host name to an IPv6 address

dns.resolveAny

Resolve a host name to an array of records

dns.resolveCname

Resolve a host name to an array of CNAME records

dns.resolveCaa

Resolve a host name to an array of CAA records

dns.resolveMx

Resolve a host name to an array of MX records

dns.resolveNaptr

Resolve a host name to an array of NAPTR records

dns.resolveNs

Resolve a host name to an array of NS records

dns.resolvePtr

Resolve a host name to an array of PTR records

dns.resolveSoa

Resolve a host name to an SOA record

dns.resolveSrv

Resolve a host name to an array of SRV records

dns.resolveTxt

Resolve a host name to an array of TXT records

dns.reverse

Perform a reverse lookup for the given address

dns.setDefaultResultOrder

Set the default order for result records

dns.setServers

Set the list of DNS servers to be used

fetch.fetch

Communicate with a web server

eval.eval

Run arbitrary JS code from a string

Function.Function

Create a new function from an arbitrary string

fs.access

Test a user's permissions for a file or directory

fs.appendFile

Append to a file

fs.chmod

Change file permissions

fs.chown

Change file ownership

fs.close

Close a file descriptor

fs.copyFile

Copy a file

fs.cp

Copy a directory

fs.createReadStream

Create a readable stream

fs.createWriteStream

Create a writable stream

fs.exists

Test whether or not a file exists

fs.fchmod

Change file permissions

fs.fchown

Change file ownership

fs.fdatasync

Force all currently queued I/O operations to completion

fs.fstat

Get file status

fs.fsync

Request data to be flushed to the storage device

fs.ftruncate

Truncate a file to a specified length

fs.futimes

Change file timestamps

fs.lchmod

Change file permissions

fs.lchown

Change file ownership

fs.lutimes

Change file timestamps

fs.link

Create a new link

fs.lstat

Get file status

fs.mkdir

Create a directory

fs.mkdtemp

Create a unique temporary directory

fs.open

Open a file

fs.opendir

Open a directory

fs.read

Read a file

fs.readdir

Read a directory

fs.readFile

Read a file

fs.readlink

Read a symbolic link

fs.readv

Read from a file

fs.realpath

Resolve a canonical path

fs.rename

Rename a file or directory

fs.rmdir

Remove a directory

fs.rm

Remove a file

fs.stat

Get file status

fs.symlink

Create a symbolic link

fs.truncate

Truncate a file to a specified length

fs.unlink

Delete a file

fs.unwatchFile

Stop watching a file for changes

fs.utimes

Change file timestamps

fs.watch

Monitor a file for changes

fs.watchFile

Monitor a file for changes

fs.write

Write to a file

fs.writeFile

Write a file

fs.writev

Write to a file

fs.accessSync

Test a user's permissions for a file or directory

fs.appendFileSync

Append data to a file

fs.chmodSync

Change file permissions

fs.chownSync

Change file owner

fs.closeSync

Close a file

fs.copyFileSync

Copy a file

fs.cpSync

Copy a directory

fs.existsSync

Test whether a file exists

fs.fchmodSync

Change file permissions

fs.fchownSync

Change file owner

fs.fdatasyncSync

Force all currently queued I/O operations to completion

fs.fstatSync

Get file status

fs.fsyncSync

Force all data to be flushed to the storage device

fs.ftruncateSync

Truncate a file to a specified length

fs.futimesSync

Change file timestamps

fs.lchmodSync

Change file permissions

fs.lchownSync

Change file owner

fs.lutimesSync

Change file timestamps

fs.linkSync

Create a hard link

fs.lstatSync

Get file status

fs.mkdirSync

Create a directory

fs.mkdtempSync

Create a temporary directory

fs.openSync

Open a file

fs.opendirSync

Open a directory

fs.readSync

Read a file

fs.readdirSync

Read a directory

fs.readFileSync

Read a file

fs.readlinkSync

Read a symbolic link

fs.readvSync

Read from a file

fs.realpathSync

Return canonical absolute pathname

fs.renameSync

Rename a file or directory

fs.rmdirSync

Remove a directory

fs.rmSync

Remove a file

fs.statSync

Get file status

fs.symlinkSync

Create a symbolic link

fs.truncateSync

Truncate a file to a specified length

fs.unlinkSync

Delete a file

fs.utimesSync

Change file timestamps

fs.writeSync

Write to a file

fs.writeFileSync

Write a file

fs.writevSync

Write to a file

fs/promises.access

Test a user's permissions for a file or directory

fs/promises.appendFile

Append data to a file

fs/promises.chmod

Change file permissions

fs/promises.chown

Change file owner

fs/promises.copyFile

Copy a file

fs/promises.cp

Copy a file

fs/promises.lchmod

Change file permissions

fs/promises.lchown

Change file owner

fs/promises.lutimes

Change file timestamps

fs/promises.link

Create a hard link

fs/promises.lstat

Get file status

fs/promises.mkdir

Create a directory

fs/promises.mkdtemp

Create a temporary directory

fs/promises.open

Open a file

fs/promises.opendir

Open a directory

fs/promises.readdir

Read a directory

fs/promises.readFile

Read a file

fs/promises.readlink

Read a symbolic link

fs/promises.realpath

Return canonical absolute pathname

fs/promises.rename

Rename a file or directory

fs/promises.rmdir

Remove a directory

fs/promises.rm

Remove a file

fs/promises.stat

Get file status

fs/promises.symlink

Create a symbolic link

fs/promises.truncate

Truncate a file to a specified length

fs/promises.unlink

Delete a file

fs/promises.utimes

Change file timestamps

fs/promises.watch

Watch for changes on a file

fs/promises.writeFile

Write data to a file

http.Agent

Manage HTTP connection persistence and reuse

http.createServer

Create a new HTTP server

http.get

Send a GET request to a server

http.request

Send an HTTP request to a server

http2.createServer

Create a new HTTP/2 server

http2.createSecureServer

Create a new secure HTTP/2 server

http2.connect

Establish a connection to a server

http2.getDefaultSettings

Get the default settings for a HTTP/2 session

http2.getPackedSettings

Get the current settings for a HTTP/2 session

http2.getUnpackedSettings

Get the current settings for a HTTP/2 session

https.Agent

Manage HTTPS connection persistence and reuse

https.createServer

Create a new HTTPS server

https.get

Send a GET request to a server

https.request

Send an HTTPS request to a server

inspector.close

Close a V8 inspector

inspector.open

Open a V8 inspector

inspector.url

Get the URL of the V8 inspector

inspector.waitForDebugger

Wait for the V8 debugger to connect

inspector.Session

Create a new V8 inspector session

net.Server

Create a new TCP server

net.Socket

Create a new TCP socket

net.connect

Connect to a remote TCP server

net.createConnection

Connect to a remote TCP server

net.createServer

Create a new TCP server

os.arch

Get the CPU architecture

os.cpus

Get CPU information

os.endianness

Get the endianness of the CPU

os.freemem

Get the amount of free system memory

os.getPriority

Get the scheduling priority for a process

os.homedir

Get the home directory path for the current user

os.hostname

Get the hostname of the OS

os.loadavg

Get system load average information

os.networkInterfaces

Get a list of network interfaces

os.platform

Get the operating system platform

os.release

Get the operating system release

os.setPriority

Set the scheduling priority for a process

os.tmpdir

Get the path of a temporary directory

os.totalmem

Get the total amount of system memory

os.type

Get the operating system name

os.uptime

Get the system uptime

os.userInfo

Get current user information

os.version

Get the kernel version

process.abort

Exit the Node.js process immediately

process.chdir

Change the current working directory

process.cpuUsage

Get current process CPU usage info

process.cwd

Get the current working directory

process.disconnect

Disconnect child process from parent

process.dlopen

Load C++ addons

process.emitWarning

Emit a custom process warning

process.exit

Exit the Node.js process

process.getActiveResourcesInfo

Get a list of resources currently keeping the event loop alive

process.getegid

Get the effective group id of the Node.js process

process.geteuid

Get the effective numerical user id

process.getgid

Get the numerical group id of the process

process.getgroups

Get the list of supplementary group ids

process.getuid

Get the numerical user id of the process

process.hasUncaughtExceptionCaptureCallback

Find out if there is an uncaught exception callback set

process.hrtime

Get high resolution time

process.initgroups

Initialize the group access list

process.kill

Kill a process

process.memoryUsage

Get memory usage information

process.resourceUsage

Get resource usage information

process.send

Send a message to a process

process.setegid

Set the effective group id of the process

process.seteuid

Set the effective user id of the process

process.setgid

Set the group id of the process

process.setgroups

Set the supplementary group ids of the process

process.setuid

Set the user id of the process

process.setSourceMapsEnabled

Enable/disable source maps

process.setUncaughtExceptionCaptureCallback

Set a callback to run when there is an uncaught exception

process.umask

Set the file mode creation mask

process.uptime

Get the process uptime

process.on

Add a listener for a process event

timers.setImmediate

Queue a function for execution

timers.setInterval

Set a repeating timer to execute a function

timers.setTimeout

Set a timer to execute a function

timers.clearImmediate

Cancel a setImmediate callback

timers.clearInterval

Cancel a setInterval callback

timers.clearTimeout

Cancel a setTimeout callback

timers/promises.setImmediate

Queue a function for execution

timers/promises.setInterval

Set a repeating timer to execute a function

timers/promises.setTimeout

Set a timer to execute a function

tls.Server

Create a new TLS server

tls.TLSSocket

Create a new TLS socket

tls.checkServerIdentity

Verify that a server certificate is valid for a given host

tls.connect

Connect to a TLS server

tls.createSecureContext

Create a new secure context

tls.createSecurePair

Create a new secure pair

tls.createServer

Create a new TLS server

tls.getCiphers

Get a list of supported TLS ciphers

trace_events.createTracing

Centralize system tracing information

trace_events.getEnabledCategories

Get the enabled trace event categories

v8.cachedDataVersionTag

Get a version tag derived from the V8 version, command-line flags, and detected CPU features

v8.getHeapCodeStatistics

Get statistics about code and its metadata in the heap

v8.getHeapSnapshot

Generate a snapshot of the current V8 heap

v8.getHeapSpaceStatistics

Get statistics about the V8 heap spaces

v8.getHeapStatistics

Get detailed V8 heap statistics

v8.setFlagsFromString

Programmatically set V8 command-line flags

v8.stopCoverage

Stop collecting JavaScript code coverage collection

v8.takeCoverage

Write code coverage data to disk

v8.writeHeapSnapshot

Write a heap snapshot to a file

v8.serialize

Serialize value into a buffer

v8.deserialize

Deserialize value from a buffer

vm.Script

Precompile arbitrary code to execute later

vm.SourceTextModule

Create a module defined from ECMAScript source text

vm.SyntheticModule

Create a WebIDL synthetic module

vm.compileFunction

Compile a JavaScript function

vm.createContext

Create a new execution context

vm.isContext

Check if the given object is an execution context

vm.measureMemory

Measure V8 memory usage

vm.runInContext

Run arbitrary code in a context

vm.runInNewContext

Run arbitrary code in a new context

vm.runInThisContext

Run arbitrary code in the current context

wasi.WASI

Give WebAssembly apps access to the underlying OS

worker_threads.Worker

Create a new independent JavaScript execution thread

worker_threads.getEnvironmentData

Get thread environment data

worker_threads.markAsUntransferable

Mark a buffer as untransferable between threads

worker_threads.moveMessagePortToContext

Move a message port to a different context

worker_threads.receiveMessageOnPort

Receive single a message on a port

worker_threads.setEnvironmentData

Set thread environment data

Web

MethodDescriptionDocs

AudioContext.AudioContext

Enable execution of audio processing or decoding.

BackgroundFetchManager.fetch

Register URLs for background fetch

BackgroundFetchManager.get

Get info on background fetch job

BackgroundFetchManager.getIds

Return the IDs of all registered background fetches

BackgroundTasks.requestIdleCallback

Queue task to be executed in the background

BackgroundTasks.cancelIdleCallback

Cancel a previously queued background task

Beacon.sendBeacon

Send an asynchronous request that does not expect a response

Bluetooth.getAvailability

Is the browser able to use Bluetooth

Bluetooth.getDevices

Get a list of available Bluetooth devices

Bluetooth.requestDevice

Request a Bluetooth device

Clipboard.read

Request arbitrary data from the clipboard

Clipboard.readText

Request text from the clipboard

Clipboard.write

Write arbitrary data to the clipboard

Clipboard.writeText

Write text to the clipboard

ContactsManager.select

Retrieve contact information from user device

ContactsManager.getProperties

List all available contact properties

ContentIndex.add

Register offline enabled content with the browser

ContentIndex.delete

Delete an offline enabled content

ContentIndex.getAll

Get all offline enabled content

CookieStore.delete

Delete a cookie

CookieStore.get

Get a cookie

CookieStore.getAll

Get all cookies

CookieStore.set

Set a cookie

CredentialsContainer.create

Create a new Credential instance

CredentialsContainer.get

Retrieve saved authentication credentials

CredentialsContainer.preventSilentAccess

Set if automatic log in is allowed

CredentialsContainer.store

Store user authentication credentials

EventSource.EventSource

Recieve events from a server, via a persistent connection

Fetch.fetch

Communicate with a web server

FileReader.abort

Abort reading file

FileReader.readAsArrayBuffer

Read file as ArrayBuffer

FileReader.readAsBinaryString

Read file as binary string

FileReader.readAsDataURL

Read file as data URL

FileReader.readAsText

Read file as text

FileReader.FileReader

Read the contents of a user file

FileReaderSync.readAsArrayBuffer

Read file as ArrayBuffer

FileReaderSync.readAsBinaryString

Read file as binary string

FileReaderSync.readAsDataURL

Read file as data URL

FileReaderSync.readAsText

Read file as text

FileReaderSync.FileReaderSync

Read the contents of a user file

FileSystem.showOpenFilePicker

Prompt user to allow reading a file from his system

FileSystem.showSaveFilePicker

Prompt user to allow saving a file to his system

FileSystem.showDirectoryPicker

Prompt user to allow reading a directory from his system

Gamepad.getGamepads

Get a list of connected gamepads

Geolocation.clearWatch

Stop tracking user location

Geolocation.getCurrentPosition

Get user location

Geolocation.watchPosition

Track user location

Battery.getBattery

Get device battery information

HID.getDevices

List connected Human Interface Devices

HID.requestDevice

Connect to a Human Interface Device

History.back

Go back in navigation history

History.forward

Go forward in navigation history

History.go

Go to a specific point in the navigation history

History.pushState

Add a new entry to the history stack

History.replaceState

Replace the current entry in the history stack

IDBFactory.cmp

Compare two database keys

IDBFactory.databases

List all available databases

IDBFactory.deleteDatabase

Delete a database

IDBFactory.open

Open a database

ImageCapture.getPhotoCapabilities

Get the capabilities of the camera

ImageCapture.getPhotoSettings

Get the settings of the camera

ImageCapture.grabFrame

Take a snapshot of the live video stream

ImageCapture.takePhoto

Take a single exposure using the video capture device

ImageCapture.ImageCapture

Enable the capture of images or photos from a camera

MediaDevices.enumerateDevices

List all connected media devices

MediaDevices.getDisplayMedia

Capture the contents of a display or portion thereof

MediaDevices.getSupportedConstraints

Get the supported media device constraints

MediaDevices.getUserMedia

Request access to user media devices

MediaDevices.selectAudioOutput

Select an audio output device

MediaRecorder.MediaRecorder

Record audio and video

MediaStream.MediaStream

A stream of media content

MessageChannel.postMessage

Send cross-origin communication between windows

MessageChannel.MessageChannel

A channel for passing messages between threads

MIDI.requestMIDIAccess

Request access to connected MIDI devices

Notification.requestPermission

Request permission to show notifications

Notification.showNotification

Show a browser notification

Notification.getNotifications

List received notifications

Notification.Notification

Create a user notification

PaymentRequest.PaymentRequest

Create a payment request

PerformanceObserver.PerformanceObserver

Monitor the performance of the page

PeriodicSyncManager.register

Registers a periodic background sync request

PeriodicSyncManager.unregister

Unregisters a periodic background sync request

PeriodicSyncManager.getTags

List registered periodic sync requests

Permissions.query

Get user permission status for a given API

Permissions.revoke

Revoke a user permission for a given API

PresentationRequest.start

Start a presentation

PresentationRequest.reconnect

Reconnect to a presentation

PresentationRequest.getAvailability

Get availability for starting presentations

PresentationRequest.PresentationRequest

Create a presentation request

PushManager.getSubscription

Get the current push subscription

PushManager.hasPermission

Get push subscription permission state

PushManager.permissionState

Get push subscription permission state

PushManager.register

Register a push subscription

PushManager.registrations

List of registered push subscriptions

PushManager.subscribe

Subscribe to a push subscription

PushManager.unregister

Unregister a push subscription

ReportingObserver.ReportingObserver

Collect and access reports on various issues

Scheduler.postTask

Create a new scheduled task

Selection.getSelection

Get the current webpage selection

Selection.getSelection

Get the current webpage selection

Sensor.AbsoluteOrientationSensor

Absolute orientation sensor

Sensor.Accelerometer

Accelerometer sensor

Sensor.AmbientLightSensor

Ambient light sensor

Sensor.GravitySensor

Gravity sensor

Sensor.Gyroscope

Gyroscope sensor

Sensor.LinearAccelerationSensor

Linear acceleration sensor

Sensor.Magnetometer

Magnetometer sensor

Sensor.RelativeOrientationSensor

Relative orientation sensor

Share.share

Share content to user-selected targets

Share.canShare

Check if sharing is supported

SpeechRecognition.abort

Abort a speech recognition process

SpeechRecognition.start

Start a speech recognition process

SpeechRecognition.stop

Stop a speech recognition process

SpeechRecognition.SpeechRecognition

Use the speech recognition API

SpeechRecognition.webkitSpeechRecognition

Use the speech recognition API

SpeechSynthesis.cancel

Cancel speech synthesis

SpeechSynthesis.getVoices

Get the list of available voices

SpeechSynthesis.pause

Pause speech synthesis

SpeechSynthesis.resume

Resume speech synthesis

SpeechSynthesis.speak

Speak text

Storage.getItem

Return an item from local storage

Storage.setItem

Save an item to local storage

Storage.removeItem

Remove an item from local storage

Storage.clear

Clear local storage

Storage.key

Return the name of the nth key in local storage

StorageAccess.requestStorageAccess

Request access to first-party storage

StorageAccess.hasStorageAccess

Check if storage access is granted

StorageManager.estimate

Returns current storage space - used and available

StorageManager.persist

Request permission to use persistent storage

StorageManager.persisted

Check if persistent storage is granted

SubtleCrypto.decrypt

Decrypt data

SubtleCrypto.deriveBits

Derive bits from a crypto key

SubtleCrypto.deriveKey

Derive a secret key from a master key

SubtleCrypto.digest

Generate a crypto digest from data

SubtleCrypto.encrypt

Encrypt data

SubtleCrypto.exportKey

Export a crypto key

SubtleCrypto.generateKey

Generate a crypto key

SubtleCrypto.importKey

Import a crypto key

SubtleCrypto.sign

Sign data

SubtleCrypto.unwrapKey

Unwrap a crypto key

SubtleCrypto.verify

Verify data

SubtleCrypto.wrapKey

Wrap a crypto key

USB.getDevices

Get a list of paired attached USB devices

USB.requestDevice

Request access to a USB device

Vibration.vibrate

Vibrate the device

WakeLock.request

Request a device wake lock

WebSocket.close

Close a websocket connection

WebSocket.send

Send data on a websocket connection

WebSocket.WebSocket

Create a new WebSocket object

Worker.postMessage

Post a message to a web worker

Worker.terminate

Terminate a web worker

Worker.Worker

Create a new web worker

SharedWorker.SharedWorker

Create a new shared worker

XMLHttpRequest.abort

Abort an web request

XMLHttpRequest.getAllResponseHeaders

Get all response headers

XMLHttpRequest.getResponseHeader

Get a response header

XMLHttpRequest.open

Open a web request

XMLHttpRequest.overrideMimeType

Override the MIME type

XMLHttpRequest.send

Send data via a web request

XMLHttpRequest.setRequestHeader

Set a request header

XMLHttpRequest.XMLHttpRequest

Communicate with a web server

bind calls

For each method listed above, Sandworm also intercepts bind calls. To allow bind calls with more than one argument, the bind.args permission is required. Read more.

Last updated