@supabase/functions-js - npm Package Compare versions

Comparing version 1.4.0-next.4 to 1.4.0-next.5

dist/main/FunctionsClient.d.ts

@@ -12,3 +12,3 @@ import { Fetch, FunctionsResponse, FunctionInvokeOptions } from './types';
      * 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
      */
@@ -19,4 +19,2 @@ setAuth(token: string): void;
      * @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
      */
@@ -23,0 +21,0 @@ invoke<T = any>(functionName: string, invokeOptions?: FunctionInvokeOptions): Promise<FunctionsResponse<T>>;

dist/main/FunctionsClient.js

@@ -23,3 +23,3 @@ "use strict";
      * 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
      */
@@ -32,4 +32,2 @@ setAuth(token) {
      * @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
      */
@@ -36,0 +34,0 @@ invoke(functionName, invokeOptions = {}) {

dist/main/types.d.ts

@@ -6,7 +6,7 @@ export declare type Fetch = typeof fetch;
  */
-interface FunctionsResponseSuccess<T> {
+export interface FunctionsResponseSuccess<T> {
     data: T;
     error: null;
 }
-interface FunctionsResponseFailure {
+export interface FunctionsResponseFailure {
     data: null;
@@ -30,8 +30,13 @@ error: any;
 export declare type FunctionInvokeOptions = {
+    /**
+     * object representing the headers to send with the request
+     * */
     headers?: {
         [key: string]: string;
     };
+    /**
+     * the body of the request
+     */
     body?: File | Blob | ArrayBuffer | FormData | ReadableStream<Uint8Array> | Record<string, any> | string;
 };
-export {};
 //# sourceMappingURL=types.d.ts.map

dist/main/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "1.4.0-next.4";
+export declare const version = "1.4.0-next.5";
 //# sourceMappingURL=version.d.ts.map

dist/main/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '1.4.0-next.4';
+exports.version = '1.4.0-next.5';
 //# sourceMappingURL=version.js.map

dist/module/FunctionsClient.d.ts

@@ -12,3 +12,3 @@ import { Fetch, FunctionsResponse, FunctionInvokeOptions } from './types';
      * 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
      */
@@ -19,4 +19,2 @@ setAuth(token: string): void;
      * @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
      */
@@ -23,0 +21,0 @@ invoke<T = any>(functionName: string, invokeOptions?: FunctionInvokeOptions): Promise<FunctionsResponse<T>>;

dist/module/FunctionsClient.js

@@ -20,3 +20,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
      * 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
      */
@@ -29,4 +29,2 @@ setAuth(token) {
      * @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
      */
@@ -33,0 +31,0 @@ invoke(functionName, invokeOptions = {}) {

dist/module/types.d.ts

@@ -6,7 +6,7 @@ export declare type Fetch = typeof fetch;
  */
-interface FunctionsResponseSuccess<T> {
+export interface FunctionsResponseSuccess<T> {
     data: T;
     error: null;
 }
-interface FunctionsResponseFailure {
+export interface FunctionsResponseFailure {
     data: null;
@@ -30,8 +30,13 @@ error: any;
 export declare type FunctionInvokeOptions = {
+    /**
+     * object representing the headers to send with the request
+     * */
     headers?: {
         [key: string]: string;
     };
+    /**
+     * the body of the request
+     */
     body?: File | Blob | ArrayBuffer | FormData | ReadableStream<Uint8Array> | Record<string, any> | string;
 };
-export {};
 //# sourceMappingURL=types.d.ts.map

dist/module/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "1.4.0-next.4";
+export declare const version = "1.4.0-next.5";
 //# sourceMappingURL=version.d.ts.map

dist/module/version.js

@@ -1,2 +0,2 @@
-export const version = '1.4.0-next.4';
+export const version = '1.4.0-next.5';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@supabase/functions-js",
-  "version": "1.4.0-next.4",
+  "version": "1.4.0-next.5",
   "description": "JS Client library to interact with Supabase Functions.",
@@ -46,3 +46,3 @@ "main": "dist/main/index.js",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
-    "typedoc": "^0.23.10",
+    "typedoc": "^0.22.16",
     "typescript": "^4.6.2"
@@ -49,0 +49,0 @@ },

src/FunctionsClient.ts

@@ -33,3 +33,3 @@ import { resolveFetch } from './helper'
    * 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
    */
@@ -43,4 +43,2 @@ setAuth(token: string) {
    * @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
    */
@@ -47,0 +45,0 @@ async invoke<T = any>(

src/types.ts

@@ -7,7 +7,7 @@ export type Fetch = typeof fetch
  */
-interface FunctionsResponseSuccess<T> {
+export interface FunctionsResponseSuccess<T> {
   data: T
   error: null
 }
-interface FunctionsResponseFailure {
+export interface FunctionsResponseFailure {
   data: null
@@ -46,3 +46,9 @@ error: any
 export type FunctionInvokeOptions = {
+  /**
+   * object representing the headers to send with the request
+   * */
   headers?: { [key: string]: string }
+  /**
+   * the body of the request
+   */
   body?:
@@ -49,0 +55,0 @@ | File

src/version.ts

@@ -1,1 +0,1 @@
-export const version = '1.4.0-next.4'
+export const version = '1.4.0-next.5'

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

656

increased by0.92%

Worsened metrics

Total package byte prevSize

42486

decreased by-0.74%

No dependency changes