PreviewWiring
Defined in: src/poller.ts:52
Injectable preview wiring: service + throttle cadence + scan/pick overrides. Defaults to the real implementations; tests inject fakes to avoid /proc + network.
Properties
Section titled “Properties”idleStop?
Section titled “idleStop?”
optionalidleStop?:object
Defined in: src/poller.ts:72
Opt-in idle-stop. idleMs > 0 enables it; stop signals a session’s dev-server
process (wired to SessionService.stopPreview in index.ts). Absent = disabled.
idleMs
Section titled “idleMs”idleMs:
number
stop: (
sessionId,signal) =>void
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
signal
Section titled “signal”Signals
Returns
Section titled “Returns”void
pick: (
ports,worktreePath) =>Promise<number|null>
Defined in: src/poller.ts:69
Pick the primary dev port from a set of listening ports for a given worktree.
Defaults to resolveDevPort, which honors the agent-declared .shepherd-preview
hint (if listening + HTTP-live) and otherwise falls back to the primary-port heuristic.
Parameters
Section titled “Parameters”number[]
worktreePath
Section titled “worktreePath”string
Returns
Section titled “Returns”Promise<number | null>
scan: (
worktrees) =>Map<string,number[]>
Defined in: src/poller.ts:65
Batched /proc scan: builds the inode→port map ONCE and resolves all worktrees.
Defaults to the real scanListeningPortsByWorktree.
Parameters
Section titled “Parameters”worktrees
Section titled “worktrees”string[]
Returns
Section titled “Returns”Map<string, number[]>
service
Section titled “service”service:
object
Defined in: src/poller.ts:53
converge()
Section titled “converge()”converge(
active):void
Parameters
Section titled “Parameters”active
Section titled “active”object[]
Returns
Section titled “Returns”void
ensure()
Section titled “ensure()”ensure(
sessionId,devPort):number|null
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
devPort
Section titled “devPort”number
Returns
Section titled “Returns”number | null
idleSince()?
Section titled “idleSince()?”
optionalidleSince(sessionId,now):number|null
Ms since last proxy activity for a bound session, null if unbound.
Optional so existing fake service literals in tests still compile.
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
number
Returns
Section titled “Returns”number | null
release()
Section titled “release()”release(
sessionId):void
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
Returns
Section titled “Returns”void
snapshot()
Section titled “snapshot()”snapshot():
Record<string, {previewPort:number|null; }>
Returns
Section titled “Returns”Record<string, { previewPort: number | null; }>
sweepMs
Section titled “sweepMs”sweepMs:
number
Defined in: src/poller.ts:62