docs: add allowCustomFetcher config flag documentation for TypeScript SDK #2059
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ``` | ||
| <ParamField path="allowCustomFetcher" type="boolean" default="false" toc={true}> | ||
| When enabled, the generated SDK accepts a `fetcher` parameter in the client options. This allows you to wrap the default fetcher with custom logic, enabling dynamic authentication patterns like JWT signing, OAuth token refresh, or HMAC signing. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'HMAC' has no definition.
tjb9dc
reviewed
Nov 17, 2025
Comment on lines
19
to
20
| <ParamField path="allowCustomFetcher" type="boolean" default="false" toc={true}> | ||
| When enabled, the generated SDK accepts a `fetcher` parameter in the client options. This allows you to wrap the default fetcher with custom logic, enabling dynamic authentication patterns like JWT signing, OAuth token refresh, or HMAC signing. |
Contributor
There was a problem hiding this comment.
Let's not make this solely about authentication. I think we can remove all of this
| }); | ||
| ``` | ||
|
|
||
| See [Dynamic authentication](/sdks/generators/typescript/dynamic-authentication) for detailed implementation examples. |
Contributor
There was a problem hiding this comment.
Let's say something like:
Suggested change
| See [Dynamic authentication](/sdks/generators/typescript/dynamic-authentication) for detailed implementation examples. | |
| See [Dynamic authentication](/sdks/generators/typescript/dynamic-authentication) for an example of adding authentication middleware with a custom fetcher. |
Comment on lines
33
to
48
| import { fetcher as defaultFetcher } from "plant-store-sdk/core"; | ||
| const customFetcher = async (args) => { | ||
| // Add custom authentication logic here | ||
| const headers = { | ||
| ...args.headers, | ||
| Authorization: `Bearer ${getToken()}`, | ||
| }; | ||
| return defaultFetcher({ ...args, headers }); | ||
| }; | ||
|
|
||
| const client = new PlantStoreClient({ | ||
| environment: "https://api.plantstore.com", | ||
| fetcher: customFetcher, | ||
| }); | ||
| ``` |
Contributor
There was a problem hiding this comment.
let's make this example not about authentication
…hentication Co-Authored-By: [email protected] <[email protected]>
Contributor
Author
|
Updated! I've changed the documentation to be more general-purpose:
The example now demonstrates logging and header injection without focusing on authentication, while still linking to the dynamic-authentication page for users who need that specific use case. |
devin-ai-integration
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs: add allowCustomFetcher config flag documentation for TypeScript SDK
Summary
Added documentation for the
allowCustomFetcherconfiguration flag to the TypeScript SDK configuration reference page. This flag enables passing a custom fetcher function to intercept all SDK HTTP requests for cross-cutting concerns like logging, tracing, metrics, header injection, proxies, or custom retry logic.The documentation includes:
Review & Testing Checklist for Human
import { fetcher as defaultFetcher, type FetchFunction } from "../core/fetcher". Confirm this path is correct for typical SDK generation configurations and that the wrapper pattern (extending the generated client) is the recommended approach.allowCustomFetcher: trueenabled.Notes
products/cli-api-reference/cli-changelog/2025-11-14.mdx(acorn parse error). This file is identical to main and the error reproduces locally. The Vale linter check passed successfully.fern docs devbut the server failed due to the same unrelated parsing error. Unable to provide visual proof of rendering.