Skip to content

Commit 0b6644c

Browse files
committed
update inlineFileProperties description
1 parent 1d518ab commit 0b6644c

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

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

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,56 @@ const bar: MyRootType.Foo.Bar = {};
255255
```
256256
</ParamField>
257257

258-
<ParamField path="inlineFileProperties" type="boolean">
258+
<ParamField path="inlineFileProperties" type="boolean" default="true">
259+
Generate file upload properties as inline request properties (instead of positional parameters).
260+
261+
`inlineFileProperties: false`:
262+
263+
```typescript
264+
/**
265+
* @param {File | fs.ReadStream} file
266+
* @param {File[] | fs.ReadStream[]} fileList
267+
* @param {File | fs.ReadStream | undefined} maybeFile
268+
* @param {File[] | fs.ReadStream[] | undefined} maybeFileList
269+
* @param {Acme.MyRequest} request
270+
* @param {Service.RequestOptions} requestOptions - Request-specific configuration.
271+
*
272+
* @example
273+
* await client.service.post(fs.createReadStream("/path/to/your/file"), [fs.createReadStream("/path/to/your/file")], fs.createReadStream("/path/to/your/file"), [fs.createReadStream("/path/to/your/file")], {})
274+
*/
275+
public async post(
276+
file: File | fs.ReadStream,
277+
fileList: File[] | fs.ReadStream[],
278+
maybeFile: File | fs.ReadStream | undefined,
279+
maybeFileList: File[] | fs.ReadStream[] | undefined,
280+
request: Acme.MyRequest,
281+
requestOptions?: Acme.RequestOptions
282+
): Promise<void> {
283+
...
284+
}
285+
```
286+
287+
`inlineFileProperties: true`:
288+
289+
```typescript
290+
/**
291+
* @param {Acme.MyRequest} request
292+
* @param {Service.RequestOptions} requestOptions - Request-specific configuration.
293+
*
294+
* @example
295+
* await client.service.post({
296+
* file: fs.createReadStream("/path/to/your/file"),
297+
* fileList: [fs.createReadStream("/path/to/your/file")]
298+
* })
299+
*/
300+
public async post(
301+
request: Acme.MyRequest,
302+
requestOptions?: Service.RequestOptions
303+
): Promise<void> {
304+
...
305+
}
306+
```
307+
259308
</ParamField>
260309

261310
<ParamField path="inlinePathParameters" type="boolean">

0 commit comments

Comments
 (0)