Skip to content

docs: add naming configuration for TypeScript SDK #4271

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

Merged
fern-support merged 3 commits into from
Mar 14, 2026
Merged

docs: add naming configuration for TypeScript SDK #4271

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c58762
docs: add naming configuration object for TypeScript SDK
devin-ai-integration[bot] Mar 13, 2026
514d330
docs: document naming string shorthand form
devin-ai-integration[bot] Mar 14, 2026
e509cbe
docs: replace xai with acme in naming example
devin-ai-integration[bot] Mar 14, 2026
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
41 changes: 41 additions & 0 deletions fern/products/sdks/overview/typescript/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,47 @@ import { AcmePayments, AcmePaymentsClient } from "@acme/node";

</ParamField>

<ParamField path="naming" type="string | object" toc={true}>
Customize the namespace export and class/type names. Accepts a string shorthand or a full object.

**String shorthand** — sets the namespace and derives all class names via PascalCase:

```yaml title="generators.yml"
config:
naming: acme
```

```typescript
import { acme, AcmeClient } from "acme";
```

**Object form** — override individual names:

```yaml title="generators.yml"
config:
naming:
namespace: acme
client: AcmeSdkClient
error: AcmeSdkError
environment: AcmeSdkEnvironment
```

```typescript
import { acme, AcmeSdkClient } from "acme";
```

| Field | Type | Description |
| --- | --- | --- |
| `namespace` | `string` | Namespace export name. Equivalent to `namespaceExport`. |
| `client` | `string` | Client class name (default: `${PascalCase(namespace)}Client`). |
| `error` | `string` | Generic API error class name (default: `${PascalCase(namespace)}Error`). |
| `timeoutError` | `string` | Timeout error class name (default: `${PascalCase(namespace)}TimeoutError`). |
| `environment` | `string` | Environment enum name (default: `${PascalCase(namespace)}Environment`). |
| `environmentUrls` | `string` | Environment URLs type name (default: `${PascalCase(namespace)}EnvironmentUrls`). |
| `version` | `string` | Version enum name (default: `${PascalCase(namespace)}Version`). |

`namespaceExport` is still supported for backwards compatibility but `naming.namespace` takes precedence.
</ParamField>

<ParamField path="neverThrowErrors" type="boolean" default="false" toc={true}>
When enabled, the client doesn't throw errors when a non-200 response is received from the server. Instead, the response is wrapped in an [`ApiResponse`](https://github.com/fern-api/fern/blob/main/seed/ts-sdk/alias/src/core/fetcher/APIResponse.ts).
Expand Down
Loading