RequestProxy
Nodepod API / src / RequestProxy
Class: RequestProxy
Section titled “Class: RequestProxy”Defined in: src/request-proxy.ts:176
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RequestProxy(
opts?):RequestProxy
Defined in: src/request-proxy.ts:211
Parameters
Section titled “Parameters”ProxyOptions = {}
Returns
Section titled “Returns”RequestProxy
Overrides
Section titled “Overrides”EventEmitter.constructor
Properties
Section titled “Properties”_ceiling
Section titled “_ceiling”_ceiling:
number
Defined in: src/polyfills/events.ts:88
Inherited from
Section titled “Inherited from”_registry
Section titled “_registry”_registry:
Map<string,EventHandler[]>
Defined in: src/polyfills/events.ts:87
Inherited from
Section titled “Inherited from”
staticDEBUG:boolean=false
Defined in: src/request-proxy.ts:177
defaultMaxListeners
Section titled “defaultMaxListeners”
staticdefaultMaxListeners:number
Defined in: src/polyfills/events.ts:111
Inherited from
Section titled “Inherited from”EventEmitter.defaultMaxListeners
EventEmitter
Section titled “EventEmitter”
staticEventEmitter:EventEmitterConstructor
Defined in: src/polyfills/events.ts:110
Inherited from
Section titled “Inherited from”EventEmitter.EventEmitter
Accessors
Section titled “Accessors”isServiceWorkerReady
Section titled “isServiceWorkerReady”Get Signature
Section titled “Get Signature”get isServiceWorkerReady():
boolean
Defined in: src/request-proxy.ts:236
True after a successful Service Worker registration.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”activePorts()
Section titled “activePorts()”activePorts(
instanceId?):number[]
Defined in: src/request-proxy.ts:1127
ports registered with the given instance. no arg returns the union across all instances (flat-list back-compat)
Parameters
Section titled “Parameters”instanceId?
Section titled “instanceId?”string
Returns
Section titled “Returns”number[]
addListener()
Section titled “addListener()”addListener(
name,handler):this
Defined in: src/polyfills/events.ts:89
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”attach()
Section titled “attach()”attach(
instanceId,processManager):void
Defined in: src/request-proxy.ts:265
attach a Nodepod to this proxy. idempotent: re-attaching with the same id rewires the process manager but keeps registry/preview script etc
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
processManager
Section titled “processManager”any
Returns
Section titled “Returns”void
configureInstance()
Section titled “configureInstance()”configureInstance(
instanceId,options):void
Defined in: src/request-proxy.ts:296
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
options
Section titled “options”InstanceProxyOptions
Returns
Section titled “Returns”void
createFetchHandler()
Section titled “createFetchHandler()”createFetchHandler(): (
req) =>Promise<Response>
Defined in: src/request-proxy.ts:2075
Returns
Section titled “Returns”(req) => Promise<Response>
detach()
Section titled “detach()”detach(
instanceId):void
Defined in: src/request-proxy.ts:306
detach an instance, unregister all its servers and tear down its ws connections. safe on an unknown id
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
Returns
Section titled “Returns”void
displayServerUrl()
Section titled “displayServerUrl()”displayServerUrl(
instanceId,port):string|null|undefined
Defined in: src/request-proxy.ts:699
URL state used only for rewriting user-visible CLI output.
null means a registered server is waiting for its preview bridge;
undefined means the port does not belong to this instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
number
Returns
Section titled “Returns”string | null | undefined
emit()
Section titled “emit()”emit(
name, …payload):boolean
Defined in: src/polyfills/events.ts:95
Parameters
Section titled “Parameters”string
payload
Section titled “payload”…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: src/polyfills/events.ts:99
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”getBaseUrl()
Section titled “getBaseUrl()”getBaseUrl():
string
Defined in: src/request-proxy.ts:231
Returns
Section titled “Returns”string
getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Defined in: src/polyfills/events.ts:101
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”handleRequest()
Section titled “handleRequest()”Call Signature
Section titled “Call Signature”handleRequest(
instanceId,port,method,url,headers,body?,options?):Promise<CompletedResponse>
Defined in: src/request-proxy.ts:1139
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
number
method
Section titled “method”string
string
headers
Section titled “headers”Record<string, string>
ArrayBuffer
options?
Section titled “options?”HandleRequestOptions
Returns
Section titled “Returns”Promise<CompletedResponse>
Call Signature
Section titled “Call Signature”handleRequest(
port,method,url,headers,body?,options?):Promise<CompletedResponse>
Defined in: src/request-proxy.ts:1148
Parameters
Section titled “Parameters”number
method
Section titled “method”string
string
headers
Section titled “headers”Record<string, string>
ArrayBuffer
options?
Section titled “options?”HandleRequestOptions
Returns
Section titled “Returns”Promise<CompletedResponse>
initServiceWorker()
Section titled “initServiceWorker()”initServiceWorker(
config?):Promise<void>
Defined in: src/request-proxy.ts:1265
concurrent callers share one in-flight promise, stops the Chromium SW-registration storm when N Nodepods boot in parallel.
NOT async on purpose. an async wrapper would create a fresh outer promise per call, so N callers each get their own identity and a .catch() on the inner shared promise wouldn’t reach them, causing unhandled rejection warnings. returning the memoized promise directly means all callers share one object
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”Promise<void>
listenerCount()
Section titled “listenerCount()”listenerCount(
name):number
Defined in: src/polyfills/events.ts:98
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”listeners()
Section titled “listeners()”listeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:96
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”off(
name,handler):this
Defined in: src/polyfills/events.ts:93
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”on(
name,handler):this
Defined in: src/polyfills/events.ts:90
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once(
name,handler):this
Defined in: src/polyfills/events.ts:91
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependListener()
Section titled “prependListener()”prependListener(
name,handler):this
Defined in: src/polyfills/events.ts:102
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener(
name,handler):this
Defined in: src/polyfills/events.ts:103
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.prependOnceListener
rawListeners()
Section titled “rawListeners()”rawListeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”register()
Section titled “register()”Call Signature
Section titled “Call Signature”register(
instanceId,server,port,hostname?):void
Defined in: src/request-proxy.ts:360
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
server
Section titled “server”Server | IVirtualServer
number
hostname?
Section titled “hostname?”string
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”register(
server,port,hostname?):void
Defined in: src/request-proxy.ts:366
Parameters
Section titled “Parameters”server
Section titled “server”Server | IVirtualServer
number
hostname?
Section titled “hostname?”string
Returns
Section titled “Returns”void
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
name?):this
Defined in: src/polyfills/events.ts:94
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
name,handler):this
Defined in: src/polyfills/events.ts:92
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”reserveHostPaths()
Section titled “reserveHostPaths()”reserveHostPaths(
paths):void
Defined in: src/request-proxy.ts:588
Same-origin paths the host keeps for itself: the SW never routes them (or requests made by documents at them) to a pod, even when a preview claimed an enclosing path. Entries ending in “/” are prefixes.
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”void
serverUrl()
Section titled “serverUrl()”Call Signature
Section titled “Call Signature”serverUrl(
instanceId,port):string
Defined in: src/request-proxy.ts:684
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
number
Returns
Section titled “Returns”string
Call Signature
Section titled “Call Signature”serverUrl(
port):string
Defined in: src/request-proxy.ts:685
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”string
setBaseUrl()
Section titled “setBaseUrl()”setBaseUrl(
url):void
Defined in: src/request-proxy.ts:227
Update the origin used by serverUrl() / onServerReady (e.g. Node local HTTP).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
limit):this
Defined in: src/polyfills/events.ts:100
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”setPreviewInspectorScript()
Section titled “setPreviewInspectorScript()”setPreviewInspectorScript(
instanceId,script):void
Defined in: src/request-proxy.ts:567
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
script
Section titled “script”string | null
Returns
Section titled “Returns”void
setPreviewScript()
Section titled “setPreviewScript()”Call Signature
Section titled “Call Signature”setPreviewScript(
instanceId,script):void
Defined in: src/request-proxy.ts:537
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
script
Section titled “script”string | null
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”setPreviewScript(
script):void
Defined in: src/request-proxy.ts:538
Parameters
Section titled “Parameters”script
Section titled “script”string | null
Returns
Section titled “Returns”void
setProcessManager()
Section titled “setProcessManager()”setProcessManager(
pm):void
Defined in: src/request-proxy.ts:354
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Deprecated
Section titled “Deprecated”use attach(instanceId, pm). legacy callers route to DEFAULT_INSTANCE
setWatermark()
Section titled “setWatermark()”setWatermark(
enabled):void
Defined in: src/request-proxy.ts:597
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
unregister()
Section titled “unregister()”Call Signature
Section titled “Call Signature”unregister(
instanceId,port):void
Defined in: src/request-proxy.ts:462
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
number
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”unregister(
port):void
Defined in: src/request-proxy.ts:463
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
getEventListeners()
Section titled “getEventListeners()”
staticgetEventListeners(target,name):EventHandler[]
Defined in: src/polyfills/events.ts:115
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”EventEmitter.getEventListeners
listenerCount()
Section titled “listenerCount()”
staticlistenerCount(target,name):number
Defined in: src/polyfills/events.ts:112
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
staticon(target,name):AsyncIterable<unknown[]>
Defined in: src/polyfills/events.ts:114
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”AsyncIterable<unknown[]>
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”
staticonce(target,name):Promise<unknown[]>
Defined in: src/polyfills/events.ts:113
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”Promise<unknown[]>
Inherited from
Section titled “Inherited from”EventEmitter.once