Add TypeScript configuration options #8
Conversation
|
🌿 Preview your docs: https://fernv2-preview-083eee84-3167-4012-91e1-fd5141a9000c.docs.buildwithfern.com |
|
🌿 Preview your docs: https://fernv2-preview-cfc0655c-7a2a-4731-9958-a3e80745ab86.docs.buildwithfern.com |
|
🌿 Preview your docs: https://fernv2-preview-41192b95-0e75-4986-8cde-da92e34ff21b.docs.buildwithfern.com |
| <ParamField path="shouldGenerateWebsocketClients" type="boolean"> | ||
| </ParamField> | ||
|
|
||
| <ParamField path="defaultTimeoutInSeconds" type="number | 'infinity'"> |
There was a problem hiding this comment.
Am I understanding the TS SDK generator correct here?
If infinity, it'll use the timeout provided by the request options; otherwise, it'll fall back to 60000ms.
infinity seems kind of misleading here.
@dsinghvi
The default timeout for HTTP requests in seconds. Users can change the timeout during SDK initialization and for individual HTTP requests.
There was a problem hiding this comment.
That's right, i think its okay to ignore documenting RequestOptions since we already make it clear in the TS readme that it is to override the default timeout.
There was a problem hiding this comment.
My understanding based on your comments is that I don't need to make any changes to this. Let me know if that's wrong though!
| jest: "29.0.7" | ||
| ``` | ||
|
|
||
| <Note>Only applies when publishing to Github.</Note> |
There was a problem hiding this comment.
Is the note accurate for this option?
There was a problem hiding this comment.
I copied over this note from the readme's entry for extraDevDependencies: https://github.com/fern-api/fern/tree/main/generators/typescript. @Swimburger @dsinghvi let me know if that's not right though!
| ``` | ||
| </ParamField> | ||
|
|
||
| <ParamField path="tolerateRepublish" type="boolean"> |
There was a problem hiding this comment.
The tolerateRepublish flag allows npm to overwrite an already-published package version, bypassing npm's default protection against republishing the same version number.
I don't know anyone using this flag, we may want to not document it, or put it at the bottom. Not sure how we're currently sorting the flags on this page.
There was a problem hiding this comment.
I added this description. The page is sorted by the order of the options in the config file (with deprecated/not relevant options removed entirely). If you don't think the flag is relevant, maybe removing is the best option? Can always add back in later if needed.
There was a problem hiding this comment.
@dsinghvi I do think this is so uncommonly used, we could omit it to make the flag list smaller.
There was a problem hiding this comment.
I just removed this flag for now!
Added all options from here using
ParamFieldformatting. Filled in definitions and examples for some options per readme. Many options don't have definitions and examples, and need to be filled in at a later date.Other modifications I made:
-Converted the Zod types to TypeScript types (
z.boolean()toboolean)-Added
deprecated={true}attribute for the deprecated optionsOrganized options into sections per config schema
-Handled union formatting (
z.union([z.literal("infinity"), z.number()])tonumber | 'infinity')-Converted enum types to literal unions (
z.enum(["wrapper", "web"])→'wrapper' | 'web')-Lightly edited/reorganized some of the definitions and examples
-Added highlighting to some examples