Skip to content

Commit 02d0ca2

Browse files
refactor: rename sessionIdleTimeoutMs to sessionIdleTimeoutSeconds
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7e794c4 commit 02d0ca2

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/features/session-persistence.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -433,15 +433,15 @@ await client.deleteSession("user-123-task-456");
433433
434434
## Automatic Cleanup: Idle Timeout
435435

436-
By default, sessions have **no idle timeout** and live indefinitely until explicitly disconnected or deleted. You can optionally configure a server-wide idle timeout via `CopilotClientOptions.sessionIdleTimeoutMs`:
436+
By default, sessions have **no idle timeout** and live indefinitely until explicitly disconnected or deleted. You can optionally configure a server-wide idle timeout via `CopilotClientOptions.sessionIdleTimeoutSeconds`:
437437

438438
```typescript
439439
const client = new CopilotClient({
440-
sessionIdleTimeoutMs: 30 * 60 * 1000, // 30 minutes
440+
sessionIdleTimeoutSeconds: 30 * 60, // 30 minutes
441441
});
442442
```
443443

444-
When a timeout is configured, sessions without activity for that duration are automatically cleaned up. The minimum value is 5 minutes (300,000ms). Set to `0` or omit to disable.
444+
When a timeout is configured, sessions without activity for that duration are automatically cleaned up. The minimum value is 300 seconds (5 minutes). Set to `0` or omit to disable.
445445

446446
> **Note:** This option only applies when the SDK spawns the runtime process. When connecting to an existing server via `cliUrl`, the server's own timeout configuration applies.
447447

nodejs/src/client.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ export class CopilotClient {
339339
// Default useLoggedInUser to false when githubToken is provided, otherwise true
340340
useLoggedInUser: options.useLoggedInUser ?? (options.githubToken ? false : true),
341341
telemetry: options.telemetry,
342-
sessionIdleTimeoutMs: options.sessionIdleTimeoutMs ?? 0,
342+
sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0,
343343
};
344344
}
345345

@@ -1386,8 +1386,8 @@ export class CopilotClient {
13861386
args.push("--no-auto-login");
13871387
}
13881388

1389-
if (this.options.sessionIdleTimeoutMs !== undefined && this.options.sessionIdleTimeoutMs > 0) {
1390-
args.push("--session-idle-timeout", this.options.sessionIdleTimeoutMs.toString());
1389+
if (this.options.sessionIdleTimeoutSeconds !== undefined && this.options.sessionIdleTimeoutSeconds > 0) {
1390+
args.push("--session-idle-timeout", this.options.sessionIdleTimeoutSeconds.toString());
13911391
}
13921392

13931393
// Suppress debug/trace output that might pollute stdout

nodejs/src/types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,13 +184,13 @@ export interface CopilotClientOptions {
184184
sessionFs?: SessionFsConfig;
185185

186186
/**
187-
* Server-wide idle timeout for sessions in milliseconds.
187+
* Server-wide idle timeout for sessions in seconds.
188188
* Sessions without activity for this duration are automatically cleaned up.
189189
* Set to 0 or omit to disable (sessions live indefinitely).
190-
* Minimum value: 300000 (5 minutes).
190+
* Minimum value: 300 (5 minutes).
191191
* @default 0 (disabled)
192192
*/
193-
sessionIdleTimeoutMs?: number;
193+
sessionIdleTimeoutSeconds?: number;
194194
}
195195

196196
/**

0 commit comments

Comments
 (0)