@supabase/functions-js
Version:
JS Client library to interact with Supabase Functions.
65 lines • 1.82 kB
TypeScript
export declare type Fetch = typeof fetch;
/**
* Response format
*
*/
export interface FunctionsResponseSuccess<T> {
data: T;
error: null;
}
export interface FunctionsResponseFailure {
data: null;
error: any;
}
export declare type FunctionsResponse<T> = FunctionsResponseSuccess<T> | FunctionsResponseFailure;
export declare class FunctionsError extends Error {
context: any;
constructor(message: string, name?: string, context?: any);
}
export declare class FunctionsFetchError extends FunctionsError {
constructor(context: any);
}
export declare class FunctionsRelayError extends FunctionsError {
constructor(context: any);
}
export declare class FunctionsHttpError extends FunctionsError {
constructor(context: any);
}
export declare enum FunctionRegion {
Any = "any",
ApNortheast1 = "ap-northeast-1",
ApNortheast2 = "ap-northeast-2",
ApSouth1 = "ap-south-1",
ApSoutheast1 = "ap-southeast-1",
ApSoutheast2 = "ap-southeast-2",
CaCentral1 = "ca-central-1",
EuCentral1 = "eu-central-1",
EuWest1 = "eu-west-1",
EuWest2 = "eu-west-2",
EuWest3 = "eu-west-3",
SaEast1 = "sa-east-1",
UsEast1 = "us-east-1",
UsWest1 = "us-west-1",
UsWest2 = "us-west-2"
}
export declare type FunctionInvokeOptions = {
/**
* Object representing the headers to send with the request.
* */
headers?: {
[key: string]: string;
};
/**
* The HTTP verb of the request
*/
method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE';
/**
* The Region to invoke the function in.
*/
region?: FunctionRegion;
/**
* The body of the request.
*/
body?: File | Blob | ArrayBuffer | FormData | ReadableStream<Uint8Array> | Record<string, any> | string;
};
//# sourceMappingURL=types.d.ts.map