File size: 7,025 Bytes
c212805 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | import { Fetch, FunctionInvokeOptions, FunctionRegion, FunctionsResponse } from './types';
/**
* Client for invoking Supabase Edge Functions.
*/
export declare class FunctionsClient {
protected url: string;
protected headers: Record<string, string>;
protected region: FunctionRegion;
protected fetch: Fetch;
/**
* Creates a new Functions client bound to an Edge Functions URL.
*
* @example Using supabase-js (recommended)
* ```ts
* import { createClient } from '@supabase/supabase-js'
*
* const supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')
* const { data, error } = await supabase.functions.invoke('hello-world')
* ```
*
* @category Edge Functions
*
* @example Standalone import for bundle-sensitive environments
* ```ts
* import { FunctionsClient, FunctionRegion } from '@supabase/functions-js'
*
* const functions = new FunctionsClient('https://xyzcompany.supabase.co/functions/v1', {
* headers: { apikey: 'your-publishable-key' },
* region: FunctionRegion.UsEast1,
* })
* ```
*/
constructor(url: string, { headers, customFetch, region, }?: {
headers?: Record<string, string>;
customFetch?: Fetch;
region?: FunctionRegion;
});
/**
* Updates the authorization header
* @param token - the new jwt token sent in the authorisation header
*
* @category Edge Functions
*
* @example Setting the authorization header
* ```ts
* functions.setAuth(session.access_token)
* ```
*/
setAuth(token: string): void;
/**
* Invokes a function
* @param functionName - The name of the Function to invoke.
* @param options - Options for invoking the Function.
* @example
* ```ts
* const { data, error } = await functions.invoke('hello-world', {
* body: { name: 'Ada' },
* })
* ```
*
* @category Edge Functions
*
* @remarks
* - The API key is sent in the `apikey` header. The `Authorization` header is reserved
* for the signed-in user's JWT (or a custom auth token) — when there is no session, a
* new-format API key (`sb_publishable_…` / `sb_secret_…`) is not sent as a Bearer token.
* - Invoke params generally match the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) spec.
* - When you pass in a body to your function, we automatically attach the Content-Type header for `Blob`, `ArrayBuffer`, `File`, `FormData` and `String`. If it doesn't match any of these types we assume the payload is `json`, serialize it and attach the `Content-Type` header as `application/json`. You can override this behavior by passing in a `Content-Type` header of your own.
* - Responses are automatically parsed as `json`, `blob` and `form-data` depending on the `Content-Type` header sent by your function. Responses are parsed as `text` by default.
*
* @example Basic invocation
* ```js
* const { data, error } = await supabase.functions.invoke('hello', {
* body: { foo: 'bar' }
* })
* ```
*
* @exampleDescription Error handling
* A `FunctionsHttpError` error is returned if your function throws an error, `FunctionsRelayError` if the Supabase Relay has an error processing your function and `FunctionsFetchError` if there is a network error in calling your function. Log the full error object so fields like `name`, `context`, and any structured body aren't hidden.
*
* @example Error handling
* ```js
* import { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from "@supabase/supabase-js";
*
* const { data, error } = await supabase.functions.invoke('hello', {
* headers: {
* "my-custom-header": 'my-custom-header-value'
* },
* body: { foo: 'bar' }
* })
*
* if (error instanceof FunctionsHttpError) {
* const errorMessage = await error.context.json()
* console.error('Function returned an error', errorMessage)
* } else if (error instanceof FunctionsRelayError) {
* console.error('Relay error:', error)
* } else if (error instanceof FunctionsFetchError) {
* console.error('Fetch error:', error)
* }
* ```
*
* @exampleDescription Passing custom headers
* You can pass custom headers to your function. Note: supabase-js automatically passes the `Authorization` header with the signed in user's JWT.
*
* @example Passing custom headers
* ```js
* const { data, error } = await supabase.functions.invoke('hello', {
* headers: {
* "my-custom-header": 'my-custom-header-value'
* },
* body: { foo: 'bar' }
* })
* ```
*
* @exampleDescription Calling with DELETE HTTP verb
* You can also set the HTTP verb to `DELETE` when calling your Edge Function.
*
* @example Calling with DELETE HTTP verb
* ```js
* const { data, error } = await supabase.functions.invoke('hello', {
* headers: {
* "my-custom-header": 'my-custom-header-value'
* },
* body: { foo: 'bar' },
* method: 'DELETE'
* })
* ```
*
* @exampleDescription Invoking a Function in the UsEast1 region
* Here are the available regions:
* - `FunctionRegion.Any`
* - `FunctionRegion.ApNortheast1`
* - `FunctionRegion.ApNortheast2`
* - `FunctionRegion.ApSouth1`
* - `FunctionRegion.ApSoutheast1`
* - `FunctionRegion.ApSoutheast2`
* - `FunctionRegion.CaCentral1`
* - `FunctionRegion.EuCentral1`
* - `FunctionRegion.EuWest1`
* - `FunctionRegion.EuWest2`
* - `FunctionRegion.EuWest3`
* - `FunctionRegion.SaEast1`
* - `FunctionRegion.UsEast1`
* - `FunctionRegion.UsWest1`
* - `FunctionRegion.UsWest2`
*
* @example Invoking a Function in the UsEast1 region
* ```js
* import { createClient, FunctionRegion } from '@supabase/supabase-js'
*
* const { data, error } = await supabase.functions.invoke('hello', {
* body: { foo: 'bar' },
* region: FunctionRegion.UsEast1
* })
* ```
*
* @exampleDescription Calling with GET HTTP verb
* You can also set the HTTP verb to `GET` when calling your Edge Function.
*
* @example Calling with GET HTTP verb
* ```js
* const { data, error } = await supabase.functions.invoke('hello', {
* headers: {
* "my-custom-header": 'my-custom-header-value'
* },
* method: 'GET'
* })
* ```
*
* @example Standalone client invoke
* ```ts
* const { data, error } = await functions.invoke('hello-world', {
* body: { name: 'Ada' },
* })
* ```
*/
invoke<T = any>(functionName: string, options?: FunctionInvokeOptions): Promise<FunctionsResponse<T>>;
}
//# sourceMappingURL=FunctionsClient.d.ts.map |