Class SessionManager

Session manager with LRU cache and TTL

Index

Constructors

Methods

beginOperation closeAllSessions closeSession destroy endOperation getActiveSessions getOSInfo getSession getSessionWithReconnect isSessionAlive onSessionClose openSession reconnectSession

Constructors

constructor

new SessionManager(
    maxSessions?: number,
    defaultTtlMs?: number,
    cleanupIntervalMs?: number,
    security?: {
        allowedCiphers: string[];
        allowRootLogin: boolean;
        hostKeyPolicy: HostKeyPolicy;
        knownHostsPath: string;
    },
    policy?: Pick<PolicyEngine, "assertAllowed">,
): SessionManager
Parameters
- maxSessions: number = 20
- defaultTtlMs: number = 900_000
- cleanupIntervalMs: number = 10_000
- security: {
      allowedCiphers: string[];
      allowRootLogin: boolean;
      hostKeyPolicy: HostKeyPolicy;
      knownHostsPath: string;
  } = ...
- Optionalpolicy: Pick<PolicyEngine, "assertAllowed">
Returns SessionManager
- Defined in src/session.ts:75

Methods

beginOperation

beginOperation(sessionId: string): void
Records that an operation is starting on a session. Prevents cleanup/eviction from removing the session while busy.
Parameters
- sessionId: string
Returns void
- Defined in src/session.ts:609

closeAllSessions

closeAllSessions(): Promise<void>
Closes all active sessions

Returns Promise<void>
- Defined in src/session.ts:662

closeSession

closeSession(sessionId: string): Promise<boolean>
Closes an SSH session
Parameters
- sessionId: string
Returns Promise<boolean>
- Defined in src/session.ts:329

destroy

destroy(): Promise<void>
Destroys the session manager, cleaning up all sessions and intervals

Returns Promise<void>
- Defined in src/session.ts:99

endOperation

endOperation(sessionId: string): void
Records that an operation on a session has completed. Must be called in a finally block paired with beginOperation.
Parameters
- sessionId: string
Returns void
- Defined in src/session.ts:618

getActiveSessions

getActiveSessions(): SessionInfo[]
Returns information about all active non-expired non-closing sessions.

Returns SessionInfo[]
- Defined in src/session.ts:641

getOSInfo

getOSInfo(sessionId: string): Promise<OSInfo>
Gets cached OS info for a session (detects and caches if needed)
Parameters
- sessionId: string
Returns Promise<OSInfo>
- Defined in src/session.ts:117

getSession

getSession(sessionId: string): SSHSession | undefined
Gets an active session by ID
Parameters
- sessionId: string
Returns SSHSession | undefined
- Defined in src/session.ts:365

getSessionWithReconnect

getSessionWithReconnect(sessionId: string): Promise<SSHSession | undefined>
Gets session with auto-reconnect if disconnected
Parameters
- sessionId: string
Returns Promise<SSHSession | undefined>
- Defined in src/session.ts:723

isSessionAlive

isSessionAlive(sessionId: string): Promise<boolean>
Checks if a session is alive by executing a simple command
Parameters
- sessionId: string
Returns Promise<boolean>
- Defined in src/session.ts:705

onSessionClose

onSessionClose(listener: SessionCloseListener): () => void
Parameters
- listener: SessionCloseListener
Returns () => void
- Defined in src/session.ts:107

openSession

openSession(params: ConnectionParams): Promise<SessionResult>
Opens a new SSH session with authentication
Parameters
- params: ConnectionParams
Returns Promise<SessionResult>
- Defined in src/session.ts:135

reconnectSession

reconnectSession(sessionId: string): Promise<SessionResult | null>
Attempts to reconnect a session
Parameters
- sessionId: string
Returns Promise<SessionResult | null>
- Defined in src/session.ts:670

Class SessionManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SessionManager

Methods

beginOperation

Parameters

Returns void

closeAllSessions

Returns Promise<void>

closeSession

Parameters

Returns Promise<boolean>

destroy

Returns Promise<void>

endOperation

Parameters

Returns void

getActiveSessions

Returns SessionInfo[]

getOSInfo

Parameters

Returns Promise<OSInfo>

getSession

Parameters

Returns SSHSession | undefined

getSessionWithReconnect

Parameters

Returns Promise<SSHSession | undefined>

isSessionAlive

Parameters

Returns Promise<boolean>

onSessionClose

Parameters

Returns () => void

openSession

Parameters

Returns Promise<SessionResult>

reconnectSession

Parameters

Returns Promise<SessionResult | null>

Settings

On This Page