Skip to content

Commit 71bc23c

Browse files
committed
fix docs for invokeOptions
1 parent ce7a399 commit 71bc23c

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

src/index.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,6 @@ export class FunctionsClient {
3232
/**
3333
* Invokes a function
3434
* @param functionName - the name of the function to invoke
35-
* @param invokeOptions - object with the following properties
36-
* `headers`: object representing the headers to send with the request
37-
* `body`: the body of the request
38-
* `responseType`: how the response should be parsed. The default is `json`
3935
*/
4036
async invoke<T = any>(
4137
functionName: string,

src/types.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ export enum ResponseType {
88
}
99

1010
export type FunctionInvokeOptions = {
11+
/** object representing the headers to send with the request 1 */
1112
headers?: { [key: string]: string }
13+
/** the body of the request */
1214
body?: Blob | BufferSource | FormData | URLSearchParams | ReadableStream<Uint8Array> | string
15+
/** how the response should be parsed. The default is `json` */
1316
responseType?: keyof typeof ResponseType
1417
}

0 commit comments

Comments
 (0)