Skip to content

Clarify namespaceExport config option (SDKs) #638

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
merged 1 commit into from
Aug 28, 2025
Merged

Clarify namespaceExport config option (SDKs) #638

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
30 changes: 16 additions & 14 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 @@ -13,7 +13,7 @@ groups:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/>
config:
namespaceExport: Acme
namespaceExport: AcmePayments
```

## SDK configuration options
Expand Down Expand Up @@ -258,26 +258,28 @@ await service.getFoo({ pathParamName: "pathParamValue", id: "SOME_ID" });
</ParamField>

<ParamField path="namespaceExport" type="string" toc={true}>
By default, names are based on the organization and API names in the Fern Definition:
Customizes the exported namespace and client class names in the generated SDK. Must be in PascalCase.

By default, names are derived from the organization and API names defined in your API definition:

```typescript
import { AcmeApi, AcmeApiClient } from "@acme/node";
```
```typescript
import { AcmeApi, AcmeApiClient } from "@acme/node";
```

`namespaceExport` customizes the exported namespace and client names:
Setting namespaceExport overrides these default names:

```yaml
# generators.yml
config:
namespaceExport: Acme
```
```yaml title="generators.yml"
config:
namespaceExport: AcmePayments
```

```typescript
import { Acme, AcmeClient } from "@acme/node";
```
```typescript
import { AcmePayments, AcmeClient } from "@acme/node";
```

</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