Home

Local Development

You can run your Edge Function locally using supabase functions serve:

1supabase start # start the supabase stack
2supabase functions serve hello-world # start the Function watcher

The functions serve command has hot-reloading capabilities. It will watch for any changes to your files and restart the Deno server.

Invoking functions locally#

While serving your local Function, you can invoke it using curl:

1curl --request POST 'http://localhost:54321/functions/v1/hello-world' \
2  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs' \
3  --header 'Content-Type: application/json' \
4  --data '{ "name":"Functions" }'

or using one of the client libraries, e.g. using supabase-js:

import { createClient } from '@supabase/supabase-js'

// Use the credentials outputted in your terminal when running `supabase start`
const supabase = createClient(
  'http://localhost:54321',
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0'
)

const { data, error } = await supabase.functions.invoke('hello-world', {
  body: { name: 'Functions' },
})

You should see the response { "message":"Hello Functions!" }.

If you execute Function with a different payload the response will change.
Modify the --data '{"name":"Functions"}' line to --data '{"name":"World"}' and try invoking the command again!

note

  • Edge Functions don't serve HTML content (GET requests that return text/html are rewritten to text/plain).
  • The Authorization header is required. You can use either the ANON key, the SERVICE_ROLE key, or a logged-in user's JWT.
  • The Function is proxied through the local API (http://localhost:54321)
Need some help?

Not to worry, our specialist engineers are here to help. Submit a support ticket through the Dashboard.