Nodepod
Nodepod API / src / Nodepod
Class: Nodepod
Section titled “Class: Nodepod”Defined in: src/sdk/nodepod.ts:106
Properties
Section titled “Properties”
readonlyfs:NodepodFS
Defined in: src/sdk/nodepod.ts:107
inspect
Section titled “inspect”
readonlyinspect:PreviewInspector
Defined in: src/sdk/nodepod.ts:110
Opt-in inspection of a host-owned preview iframe.
instanceId
Section titled “instanceId”
readonlyinstanceId:string
Defined in: src/sdk/nodepod.ts:114
unique id used by RequestProxy + SW to route back to this Nodepod when multiple coexist on one page
profiler
Section titled “profiler”
readonlyprofiler:NodepodProfiler
Defined in: src/sdk/nodepod.ts:108
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get cwd():
string
Defined in: src/sdk/nodepod.ts:1170
Returns
Section titled “Returns”string
engine
Section titled “engine”Get Signature
Section titled “Get Signature”get engine():
never
Defined in: src/sdk/nodepod.ts:1155
Deprecated
Section titled “Deprecated”Main-thread engine removed for security. all code now runs in isolated Web Workers via spawn() <– this removes fatal security flaws.
Returns
Section titled “Returns”never
isHeadless
Section titled “isHeadless”Get Signature
Section titled “Get Signature”get isHeadless():
boolean
Defined in: src/sdk/nodepod.ts:477
Whether this instance was booted in headless mode.
Returns
Section titled “Returns”boolean
isSharedArrayBufferEnabled
Section titled “isSharedArrayBufferEnabled”Get Signature
Section titled “Get Signature”get isSharedArrayBufferEnabled():
boolean
Defined in: src/sdk/nodepod.ts:1174
true if SAB features are active on this instance
Returns
Section titled “Returns”boolean
packages
Section titled “packages”Get Signature
Section titled “Get Signature”get packages():
DependencyInstaller
Defined in: src/sdk/nodepod.ts:1161
Returns
Section titled “Returns”processManager
Section titled “processManager”Get Signature
Section titled “Get Signature”get processManager():
ProcessManager
Defined in: src/sdk/nodepod.ts:1167
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get proxy():
RequestProxy
Defined in: src/sdk/nodepod.ts:1164
Returns
Section titled “Returns”sharedFSBuffer
Section titled “sharedFSBuffer”Get Signature
Section titled “Get Signature”get sharedFSBuffer():
SharedArrayBuffer|null
Defined in: src/sdk/nodepod.ts:1120
postMessage this to a sibling worker (one the host app spawned, not one nodepod spawned via spawn()), then call Nodepod.attachFS(buffer) on the other side. null if SAB is unavailable, but boot() would have thrown in that case so this is mostly defensive.
default capacity is 256 MiB (or sharedVFSBufferSize at boot), 65,536 entries, 248-byte paths. writes past either cap count as dropped writes so callers can detect an undersized mirror.
Returns
Section titled “Returns”SharedArrayBuffer | null
volume
Section titled “volume”Get Signature
Section titled “Get Signature”get volume():
MemoryVolume
Defined in: src/sdk/nodepod.ts:1151
Returns
Section titled “Returns”Methods
Section titled “Methods”clearPreviewScript()
Section titled “clearPreviewScript()”clearPreviewScript():
Promise<void>
Defined in: src/sdk/nodepod.ts:943
Returns
Section titled “Returns”Promise<void>
createTerminal()
Section titled “createTerminal()”createTerminal(
opts):NodepodTerminal
Defined in: src/sdk/nodepod.ts:662
Parameters
Section titled “Parameters”Returns
Section titled “Returns”memoryStats()
Section titled “memoryStats()”memoryStats():
object
Defined in: src/sdk/nodepod.ts:1044
Returns
Section titled “Returns”object
engine
Section titled “engine”engine:
object
engine.moduleCacheSize
Section titled “engine.moduleCacheSize”moduleCacheSize:
number
engine.transformCacheApproxBytes
Section titled “engine.transformCacheApproxBytes”transformCacheApproxBytes:
number
engine.transformCacheSize
Section titled “engine.transformCacheSize”transformCacheSize:
number
heap: {
limitMB:number;totalMB:number;usedMB:number; } |null
runtime
Section titled “runtime”runtime:
object
runtime.budgetMB
Section titled “runtime.budgetMB”budgetMB:
number
runtime.messagePorts
Section titled “runtime.messagePorts”messagePorts:
number
runtime.pendingHttp
Section titled “runtime.pendingHttp”pendingHttp:
number
runtime.processes
Section titled “runtime.processes”processes:
number
runtime.sharedFSAllocated
Section titled “runtime.sharedFSAllocated”sharedFSAllocated:
boolean
runtime.sharedFSBytes
Section titled “runtime.sharedFSBytes”sharedFSBytes:
number
runtime.sharedFSUsedBytes
Section titled “runtime.sharedFSUsedBytes”sharedFSUsedBytes:
number
runtime.wasmCacheEntries
Section titled “runtime.wasmCacheEntries”wasmCacheEntries:
number
runtime.workers
Section titled “runtime.workers”workers:
number
vfs:
object
vfs.dirCount
Section titled “vfs.dirCount”dirCount:
number
vfs.fileCount
Section titled “vfs.fileCount”fileCount:
number
vfs.lazyResidentBytes
Section titled “vfs.lazyResidentBytes”lazyResidentBytes:
number
vfs.totalBytes
Section titled “vfs.totalBytes”totalBytes:
number
vfs.watcherCount
Section titled “vfs.watcherCount”watcherCount:
number
performanceStats()
Section titled “performanceStats()”performanceStats():
PerformanceStats
Defined in: src/sdk/nodepod.ts:1040
Returns
Section titled “Returns”port()
Section titled “port()”port(
num):string|null
Defined in: src/sdk/nodepod.ts:952
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”string | null
request()
Section titled “request()”request(
port,init?):Promise<CompletedResponse>
Defined in: src/sdk/nodepod.ts:485
Programmatic HTTP against a virtual server registered on this instance. Works without Service Worker / preview iframes (headless-friendly).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<CompletedResponse>
restore()
Section titled “restore()”restore(
snapshot,opts?):Promise<void>
Defined in: src/sdk/nodepod.ts:976
Parameters
Section titled “Parameters”snapshot
Section titled “snapshot”SnapshotOptions
Returns
Section titled “Returns”Promise<void>
setPreviewScript()
Section titled “setPreviewScript()”setPreviewScript(
script):Promise<void>
Defined in: src/sdk/nodepod.ts:938
Parameters
Section titled “Parameters”script
Section titled “script”string
Returns
Section titled “Returns”Promise<void>
snapshot()
Section titled “snapshot()”snapshot(
opts?):VolumeSnapshot
Defined in: src/sdk/nodepod.ts:967
Parameters
Section titled “Parameters”SnapshotOptions
Returns
Section titled “Returns”spawn()
Section titled “spawn()”spawn(
cmd,args?,opts?):Promise<NodepodProcess>
Defined in: src/sdk/nodepod.ts:532
Parameters
Section titled “Parameters”string
string[]
Returns
Section titled “Returns”Promise<NodepodProcess>
teardown()
Section titled “teardown()”teardown():
void
Defined in: src/sdk/nodepod.ts:993
Returns
Section titled “Returns”void
attachFS()
Section titled “attachFS()”
staticattachFS(buffer):NodepodFSClient
Defined in: src/sdk/nodepod.ts:1140
attach to an existing nodepod from a sibling worker using the buffer from nodepod.sharedFSBuffer. the returned client is read-only, writes throw ENOTSUP.
Parameters
Section titled “Parameters”buffer
Section titled “buffer”SharedArrayBuffer
Returns
Section titled “Returns”boot()
Section titled “boot()”
staticboot(opts?):Promise<Nodepod>
Defined in: src/sdk/nodepod.ts:277
Parameters
Section titled “Parameters”NodepodOptions = {}
Returns
Section titled “Returns”Promise<Nodepod>