[DOCS] TypeScript SDK: Missing `settings` parameter in Options interface (Python has it)

Resolved 💬 3 comments Opened Jan 25, 2026 by coygeek Closed Feb 27, 2026

Documentation Type

missing documentation

Documentation Location

https://platform.claude.com/docs/en/agent-sdk/typescript

Section/Topic

Section: Options interface table

Current Documentation

Python SDK (line 510) documents:

| `settings` | `str \| None` | `None` | Path to settings file |

TypeScript SDK Options table documents settingSources (line 128) but has no settings parameter:

| `settingSources` | `SettingSource[]` | `[]` | Control which filesystem settings to load |

What's Wrong or Missing?

The Python SDK has both:

  • settings: str | None — Path to a specific settings file
  • setting_sources: list[SettingSource] | None — Which filesystem sources to load

The TypeScript SDK only documents settingSources but not settings. This creates either:

  1. A documentation gap if TypeScript supports --settings CLI flag (likely, since both SDKs wrap the same CLI)
  2. A feature parity gap that should be noted

Affected Pages:
| Page | Line(s) |
|------|---------|
| platform.claude.com/docs/en/agent-sdk/typescript | Options table (lines 100-140) |

Total scope: 1 page affected

Suggested Improvement

If TypeScript supports the settings option, add it to the Options table:

| `settings` | `string` | `undefined` | Path to settings file |

If TypeScript intentionally omits this option, add a note in the Python SDK docs indicating settings is Python-only.

Impact

Medium - Makes feature difficult to understand

Additional Context

  • Both SDKs wrap the Claude Code CLI which supports --settings <path>
  • The settingSources option controls which built-in locations to load; settings specifies a custom path
  • These are complementary, not redundant features

View original on GitHub ↗

This issue has 3 comments on GitHub. Read the full discussion on GitHub ↗