JavaScript: Invokes a Supabase Edge Function.

Invokes a function

Invoke a Supabase Edge Function.

• Requires an Authorization header.
• Invoke params generally match the 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.

Parameters

• functionName

  (Required)

  The name of the Function to invoke.

• options

  (Required)

  Options for invoking the Function.

Examples

Basic invocation

const \{ data, error \} = await supabase.functions.invoke('hello', \{
  body: \{ foo: 'bar' \}
\})

Error handling

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.log('Function returned an error', errorMessage)
\} else if (error instanceof FunctionsRelayError) \{
  console.log('Relay error:', error.message)
\} else if (error instanceof FunctionsFetchError) \{
  console.log('Fetch error:', error.message)
\}

Passing custom headers

const \{ data, error \} = await supabase.functions.invoke('hello', \{
  headers: \{
    "my-custom-header": 'my-custom-header-value'
  \},
  body: \{ foo: 'bar' \}
\})

Calling with DELETE HTTP verb

const \{ data, error \} = await supabase.functions.invoke('hello', \{
  headers: \{
    "my-custom-header": 'my-custom-header-value'
  \},
  body: \{ foo: 'bar' \},
  method: 'DELETE'
\})

Invoking a Function in the UsEast1 region

import \{ createClient, FunctionRegion \} from '@supabase/supabase-js'

const \{ data, error \} = await supabase.functions.invoke('hello', \{
  body: \{ foo: 'bar' \},
  region: FunctionRegion.UsEast1
\})

Calling with GET HTTP verb

const \{ data, error \} = await supabase.functions.invoke('hello', \{
  headers: \{
    "my-custom-header": 'my-custom-header-value'
  \},
  method: 'GET'
\})