Skip to content
nodepod
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting started
Introduction
First program
Set up
Vite
Next.js
Generic server
Static hosts
Preview deployment
Guides
Terminal and filesystem
npm packages
HTTP servers
Snapshots
Headless mode
Profiling and inspection
Concepts
How Nodepod works
Compatibility and browser requirements
Security model
Licensing FAQ
Reference
SDK overview
API reference
API reference
classes
src.IframeSandbox
IframeSandbox
src.LRUCache
LRUCache
src.MemoryHandler
MemoryHandler
src.MemoryVolume
MemoryVolume
src.module.SourceMap
SourceMap
src.Nodepod
Nodepod
src.NodepodFS
NodepodFS
src.NodepodFSClient
NodepodFSClient
src.NodepodFSClientError
NodepodFSClientError
src.NodepodProcess
NodepodProcess
src.NodepodSWSetupError
NodepodSWSetupError
src.NodepodTerminal
NodepodTerminal
src.npm.DependencyInstaller
DependencyInstaller
src.npm.RegistryClient
RegistryClient
src.PreviewAgentUnavailableError
PreviewAgentUnavailableError
src.PreviewInspectionTimeoutError
PreviewInspectionTimeoutError
src.PreviewInspector
PreviewInspector
src.PreviewInspectorError
PreviewInspectorError
src.PreviewNotAttachedError
PreviewNotAttachedError
src.PreviewScreenshotUnavailableError
PreviewScreenshotUnavailableError
src.ProcessHandle
ProcessHandle
src.ProcessManager
ProcessManager
src.ProcessWorkerAdapter
ProcessWorkerAdapter
src.RequestProxy
RequestProxy
src.ScriptEngine
ScriptEngine
src.SharedVFSController
SharedVFSController
src.SharedVFSReader
SharedVFSReader
src.SyncChannelController
SyncChannelController
src.SyncChannelWorker
SyncChannelWorker
src.VFSBridge
VFSBridge
src.WorkerSandbox
WorkerSandbox
src.WorkerVFS
WorkerVFS
functions
src_headless.createLocalHttpIngress
createLocalHttpIngress
src_headless.createNodeHost
createNodeHost
src_headless.openFsSnapshotCache
openFsSnapshotCache
src_integrations_next.GET
GET
src_integrations_next.GET_PREVIEW_BRIDGE
GET_PREVIEW_BRIDGE
src_integrations_next.GET_PREVIEW_BRIDGE_SCRIPT
GET_PREVIEW_BRIDGE_SCRIPT
src_integrations_next.nodepodProxy
nodepodProxy
src_integrations_server.getServiceWorkerSource
getServiceWorkerSource
src_integrations_server.servePreviewBootstrap
servePreviewBootstrap
src_integrations_server.servePreviewBridge
servePreviewBridge
src_integrations_server.servePreviewBridgeNode
servePreviewBridgeNode
src_integrations_server.servePreviewBridgeScript
servePreviewBridgeScript
src_integrations_server.serveSW
serveSW
src_integrations_server.serveSWNode
serveSWNode
src_integrations_vite.nodepod
nodepod
src.assert.assert
assert
src.buildFileSystemBridge
buildFileSystemBridge
src.buildProcessEnv
buildProcessEnv
src.chokidar.setVolume
setVolume
src.chokidar.watch
watch
src.createBrowserHost
createBrowserHost
src.createProcessContext
createProcessContext
src.createWorkspace
createWorkspace
src.discoverWorkspaces
discoverWorkspaces
src.ensureRuntimeHost
ensureRuntimeHost
src.esbuild.analyzeMetafile
analyzeMetafile
src.esbuild.analyzeMetafileSync
analyzeMetafileSync
src.esbuild.build
build
src.esbuild.buildSync
buildSync
src.esbuild.context
context
src.esbuild.formatMessages
formatMessages
src.esbuild.initialize
initialize
src.esbuild.setVolume
setVolume
src.esbuild.setWasmUrl
setWasmUrl
src.esbuild.stop
stop
src.esbuild.transform
transform
src.esbuild.transformSync
transformSync
src.executeCode
executeCode
src.fsevents.getInfo
getInfo
src.fsevents.watch
watch
src.generateSandboxDeployment
generateSandboxDeployment
src.getActiveContext
getActiveContext
src.getCorsProxy
getCorsProxy
src.getProxyInstance
getProxyInstance
src.getRuntimeHost
getRuntimeHost
src.getSandboxHostingConfig
getSandboxHostingConfig
src.getSandboxPageHtml
getSandboxPageHtml
src.http._buildClientRequest
_buildClientRequest
src.http.closeAllServers
closeAllServers
src.http.closeServersByPid
closeServersByPid
src.http.createServer
createServer
src.http.decodeFrame
decodeFrame
src.http.encodeFrame
encodeFrame
src.http.get
get
src.http.getAllServers
getAllServers
src.http.getServer
getServer
src.http.getServerOwner
getServerOwner
src.http.request
request
src.http.setHttpClientBridge
setHttpClientBridge
src.http.setServerCloseCallback
setServerCloseCallback
src.http.setServerListenCallback
setServerListenCallback
src.installFetchHeadersSetCookieParity
installFetchHeadersSetCookieParity
src.installNodeFetchClassParity
installNodeFetchClassParity
src.isSharedArrayBufferAvailable
isSharedArrayBufferAvailable
src.module._findPath
_findPath
src.module._load
_load
src.module._nodeModulePaths
_nodeModulePaths
src.module._resolveFilename
_resolveFilename
src.module.createRequire
createRequire
src.module.findSourceMap
findSourceMap
src.module.isBuiltin
isBuiltin
src.module.Module
Module
src.module.syncBuiltinESMExports
syncBuiltinESMExports
src.module.wrap
wrap
src.net.createConnection
createConnection
src.net.createServer
createServer
src.net.isIP
isIP
src.net.isIPv4
isIPv4
src.net.isIPv6
isIPv6
src.npm.findWasiPackageReferences
findWasiPackageReferences
src.npm.install
install
src.npm.isEagerTransform
isEagerTransform
src.npm.isManifestSnapshotComplete
isManifestSnapshotComplete
src.npm.manifestSnapshotKey
manifestSnapshotKey
src.npm.splitSpecifier
splitSpecifier
src.path.basename
basename
src.path.dirname
dirname
src.path.extname
extname
src.path.format
format
src.path.isAbsolute
isAbsolute
src.path.join
join
src.path.normalize
normalize
src.path.parse
parse
src.path.relative
relative
src.path.resolve
resolve
src.perf_hooks.createHistogram
createHistogram
src.perf_hooks.monitorEventLoopDelay
monitorEventLoopDelay
src.querystring.escape
escape
src.querystring.parse
parse
src.querystring.stringify
stringify
src.querystring.unescape
unescape
src.readdirp.default
default
src.readdirp.readdirpPromise
readdirpPromise
src.readdirp.setVolume
setVolume
src.readWorkspacePatterns
readWorkspacePatterns
src.resetProxy
resetProxy
src.resetRuntimeHost
resetRuntimeHost
src.rollup.defineConfig
defineConfig
src.rollup.getPackageBase
getPackageBase
src.rollup.loadRollup
loadRollup
src.rollup.parseAst
parseAst
src.rollup.parseAstAsync
parseAstAsync
src.rollup.rollup
rollup
src.rollup.setVFSBridge
setVFSBridge
src.rollup.watch
watch
src.setActiveContext
setActiveContext
src.setAllowedDomains
setAllowedDomains
src.setCorsProxy
setCorsProxy
src.setFetchResponse
setFetchResponse
src.setRuntimeHost
setRuntimeHost
src.spawnEngine
spawnEngine
src.spawnProcessWorkerEngine
spawnProcessWorkerEngine
src.stream.addAbortSignal
addAbortSignal
src.stream.compose
compose
src.stream.finished
finished
src.stream.getDefaultHighWaterMark
getDefaultHighWaterMark
src.stream.isDisturbed
isDisturbed
src.stream.isErrored
isErrored
src.stream.isReadable
isReadable
src.stream.isWritable
isWritable
src.stream.pipeline
pipeline
src.stream.setDefaultHighWaterMark
setDefaultHighWaterMark
src.url.domainToASCII
domainToASCII
src.url.domainToUnicode
domainToUnicode
src.url.fileURLToPath
fileURLToPath
src.url.format
format
src.url.parse
parse
src.url.pathToFileURL
pathToFileURL
src.url.resolve
resolve
src.util._extend
_extend
src.util.callbackify
callbackify
src.util.debuglog
debuglog
src.util.deprecate
deprecate
src.util.format
format
src.util.inherits
inherits
src.util.inspect
inspect
src.util.isArray
isArray
src.util.isBoolean
isBoolean
src.util.isBuffer
isBuffer
src.util.isDate
isDate
src.util.isDeepStrictEqual
isDeepStrictEqual
src.util.isError
isError
src.util.isFunction
isFunction
src.util.isNull
isNull
src.util.isNullOrUndefined
isNullOrUndefined
src.util.isNumber
isNumber
src.util.isObject
isObject
src.util.isPrimitive
isPrimitive
src.util.isPromise
isPromise
src.util.isRegExp
isRegExp
src.util.isString
isString
src.util.isUndefined
isUndefined
src.util.parseArgs
parseArgs
src.util.promisify
promisify
src.util.stripVTControlCharacters
stripVTControlCharacters
src.util.styleText
styleText
src.worker_threads.getEnvironmentData
getEnvironmentData
src.worker_threads.getWorkerThreadForkCallback
getWorkerThreadForkCallback
src.worker_threads.installHostMessagePortKeepAlive
installHostMessagePortKeepAlive
src.worker_threads.markAsUntransferable
markAsUntransferable
src.worker_threads.moveMessagePortToContext
moveMessagePortToContext
src.worker_threads.receiveMessageOnPort
receiveMessageOnPort
src.worker_threads.setEnvironmentData
setEnvironmentData
src.worker_threads.setWorkerConstructorOverride
setWorkerConstructorOverride
src.worker_threads.setWorkerThreadForkCallback
setWorkerThreadForkCallback
src.ws.createWebSocketStream
createWebSocketStream
interfaces
src_headless.NodeHostOptions
NodeHostOptions
src_integrations_server.NodeServeSWResult
NodeServeSWResult
src_integrations_vite.NodepodVitePluginOptions
NodepodVitePluginOptions
src.assert.AssertionError
AssertionError
src.chokidar.PathWatcher
PathWatcher
src.chokidar.WatcherConfig
WatcherConfig
src.CommandOptions
CommandOptions
src.CommandResult
CommandResult
src.EngineConfig
EngineConfig
src.EngineOptions
EngineOptions
src.esbuild.BundleConfig
BundleConfig
src.esbuild.BundleOutput
BundleOutput
src.esbuild.TransformConfig
TransformConfig
src.esbuild.TransformOutput
TransformOutput
src.events.EventEmitter
EventEmitter
src.events.EventEmitterConstructor
EventEmitterConstructor
src.ExecutionOutcome
ExecutionOutcome
src.FileStat
FileStat
src.FileWatchHandle
FileWatchHandle
src.FsBridge
FsBridge
src.HostWorker
HostWorker
src.http.Agent
Agent
src.http.AgentConfig
AgentConfig
src.http.AgentConstructor
AgentConstructor
src.http.ClientRequest
ClientRequest
src.http.ClientRequestConstructor
ClientRequestConstructor
src.http.CompletedResponse
CompletedResponse
src.http.ConnectionOptions
ConnectionOptions
src.http.IncomingMessage
IncomingMessage
src.http.IncomingMessageConstructor
IncomingMessageConstructor
src.http.Server
Server
src.http.ServerConstructor
ServerConstructor
src.http.ServerResponse
ServerResponse
src.http.ServerResponseConstructor
ServerResponseConstructor
src.HttpIngress
HttpIngress
src.InspectA11yNode
InspectA11yNode
src.InspectA11yViolation
InspectA11yViolation
src.InspectAttachOptions
InspectAttachOptions
src.InspectConsoleEntry
InspectConsoleEntry
src.InspectDomNode
InspectDomNode
src.InspectErrorEntry
InspectErrorEntry
src.InspectQueryNode
InspectQueryNode
src.InspectRect
InspectRect
src.InspectResult
InspectResult
src.InspectScreenshot
InspectScreenshot
src.InspectSnapshot
InspectSnapshot
src.InspectTarget
InspectTarget
src.IScriptEngine
IScriptEngine
src.MemoryHandlerOptions
MemoryHandlerOptions
src.ModuleRecord
ModuleRecord
src.net.BindOptions
BindOptions
src.net.NetAddress
NetAddress
src.net.ServerConfig
ServerConfig
src.net.SocketConfig
SocketConfig
src.net.TcpServer
TcpServer
src.net.TcpServerConstructor
TcpServerConstructor
src.net.TcpSocket
TcpSocket
src.net.TcpSocketConstructor
TcpSocketConstructor
src.NodepodOptions
NodepodOptions
src.NodepodProfiler
NodepodProfiler
src.NodepodProfileReport
NodepodProfileReport
src.NodepodRequestOptions
NodepodRequestOptions
src.npm.ExtractionOptions
ExtractionOptions
src.npm.InstallFlags
InstallFlags
src.npm.InstallOutcome
InstallOutcome
src.npm.PackageMetadata
PackageMetadata
src.npm.RegistryConfig
RegistryConfig
src.npm.ResolutionConfig
ResolutionConfig
src.npm.ResolvedDependency
ResolvedDependency
src.npm.VersionDetail
VersionDetail
src.npm.WorkspaceInstallOutcome
WorkspaceInstallOutcome
src.OpenFileEntry
OpenFileEntry
src.perf_hooks.PerformanceObserver
PerformanceObserver
src.perf_hooks.TimingEntryList
TimingEntryList
src.perf_hooks.TimingHistogram
TimingHistogram
src.PerformanceStats
PerformanceStats
src.PerformanceTiming
PerformanceTiming
src.PreviewOriginContext
PreviewOriginContext
src.ProcessContext
ProcessContext
src.ProcessEnvVars
ProcessEnvVars
src.ProcessInfo
ProcessInfo
src.ProcessObject
ProcessObject
src.ProcessReader
ProcessReader
src.ProcessWriter
ProcessWriter
src.ProfileAggregate
ProfileAggregate
src.ProfileEnvironment
ProfileEnvironment
src.ProfileLongTaskSample
ProfileLongTaskSample
src.ProfileMemorySample
ProfileMemorySample
src.ProfilerOptions
ProfilerOptions
src.ProfileSession
ProfileSession
src.ProfileSpan
ProfileSpan
src.ProfileSpanOptions
ProfileSpanOptions
src.ProfileSummary
ProfileSummary
src.ProfileWarning
ProfileWarning
src.ProxyOptions
ProxyOptions
src.readdirp.DirectoryScanner
DirectoryScanner
src.readdirp.ScanEntry
ScanEntry
src.readdirp.ScanOptions
ScanOptions
src.ResolverFn
ResolverFn
src.rollup.Plugin
Plugin
src.rollup.PluginContext
PluginContext
src.RuntimeHost
RuntimeHost
src.ServiceWorkerConfig
ServiceWorkerConfig
src.SharedVFSStat
SharedVFSStat
src.ShellLimits
ShellLimits
src.ShellOptions
ShellOptions
src.SpawnConfig
SpawnConfig
src.SpawnEngineConfig
SpawnEngineConfig
src.SpawnOptions
SpawnOptions
src.StatResult
StatResult
src.stream.Duplex
Duplex
src.stream.PassThrough
PassThrough
src.stream.Readable
Readable
src.stream.Stream
Stream
src.stream.Transform
Transform
src.stream.Writable
Writable
src.SystemError
SystemError
src.TerminalOptions
TerminalOptions
src.TerminalTheme
TerminalTheme
src.url.Url
Url
src.VFSBinarySnapshot
VFSBinarySnapshot
src.VFSSnapshotEntry
VFSSnapshotEntry
src.VolumeNode
VolumeNode
src.VolumeSnapshot
VolumeSnapshot
src.worker_threads.BroadcastChannel
BroadcastChannel
src.worker_threads.MessageChannel
MessageChannel
src.worker_threads.MessagePort
MessagePort
src.worker_threads.Worker
Worker
src.WorkspaceConfig
WorkspaceConfig
src.WorkspaceGraph
WorkspaceGraph
src.WorkspacePackage
WorkspacePackage
src.ws.ServerConfig
ServerConfig
src.ws.WebSocket
WebSocket
src.ws.WebSocketServer
WebSocketServer
modules
src
src
src_headless
src/headless
src_integrations_next
src/integrations/next
src_integrations_server
src/integrations/server
src_integrations_vite
src/integrations/vite
src.assert
assert
src.chokidar
chokidar
src.esbuild
esbuild
src.events
events
src.fsevents
fsevents
src.http
http
src.module
module
src.net
net
src.npm
npm
src.path
path
src.perf_hooks
perf_hooks
src.querystring
querystring
src.readdirp
readdirp
src.rollup
rollup
src.stream
stream
src.url
url
src.util
util
src.worker_threads
worker_threads
src.ws
ws
types
src.events.EventHandler
EventHandler
src.http.HttpClientBridge
HttpClientBridge
src.http.HttpHandler
HttpHandler
src.http.RegistryHook
RegistryHook
src.InspectEvent
InspectEvent
src.InspectWaitUntil
InspectWaitUntil
src.MainToWorkerMessage
MainToWorkerMessage
src.NodepodSWFrameworkHint
NodepodSWFrameworkHint
src.perf_hooks.MarkResourceTimingFn
MarkResourceTimingFn
src.PreviewOriginOption
PreviewOriginOption
src.ProcessState
ProcessState
src.ProfileCategory
ProfileCategory
src.ProfileExportFormat
ProfileExportFormat
src.ProfilePathDetail
ProfilePathDetail
src.ProfilerLevel
ProfilerLevel
src.ProfileSample
ProfileSample
src.querystring.ParsedQuery
ParsedQuery
src.Snapshot
Snapshot
src.WatchCallback
WatchCallback
src.WatchEventKind
WatchEventKind
src.worker_threads.WorkerThreadForkFn
WorkerThreadForkFn
src.WorkerSpec
WorkerSpec
src.WorkerToMainMessage
WorkerToMainMessage
variables
src_integrations_next.nodepodMatcher
nodepodMatcher
src_integrations_next.nodepodMatchers
nodepodMatchers
src_integrations_next.nodepodMiddleware
nodepodMiddleware
src_integrations_server.DEFAULT_BRIDGE_HTML_PATH
DEFAULT_BRIDGE_HTML_PATH
src_integrations_server.DEFAULT_BRIDGE_SCRIPT_PATH
DEFAULT_BRIDGE_SCRIPT_PATH
src_integrations_server.DEFAULT_SW_PATH
DEFAULT_SW_PATH
src.assert.AssertionError
AssertionError
src.chokidar.PathWatcher
PathWatcher
src.esbuild.version
version
src.events.default
default
src.events.EventEmitter
EventEmitter
src.fsevents.constants
constants
src.http.Agent
Agent
src.http.ClientRequest
ClientRequest
src.http.globalAgent
globalAgent
src.http.IncomingMessage
IncomingMessage
src.http.METHODS
METHODS
src.http.Server
Server
src.http.ServerResponse
ServerResponse
src.http.STATUS_CODES
STATUS_CODES
src.http.WS_GUID
WS_GUID
src.module._cache
_cache
src.module._extensions
_extensions
src.module._pathCache
_pathCache
src.module.builtinModules
builtinModules
src.module.wrapper
wrapper
src.net.connect
connect
src.net.TcpServer
TcpServer
src.net.TcpSocket
TcpSocket
src.path.delimiter
delimiter
src.path.posix
posix
src.path.sep
sep
src.path.win32
win32
src.perf_hooks.performance
performance
src.perf_hooks.PerformanceObserver
PerformanceObserver
src.perf_hooks.TimingHistogram
TimingHistogram
src.querystring.decode
decode
src.querystring.encode
encode
src.readdirp.DirectoryScanner
DirectoryScanner
src.rollup.VERSION
VERSION
src.SANDBOX_DEPLOYMENT_GUIDE
SANDBOX_DEPLOYMENT_GUIDE
src.stream.Duplex
Duplex
src.stream.PassThrough
PassThrough
src.stream.promises
promises
src.stream.Readable
Readable
src.stream.Stream
Stream
src.stream.Transform
Transform
src.stream.Writable
Writable
src.url.URL
URL
src.url.URLSearchParams
URLSearchParams
src.util.debug
debug
src.util.TextDecoder
TextDecoder
src.util.TextEncoder
TextEncoder
src.util.types
types
src.worker_threads.BroadcastChannel
BroadcastChannel
src.worker_threads.isMainThread
isMainThread
src.worker_threads.MessageChannel
MessageChannel
src.worker_threads.MessagePort
MessagePort
src.worker_threads.parentPort
parentPort
src.worker_threads.SHARE_ENV
SHARE_ENV
src.worker_threads.threadId
threadId
src.worker_threads.Worker
Worker
src.worker_threads.workerData
workerData
src.ws.CLOSED
CLOSED
src.ws.CLOSING
CLOSING
src.ws.CONNECTING
CONNECTING
src.ws.OPEN
OPEN
src.ws.Server
Server
src.ws.WebSocket
WebSocket
src.ws.WebSocketServer
WebSocketServer
Troubleshooting
GitHub
Select theme
Dark
Light
Auto
url
Nodepod API
Nodepod API
/
src
/ url
url
Section titled “url”
Interfaces
Section titled “Interfaces”
Url
Variables
Section titled “Variables”
URL
URLSearchParams
Functions
Section titled “Functions”
domainToASCII
domainToUnicode
fileURLToPath
format
parse
pathToFileURL
resolve