fix: typedocs

src/FunctionsClient.ts

@@ -30,7 +30,7 @@ export class FunctionsClient {
 
   /**
    * Updates the authorization header
-   * @params token - the new jwt token sent in the authorisation header
+   * @param token - the new jwt token sent in the authorisation header
    */
   setAuth(token: string) {
     this.headers.Authorization = `Bearer ${token}`
@@ -39,8 +39,6 @@ export class FunctionsClient {
   /**
    * Invokes a function
    * @param functionName - the name of the function to invoke
-   * @param invokeOption.headers - object representing the headers to send with the request
-   * @param invokeOptions.body - the body of the request
    */
   async invoke<T = any>(
     functionName: string,

src/types.ts

@@ -4,11 +4,11 @@ export type Fetch = typeof fetch
  * Response format
  *
  */
-interface FunctionsResponseSuccess<T> {
+export interface FunctionsResponseSuccess<T> {
   data: T
   error: null
 }
-interface FunctionsResponseFailure {
+export interface FunctionsResponseFailure {
   data: null
   error: any
 }
@@ -42,7 +42,13 @@ export class FunctionsHttpError extends FunctionsError {
 }
 
 export type FunctionInvokeOptions = {
+  /**
+   * object representing the headers to send with the request
+   * */
   headers?: { [key: string]: string }
+  /**
+   * the body of the request
+   */
   body?:
     | File
     | Blob