Skip to content

Commit 97b4817

Browse files
committed
update noScripts and includeContentHeadersOnFileDownloadResponse
1 parent 0b59d2c commit 97b4817

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

fern/products/sdks/pages/typescript/configuration.mdx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ groups:
2121
<ParamField path="outputSourceFiles" type="boolean" default="false">
2222
When enabled, the generator outputs raw TypeScript files. When disabled (the default), outputs `.js` and `d.ts` files.
2323

24-
<Note>This only applies when dumping code locally. This configuration is ignored when publishing to Github or npm._ </Note>
24+
<Note>This only applies when dumping code locally. This configuration is ignored when publishing to Github or npm.</Note>
2525
</ParamField>
2626

2727
<ParamField path="includeCredentialsOnCrossOriginRequests" type="boolean" default="false">
@@ -521,6 +521,18 @@ interface ObjectWithLongAndBigInt {
521521
### Beta options
522522

523523
<ParamField path="includeContentHeadersOnFileDownloadResponse" type="boolean">
524+
525+
Includes the content type and content length from binary responses. The user will receive an object of the following type:
526+
527+
```typescript
528+
{
529+
data: <BINARY_RESPONSE_TYPE>;
530+
contentLengthInBytes?: number;
531+
contentType?: string;
532+
}
533+
```
534+
535+
`<BINARY_RESPONSE_TYPE>` is `core.BinaryResponse` or a stream, depending on `fileResponseType` setting.
524536
</ParamField>
525537

526538
<ParamField path="includeUtilsOnUnionMembers" type="boolean">
@@ -530,5 +542,6 @@ interface ObjectWithLongAndBigInt {
530542
</ParamField>
531543

532544
<ParamField path="noScripts" type="boolean">
545+
Prevent the generator from running any scripts such as `yarn format` or `yarn install`. If any of the scripts cause errors, toggling this option will allow you to receive the generated code.
533546
</ParamField>
534547

0 commit comments

Comments
 (0)