JavaScript: Invokes a Supabase Edge Function. (original) (raw)

• Introduction
• Installing
• Initializing
• TypeScript support
• Database
• Fetch data
• Insert data
• Update data
• Upsert data
• Delete data
• Call a Postgres function
• Using filters
• Column is equal to a value
• Column is not equal to a value
• Column is greater than a value
• Column is greater than or equal to a value
• Column is less than a value
• Column is less than or equal to a value
• Column matches a pattern
• Column matches a case-insensitive pattern
• Column is a value
• Column is in an array
• Column contains every element in a value
• Contained by value
• Greater than a range
• Greater than or equal to a range
• Less than a range
• Less than or equal to a range
• Mutually exclusive to a range
• With a common element
• Match a string
• Match an associated value
• Don't match the filter
• Match at least one filter
• Match the filter
• Using modifiers
• Return data after inserting
• Order the results
• Limit the number of rows returned
• Limit the query to a range
• Set an abort signal
• Retrieve one row of data
• Retrieve zero or one row of data
• Retrieve as a CSV
• Override type of successful response
• Partially override or replace type of successful response
• Using explain
• Auth
• Overview
• Create a new user
• Listen to auth events
• Create an anonymous user
• Sign in a user
• Sign in with ID Token
• Sign in a user through OTP
• Sign in a user through OAuth
• Sign in a user through SSO
• Sign out a user
• Send a password reset request
• Verify and log in through OTP
• Retrieve a session
• Retrieve a new session
• Retrieve a user
• Update a user
• Retrieve identities linked to a user
• Link an identity to a user
• Unlink an identity from a user
• Send a password reauthentication nonce
• Resend an OTP
• Set the session data
• Exchange an auth code for a session
• Start auto-refresh session (non-browser)
• Stop auto-refresh session (non-browser)
• Auth MFA
• Enroll a factor
• Create a challenge
• Verify a challenge
• Create and verify a challenge
• Unenroll a factor
• Get Authenticator Assurance Level
• Auth Admin
• Retrieve a user
• List all users
• Create a user
• Delete a user
• Send an email invite link
• Generate an email link
• Update a user
• Delete a factor for a user
• Edge Functions
• Invokes a Supabase Edge Function.
• Realtime
• Subscribe to channel
• Unsubscribe from a channel
• Unsubscribe from all channels
• Retrieve all channels
• Broadcast a message
• Storage
• Create a bucket
• Retrieve a bucket
• List all buckets
• Update a bucket
• Delete a bucket
• Empty a bucket
• Upload a file
• Download a file
• List all files in a bucket
• Replace an existing file
• Move an existing file
• Copy an existing file
• Delete files in a bucket
• Create a signed URL
• Create signed URLs
• Create signed upload URL
• Upload to a signed URL
• Retrieve public URL
• Misc
• Release Notes

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'
})