Skip to content

docs: document requireBaseUrl TypeScript generator config #6545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document requireBaseUrl TypeScript generator config #6545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions fern/products/sdks/generators/typescript/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,16 @@ Publish your SDK to [JSR](https://jsr.io/). When enabled, the generator will
generate a `jsr.json` as well as a GitHub workflow to publish to JSR.
</ParamField>

<ParamField path="requireBaseUrl" type="boolean" default="false" toc={true}>
When enabled, `baseUrl` becomes a required client option and `environment` becomes optional. Generated code snippets and the `README.md` construct the client with `baseUrl` and omit the environments section.

```typescript
const client = new AcmeClient({ baseUrl: "https://api.acme.com" });
```

Enable this for APIs with no named [environments](/learn/sdks/reference/generators-yml), or when callers point the SDK at an arbitrary host. The option is ignored for APIs with multiple base URLs, whose clients resolve each URL from `environment`.
</ParamField>

<ParamField path="retainOriginalCasing" type="boolean" default="false" toc={true}>
When enabled, property names in the generated code retain their original casing from the API definition instead of being converted to camelCase.

Expand Down
Loading