A channel is the basic building block of Realtime and narrows the scope of data flow to subscribed clients. You can think of a channel as a chatroom where participants are able to see who's online and send and receive messages.

Supabase Client.

WorkflowContext is used for providing api access to the workflow engine.

Adds durable encryption layer to the sent messages.

Adds a layer of verification for received messages

Adds the caller signature to the headers allowing receiveirs to validate the identity of the request.

Encode a given message to string.

Creates a new Supabase Client.

Exposes a workflow function as a http handler.

Exposes a workflow function as a runner.

Exposes a workflow function as a http websocket handler.

Implements a global exclusive lock using the Navigator LockManager API. It is available on all browsers released after 2022-03-15 with Safari being the last one to release support. If the API is not available, this function will throw. Make sure you check availablility before configuring GoTrueClient.

Raised when an activity is in completed state.

ActivityStartedEvent is the event that is raised when the activity starts.

Event is the base event

Invoke the given http endpoint

WorkflowStartedEvent is the event that should start the workflow

An authentication methord reference (AMR) entry.

A MFA factor.

Contains the full multi-factor authentication administration API.

Contains the full multi-factor authentication API.

TimerFiredEvent is the event that is raised when a timer is fired.

TimerScheduledEvent is the event that is raised when a timer is scheduled.

WaitingSignalEvent is used to indicate that the state is waiting for signal to proceed.

WorkflowCanceledEvent is a event that will cancel the workflow

WorkflowStartedEvent is the event that should start the workflow

WorkflowStartedEvent is the event that should start the workflow

Arg is a generic argument

All possible types of events.

JSON Schema v7

Primitive type

AuthOtpResponse is returned when OTP is used.

The properties related to the email link generated

Provide your own global lock implementation instead of the default implementation. The function should acquire a lock for the duration of the fn async function, such that no other client instances will be able to hold it at the same time.

Error format

One of the providers supported by GoTrue.

WorkflowGen is the generator function returned by a workflow function.